com.netegrity.llsdk6.imsapi.provider
Interface AccessControlProvider

public interface AccessControlProvider

Provides access to the access roles and admin roles in all accessible Identity Manager environments, and to all the Identity Manager environments in a specified SiteMinder user directory.

To retrieve roles from the current Identity Manager environment only, use AccessRoleProvider or AdminRoleProvider.

This and all Identity Manager providers are retrieved through ProviderAccessor.

Note: To commit the changes you make to a managed object retrieved through AccessControlProvider, call modifyObject(). The changes are then immediately persisted to the data store. No Identity Manager events are generated, and no workflow approvals, auditing, or security checks are performed.

Since:

IdentityMinder 6.0

Method Summary

java.util.Vector	getImsEnvironmentsBySmDirectory(java.lang.String smDirOID) Retrieves a Vector of the available Identity Manager environments that are associated with a particular Identity Manager directory, which, in turn, is based on the specified SiteMinder user directory.
Role	getRole(java.lang.String uniqueName) Retrieves an admin role or an access role by unique name.
java.util.Vector	getRoleDisplayData(java.util.Vector roleUniqueNames) Retrieves information about the specified roles, based on their unique names.
java.util.Vector	getUserAccessRoles(java.lang.String smDirOID, java.lang.String userUniqueName) Retrieves the names of all access roles to which the specified user is assigned in all accessible environments.
java.util.Vector	getUserAdminRoles(java.lang.String smDirOID, java.lang.String userUniqueName) Retrieves the names of all admin roles to which the specified user is assigned in all accessible environments.

Method Detail

getImsEnvironmentsBySmDirectory

java.util.Vector getImsEnvironmentsBySmDirectory(java.lang.String smDirOID)
                                                 throws SmApiException

Retrieves a Vector of the available Identity Manager environments that are associated with a particular Identity Manager directory, which, in turn, is based on the specified SiteMinder user directory.

Parameters:

smDirOID - The unique name (OID) of the SiteMinder user directory to search.

Returns:

A Vector of the Identity Manager environments that use the specified SiteMinder user directory.

Throws:

com.netegrity.sdk.apiutil.SmApiException

SmApiException

getRole

Role getRole(java.lang.String uniqueName)
             throws SmApiException

Retrieves an admin role or an access role by unique name.

This method is useful when you know the unique name of the role to retrieve, but you do not know what Identity Manager environment it is in.

Parameters:

name - The unique name of the role to retrieve.

Returns:

The role object.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSuchObjectException - if the object can not be found.

SmApiException

getRoleDisplayData

java.util.Vector getRoleDisplayData(java.util.Vector roleUniqueNames)
                                    throws SmApiException

Retrieves information about the specified roles, based on their unique names.

Identity Manager includes this information when displaying a list of roles.

Parameters:

roleUniqueNames - A Vector of Strings containing the unique names of roles.

Returns:

A Vector of RoleDisplayData objects.

Throws:

SmApiException

getUserAccessRoles

java.util.Vector getUserAccessRoles(java.lang.String smDirOID,
                                    java.lang.String userUniqueName)
                                    throws SmApiException

Retrieves the names of all access roles to which the specified user is assigned in all accessible environments. The user is specified by the combination of a SiteMinder user directory identifier and a user identifier within that directory.

Parameters:

smDirOID - The unique name (OID) of the user's SiteMinder user directory.

userUniqueName - The user's unique identifier within the specified directory.

Returns:

A Vector of Strings representing the unique names of the access roles.

Throws:

SmApiException

getUserAdminRoles

java.util.Vector getUserAdminRoles(java.lang.String smDirOID,
                                   java.lang.String userUniqueName)
                                   throws SmApiException

Retrieves the names of all admin roles to which the specified user is assigned in all accessible environments. The user is specified by the combination of a SiteMinder user directory identifier and a user identifier within that directory.

Parameters:

smDirOID - The unique name (OID) of the user's SiteMinder user directory.

userUniqueName - The user's unique identifier within the specified directory.

Returns:

A Vector of Strings representing the unique names of the admin roles.

Throws:

SmApiException