com.ibm.itim.dataservices.model.domain

Class AdminDomainSearch

java.lang.Object

com.ibm.itim.dataservices.model.domain.AdminDomainSearch

public class AdminDomainSearch
extends java.lang.Object

Class that provides an interface for searching for admin domains. 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 admin domains.

See Also:

AdminDomainEntity

Constructor Summary

Constructors

Constructor and Description
AdminDomainSearch() Default constructor.

Method Summary

Modifier and Type	Method and Description
AdminDomainEntity	lookup(DistinguishedName dn) Retrieves the administrative domain with the given distinguished name.
SearchResults	searchByFilter(CompoundDN searchContext, java.lang.String filter, SearchParameters params) Searches for admin domains that meet the criteria defined within the given filter.
SearchResults	searchByFilter(CompoundDN searchContext, java.lang.String filter, SearchParameters params, javax.naming.ldap.InitialLdapContext ldapContext) Searches for admin domains that meet the criteria defined within the given filter.
SearchResults	searchByFilter(OrganizationalContainerEntity searchContext, java.lang.String filter, SearchParameters params) Searches for admin domains that meet the criteria defined within the given filter.
AdminDomainEntity	searchByURI(OrganizationalContainerEntity searchContext, java.lang.String uri) Finds the administrative domain for a specific URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminDomainSearch

public AdminDomainSearch()

Default constructor.

Method Detail

lookup

public AdminDomainEntity lookup(DistinguishedName dn)
                         throws ModelCommunicationException,
                                ObjectNotFoundException

Retrieves the administrative domain with the given distinguished name.

Parameters:

dn - DistinguishedName to search with.

Returns:

AdminDomainEntity matching the given dn.

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.

searchByFilter

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

Searches for admin domains 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 - OrganizationalContainerEntity which is to be used as the base context to search from.

filter - Filter that defines the criteria for returned admin domains 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. If the search scope is ONELEVEL_SCOPE, the search is limited only to the admin domains belong to the given parent (searchContext.last()). Otherwise, the whole logical subtree will be searched.

Returns:

SearchResults holding AdminDomainEntities for all admin domains that meet the search criteria.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the container specified in the searchContext. This may be due to the container being removed by another client.

searchByFilter

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

Searches for admin domains 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 that defines the base of the search. At least one (1) element and at most three (3) are expected:

• searchContext.elements[0] must contain the tenant DN
• searchContext.elements[1] may contain the organization DN
• searchContext.elements[2] may contain the parent DN (optional)

An element cannot be skipped. For example, you can not pass the parent DN without passing the organization DN.

filter - Filter that defines the criteria for returned admin domains 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. If the search scope is ONELEVEL_SCOPE, the search is limited only to the admin domains that belong to the given parent (searchContext.last()). Otherwise, the whole logical subtree will be searched.

Returns:

SearchResults holding AdminDomainEntities for all admin domains that meet the search criteria.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the container specified in the searchContext. This may be due to the container being removed by another client.

searchByFilter

public SearchResults searchByFilter(CompoundDN searchContext,
                                    java.lang.String filter,
                                    SearchParameters params,
                                    javax.naming.ldap.InitialLdapContext ldapContext)
                             throws ObjectNotFoundException,
                                    ModelCommunicationException

Searches for admin domains 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 that defines the base of the search. At least one (1) element and at most three (3) are expected:

• searchContext.elements[0] must contain the tenant DN
• searchContext.elements[1] may contain the organization DN
• searchContext.elements[2] may contain the parent DN (optional)

An element cannot be skipped. For example, you can not pass the parent DN without passing the organization DN.

filter - Filter that defines the criteria for returned admin domains 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. If the search scope is ONELEVEL_SCOPE, the search is limited only to the admin domains that belong to the given parent (searchContext.last()). Otherwise, the whole logical subtree will be searched.

ldapContext - The JNDI context on which the search will be issued. Note: the SearchResults will hold a reference to this JNDI context.

Returns:

SearchResults(PagedResults) object having factory object of AdminDomainObjectFactory.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the container specified in the searchContext. This may be due to the container being removed by another client.

searchByURI

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

Finds the administrative domain for a specific URI.

Parameters:

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

uri - URI of the administrative domain.

Returns:

AdminDomainEntity 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 administrative domain 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.