com.ibm.itim.dataservices.model.system

Class SystemUserSearch

java.lang.Object

com.ibm.itim.dataservices.model.system.SystemUserSearch

public class SystemUserSearch
extends java.lang.Object

Provides an interface for searching for SystemUserEntity(s). This interface is supplied to clients so that they can search in a more direct manner without having to traverse data model relationships to retrieve SystemUserEntity(s). It should be noted that, like all other classes in the com.ibm.itim.dataservices package and its sub-packages, this class is not remote able. It should be used from local customization code such as JavaScript extensions, but not from code deployed outside the platform. It should also be noted that, like all other search classes in the com.ibm.itim.dataservices package and its sub-packages, this search class does not check ACIs to filter out results. A remote able equivalent that performs ACI checking is available in the com.ibm.itim.apps.provisioning.AccountManager class.

See Also:

SystemUserEntity

Constructor Summary

Constructors

Constructor and Description
SystemUserSearch() Default constructor.

Method Summary

Modifier and Type	Method and Description
SystemUserEntity	lookup(DistinguishedName dn) Retrieves the SystemUser from the data store with the given distinguished name.
SearchResults	searchByDelegate(DistinguishedName tenantDN, DistinguishedName delegateDN, SearchParameters params) Searches for system users that have the specified delegate.
SearchResults	searchByFilter(CompoundDN searchContext, java.lang.String filter, SearchParameters params) Searches for system users that meet the criteria defined within the given filter.
SearchResults	searchByFilter(DistinguishedName tenantDN, java.lang.String filter, SearchParameters params) Searches for system users that meet the criteria defined within the given filter.
SearchResults	searchByOwner(DistinguishedName ownerDN, SearchParameters params) Searches for system users (platform accounts) owned by the given person (identity).
SearchResults	searchByRole(DistinguishedName roleDN, SearchParameters params) Searches for system users (platform accounts) that are members of the given system role (group).
SystemUserEntity	searchByURI(OrganizationalContainerEntity searchContext, java.lang.String uri) Find the system user for a specific URI.
SystemUserEntity	searchByUserID(DistinguishedName tenantDN, java.lang.String userID) Retrieves the system user with the given id.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SystemUserSearch

public SystemUserSearch()

Default constructor.

Method Detail

lookup

public SystemUserEntity lookup(DistinguishedName dn)
                        throws ModelCommunicationException,
                               ObjectNotFoundException

Retrieves the SystemUser from the data store with the given distinguished name.

Parameters:

dn - DistinguishedName of the SystemUser.

Returns:

SystemUser with the corresponding distinguished name.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the entity in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

searchByUserID

public SystemUserEntity searchByUserID(DistinguishedName tenantDN,
                                       java.lang.String userID)
                                throws ModelCommunicationException,
                                       ObjectNotFoundException

Retrieves the system user with the given id.

Parameters:

tenantDN - DistinguishedName of the tenant (system root) to use as the base of the search.

userID - Id of the system user to search for.

Returns:

SystemUserEntity with the matching id.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if search base is invalid or no system user has the given id in the data store.

searchByFilter

public SearchResults searchByFilter(DistinguishedName tenantDN,
                                    java.lang.String filter,
                                    SearchParameters params)
                             throws ModelCommunicationException,
                                    ObjectNotFoundException

Searches for system users that meet the criteria defined within the given filter. This search is performed as a raw search against the data store without any semantic mapping.

Parameters:

tenantDN - DistinguishedName of the tenant (system root) to use as the base of the search.

filter - Filter that defines the criteria for returned SystemUserEntities to meet. The filter must be in the format defined by RFC2254.

params - SearchParameters that provide additional context for how the search should be performed. Scope is not supported.

Returns:

SearchResults holding SystemUserEntities for all system users that meet the search criteria.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if search base is invalid.

searchByFilter

public SearchResults searchByFilter(CompoundDN searchContext,
                                    java.lang.String filter,
                                    SearchParameters params)
                             throws ModelCommunicationException,
                                    ObjectNotFoundException

Searches for system users that meet the criteria defined within the given filter. This search is performed as a raw search against the data store without any semantic mapping.

Parameters:

searchContext - CompoundDN with only one DistinguishedName identifying the tenant (system root) to use as the base of the search.

filter - Filter that defines the criteria for returned SystemUserEntities to meet. The filter must be in the format defined by RFC2254.

params - SearchParameters that provide additional context for how the search should be performed. Scope is not supported.

Returns:

SearchResults holding SystemUserEntities for all system users that meet the search criteria.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if search base is invalid.

searchByOwner

public SearchResults searchByOwner(DistinguishedName ownerDN,
                                   SearchParameters params)
                            throws ModelCommunicationException,
                                   ObjectNotFoundException

Searches for system users (platform accounts) owned by the given person (identity).

Parameters:

ownerDN - DistinguishedName of the person (identity) who is the subject of the search.

params - SearchParameters that provide additional context for how the search should be performed. Scope is not supported.

Returns:

SearchResults holding SystemUserEntities for all system users that are owned by the given person.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the owner in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

searchByRole

public SearchResults searchByRole(DistinguishedName roleDN,
                                  SearchParameters params)
                           throws ModelCommunicationException,
                                  ObjectNotFoundException

Searches for system users (platform accounts) that are members of the given system role (group).

Parameters:

roleDN - DistinguishedName of the role (group) that is the subject of the search.

params - SearchParameters that provide additional context for how the search should be performed. Scope is not supported.

Returns:

SearchResults holding SystemUserEntities for all system users that are members of the given role (group).

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the role in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

searchByDelegate

public SearchResults searchByDelegate(DistinguishedName tenantDN,
                                      DistinguishedName delegateDN,
                                      SearchParameters params)
                               throws ModelCommunicationException,
                                      ObjectNotFoundException

Searches for system users that have the specified delegate.

Parameters:

tenantDN - DistinguishedName of the tenant (system root) to use as the base of the search.

delegateDN - The DistinguishedName of the delegate (system user).

params - SearchParameters that provide additional context for how the search should be performed. Scope is not supported.

Returns:

SearchResults holding SystemUserEntities for all system users that meet the search criteria.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if search base is invalid.

searchByURI

public SystemUserEntity searchByURI(OrganizationalContainerEntity searchContext,
                                    java.lang.String uri)
                             throws ModelCommunicationException,
                                    URINotUniqueException,
                                    ObjectNotFoundException

Find the system user for a specific URI.

Parameters:

searchContext - OrganizationalContainerEntity which is to be used as the base context to search from.

uri - URI of the policy.

Returns:

SystemUserEntity with the corresponding URI.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

URINotUniqueException - Thrown if more than one object is found for the URI under the specified search context.

ObjectNotFoundException - Thrown if unable to locate the system user or the search context in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.