com.netegrity.llsdk6.imsapi.policy
Interface ProvisioningPolicy

All Superinterfaces:

AttributeCollection, ManagedObject, java.util.Map, ModifiableObject, NamedObject, java.io.Serializable

public interface ProvisioningPolicy
extends ManagedObject

Contains information about an eTrust Admin provisioning policy as it is defined to Identity Manager.

A provisioning policy serves as a template for an eTrust Admin account on one or more eTrust Admin directories of a specific namespace.

When an account is updated or synchronized against a provisioning policy, the account's capability attributes are updated or synchronized by the corresponding attributes in the policy.

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

Since:

Identity Manager 8.1

See Also:

Account, ProvisioningRole

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

static java.lang.String	ACCOUNT_CONTAINER The Provisioning Policy object's AccountContainer.
static java.lang.String	ACCOUNT_NAME The Provisioning Policy object's account name mapping.
static java.lang.String	ENDPOINT The Provisioning Policy object's endpoint(s).
static java.lang.String	ENDPOINT_TYPE The Provisioning Policy object's endpoint type.

Method Summary

java.lang.String	getAccountContainerName() Retrieves the name of the account container that the associated account is created in.
java.lang.String	getAccountName() Retrieves the name of the eTrust Admin account associated with the policy.
java.util.Vector	getAssociatedRoles() Retrieves the eTrust Admin provisioning roles associated with the policy.
java.util.Vector	getEndPointNames() Retrieves the name of the EndPoint associated with the policy.
java.lang.String	getEndPointType()
java.lang.String	getFirstEndpointName() Get the first endpoint name in the account template
java.lang.Object	getIAMHandle() Retrieves the unique IAMHandle for this policy.
java.lang.String	getName() Retrieves the policy name.
java.lang.String	getNameSpace() Retrieves the policy namespace -- that is, the type of endpoint (such as ActiveDirectory, Unix, or LDAP) that the policy is associated with.

Methods inherited from interface com.netegrity.llsdk6.imsapi.managedobject.ManagedObject

directAddAttributeValue, directRemoveAttributeValue, equals, fixUniqueNames, getImsDirectory, getImsEnvironment, getObjectType, getOrg, getOrg, getProvider, hashCode, move, persisted

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.NamedObject

getFriendlyName, getUniqueName, toString

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.AttributeCollection

addAttributes, addValueToAttribute, containsAttribute, doesAttributeHaveMultipleValues, enumerateAttributes, getAttribute, getAttributeMultiValue, getAttributePermission, getAttributes, getExtendedAttribute, getLastCommittedAttribute, getLastCommittedAttributeMultiValue, getLastCommittedValue, getOriginalAttribute, getOriginalAttributeMultiValue, getOriginalValue, getValue, hasAttributeChanged, isAttributeUncommitted, isUncommitted, makeCurrentValueOriginal, removeAttributes, setAttribute, setAttributeMultiValue, setAttributes, setValue, updateAttributeSet

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.ModifiableObject

modifyObject, modifyObject

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

ENDPOINT

static final java.lang.String ENDPOINT

The Provisioning Policy object's endpoint(s).

See Also:

Constant Field Values

ENDPOINT_TYPE

static final java.lang.String ENDPOINT_TYPE

The Provisioning Policy object's endpoint type. Note: Also referred to as the namespace

See Also:

Constant Field Values

ACCOUNT_NAME

static final java.lang.String ACCOUNT_NAME

The Provisioning Policy object's account name mapping.

See Also:

Constant Field Values

ACCOUNT_CONTAINER

static final java.lang.String ACCOUNT_CONTAINER

The Provisioning Policy object's AccountContainer.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws JIAMOperationException

Retrieves the policy name.

Returns:

The name of the provisioning policy.

Throws:

JIAMOperationException

getNameSpace

java.lang.String getNameSpace()
                              throws JIAMOperationException

Retrieves the policy namespace -- that is, the type of endpoint (such as ActiveDirectory, Unix, or LDAP) that the policy is associated with.

Returns:

The provisioning policy namespace.

Throws:

JIAMOperationException

getAccountName

java.lang.String getAccountName()
                                throws JIAMOperationException

Retrieves the name of the eTrust Admin account associated with the policy.

Returns:

The name of the account associated with the provisioning policy.

Throws:

JIAMOperationException

getAccountContainerName

java.lang.String getAccountContainerName()
                                         throws JIAMOperationException

Retrieves the name of the account container that the associated account is created in.

The account container name is namespace-specific -- for example, a domain name with Active Directory, or an organization or group name with LDAP.

Returns:

The name of the account container associated with the policy.

Throws:

JIAMOperationException

getIAMHandle

java.lang.Object getIAMHandle()
                              throws JIAMOperationException

Retrieves the unique IAMHandle for this policy.

For information on the policy's unique IAMHandle identifier, see the eTrust IAM API Documentation (Javadoc).

Returns:

The policy's IAMHandle.

Throws:

JIAMOperationException

getEndPointNames

java.util.Vector getEndPointNames()
                                  throws JIAMOperationException

Retrieves the name of the EndPoint associated with the policy.

Returns:

A Vector of EndPoint name(s) associated with the provisioning policy.

Throws:

JIAMOperationException

getAssociatedRoles

java.util.Vector getAssociatedRoles()
                                    throws JIAMOperationException

Retrieves the eTrust Admin provisioning roles associated with the policy.

Returns:

A Vector of ProvisioningRole objects.

Throws:

JIAMOperationException

getEndPointType

java.lang.String getEndPointType()
                                 throws JIAMOperationException

Throws:

JIAMOperationException

getFirstEndpointName

java.lang.String getFirstEndpointName()
                                      throws JIAMOperationException

Get the first endpoint name in the account template

Returns:

Endpoint name or null

Throws:

JIAMOperationException