com.ibm.itim.dataservices.model

Class ObjectProfileSearch

java.lang.Object

com.ibm.itim.dataservices.model.ObjectProfileSearch

public class ObjectProfileSearch
extends java.lang.Object

Class that provides an interface for searching for object profiles that reside in the data store. Since object profiles can be registered with the platform in a non-persistent manner (see ProfileLocator), searches performed here may not return every object profile known to the platform.

See Also:

ObjectProfileEntity

Constructor Summary

Constructors

Constructor and Description
ObjectProfileSearch() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Collection	getAllLifecycleProfiles(DistinguishedName tenantDN) This method gets all lifecycle profiles in the data store.
java.util.Collection	getAllServiceProfiles(DistinguishedName tenantDN) Returns all service profiles in the data store.
java.util.Collection	getLifeCycleProfilebyServiceTarget(DistinguishedName tenantDN, DistinguishedName targetDN) This method gets all lifecycle profiles pointing to particular service.
java.util.Collection	getProfilesInCategory(DistinguishedName tenantDN, java.lang.String category) Returns all object profiles with the given category in the data store.
ObjectProfileEntity	getServiceProfileForGroup(DistinguishedName tenantDN, java.lang.String customClass) Returns the service profile associated with the group
ObjectProfileEntity	lookup(DistinguishedName dn) Searches for an object profile with the given distinguished name.
ObjectProfileEntity	lookup(DistinguishedName tenantDN, java.lang.String profileName) Searches for an object profile in the data store with the given profile name.
java.util.Collection<ObjectProfileEntity>	searchByCustomClass(DistinguishedName tenantDN, java.lang.String customClass) Searches for object profile(s) in the data store with the given custom class.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectProfileSearch

public ObjectProfileSearch()

Default constructor.

Method Detail

lookup

public ObjectProfileEntity lookup(DistinguishedName dn)
                           throws ObjectNotFoundException,
                                  ModelCommunicationException

Searches for an object profile with the given distinguished name.

Parameters:

dn - DistinguishedName to search with.

Returns:

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

lookup

public ObjectProfileEntity lookup(DistinguishedName tenantDN,
                                  java.lang.String profileName)
                           throws ObjectNotFoundException,
                                  ModelCommunicationException

Searches for an object profile in the data store with the given profile name.

Parameters:

tenantDN - Distinguished name of the tenant (system root) to provide the base of the search.

profileName - Profile name to search with.

Returns:

ObjectProfileEntity matching the given profile 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 profile name, or the entity may have been removed by another client.

searchByCustomClass

public java.util.Collection<ObjectProfileEntity> searchByCustomClass(DistinguishedName tenantDN,
                                                                     java.lang.String customClass)
                                                              throws ObjectNotFoundException,
                                                                     ModelCommunicationException

Searches for object profile(s) in the data store with the given custom class.

Parameters:

tenantDN - Distinguished name of the tenant (system root) to provide the base of the search.

customClass - name of the custom class to be searched.

Returns:

collection of ObjectProfileEntity matching the given custom class.

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 profile name, or the entity may have been removed by another client.

getProfilesInCategory

public java.util.Collection getProfilesInCategory(DistinguishedName tenantDN,
                                                  java.lang.String category)
                                           throws ModelCommunicationException

Returns all object profiles with the given category in the data store.

Parameters:

tenantDN - Distinguished name of the tenant (system root) to provide the base of the search.

category - Category of object profiles to return.

Returns:

Collection of ObjectProfileEntities.

Throws:

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

getAllServiceProfiles

public java.util.Collection getAllServiceProfiles(DistinguishedName tenantDN)
                                           throws ModelCommunicationException

Returns all service profiles in the data store.

Parameters:

tenantDN - Distinguished name of the tenant (system root) to provide the base of the search.

Returns:

Collection of ObjectProfileEntities.

Throws:

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

getAllLifecycleProfiles

public java.util.Collection getAllLifecycleProfiles(DistinguishedName tenantDN)
                                             throws ModelCommunicationException

This method gets all lifecycle profiles in the data store.

Parameters:

tenantDN - Distinguished name of the tenant (system root) to provide the base of the search.

Returns:

Collection of ObjectProfileEntities.

Throws:

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

getLifeCycleProfilebyServiceTarget

public java.util.Collection getLifeCycleProfilebyServiceTarget(DistinguishedName tenantDN,
                                                               DistinguishedName targetDN)
                                                        throws ModelCommunicationException

This method gets all lifecycle profiles pointing to particular service.

Parameters:

tenantDN - Distinguished name of the tenant (system root) to provide the base of the search.

targetDN - Distinguished name of the target service.

Returns:

Collection of ObjectProfileEntities.

Throws:

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

getServiceProfileForGroup

public ObjectProfileEntity getServiceProfileForGroup(DistinguishedName tenantDN,
                                                     java.lang.String customClass)
                                              throws ModelCommunicationException

Returns the service profile associated with the group

Parameters:

tenantDN - Distinguished name of the tenant (system root) to provide the base of the search.

customClass - custom class name of the group that the service profile will be retrieved.

Returns:

ObjectProfileEntity.

Throws:

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