com.ibm.portal.um.portletservice
Interface PumaHome

All Superinterfaces:

PortletService

public interface PumaHome
extends PortletService

This Interface can be used to access the UserManagement component of WebSphere Portal
from a JSR 168 portlet. An instance can be retrieved using a JNDI lookup for the following JNDI name portletservice/com.ibm.portal.um.portletservice.PumaHome The returned instance provides a way to access the three views to the user repository
com.ibm.portal.um.PumaProfile
com.ibm.portal.um.PumaController
com.ibm.portal.um.PumaLocator
The following sample shows you how to perform the JNDI lookup

     PortletServiceHome psh;
     javax.naming.Context ctx = new javax.naming.InitialContext();
     try {
          psh = (PortletServiceHome) 
             ctx.lookup("portletservice/com.ibm.portal.um.portletservice.PumaHome");
     } catch(javax.naming.NameNotFoundException ex) {
          ... error handling ...
     }
     ...
     // use the service
     PumaHome service = (PumaHome) psh.getPortletService(PumaHome.class);
 

Since:

5.1.0.1

See Also:

PumaProfile, PumaLocator, PumaController

Method Summary

PumaController	javax.portlet.ActionRequest)">getController(javax.portlet.ActionRequest aRequest) The returned instance of PumaController can be used to read/modify attributes for a Principal
PumaEnvironment	getEnvironment() The returned instance of PumaEnvironment can be used to read the common configuration of Portal User Management
PumaLocator	javax.portlet.PortletRequest)">getLocator(javax.portlet.PortletRequest aRequest) The returned instance of PumaLocator can be used find Principal
PumaLocator	javax.portlet.PortletRequest, int)">getLocator(javax.portlet.PortletRequest aRequest, int maxSearchResult) The returned instance of PumaLocator can be used to find Principal objects
PumaProfile	javax.portlet.PortletRequest)">getProfile(javax.portlet.PortletRequest aRequest) The returned instance of PumaProfile can be used to read attributes for a Principal

Method Detail

javax.portlet.ActionRequest)">

getController

PumaController getController(javax.portlet.ActionRequest aRequest)

The returned instance of PumaController can be used to read/modify attributes for a Principal

Parameters:

aRequest - NULL is not allowed as parameter

Returns:

a handle to the read/write PUMA service

javax.portlet.PortletRequest)">

getLocator

PumaLocator getLocator(javax.portlet.PortletRequest aRequest)

The returned instance of PumaLocator can be used find Principal

Parameters:

aRequest - NULL is not allowed as parameter

Returns:

a handle to the find PUMA service

javax.portlet.PortletRequest)">

getProfile

PumaProfile getProfile(javax.portlet.PortletRequest aRequest)

The returned instance of PumaProfile can be used to read attributes for a Principal

Parameters:

aRequest - NULL is not allowed as parameter

Returns:

a handle to the read PUMA service

getEnvironment

PumaEnvironment getEnvironment()

The returned instance of PumaEnvironment can be used to read the common configuration of Portal User Management

Returns:

an Environment instance.

Since:

6.1

javax.portlet.PortletRequest, int)">

getLocator

PumaLocator getLocator(javax.portlet.PortletRequest aRequest,
                       int maxSearchResult)

The returned instance of PumaLocator can be used to find Principal objects

Parameters:

aRequest - NULL is not allowed as parameter

maxSearchResult - the maximal amount of results allowed for any call on the returned PumaLocator.

Returns:

a locator instance. Will return null if called via webservices

Since:

6.1