PumaProfile (IBM WebSphere Portal Version 8.5.0.0 SPI Docs)

+
Search Tips | Advanced Search
PREV CLASS NEXT CLASS

Tree

SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ibm.portal.um
Interface PumaProfile

All Known Subinterfaces:
PumaController
public interface PumaProfile
The PumaProfile provides functions to read attribute of com.ibm.portal.um.User and com.ibm.portal.um.Group objects.
An instance of this Interface can be retrieved by calling the getPumaProfile() method exposed by the interfaces com.ibm.portal.um.PumaHome, com.ibm.portal.um.portletservice.PumaHome or com.ibm.portal.um.portletservice.legacy.PumaHome

Since:

5.1.0.1

See Also:
PumaHome, PumaHome, PumaHome

Field Summary

static java.lang.String EXTERNAL_USERS_PARENT_DN_ALIAS
          Deprecated. As of release 6.1, replaced by com.ibm.portal.um.PumaEnvironment.EXTERNAL_USERS_PARENT_DN_ALIAS

Method Summary

java.util.List<java.lang.String> getAllParentDNs()
          Deprecated. As of release 6.1, replaced by PumaEnvironment.getAllParentDNs()

java.util.Map<Principal,java.util.Map<java.lang.String,java.lang.Object>> getAttributes(java.util.Collection<? extends Principal> principals, java.util.Collection<java.lang.String> attributeNames)
          Return a map that maps principals to a map of values based on the given Attributenames.

java.util.Map<java.lang.String,java.lang.Object> getAttributes(Principal aPrincipal, java.util.List<java.lang.String> aAttributeNames)
          Return a map of values based on the given Attributenames.

User getCurrentUser()
          Return an object of type User for the current User.
This method returns null
if no security context is available from the WebShpere Application Server runtime and the service instance has no access to the request object

java.util.List<AttributeDefinition> getDefinedGroupAttributeDefinitions()
          Return all attributes available for the type Group

java.util.List<AttributeDefinition> getDefinedUserAttributeDefinitions()
          Return all attributes available for the type User

java.util.List<java.lang.String> getDefinedUserAttributeNames()
          Return all attributes available for the type User

java.lang.String getExternalParentDN()
          Deprecated. As of release 6.1, replaced by PumaEnvironment.getExternalParentDN()

AttributeDefinition getGroupAttributeDefinition(java.lang.String anAttribute)
          Return an instance of AttributeDefintion for the given name

java.lang.String getGroupDefaultSearchAttributeName()
          Return the attribute that is configured as default search attribute for groups

java.lang.String getIdentifier(Principal aPrincipal)
          Return the unique identifier for the given Principal.

java.util.List<java.lang.String> getMandatoryGroupAttributeNames()
          Return the mandatory attributes of the type Group

java.util.List<java.lang.String> getMandatoryUserAttributeNames()
          Return the mandatory attributes of the type User

java.lang.String getParentDN(java.lang.String alias)
          Deprecated. As of release 6.1, replaced by PumaEnvironment.getParentDN(String)

AttributeDefinition getUserAttributeDefinition(java.lang.String anAttribute)
          Return an instance of AttributeDefintion for the given name

java.lang.String getUserDefaultSearchAttributeName()
          Return the attribute that is configured as default search attribute for users

boolean isExternal(Principal aPrincipal)
          Deprecated. As of release 6.1, replaced by PumaEnvironment.isExternal(Principal)

boolean matchesParentDN(Principal aPrincipal, java.lang.String alias)
          Deprecated. As of release 6.1, replaced by PumaEnvironment.matchesParentDN(Principal, String)

Principal reload(Principal aPrincipal)
          Loads the content of the given Principal from the repository

Field Detail

EXTERNAL_USERS_PARENT_DN_ALIAS
static final java.lang.String EXTERNAL_USERS_PARENT_DN_ALIAS
Deprecated. As of release 6.1, replaced by com.ibm.portal.um.PumaEnvironment.EXTERNAL_USERS_PARENT_DN_ALIAS
Alias for the parent DN configured for external users.

See Also:
getParentDN(String), Constant Field Values

Method Detail

getAttributes
java.util.Map<java.lang.String,java.lang.Object> getAttributes(Principal aPrincipal,
                                                               java.util.List<java.lang.String> aAttributeNames)
                                                               throws PumaAttributeException,
                                                                      PumaSystemException,
                                                                      PumaModelException,
                                                                      PumaMissingAccessRightsException
Returns a map of values based on the given Attributenames. Those values are stored with the given Principal Attributes not defined in the Map have either not been defined in the Schema or are not set at this User Object
The character encoding used as input for attribute key and value must match the encoding acceptable by the user store

Parameters:
aPrincipal - the Principal to get the values from, null is not allowed as input parameter
aAttributeNames - the names of the attributes to get the values of.
Returns:
Map read-only Map including attribute names and their values. Multivalue attributes will return a java.util.List object as Value
Throws:
PumaAttributeException - will be thrown if attributes are read-only, missing or not defined
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaModelException - will be thrown if no Principal could be found
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights

getAttributes
java.util.Map<Principal,java.util.Map<java.lang.String,java.lang.Object>> getAttributes(java.util.Collection<? extends Principal> principals,
                                                                                        java.util.Collection<java.lang.String> attributeNames)
                                                                                        throws PumaAttributeException,
                                                                                               PumaSystemException,
                                                                                               PumaModelException,
                                                                                               PumaMissingAccessRightsException
Returns a map that maps principals to a map of values based on the given Attributenames. Those values are stored with the given Principals Attributes not defined in the Map have either not been defined in the Schema or are not set at the corresponding User Object
The character encoding used as input for attribute key and value must match the encoding acceptable by the user store

Parameters:
principals - the Principals to get the values from, null is not allowed as input parameter
attributeNames - the names of the attributes to get the values of.
Returns:
Map read-only Map associating the input principals with their attribute maps including attribute names and their values. Multivalue attributes will return a java.util.List object as Value
Throws:
PumaAttributeException - will be thrown if attributes are read-only, missing or not defined
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaModelException - will be thrown if one of the Principals could be found
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights
Since:

6.1

getDefinedUserAttributeNames
java.util.List<java.lang.String> getDefinedUserAttributeNames()
                                                              throws PumaSystemException,
                                                                     PumaMissingAccessRightsException
Returns all attributes available for the type User

Returns:
read-only List of Strings containing all available attribute names for com.ibm.poral.um.User as java.lang.String
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights

getUserAttributeDefinition
AttributeDefinition getUserAttributeDefinition(java.lang.String anAttribute)
                                               throws PumaSystemException,
                                                      PumaMissingAccessRightsException
Returns an instance of AttributeDefintion for the given name

Returns:
AttributeDefinition for the given String
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights

getGroupAttributeDefinition
AttributeDefinition getGroupAttributeDefinition(java.lang.String anAttribute)
                                                throws PumaSystemException,
                                                       PumaMissingAccessRightsException
Returns an instance of AttributeDefintion for the given name

Returns:
AttributeDefinition for the given String
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights

getDefinedUserAttributeDefinitions
java.util.List<AttributeDefinition> getDefinedUserAttributeDefinitions()
                                                                       throws PumaSystemException,
                                                                              PumaMissingAccessRightsException
Returns all attributes available for the type User

Returns:
read-only List of AttributeDefinition containing all available attribute for com.ibm.poral.um.User as com.ibm.puma.um.AttributeDefinition
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights
Since:

6.0

getDefinedGroupAttributeDefinitions
java.util.List<AttributeDefinition> getDefinedGroupAttributeDefinitions()
                                                                        throws PumaSystemException,
                                                                               PumaMissingAccessRightsException
Returns all attributes available for the type Group

Returns:
read-only List of AttributeDefinition containing all available attributes for com.ibm.poral.um.Group as com.ibm.puma.um.AttributeDefinition
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights
Since:

6.0

getMandatoryUserAttributeNames
java.util.List<java.lang.String> getMandatoryUserAttributeNames()
                                                                throws PumaSystemException,
                                                                       PumaMissingAccessRightsException
Returns the mandatory attributes of the type User

Returns:
read-only List of Strings containing the names of all mandatory attributes of com.ibm.portal.um.User as java.util.String
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights
See Also:
User, String

getMandatoryGroupAttributeNames
java.util.List<java.lang.String> getMandatoryGroupAttributeNames()
                                                                 throws PumaSystemException,
                                                                        PumaMissingAccessRightsException
Returns the mandatory attributes of the type Group

Returns:
read-only List of Strings containing the names of all mandatory attributes of com.ibm.portal.um.Group as java.util.String
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights
Since:

6.0

See Also:
Group, String

getCurrentUser
User getCurrentUser()
                    throws PumaException
Returns an object of type User for the current User.
This method returns null
if no security context is available from the WebShpere Application Server runtime and the service instance has no access to the request object

Returns:
the User object representing the current logged-in user.
Throws:
PumaException - will be thrown whenever an unrecoverable backend error occurs

getIdentifier
java.lang.String getIdentifier(Principal aPrincipal)
                               throws PumaSystemException,
                                      PumaMissingAccessRightsException,
                                      PumaModelException
Returns the unique identifier for the given Principal. This is the distinguished name (DN).

Parameters:
aPrincipal - the Principal to be processed. null is not allowed as input parameter
Returns:
the unique identifier of this Principal
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights
PumaModelException - will be thrown if no Principal could be found

reload
Principal reload(Principal aPrincipal)
                 throws PumaSystemException,
                        PumaMissingAccessRightsException,
                        PumaModelException
Loads the content of the given Principal from the repository

Parameters:
aPrincipal - the Principal to be processed. null is not allowed as input parameter
Returns:
the refreshed instance of the given Principal. null will not be returned.
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
PumaMissingAccessRightsException - will be thrown if the current authenticated user does not have the necessary rights
PumaModelException - will be thrown if no Principal could be found
Since:

6.0

isExternal
boolean isExternal(Principal aPrincipal)
Deprecated. As of release 6.1, replaced by PumaEnvironment.isExternal(Principal)

Checks whether the DN of the given principal is configured as 'external'. This is equivalent to matchesParentDN(principal, EXTERNAL_USERS_PARENT_DN_ALIAS)

Parameters:
aPrincipal - the Principal to be processed. null is not allowed as input parameter
Returns:
true if and only if the principal has a DN that matches the parent DN configured for external
Since:

6.0.1

matchesParentDN
boolean matchesParentDN(Principal aPrincipal,
                        java.lang.String alias)
Deprecated. As of release 6.1, replaced by PumaEnvironment.matchesParentDN(Principal, String)

checks whether the DN of the given principal matches to the parent DN of the given alias

Parameters:
aPrincipal - the Principal to be processed. null is not allowed as input parameter
alias - the alias of the parent DN
Returns:
true if and only if the principal has a DN that matches to the parent DN of the given alias
Since:

6.0.1

getParentDN
java.lang.String getParentDN(java.lang.String alias)
Deprecated. As of release 6.1, replaced by PumaEnvironment.getParentDN(String)

Returns the DN that bound to the given alias

Parameters:
alias - - the alias that points to the stored DN.
Returns:
the parent DN for a given alias
Since:

6.0.1

getExternalParentDN
java.lang.String getExternalParentDN()
Deprecated. As of release 6.1, replaced by PumaEnvironment.getExternalParentDN()

Returns the DN that is configured for external users. This is equivalent to getParentDN(EXTERNAL_USERS_PARENT_DN_ALIAS)

Returns:
the DN that s configured for external users
Since:

6.0.1

getAllParentDNs
java.util.List<java.lang.String> getAllParentDNs()
                                                 throws PumaSystemException
Deprecated. As of release 6.1, replaced by PumaEnvironment.getAllParentDNs()

Retrieves all parent DNs available in the current virtual portal context

Returns:
list of Strings - representing the parent DNs available in the current virtual Portal context
Throws:
PumaSystemException - will be thrown whenever an unrecoverable backend error occurs
Since:

6.0.1

getGroupDefaultSearchAttributeName
java.lang.String getGroupDefaultSearchAttributeName()
Returns the attribute that is configured as default search attribute for groups

Returns:
String
Since:

6.1

getUserDefaultSearchAttributeName
java.lang.String getUserDefaultSearchAttributeName()
Returns the attribute that is configured as default search attribute for users

Returns:
String
Since:

6.1

PREV CLASS NEXT CLASS

Tree

SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Field Summary
static java.lang.String	EXTERNAL_USERS_PARENT_DN_ALIAS Deprecated. As of release 6.1, replaced by com.ibm.portal.um.PumaEnvironment.EXTERNAL_USERS_PARENT_DN_ALIAS

Method Summary
java.util.List<java.lang.String>	getAllParentDNs() Deprecated. As of release 6.1, replaced by PumaEnvironment.getAllParentDNs()
java.util.Map<Principal,java.util.Map<java.lang.String,java.lang.Object>>	getAttributes(java.util.Collection<? extends Principal> principals, java.util.Collection<java.lang.String> attributeNames) Return a map that maps principals to a map of values based on the given Attributenames.
java.util.Map<java.lang.String,java.lang.Object>	getAttributes(Principal aPrincipal, java.util.List<java.lang.String> aAttributeNames) Return a map of values based on the given Attributenames.
User	getCurrentUser() Return an object of type User for the current User. This method returns null if no security context is available from the WebShpere Application Server runtime and the service instance has no access to the request object
java.util.List<AttributeDefinition>	getDefinedGroupAttributeDefinitions() Return all attributes available for the type Group
java.util.List<AttributeDefinition>	getDefinedUserAttributeDefinitions() Return all attributes available for the type User
java.util.List<java.lang.String>	getDefinedUserAttributeNames() Return all attributes available for the type User
java.lang.String	getExternalParentDN() Deprecated. As of release 6.1, replaced by PumaEnvironment.getExternalParentDN()
AttributeDefinition	getGroupAttributeDefinition(java.lang.String anAttribute) Return an instance of AttributeDefintion for the given name
java.lang.String	getGroupDefaultSearchAttributeName() Return the attribute that is configured as default search attribute for groups
java.lang.String	getIdentifier(Principal aPrincipal) Return the unique identifier for the given Principal.
java.util.List<java.lang.String>	getMandatoryGroupAttributeNames() Return the mandatory attributes of the type Group
java.util.List<java.lang.String>	getMandatoryUserAttributeNames() Return the mandatory attributes of the type User
java.lang.String	getParentDN(java.lang.String alias) Deprecated. As of release 6.1, replaced by PumaEnvironment.getParentDN(String)
AttributeDefinition	getUserAttributeDefinition(java.lang.String anAttribute) Return an instance of AttributeDefintion for the given name
java.lang.String	getUserDefaultSearchAttributeName() Return the attribute that is configured as default search attribute for users
boolean	isExternal(Principal aPrincipal) Deprecated. As of release 6.1, replaced by PumaEnvironment.isExternal(Principal)
boolean	matchesParentDN(Principal aPrincipal, java.lang.String alias) Deprecated. As of release 6.1, replaced by PumaEnvironment.matchesParentDN(Principal, String)
Principal	reload(Principal aPrincipal) Loads the content of the given Principal from the repository

com.ibm.portal.um Interface PumaProfile

EXTERNAL_USERS_PARENT_DN_ALIAS

getAttributes

getAttributes

getDefinedUserAttributeNames

getUserAttributeDefinition

getGroupAttributeDefinition

getDefinedUserAttributeDefinitions

getDefinedGroupAttributeDefinitions

getMandatoryUserAttributeNames

getMandatoryGroupAttributeNames

getCurrentUser

getIdentifier

reload

isExternal

matchesParentDN

getParentDN

getExternalParentDN

getAllParentDNs

getGroupDefaultSearchAttributeName

getUserDefaultSearchAttributeName

com.ibm.portal.um
Interface PumaProfile