com.ibm.itim.dataservices.model
Interface IProfileLocator

public interface IProfileLocator

Field Summary

static java.lang.String

NAME

Method Summary

java.util.Collection<ObjectProfile>	getAllProfiles(DistinguishedName tenantDN) Returns all object profiles in the cache.
java.util.Collection<java.lang.String>	getDefaultProfileNames(java.lang.String category) Returns the profiles registered at runtime including the platform defaults for the given category.
java.util.Collection	getProfileByCategory(DistinguishedName tenantDN, java.lang.String cat) Returns all object profiles based on an object category.
ObjectProfile	getProfileByClass(DistinguishedName tenantDN, java.lang.String customClass) Returns the profile based on the category of the object and its defining classes.
ObjectProfile	getProfileByClass(DistinguishedName tenantDN, java.lang.String cat, java.util.Collection<java.lang.String> objClasses) Returns the profile based on the category of the object and its defining classes.
ObjectProfile	getProfileByName(DistinguishedName tenantDN, java.lang.String name) Returns the object profile with the given name.
ObjectProfile	loadProfile(ObjectProfile profile) Returns the object profile with the given name.
void	refresh(DistinguishedName tenantDN) This method refreshes ProfileTable and ModelProfile.
void	registerProfile(ObjectProfile profile) Registers an object profile with the locator.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

registerProfile

void registerProfile(ObjectProfile profile)

Registers an object profile with the locator. This registration is not persistent and must be re-executed at system re-start. Only one profile is allowed per category.

Parameters:

profile - ObjectProfile to register.

getProfileByClass

ObjectProfile getProfileByClass(DistinguishedName tenantDN,
                                java.lang.String cat,
                                java.util.Collection<java.lang.String> objClasses)

Returns the profile based on the category of the object and its defining classes.

Parameters:

tenantDN - DistinguishedName of the tenant (system root).

cat - Object category (i.e., person, account, etc.).

objClasses - Collection of class names (Strings).

Returns:

ObjectProfile matching the category and classes, null if none found.

getProfileByClass

ObjectProfile getProfileByClass(DistinguishedName tenantDN,
                                java.lang.String customClass)

Returns the profile based on the category of the object and its defining classes.

Parameters:

tenantDN - DistinguishedName of the tenant (system root).

customClass - custom class name of the profile.

Returns:

ObjectProfile matching the custom class, null if none found.

getProfileByCategory

java.util.Collection getProfileByCategory(DistinguishedName tenantDN,
                                          java.lang.String cat)

Returns all object profiles based on an object category.

Parameters:

tenantDN - DistinguishedName of the tenant (system root).

cat - Object category (i.e., person, account, etc.).

Returns:

Collection of ObjectProfiles for the category.

refresh

void refresh(DistinguishedName tenantDN)

This method refreshes ProfileTable and ModelProfile.

Parameters:

tenantDN -

getProfileByName

ObjectProfile getProfileByName(DistinguishedName tenantDN,
                               java.lang.String name)

Returns the object profile with the given name.

Parameters:

tenantDN - DistinguishedName of the tenant (system root).

name - Name of the profile.

Returns:

ObjectProfile with the given name.

loadProfile

ObjectProfile loadProfile(ObjectProfile profile)

Returns the object profile with the given name. This method is used to reload the profile after refresh() is called.

Parameters:

profile - The profile that will be reloaded after all profiles are refreshed.

Returns:

ObjectProfile with the given name.

getAllProfiles

java.util.Collection<ObjectProfile> getAllProfiles(DistinguishedName tenantDN)

Returns all object profiles in the cache.

Parameters:

tenantDN - DistinguishedName of the tenant (system root).

Returns:

Collection of object profiles (ObjectProfile).

getDefaultProfileNames

java.util.Collection<java.lang.String> getDefaultProfileNames(java.lang.String category)

Returns the profiles registered at runtime including the platform defaults for the given category.

Parameters:

category -

Returns:

Collection of object profile names (Strings).