com.ibm.portal.cp.resources
Interface PortletResourceModelProvider

All Superinterfaces:
PortletService, ResourceModelControllerProvider

public interface PortletResourceModelProvider
extends PortletService, ResourceModelControllerProvider

ResourceModelProvider for portlet scope, i. e. with portlet request / response.
Example how to lookup this provider:

 PortletServiceHome psh;
 javax.naming.Context ctx = new javax.naming.InitialContext();
 boolean serviceAvailable = false;
 
 try {
     psh = (PortletServiceHome) ctx.lookup(PortletResourceModelProvider.JNDI_NAME);
     serviceAvailable = true;
 } catch(javax.naming.NameNotFoundException ex) {
     ... error handling ...
 }
 ...
 if (serviceAvailable) {
    PortletResourceModelProvider provider = (PortletResourceModelProvider) psh.getPortletService(PortletResourceModelProvider.class);
          ResourceModel<Resource> model = provider.getResourceModel(aRequest, aResponse);
     ...
 }
 

Note: The lookup for this provider should be executed within the init method of a portlet and only the lookup for the ResourceModel itself should be performed on a per-request basis.

Since:
7.0.0

Field Summary
static java.lang.String JNDI_NAME
          The JNDI lookup name
 
Method Summary
<R extends Resource>
ResourceModel<R>
getResourceModel(javax.portlet.PortletRequest aRequest, javax.portlet.PortletResponse aResponse)
          Returns a ResourceModel which exposes a ResourceModelLocator
 
Methods inherited from interface com.ibm.portal.cp.resources.ResourceModelControllerProvider
getResourceModelController
 

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME
The JNDI lookup name

See Also:
Constant Field Values
Method Detail

getResourceModel

<R extends Resource> ResourceModel<R> getResourceModel(javax.portlet.PortletRequest aRequest,
                                                       javax.portlet.PortletResponse aResponse)
                                                   throws ModelException
Returns a ResourceModel which exposes a ResourceModelLocator

Parameters:
aRequest - The current portlet request
aResponse - The current portlet response
Returns:
The ResourceModel.
Throws:
ModelException