com.ibm.portal.um
Interface PumaHome

public interface PumaHome

This Interface can be used to access the UserManagement component of WebSphere Portal
An instance can be retrieved using a JNDI lookup for the following JNDI name portal:service/usermanagement/Puma.
The name is also available via a constant of the Interface itself PumaHome.JNDI_NAME 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 Either by

      Context ctx = new InitialContext();
      Name myjndiname = new CompositeName(PumaHome.JNDI_NAME);
      PumaHome myHome = (PumaHome) ctx.lookup(myjndiname);    
 

or

 
      String myjndiname = PumaHome.JNDI_NAME;
      PumaHome myHome = (PumaHome) ctx.lookup(myjndiname);
 

Since:

5.1.0.1

See Also:

PumaProfile, PumaLocator, PumaController

Field Summary

static java.lang.String	DEFAULT_PROVIDER Constant to address the default provider for the PUMA store when retrieving a PumaController, PumaLocator, or PumaProfile in the scope of a particular context.
static java.lang.String	JNDI_NAME The name can be used to lookup the PumaHome from JNDI

Method Summary

PumaController	getController() The returned instance of PumaController can be used to read/modify attributes for a Principal The PumaController object returned by this method uses WebSphere Application Server RunAs Subject security feature to determine the current available user.
PumaController	getController(javax.servlet.ServletRequest aRequest) Deprecated. As of release 6.1,use instead
PumaController	getController(java.lang.String aCtx, javax.servlet.ServletRequest aRequest) The returned instance of PumaController can be used to read/modify attributes for a Principal The PumaController object returned by this method uses WebSphere Application Server RunAs Subject security feature to determine the current available user.
PumaEnvironment	getEnvironment() The returned instance of PumaEnvironment can be used to read the common configuration of Portal User Management
PumaLocator	getLocator() The returned instance of PumaLocator can be used to find Principal objects
PumaLocator	getLocator(javax.servlet.ServletRequest aRequest) Deprecated. As of release 6.1,use instead
PumaLocator	getLocator(java.lang.String aCtx, javax.servlet.ServletRequest aRequest) The returned instance of PumaLocator can be used to find Principal objects
PumaProfile	getProfile() The returned instance of PumaProfil can be used to read attributes for a Principal The PumaProfil object returned by this method uses WebSphere Application Server RunAs Subject security feature to determine the current available user.
PumaProfile	getProfile(javax.servlet.ServletRequest aRequest) Deprecated. As of release 6.1,use instead
PumaProfile	getProfile(java.lang.String aCtx, javax.servlet.ServletRequest aRequest) The returned instance of PumaProfil can be used to read attributes for a Principal The PumaProfil object returned by this method uses WebSphere Application Server RunAs Subject security feature to determine the current available user.

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

The name can be used to lookup the PumaHome from JNDI

See Also:

Constant Field Values

DEFAULT_PROVIDER

static final java.lang.String DEFAULT_PROVIDER

Constant to address the default provider for the PUMA store when retrieving a PumaController, PumaLocator, or PumaProfile in the scope of a particular context.

See Also:

Constant Field Values

Method Detail

getController

PumaController getController(javax.servlet.ServletRequest aRequest)

Deprecated. As of release 6.1,use instead

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

Parameters:

aRequest - the current request. null is not allowed as parameter

Returns:

a controller instance. Will return null if called via webservices

getLocator

PumaLocator getLocator(javax.servlet.ServletRequest aRequest)

Deprecated. As of release 6.1,use instead

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

Parameters:

aRequest - the current request. NULL is not allowed as parameter

Returns:

a locator instance. Will return null if called via webservices

getProfile

PumaProfile getProfile(javax.servlet.ServletRequest aRequest)

Deprecated. As of release 6.1,use instead

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

Parameters:

aRequest - the current request. NULL is not allowed as parameter

Returns:

a profile instance

getController

PumaController getController()

The returned instance of PumaController can be used to read/modify attributes for a Principal The PumaController object returned by this method uses
WebSphere Application Server RunAs Subject security feature to determine the current available user.
Caused by the dependency to WebSphere Application Server security the getCurrentUser() method of the returned object can only return a valid user object if security is enabled

Returns:

a controller instance. Will return null if called via webservices

Since:

6.0

getLocator

PumaLocator getLocator()

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

Returns:

a locator instance. Will return null if called via webservices

Since:

6.0

getProfile

PumaProfile getProfile()

The returned instance of PumaProfil can be used to read attributes for a Principal The PumaProfil object returned by this method uses WebSphere Application Server RunAs Subject security feature to determine the current available user.
Caused by the dependency to WebSphere Application Server security the getCurrentUser() method of the returned object can only return a valid user object if security is enabled

Returns:

a profile instance

Since:

6.0

getController

PumaController getController(java.lang.String aCtx,
                             javax.servlet.ServletRequest aRequest)

The returned instance of PumaController can be used to read/modify attributes for a Principal The PumaController object returned by this method uses
WebSphere Application Server RunAs Subject security feature to determine the current available user.
Caused by the dependency to WebSphere Application Server security the getCurrentUser() method of the returned object can only return a valid user object if security is enabled

Parameters:

aCtx - context to determine the to be returned PumaController

aRequest - the current request. null is not allowed as parameter

Returns:

a controller instance. Will return null if called via webservices

Since:

6.1

getLocator

PumaLocator getLocator(java.lang.String aCtx,
                       javax.servlet.ServletRequest aRequest)

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

Parameters:

aCtx - context to determine the to be returned PumaLocator

aRequest - the current request. null is not allowed as parameter

Returns:

a locator instance. Will return null if called via webservices

Since:

6.1

getProfile

PumaProfile getProfile(java.lang.String aCtx,
                       javax.servlet.ServletRequest aRequest)

The returned instance of PumaProfil can be used to read attributes for a Principal The PumaProfil object returned by this method uses WebSphere Application Server RunAs Subject security feature to determine the current available user.
Caused by the dependency to WebSphere Application Server security the getCurrentUser() method of the returned object can only return a valid user object if security is enabled

Parameters:

aCtx - context to determine the to be returned PumaProfile

aRequest - the current request. null is not allowed as parameter

Returns:

a profile instance

Since:

6.1

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