|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PumaLocator
The PumaLocator
provides functions to lookup
com.ibm.portal.um.User
and
com.ibm.portal.um.Group
objects.
An instance of this Interface can be retrieved by calling
com.ibm.portal.um.PumaHome
,
com.ibm.portal.um.portletservice.PumaHome
or
com.ibm.portal.um.portletservice.legacy.PumaHome
Some of the search methods take a Map
with
pagingProperties. These methods perform a paged search, i.e. that the result
set is split up into subsets (pages) that can be requested individually using
the the returned PagingIterator
.
PumaHome
,
PumaHome
,
PumaHome
,
PagingIterator
Field Summary | |
---|---|
static java.lang.String |
MAXIMUM_RESULTS
Use this property to set the maximum number of total results that a search request will return when performing a paged search. |
static java.lang.String |
RESULTS_PER_PAGE
Use this property to set the page size when performing a paged search. |
static java.lang.String |
SORT_CONTROL
Use this property control the sorting when performing a paged search. |
Method Summary | |
---|---|
Group |
findGroupByIdentifier(java.lang.String aIdentifier)
Returns the Group object referenced by the identifier (DN) within the user repository. |
Group |
findGroupByObjectID(ObjectID aId)
Returns the Group object referenced by the given ObjectID .If no group is found a PumaModelException is thrown
|
java.util.List<Group> |
findGroupsByAttribute(java.lang.String aAttribute,
java.lang.String aValue)
Returns a List of Group where the attributes defined in
the LDAP server matches the value of the given attribute. |
PagingIterator<Group> |
findGroupsByAttribute(java.lang.String aAttribute,
java.lang.String aValue,
java.util.Map<java.lang.String,?> properties)
Returns a List of Group where the attributes defined in
the LDAP server matches the value of the given attribute. |
java.util.List<Group> |
findGroupsByDefaultAttribute(java.lang.String aValue)
Returns Group by comparing the provided value to the
default attribute type configured for the Group type
|
java.util.List<Group> |
findGroupsByDefaultAttribute(java.lang.String aValue,
boolean aSorted)
Returns Group by comparing the provided value to the
default attribute type configured for the Group type
|
java.util.List<Group> |
findGroupsByPrincipal(Principal aPrincipal,
boolean aNested)
Returns the Groups where the given Principal is member of. |
PagingIterator<Group> |
findGroupsByPrincipal(Principal aPrincipal,
boolean aNested,
java.util.Map<java.lang.String,?> properties)
Returns the Groups where the given Principal is member of. |
java.util.List<Group> |
findGroupsByQuery(java.lang.String aQuery)
Returns a List of Group representing the resultset of the
provided Query. |
PagingIterator<Group> |
findGroupsByQuery(java.lang.String aQuery,
java.util.Map<java.lang.String,?> properties)
Returns a List of Group representing the resultset of the
provided Query. |
java.util.List<Group> |
findGroupsByQuery(java.lang.String aQuery,
com.ibm.websphere.wim.model.SortControl aControl)
Returns a List of Group representing the resultset of the
provided Query. |
java.util.List<Principal> |
findMembersByGroup(Group aGroup,
boolean aNested)
Returns the mebers for a given Group. |
PagingIterator<Principal> |
findMembersByGroup(Group aGroup,
boolean aNested,
java.util.Map<java.lang.String,?> properties)
Returns the mebers for a given Group. |
Principal |
findPrincipalByIdentifier(java.lang.String aIdentifier)
Returns the Principal (user or group) object referenced by the given identifier. |
java.util.Map<java.lang.String,Principal> |
findPrincipalsByIdentifiers(java.util.Collection<java.lang.String> identifiers)
Returns the Principal (user and/or group) objects referenced by the given identifiers. |
User |
findUserByIdentifier(java.lang.String aIdentifier)
Returns the User object referenced by the given identifier. |
User |
findUserByObjectID(ObjectID aId)
Returns the User object referenced by the given ObjectID .If no user is found a PumaModelException is thrown
|
java.util.List<User> |
findUsersByAttribute(java.lang.String aAttribute,
java.lang.String aValue)
Returns a List of User where the attribute defined in the
LDAP server matches the given value. |
PagingIterator<User> |
findUsersByAttribute(java.lang.String aAttribute,
java.lang.String aValue,
java.util.Map<java.lang.String,?> pagingProps)
Returns a List of User s where the attribute defined in
the user repository matches the given value. |
java.util.List<User> |
findUsersByAttributeRecursively(User user,
java.lang.String attribute,
int depth)
Returns a List of Principals that are linked by the given
attribute. |
java.util.List<User> |
findUsersByDefaultAttribute(java.lang.String aValue)
Returns User by comparing the provided value to the
default attribute type configured for the User type. |
java.util.List<User> |
findUsersByDefaultAttribute(java.lang.String aValue,
boolean aSorted)
Returns User by comparing the provided value to the
default attribute type configured for the User type. |
java.util.List<User> |
findUsersByQuery(java.lang.String aQuery)
Returns a List of User representing the resultset of the
provided Query. |
PagingIterator<User> |
findUsersByQuery(java.lang.String aQuery,
java.util.Map<java.lang.String,?> properties)
Returns a List of User representing the resultset of the
provided Query. |
java.util.List<User> |
findUsersByQuery(java.lang.String aQuery,
com.ibm.websphere.wim.model.SortControl aControl)
Returns a List of User representing the resultset of the
provided Query. |
java.util.List<Group> |
searchGroupByName(java.lang.String name)
Returns a list of Group s that have a name that matches the given
name. |
PagingIterator<Group> |
searchGroupByName(java.lang.String name,
java.util.Map<java.lang.String,?> properties)
Returns a list of Group s that have a name that matches the given
name. |
java.util.List<User> |
searchUserByName(java.lang.String aName)
Returns a list of User s that have a name that matches the given
name. |
PagingIterator<User> |
searchUserByName(java.lang.String aName,
java.util.Map<java.lang.String,?> properties)
Returns a list of User s that have a name that matches the given
name. |
Field Detail |
---|
static final java.lang.String MAXIMUM_RESULTS
SizeLimitExceedException
will be
thrown. The value is optional, must be of type Integer
and
greater 0 if present.
static final java.lang.String RESULTS_PER_PAGE
Integer
and
greater 0.
static final java.lang.String SORT_CONTROL
com.ibm.websphere.wim.model.SortControl
if present.
Method Detail |
---|
Principal findPrincipalByIdentifier(java.lang.String aIdentifier) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
PumaProfile.getIdentifier(Principal)
.PumaModelException
is thrown
aIdentifier
- a unique Identifier of a Principal object within the User
Repository
PumaSystemException
- will be thrown whenever an unrecoverable
back-end 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 rightsjava.util.Map<java.lang.String,Principal> findPrincipalsByIdentifiers(java.util.Collection<java.lang.String> identifiers) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
findPrincipalByIdentifier(String)
.
PumaModelException
is thrown
identifiers
- a collection of unique Identifier of a Principal object within the
User Repository
PumaSystemException
- will be thrown whenever an unrecoverable
back-end 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 rightsUser findUserByIdentifier(java.lang.String aIdentifier) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
WSCredential.getUniqueSecurityName()
or by PumaProfile.getIdentifier(Principal)
.PumaModelException
is thrown
aIdentifier
- a unique Identifier of a User object within the User
Repository
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaModelException
- will be thrown if no User
could
be found
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsUser findUserByObjectID(ObjectID aId) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
ObjectID
.PumaModelException
is thrown
aId
- WebSphere Portal Identifier of a User
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaModelException
- will be thrown if no User
could
be found
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsGroup findGroupByObjectID(ObjectID aId) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
ObjectID
.PumaModelException
is thrown
aId
- WebSphere Portal Identifier of a Group
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaModelException
- will be thrown if no Group
could be found
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsGroup findGroupByIdentifier(java.lang.String aIdentifier) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
PumaModelException
is thrown
aIdentifier
- a unique Identifier of a Group object within the
Repository
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaModelException
- will be thrown if no Group
could be found
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsjava.util.List<User> findUsersByDefaultAttribute(java.lang.String aValue) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
User
by comparing the provided value to the
default attribute type configured for the User type.
aValue
- NULL
is not allowed as input
List
containing User
. If
nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- See Also:
User
,
List
java.util.List<User> findUsersByDefaultAttribute(java.lang.String aValue, boolean aSorted) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
User
by comparing the provided value to the
default attribute type configured for the User type.
aValue
- NULL
is not allowed as inputaSorted
- defines if the result should be sorted. if true
the result will be sorted ascending based on the defaultattribute.
List
containing User
. If
nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- Since:
- 6.1
- See Also:
User
,
List
java.util.List<Group> findGroupsByDefaultAttribute(java.lang.String aValue) throws PumaSystemException, PumaMissingAccessRightsException
Group
by comparing the provided value to the
default attribute type configured for the Group type
aValue
- NULL
is not allowed as input
List
containing com.ibm.portal.um.Group. If nothing is found an empty java.util.List will 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- See Also:
Group
,
List
java.util.List<Group> findGroupsByDefaultAttribute(java.lang.String aValue, boolean aSorted) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
Group
by comparing the provided value to the
default attribute type configured for the Group type
aValue
- NULL
is not allowed as inputaSorted
- defines if the result should be sorted. if true
the result will be sorted ascending based on the defaultattribute.
List
containing com.ibm.portal.um.Group. If nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are read-only, missing or not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- See Also:
Group
,
List
java.util.List<User> findUsersByAttribute(java.lang.String aAttribute, java.lang.String aValue) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
User
where the attribute defined in the
LDAP server matches the given value. Only attributes of type
aAttribute
- User attribute of type aValue
- Value to compare with
List
containing
com.ibm.portal.um.User. If nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- See Also:
User
,
List
PagingIterator<User> findUsersByAttribute(java.lang.String aAttribute, java.lang.String aValue, java.util.Map<java.lang.String,?> pagingProps) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
User
s where the attribute defined in
the user repository matches the given value. Only attributes of type
PagingIterator.hasNextPage()
and
PagingIterator.getNextPage(List)
to iterate over the result
pages.
aAttribute
- User attribute of type aValue
- Value to compare withpagingProperties
- Map that specifies the paging properties. Must at
least contain a positive value for RESULTS_PER_PAGE
.
java.lang.IllegalArgumentException
- if pagingProperties is null or does
contain invalid properties.
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaAttributeException
- will be thrown if attributes are not
defined
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rights
The character encoding used as input for attribute key and value
must match the encoding acceptable by the user store
,
User
,
List
java.util.List<Group> findGroupsByAttribute(java.lang.String aAttribute, java.lang.String aValue) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
Group
where the attributes defined in
the LDAP server matches the value of the given attribute. The two values
will be checked based on a LIKE pattern. Only attributes of type
aAttribute
- Group attribute of type aValue
- the Value to compare with
List
containing
com.ibm.portal.um.Group. If nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- See Also:
Group
,
List
PagingIterator<Group> findGroupsByAttribute(java.lang.String aAttribute, java.lang.String aValue, java.util.Map<java.lang.String,?> properties) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
Group
where the attributes defined in
the LDAP server matches the value of the given attribute. The two values
will be checked based on a LIKE pattern. Only attributes of type PagingIterator.hasNextPage()
and
PagingIterator.getNextPage(List)
to iterate over the result
pages.
aAttribute
- Group attribute of type aValue
- the Value to compare withpagingProperties
- Map that specifies the paging properties. Must at
least contain a positive value for RESULTS_PER_PAGE
.
java.lang.IllegalArgumentException
- if pagingProperties is null or does
contain invalid properties.
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaAttributeException
- will be thrown if attributes are not
defined
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsPagingIterator
,
Group
,
List
java.util.List<Principal> findMembersByGroup(Group aGroup, boolean aNested) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
aGroup
- Group to get Member for. null
is not allowed
as input parameteraNested
- if set to true nested members will be returned. if set to
false only the first hirarchy level will be returned
List
containing
com.ibm.portal.um.Principal. If nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaModelException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- See Also:
Principal
,
List
PagingIterator<Principal> findMembersByGroup(Group aGroup, boolean aNested, java.util.Map<java.lang.String,?> properties) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
PagingIterator.hasNextPage()
and
PagingIterator.getNextPage(List)
to iterate over the result
pages.
aGroup
- Group to get Member for. null
is not allowed
as input parameteraNested
- if set to true nested members will be returned. if set to
false only the first hirarchy level will be returnedpagingProperties
- Map that specifies the paging properties. Must at
least contain a positive value for RESULTS_PER_PAGE
.
java.lang.IllegalArgumentException
- if pagingProperties is null or does
contain invalid properties.
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 a non-existing page was
requestedPagingIterator
,
Principal
,
List
java.util.List<Group> findGroupsByPrincipal(Principal aPrincipal, boolean aNested) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
PumaEnvironment.getAllAuthenticatedUserGroup()
- are
not included in the result list.
aPrincipal
- the Principal to get its membership, null
is not allowed as input parameteraNested
- if set to true nested members will be returned. if set to
false only the first hirarchy level will be returned
List
containing
com.ibm.portal.um.Group. If nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights
PumaModelException
- See Also:
Group
,
List
PagingIterator<Group> findGroupsByPrincipal(Principal aPrincipal, boolean aNested, java.util.Map<java.lang.String,?> properties) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
PumaEnvironment.getAllAuthenticatedUserGroup()
- are
not included in the result list. PagingIterator.hasNextPage()
and
PagingIterator.getNextPage(List)
to iterate over the result
pages.
aPrincipal
- the Principal to get its membership, null
is not allowed as input parameteraNested
- if set to true nested members will be returned. if set to
false only the first hirarchy level will be returnedpagingProperties
- Map that specifies the paging properties. Must at
least contain a positive value for RESULTS_PER_PAGE
.
java.lang.IllegalArgumentException
- if pagingProperties is null or does
contain invalid properties.
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaAttributeException
- will be thrown if attributes are not
defined
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rights
PumaModelException
PagingIterator
,
Group
,
List
java.util.List<User> findUsersByQuery(java.lang.String aQuery) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
User
representing the resultset of the
provided Query. The query is based on the XPath query language
aQuery
- an XPath expression
List
containing
com.ibm.portal.um.User. If nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- Since:
- 6.1
- See Also:
User
,
List
PagingIterator<User> findUsersByQuery(java.lang.String aQuery, java.util.Map<java.lang.String,?> properties) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
User
representing the resultset of the
provided Query. The query is based on the XPath query language PagingIterator.hasNextPage()
and
PagingIterator.getNextPage(List)
to iterate over the result
pages.
aQuery
- an XPath expressionpagingProperties
- Map that specifies the paging properties. Must at
least contain a positive value for RESULTS_PER_PAGE
.
java.lang.IllegalArgumentException
- if pagingProperties is null or does
contain invalid properties.
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaAttributeException
- will be thrown if attributes are not
defined
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsPagingIterator
,
User
,
List
java.util.List<Group> findGroupsByQuery(java.lang.String aQuery) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
Group
representing the resultset of the
provided Query. The query is based on the XPath query language
aQuery
- an XPath expression
List
containing
com.ibm.portal.um.Group. If nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- Since:
- 6.1
- See Also:
User
,
List
PagingIterator<Group> findGroupsByQuery(java.lang.String aQuery, java.util.Map<java.lang.String,?> properties) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
Group
representing the resultset of the
provided Query. The query is based on the XPath query language PagingIterator.hasNextPage()
and
PagingIterator.getNextPage(List)
to iterate over the result
pages.
aQuery
- an XPath expressionpagingProperties
- Map that specifies the paging properties. Must at
least contain a positive value for RESULTS_PER_PAGE
.
java.lang.IllegalArgumentException
- if pagingProperties is null or does
contain invalid properties.
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaAttributeException
- will be thrown if attributes are not
defined
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsPagingIterator
,
User
,
List
java.util.List<User> findUsersByQuery(java.lang.String aQuery, com.ibm.websphere.wim.model.SortControl aControl) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
User
representing the resultset of the
provided Query. The query is based on the XPath query language
aQuery
- an XPath expressionaControl
- defines how the result set should be sorted
List
containing
com.ibm.portal.um.User. If nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- Since:
- 6.1
- See Also:
User
,
List
java.util.List<Group> findGroupsByQuery(java.lang.String aQuery, com.ibm.websphere.wim.model.SortControl aControl) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException
Group
representing the resultset of the
provided Query. The query is based on the XPath query language
aQuery
- an XPath expressionaControl
- defines how the result set should be sorted
List
containing
com.ibm.portal.um.Group. If nothing is found an empty java.util.List will be returned
- Throws:
PumaSystemException
- will be thrown whenever an unrecoverable backend error occurs
PumaAttributeException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current authenticated user does not have the necessary rights- Since:
- 6.1
- See Also:
User
,
List
java.util.List<User> searchUserByName(java.lang.String aName) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
User
s that have a name that matches the given
name.
The query used for finding the users considers those attributes that are
typically used as name and matches their values against the given name.
name
- defines the string to be used in the query
User
objects
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaModelException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsPagingIterator<User> searchUserByName(java.lang.String aName, java.util.Map<java.lang.String,?> properties) throws PumaSystemException, PumaMissingAccessRightsException
User
s that have a name that matches the given
name. As this is a paged search, only a subset (page) of the complete
result is returned. The page size is determined by the properties map
passed as parameter. PagingIterator.hasNextPage()
and
PagingIterator.getNextPage(List)
to iterate over the result
pages.
name
- defines the string to be used in the querypagingProperties
- Map that specifies the paging properties. Must at
least contain a positive value for RESULTS_PER_PAGE
.
java.lang.IllegalArgumentException
- if pagingProperties is null or does
contain invalid properties.
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaModelException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsThe query used for finding the users considers those attributes that are
typically used as name and matches their values against the given name.
java.util.List<Group> searchGroupByName(java.lang.String name) throws PumaSystemException, PumaModelException, PumaMissingAccessRightsException
Group
s that have a name that matches the given
name.
The query used for finding the groups considers those attributes that are
typically used as name and matches their values against the given name.
name
- defines the string to be used in the query
Group
objects
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaModelException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsPagingIterator<Group> searchGroupByName(java.lang.String name, java.util.Map<java.lang.String,?> properties) throws PumaSystemException, PumaMissingAccessRightsException
Group
s that have a name that matches the given
name. As this is a paged search, only a subset (page) of the complete
result is returned. The page size is determined by the properties map
passed as parameter. PagingIterator.hasNextPage()
and
PagingIterator.getNextPage(List)
to iterate over the result
pages.
name
- defines the string to be used in the querypagingProperties
- Map that specifies the paging properties. Must at
least contain a positive value for RESULTS_PER_PAGE
.
java.lang.IllegalArgumentException
- if pagingProperties is null or does
contain invalid properties.
PumaSystemException
- will be thrown whenever an unrecoverable
backend error occurs
PumaModelException
- will be thrown if attributes are not defined
PumaMissingAccessRightsException
- will be thrown if the current
authenticated user does not have the necessary rightsThe query used for finding the groups considers those attributes that are
typically used as name and matches their values against the given name.
java.util.List<User> findUsersByAttributeRecursively(User user, java.lang.String attribute, int depth) throws PumaSystemException, PumaAttributeException, PumaMissingAccessRightsException, MemberNotFoundException
List
of Principals that are linked by the given
attribute.
This method can only be applied on an attribute of the type
AttributeDefinition.MEMBERDN
. The (n+1)th user in the list is
identified by the value of the given attribute of the nth user. If the
given attribute is multi-valued, only the first value is considered.
The computation will stop either at the first principal where the
attribute is null or at the level where the current User does not have
the necessary permissions or at the given depth.
user
- start point to fetch all dependent principals,
null
is not allowed as input parameterattribute
- the attribute to look atdepth
- the maximum size of the list to be returned; use -1 for
"unrestricted"
PumaSystemException
PumaAttributeException
PumaMissingAccessRightsException
MemberNotFoundException
- - if the user referred to by parameter
aUser is not available
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |