com.ca.identitymanager.provisioning.managedobjectprovider
Interface AccountProvider

public interface AccountProvider

Account provider lets you create and retrieve different types of accounts.

Field Summary

static java.lang.String	ASSIGN
static java.lang.String	DELETE
static java.lang.String	GETSTATUS
static java.lang.String	MOVE
static java.lang.String	PASSWORDCHANGE
static java.lang.String	RESUME
static java.lang.String	SUSPEND
static java.lang.String	UNASSIGN
static java.lang.String	UNLOCK

Method Summary

java.util.Vector	enumerateEntitlementAttributes(java.lang.String endpointType) Enumerate IM entitlement attributes for a given endpoint type.
java.util.Vector	findManagedObjectsInScope(TSContext ctx, ScopeRule rule, AttributeRightsCollection requestedAttrs, boolean getSecondary, boolean initReasons)
java.util.Vector	findUserAccounts(TSContext ctx, ScopeRule rule, AttributeRightsCollection requestedAttrs, boolean getSecondary, boolean initReasons)
ObjectType	getObjectType(java.lang.String endpointType) Get object type of a namespace
boolean	isEndpointTypeConfigured(java.lang.String endpointType) Is the given endpoint type configured on Identity Manager.
boolean	isSupportedOperation(java.lang.String opname) Is account operation supported.
java.util.Vector	listAccounts(User user, boolean getSecondary, boolean initReasons) List user accounts Parameters: user A IM User.

Field Detail

SUSPEND

static final java.lang.String SUSPEND

See Also:

Constant Field Values

RESUME

static final java.lang.String RESUME

See Also:

Constant Field Values

UNLOCK

static final java.lang.String UNLOCK

See Also:

Constant Field Values

PASSWORDCHANGE

static final java.lang.String PASSWORDCHANGE

See Also:

Constant Field Values

ASSIGN

static final java.lang.String ASSIGN

See Also:

Constant Field Values

UNASSIGN

static final java.lang.String UNASSIGN

See Also:

Constant Field Values

DELETE

static final java.lang.String DELETE

See Also:

Constant Field Values

GETSTATUS

static final java.lang.String GETSTATUS

See Also:

Constant Field Values

MOVE

static final java.lang.String MOVE

See Also:

Constant Field Values

Method Detail

listAccounts

java.util.Vector listAccounts(User user,
                              boolean getSecondary,
                              boolean initReasons)
                              throws SmApiException

List user accounts Parameters: user A IM User. This is the user with which this account associated. The user is the primary object for these task that include the Account tab. The use is also the managed object that is leveraged in order to gain access to JIAM (without the use no JIAM operation would be possible). getSecondary A boolean that specifies whether or not the secondary account attributes should be retrieved along with the other account attributes. Secondary attributes are those attributes that can only be retrieved from the endpoint on which the account resides. In particular, the suspended state of the account and the locked state of the account. initReasons A boolean that specifies whether or not the account reasons will be retrieved along with the other account attributes. The account "Reasons" is a list of the Admin Roles and Policies, associated with user, that are the reason why this account exists.

Throws:

SmApiException

getObjectType

ObjectType getObjectType(java.lang.String endpointType)
                         throws SmApiException

Get object type of a namespace

Parameters:

endpointType -

Returns:

Throws:

SmApiException

enumerateEntitlementAttributes

java.util.Vector enumerateEntitlementAttributes(java.lang.String endpointType)
                                                throws SmApiException

Enumerate IM entitlement attributes for a given endpoint type. If the endpoint does not define any entitlement attributes a empty Vector is returned.

Parameters:

endpointType -

Returns:

entitlement attributes

Throws:

SmApiException

findManagedObjectsInScope

java.util.Vector findManagedObjectsInScope(TSContext ctx,
                                           ScopeRule rule,
                                           AttributeRightsCollection requestedAttrs,
                                           boolean getSecondary,
                                           boolean initReasons)
                                           throws SmApiException

Throws:

SmApiException

findUserAccounts

java.util.Vector findUserAccounts(TSContext ctx,
                                  ScopeRule rule,
                                  AttributeRightsCollection requestedAttrs,
                                  boolean getSecondary,
                                  boolean initReasons)
                                  throws SmApiException

Throws:

SmApiException

isSupportedOperation

boolean isSupportedOperation(java.lang.String opname)
                             throws java.lang.Exception

Is account operation supported. The provider looks at the im2jiammapping file for the list of supported operations.

Parameters:

opname - - Operation name like suspended, change password, unlock

Returns:

- true if the operation is supported. false otherwise

Throws:

java.lang.Exception

isEndpointTypeConfigured

boolean isEndpointTypeConfigured(java.lang.String endpointType)
                                 throws SmApiException

Is the given endpoint type configured on Identity Manager. Identity Manager im2jiammapping holds a list of standard endpoint types. This list defines that Identity Manager is configured with the respective endpoint types.

Parameters:

endpointType - - Name of the endpoint

Returns:

- true if endpoint type is configured on IM. false otherwise.

Throws:

SmApiException