com.ibm.portal.um.portletservice.legacy
Interface PumaHome

All Superinterfaces:

org.apache.jetspeed.portlet.service.PortletService

Deprecated.

public interface PumaHome
extends org.apache.jetspeed.portlet.service.PortletService

This Interface can be used to access the UserManagement component of WebSphere Portal
from a legacy portlet. An instance can be retrieved via querying the PortletRegistryService

 PumaHome service = (PumaHome) getPortletContext().getService(PumaHome.class);
 

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

Since:

5.1.0.1

See Also:

PumaProfile, PumaLocator, PumaController

Method Summary

PumaController	getController(org.apache.jetspeed.portlet.event.ActionEvent aEvent) Deprecated. The returned instance of PumaController can be used to read/modify attributes for a com.ibm.portal.um.Principal
PumaEnvironment	getEnvironment() Deprecated. The returned instance of PumaEnvironment can be used to read the common configuration of Portal User Management
PumaLocator	getLocator(org.apache.jetspeed.portlet.PortletRequest aRequest) Deprecated. The returned instance of PumaLocator can be used to find com.ibm.portal.um.Principal
PumaLocator	getLocator(org.apache.jetspeed.portlet.PortletRequest aRequest, int maxSearchResult) Deprecated. The returned instance of PumaLocator can be used to find Principal objects
PumaProfile	getProfile(org.apache.jetspeed.portlet.PortletRequest aRequest) Deprecated. The returned instance of PumaProfile can be used to read attributes for a Principal

Method Detail

getController

PumaController getController(org.apache.jetspeed.portlet.event.ActionEvent aEvent)

Deprecated.

The returned instance of PumaController can be used to read/modify attributes for a com.ibm.portal.um.Principal

Parameters:

aEvent - NULL is not allowed as parameter

Returns:

a handle to the read/write PUMA service

getLocator

PumaLocator getLocator(org.apache.jetspeed.portlet.PortletRequest aRequest)

Deprecated.

The returned instance of PumaLocator can be used to find com.ibm.portal.um.Principal

Parameters:

aRequest - NULL is not allowed as parameter

Returns:

a handle to the find PUMA service

getProfile

PumaProfile getProfile(org.apache.jetspeed.portlet.PortletRequest aRequest)

Deprecated.

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()

Deprecated.

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

Returns:

an Environment instance.

Since:

6.1

getLocator

PumaLocator getLocator(org.apache.jetspeed.portlet.PortletRequest aRequest,
                       int maxSearchResult)

Deprecated.

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