com.netegrity.llsdk6.imsapi.provider
Interface AccessRoleProvider

public interface AccessRoleProvider

Lets you create or retrieve access roles in the current Identity Manager environment.

To retrieve access roles from multiple Identity Manager environments, use AccessControlProvider.

This and all Identity Manager providers are retrieved through ProviderAccessor.

Access to Access Role Attributes

After you retrieve an access role object, you access its attribute data through the methods in the base interface Role.

Typically, managed objects retrieved through AccessRoleProvider are accessed for reading purposes only. However, on occassion, business logic task handlers and event listeners may need to modify objects retrieved through AccessRoleProvider.

Note: To commit the changes you make to a managed object retrieved through AccessRoleProvider, 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

AccessRole	createAccessRole(java.lang.String name, java.lang.String description, boolean enabled, boolean assignable, boolean adminAssignable) Creates a new access role without any associated policies or change rules.
AccessRole	findAccessRole(java.lang.String friendlyName) Retrieves the specified access role, using the role's friendly name.
AccessRole	getAccessRole(java.lang.String uniqueName) Retrieves the specified access role, using the role's unique name.
java.util.Vector	getAccessRoles() Retrieves all the access roles in the Identity Manager environment.
java.util.Vector	getAccessRolesAdminCanAssign(TSContext tsCtx) Retrieves the access roles to which the subject of the task can be assigned by the current administrator.
java.util.Vector	getAccessRolesAdminCanGrantAdmin(TSContext tsCtx) Retrieves the access roles for which the subject of the task can be assigned administrator rights by the current administrator.
java.util.Vector	getAccessRolesAdminCanGrantAdmin(TSContext tsCtx, java.util.Vector rolesToSearch) Returns roles from the given list that the admin can make users role admins.
java.util.Vector	getAccessRolesAdminCanManageAdmin(TSContext tsCtx) Retrieves the access roles for which the current administrator can assign administrator rights.
java.util.Vector	getAccessRolesAdminCanManageMembers(TSContext tsCtx) Retrieves the access roles to which a user can be assigned by the current administrator.
java.util.Vector	getAccessRolesAdminCanManageMembers(TSContext tsCtx, java.util.Vector rolesToSearch) Returns roles from the given list that the admin can make users role members.
java.util.Vector	getAccessRolesContainingTask(AccessTask task) Retrieves the access roles that contain the specified access task.
java.util.Vector	searchAccessRoles(RoleObjectQuery query) Searches for a subset of the access roles in the Identity Manager environment.

Method Detail

createAccessRole

AccessRole createAccessRole(java.lang.String name,
                            java.lang.String description,
                            boolean enabled,
                            boolean assignable,
                            boolean adminAssignable)
                            throws com.netegrity.sdk.apiutil.SmApiException

Creates a new access role without any associated policies or change rules.

Parameters:

name - The friendly name for the role.

description - The description of the role.

enabled - true if the role is enabled.

assignable - true if a member's role assignments can be changed.

adminAssignable - true if administrator rights to the role can be changed.

Returns:

The newly created access role.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAccessRole

AccessRole getAccessRole(java.lang.String uniqueName)
                         throws com.netegrity.sdk.apiutil.SmApiException,
                                NoSuchObjectException

Retrieves the specified access role, using the role's unique name.

Parameters:

uniqueName - The unique name of the access role to retrieve.

Returns:

The specified access role.

Throws:

NoSuchObjectException - if the object cannot be found.

com.netegrity.sdk.apiutil.SmApiException

findAccessRole

AccessRole findAccessRole(java.lang.String friendlyName)
                          throws SmApiException,
                                 NoSuchObjectException

Retrieves the specified access role, using the role's friendly name.

Parameters:

friendlyName - The friendly name of the access role to retrieve.

Returns:

The specified access role.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

getAccessRoles

java.util.Vector getAccessRoles()
                                throws com.netegrity.sdk.apiutil.SmApiException

Retrieves all the access roles in the Identity Manager environment.

Returns:

A Vector of the access roles.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAccessRolesAdminCanGrantAdmin

java.util.Vector getAccessRolesAdminCanGrantAdmin(TSContext tsCtx,
                                                  java.util.Vector rolesToSearch)
                                                  throws SmApiException

Returns roles from the given list that the admin can make users role admins. Note: Roles to search should be a list of AccessRole objects obtained from the IM server.

Parameters:

tsCtx -

rolesToSearch - collection of AccessRoles to search for.

Returns:

A Vector of the Access role objects that the Admin can grant membership to.

Throws:

SmApiException

getAccessRolesAdminCanManageMembers

java.util.Vector getAccessRolesAdminCanManageMembers(TSContext tsCtx,
                                                     java.util.Vector rolesToSearch)
                                                     throws SmApiException

Returns roles from the given list that the admin can make users role members. Note: Roles to search should be a list of AccessRole objects obtained from the IM server.

Parameters:

tsCtx -

rolesToSearch - collection of AccessRoles to search for.

Returns:

A Vector of the Access role objects that the Admin can grant administrators to.

Throws:

SmApiException

searchAccessRoles

java.util.Vector searchAccessRoles(RoleObjectQuery query)
                                   throws com.netegrity.sdk.apiutil.SmApiException

Searches for a subset of the access roles in the Identity Manager environment.

Parameters:

query - The search filter.

Returns:

A Vector of the access role objects found in the search.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAccessRolesContainingTask

java.util.Vector getAccessRolesContainingTask(AccessTask task)
                                              throws SmApiException

Retrieves the access roles that contain the specified access task.

Parameters:

task - The access task contained in the access roles to retrieve.

Returns:

The access role objects that contain the specified access task.

Throws:

SmApiException

getAccessRolesAdminCanGrantAdmin

java.util.Vector getAccessRolesAdminCanGrantAdmin(TSContext tsCtx)
                                                  throws SmApiException

Retrieves the access roles for which the subject of the task can be assigned administrator rights by the current administrator.

Parameters:

tsCtx - Context information about the current task, such as the subject of the task and the administrator who is executing the task.

Returns:

The requested access role objects.

Throws:

SmApiException

getAccessRolesAdminCanAssign

java.util.Vector getAccessRolesAdminCanAssign(TSContext tsCtx)
                                              throws SmApiException

Retrieves the access roles to which the subject of the task can be assigned by the current administrator.

Parameters:

tsCtx - Context information about the current task, such as the subject of the task and the administrator who is executing the task.

Returns:

The access roles that the administrator can make the subject a member of.

Throws:

SmApiException

getAccessRolesAdminCanManageAdmin

java.util.Vector getAccessRolesAdminCanManageAdmin(TSContext tsCtx)
                                                   throws SmApiException

Retrieves the access roles for which the current administrator can assign administrator rights.

Parameters:

tsCtx - Context information about the current task, such as the administrator who is executing the task.

Returns:

The access roles for which the administrator can assign administrator rights.

Throws:

SmApiException

getAccessRolesAdminCanManageMembers

java.util.Vector getAccessRolesAdminCanManageMembers(TSContext tsCtx)
                                                     throws SmApiException

Retrieves the access roles to which a user can be assigned by the current administrator.

Parameters:

tsCtx - Context information about the current task, such as the administrator who is executing the task.

Returns:

The requested access role objects.

Throws:

SmApiException