com.ibm.itim.dataservices.model

Class DirectoryObjectSearch

java.lang.Object

com.ibm.itim.dataservices.model.DirectoryObjectSearch

public class DirectoryObjectSearch
extends java.lang.Object

Class that provides searching capabilities for DirectoryObjects. 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 objects.

See Also:

DirectoryObjectEntity

Constructor Summary

Constructors

Constructor and Description
DirectoryObjectSearch() Default constructor.

Method Summary

Modifier and Type	Method and Description
SearchResults	fetch(DistinguishedName base, java.lang.String filter, SearchParameters params) Searches for DirectoryObjects that meet the criteria defined within the given filter.
DirectoryObjectEntity	lookup(DistinguishedName dn) Searches for a directory object with the given distinguished name.
java.util.Collection	search(DistinguishedName base, java.lang.String filter, SearchParameters params) Deprecated. Replaced by fetch(base, filter, params).
SearchResults	searchByClass(DistinguishedName base, java.lang.String className, SearchParameters params) Searches for DirectoryObjects of the given class.
SearchResults	searchByFilter(DistinguishedName base, java.lang.String filter, SearchParameters params) Searches for DirectoryObjects that meet the criteria defined within the given filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryObjectSearch

public DirectoryObjectSearch()

Default constructor.

Method Detail

lookup

public DirectoryObjectEntity lookup(DistinguishedName dn)
                             throws ObjectNotFoundException,
                                    ModelCommunicationException

Searches for a directory object with the given distinguished name.

Parameters:

dn - DistinguishedName to search with.

Returns:

DirectoryObject 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.

search

public java.util.Collection search(DistinguishedName base,
                                   java.lang.String filter,
                                   SearchParameters params)
                            throws ModelCommunicationException,
                                   ObjectNotFoundException

Deprecated. Replaced by fetch(base, filter, params).

Searches for DirectoryObjects 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 or logical hierarchy taking place.

Parameters:

base - DistinguishedName of the data store entry to be used as the base of any search.

filter - Filter that defines the criteria for returned DirectoryObects 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. Search scope set in params is not honored, it is always set to subtree scope. Use searchByFilter(base, filter, params) to perform one level scoped search.

Returns:

Collection of DirectoryObjectEntities that meet the search criteria.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the specified search base. This may be due to a data integrity problem or the base entry may have been removed by another client.

searchByClass

public SearchResults searchByClass(DistinguishedName base,
                                   java.lang.String className,
                                   SearchParameters params)
                            throws ModelCommunicationException,
                                   ObjectNotFoundException

Searches for DirectoryObjects of the given class. This search is performed as a raw search against the data store without any semantic mapping or logical hierarchy taking place.

Parameters:

base - DistinguishedName of the data store entry to be used as the base of any search.

className - Name of the class to search for.

params - SearchParameters that provide additional context for how the search should be performed.

Returns:

SearchResults holding DiretoryObjectEntities of the given class.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the specified search base. This may be due to a data integrity problem or the base entry may have been removed by another client.

fetch

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

Searches for DirectoryObjects 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 or logical hierarchy taking place.

Parameters:

base - DistinguishedName of the data store entry to be used as the base of any search.

filter - Filter that defines the criteria for returned DirectoryObects 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. Search scope set in params is not honored, it is always set to subtree scope. Use searchByFilter(base, filter, params) to perform one level scoped search.

Returns:

SearchResults holding DiretoryObjectEntities for all objects that meet the search criteria.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the specified search base. This may be due to a data integrity problem or the base entry may have been removed by another client.

searchByFilter

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

Searches for DirectoryObjects 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 or logical hierarchy taking place.

Parameters:

base - DistinguishedName of the data store entry to be used as the base of any search.

filter - Filter that defines the criteria for returned DirectoryObects 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.

Returns:

SearchResults holding DiretoryObjectEntities for all objects that meet the search criteria.

Throws:

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

ObjectNotFoundException - Thrown if unable to locate the specified search base. This may be due to a data integrity problem or the base entry may have been removed by another client.