com.netegrity.llsdk6.imsapi.provider
Interface ProvisioningPolicyProvider

public interface ProvisioningPolicyProvider

Lets you retrieve provisioning policy objects in the current Identity Manager environment.

An Identity Manager provisioning policy object is an in-memory representation of an eTrust Admin Policy, which is defined and persisted in the eTrustAdmin Server.

Provisioning policy objects retrieved through the ProvisioningPolicyProvider are accessed for reading only.

Identity Manager provisioning policy objects returned from this provider are based on the JIAM IPolicy object.

This and all Identity Manager providers are retrieved through ProviderAccessor.

Note: This object requires an instance of eTrust Admin Directory.

Since:

Identity Manager 8.1

See Also:

Account, ProvisioningPolicy, ProvisioningRole

Method Summary

ProvisioningPolicy	findProvisioningPolicy(java.lang.String friendlyName) Retrieves the specified provisioning policy, using the policy's friendly name.
java.util.Vector	getProvisioningPolicies() Retrieves all the provisioning policies in the Identity Manager environment.
java.util.Vector	getProvisioningPoliciesByNameSpace(java.lang.String namespace) Retrieves all the provisioning policies in the Identity Manager environment that are associated with the specified namespace.
ProvisioningPolicy	getProvisioningPolicy(java.lang.Object handle) Retrieves the specified provisioning policy, using the policy's unique identifier.
ProvisioningPolicy	getProvisioningPolicy(java.lang.Object handle, AttributeRightsCollection arc)
java.util.Vector	getProvisioningPolicyNameSpaceNames() Retrieves all the configured namespace names in the Identity Manager environment.
java.util.Vector	searchProvisioningPolicies(java.lang.String namespace, ProvisioningPolicyObjectQuery query, long searchLimit) Searches for a subset of the provisioning policies in the Identity Manager environment within the specified namespace.

Method Detail

getProvisioningPolicy

ProvisioningPolicy getProvisioningPolicy(java.lang.Object handle)
                                         throws JIAMOperationException,
                                                NoSuchObjectException

Retrieves the specified provisioning policy, using the policy's unique identifier.

In Identity Manager, getIAMHandle() retrieves a policy's unique IAMHandle identifier.

For more information about the IAMHandle identifier for a policy, see the eTrust IAM API Documentation (Javadoc).

Parameters:

handle - The IAMHandle representing the unique id of the provisioning policy to retrieve.

Returns:

The specified provisioning policy object.

Throws:

JIAMOperationException - is an error occurs retrieving the object thru JIAM or NoSuchObjectException if the object cannot be found.

NoSuchObjectException

getProvisioningPolicy

ProvisioningPolicy getProvisioningPolicy(java.lang.Object handle,
                                         AttributeRightsCollection arc)
                                         throws JIAMOperationException,
                                                NoSuchObjectException

Throws:

JIAMOperationException

NoSuchObjectException

findProvisioningPolicy

ProvisioningPolicy findProvisioningPolicy(java.lang.String friendlyName)
                                          throws JIAMOperationException,
                                                 NoSuchObjectException

Retrieves the specified provisioning policy, using the policy's friendly name.

Parameters:

friendlyName - The friendly name of the provisioning policy to retrieve.

Returns:

The specified provisioning policy object.

Throws:

NoSuchObjectException - if the object cannot be found.

JIAMOperationException

getProvisioningPolicies

java.util.Vector getProvisioningPolicies()
                                         throws JIAMOperationException

Retrieves all the provisioning policies in the Identity Manager environment.

Returns:

A Vector of ProvisioningPolicy objects.

Throws:

JIAMOperationException

getProvisioningPoliciesByNameSpace

java.util.Vector getProvisioningPoliciesByNameSpace(java.lang.String namespace)
                                                    throws JIAMOperationException,
                                                           NoSuchObjectException

Retrieves all the provisioning policies in the Identity Manager environment that are associated with the specified namespace.

A namespace defines the type of endpoint system that the policy is associated with -- for example, ActiveDirectory, Unix, or LDAP.

Parameters:

namespacename - The namespace name.

Returns:

A Vector of ProvisioningPolicy objects.

Throws:

JIAMOperationException

NoSuchObjectException

getProvisioningPolicyNameSpaceNames

java.util.Vector getProvisioningPolicyNameSpaceNames()
                                                     throws JIAMOperationException

Retrieves all the configured namespace names in the Identity Manager environment.

Returns:

A Vector of Strings containing unique namespace names found in the Provisioning Server associated with the Identity Manager environment

Throws:

JIAMOperationException

searchProvisioningPolicies

java.util.Vector searchProvisioningPolicies(java.lang.String namespace,
                                            ProvisioningPolicyObjectQuery query,
                                            long searchLimit)
                                            throws JIAMOperationException

Searches for a subset of the provisioning policies in the Identity Manager environment within the specified namespace.

A namespace defines the type of endpoint system that the policy is associated with -- for example, ActiveDirectory, Unix, or LDAP.

Parameters:

namespacename - The namespace name.

query - The search filter.

searchLimit - - max number of policies to return, use 0 for no limit

Returns:

A Vector of the ProvisioningPolicy objects found in the search.

Throws:

JIAMOperationException