com.ibm.portal.um
Interface PumaAdminHome


Deprecated. As of release 6.1, use PumaEnvironment#runUnrestricted(java.security.PrivilegedExceptionAction) instead: For executing a Puma Query without Puma enforcing access control (thus "as admin"), wrap your code into a PrivilegedExceptionAction and then use PumaEnvironment#runUnrestricted(PrivilegedExceptionAction) to execute the the query.

public interface PumaAdminHome

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/PumaAdmin.
The name is also available via a constant of the Interface itself PumaAdminHome.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 difference between this class and PumaHome is that this class returns views to the user repository that will NOT perform any AC permission checks when the user repository is to be read or changed.
Instead, the three methods will throw a SecurityException if Java2 security is enabled (i.e. a SecurityManager is available) and the calling code does not have the following permission: AuthPermission("doAs")
By default, this class is disabled and each of the three methods will throw an IllegalStateException. It can be enabled by setting the property enablePumaAdminHome to true in PumaService.properties. Refer to the WebSphere Portal Information Center - "Setting configuration properties" - for more information on how to change service properties.
The following sample shows you how to perform the JNDI lookup Either by

 Context ctx = new InitialContext();
 
 Name myjndiname = new CompositeName(PumaAdminHome.JNDI_NAME);
 
 PumaAdminHome myHome = (PumaAdminHome) ctx.lookup(myjndiname);
 
or
   String myjndiname = PumaAdminHome.JNDI_NAME;
   PumaAdminHome. myHome = (PumaAdminHome.) ctx.lookup(myjndiname);
 

Since:
6.0
See Also:
PumaProfile, PumaLocator, PumaController

Field Summary
static java.lang.String JNDI_NAME
          Deprecated. The name can be used to lookup the PumaAdminHome from JNDI
 
Method Summary
 PumaController getController()
          Deprecated. 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 security features to determine the current available user.
 PumaLocator getLocator()
          Deprecated. The returned instance of PumaLocator can be used to find Principal objects
 PumaProfile getProfile()
          Deprecated. 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 security features to determine the current available user.
 

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME
Deprecated. 
The name can be used to lookup the PumaAdminHome from JNDI

See Also:
Constant Field Values
Method Detail

getController

PumaController getController()
Deprecated. 
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 security features 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()
Deprecated. 
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()
Deprecated. 
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 security features 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