Overview  Package   Class  Tree  Serialized  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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);
It is possible to plug multiple stores below PUMA API. To retrieve a PumaProfile, PumaLocator or PumaController that is not using the DEFAULT_STORE, use a get method that takes the name of the store as parameter, e.g. getProfile(String).

Note: The methods containing the javax.servlet.ServletRequest parameter are deprecated - the corresponding methods without parameter shall be used instead. However, if remember me feature is utilized, the PumaProfile.getCurrentUser() method will not return the remember me cookie identified user. Please use the getProfile(javax.servlet.ServletRequest) method for correctly retrieving the remember me identified user in this scenario.

Since:
5.1.0.1
See Also:
PumaProfile, PumaLocator, PumaController

Field Summary
static java.lang.String DEFAULT_PROVIDER
          Deprecated. As of release 6.1.0.1,use DEFAULT_STORE instead
static java.lang.String DEFAULT_STORE
          Constant to address the default store for PUMA when retrieving a PumaController, PumaLocator, or PumaProfile
static java.lang.String JNDI_NAME
          The name can be used to lookup the PumaHome from JNDI
static java.lang.String READTHROUGH_DEFAULT_STORE
          Constant to address the non cached default store for PUMA when retrieving a PumaController, PumaLocator, or PumaProfile
 
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. since 6.1 use getController() instead. However, if remember me feature is utilized, getController(javax.servlet.ServletRequest) method shall still be used.
 PumaController getController(java.lang.String storeName)
          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(java.lang.String storeName, javax.servlet.ServletRequest aRequest)
          Deprecated. since 6.1.0.2 use getController(String) instead. However, if remember me feature is utilized, getController(String, javax.servlet.ServletRequest) method shall still be used.
 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(int maxSearchResult)
          The returned instance of PumaLocator can be used to find Principal objects
 PumaLocator getLocator(javax.servlet.ServletRequest aRequest)
          Deprecated. since 6.1 use getLocator() instead. However, if remember me feature is utilized, getLocator(javax.servlet.ServletRequest) method shall still be used.
 PumaLocator getLocator(java.lang.String storeName)
          The returned instance of PumaLocator can be used to find Principal objects
 PumaLocator getLocator(java.lang.String storeName, int maxSearchResult)
          The returned instance of PumaLocator can be used to find Principal objects
 PumaLocator getLocator(java.lang.String storeName, javax.servlet.ServletRequest aRequest)
          Deprecated. since 6.1.0.2 use getLocator(String) instead. However, if remember me feature is utilized, getLocator(String, javax.servlet.ServletRequest) method shall still be used.
 PumaProfile getProfile()
          The returned instance of PumaProfile can be used to read attributes for a Principal The PumaProfile 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. since 6.1 use getProfile() instead. However, if remember me feature is utilized, getProfile(javax.servlet.ServletRequest) method shall still be used.
 PumaProfile getProfile(java.lang.String storeName)
          The returned instance of PumaProfile can be used to read attributes for a Principal The PumaProfile object returned by this method uses WebSphere Application Server RunAs Subject security feature to determine the current available user.
 PumaProfile getProfile(java.lang.String storeName, javax.servlet.ServletRequest aRequest)
          Deprecated. since 6.1.0.2 use getProfile(String) instead. However, if remember me feature is utilized, getProfile(String, javax.servlet.ServletRequest) method shall still be used.
 

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
Deprecated. As of release 6.1.0.1,use DEFAULT_STORE instead
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

DEFAULT_STORE

static final java.lang.String DEFAULT_STORE
Constant to address the default store for PUMA when retrieving a PumaController, PumaLocator, or PumaProfile

Since:
6.1.0.1
See Also:
Constant Field Values

READTHROUGH_DEFAULT_STORE

static final java.lang.String READTHROUGH_DEFAULT_STORE
Constant to address the non cached default store for PUMA when retrieving a PumaController, PumaLocator, or PumaProfile

Since:
8.0.0.0
See Also:
Constant Field Values
Method Detail

getController

PumaController getController(javax.servlet.ServletRequest aRequest)
Deprecated. since 6.1 use getController() instead. However, if remember me feature is utilized, getController(javax.servlet.ServletRequest) method shall still be used.

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.

getLocator

PumaLocator getLocator(javax.servlet.ServletRequest aRequest)
Deprecated. since 6.1 use getLocator() instead. However, if remember me feature is utilized, getLocator(javax.servlet.ServletRequest) method shall still be used.

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.

getProfile

PumaProfile getProfile(javax.servlet.ServletRequest aRequest)
Deprecated. since 6.1 use getProfile() instead. However, if remember me feature is utilized, getProfile(javax.servlet.ServletRequest) method shall still be used.

The returned instance of PumaProfile 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.
Since:
6.0

getLocator

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

Returns:
a locator instance.
Since:
6.0

getProfile

PumaProfile getProfile()
The returned instance of PumaProfile can be used to read attributes for a Principal The PumaProfile 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

getLocator

PumaLocator getLocator(int maxSearchResult)
The returned instance of PumaLocator can be used to find Principal objects

Parameters:
maxSearchResult - the maximal amount of results allowed for any call on the returned PumaLocator.
Returns:
a locator instance.
Since:
6.1

getController

PumaController getController(java.lang.String storeName,
                             javax.servlet.ServletRequest aRequest)
Deprecated. since 6.1.0.2 use getController(String) instead. However, if remember me feature is utilized, getController(String, javax.servlet.ServletRequest) method shall still be used.

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:
storeName - the name of the store that the returned PumaController will use. Must not be null.
aRequest - the current request. null is not allowed as parameter
Returns:
a controller instance.
Since:
6.1

getLocator

PumaLocator getLocator(java.lang.String storeName,
                       javax.servlet.ServletRequest aRequest)
Deprecated. since 6.1.0.2 use getLocator(String) instead. However, if remember me feature is utilized, getLocator(String, javax.servlet.ServletRequest) method shall still be used.

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

Parameters:
storeName - the name of the store that the returned PumaLocator will use. Must not be null.
aRequest - the current request. null is not allowed as parameter
Returns:
a locator instance.
Since:
6.1

getProfile

PumaProfile getProfile(java.lang.String storeName,
                       javax.servlet.ServletRequest aRequest)
Deprecated. since 6.1.0.2 use getProfile(String) instead. However, if remember me feature is utilized, getProfile(String, javax.servlet.ServletRequest) method shall still be used.

The returned instance of PumaProfile can be used to read attributes for a Principal The PumaProfile 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:
storeName - the name of the store that the returned PumaProfile will use. Must not be null.
aRequest - the current request. null is not allowed as parameter
Returns:
a profile instance
Since:
6.1

getController

PumaController getController(java.lang.String storeName)
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:
storeName - the name of the store that the returned PumaController will use. Must not be null.
Returns:
a controller instance.
Since:
6.1

getLocator

PumaLocator getLocator(java.lang.String storeName)
The returned instance of PumaLocator can be used to find Principal objects

Parameters:
storeName - the name of the store that the returned PumaLocator will use. Must not be null.
Returns:
a locator instance.
Since:
6.1

getLocator

PumaLocator getLocator(java.lang.String storeName,
                       int maxSearchResult)
The returned instance of PumaLocator can be used to find Principal objects

Parameters:
storeName - the name of the store that the returned PumaLocator will use. Must not be null.
maxSearchResult - the maximal amount of results allowed for any call on the returned PumaLocator.
Returns:
a locator instance.
Since:
6.1.0.2

getProfile

PumaProfile getProfile(java.lang.String storeName)
The returned instance of PumaProfile can be used to read attributes for a Principal The PumaProfile 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:
storeName - the name of the store that the returned PumaProfile will use. Must not be null.
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
Overview  Package   Class  Tree  Serialized  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD