com.netegrity.llsdk6.imsapi.provider
Interface AdminRoleProvider

public interface AdminRoleProvider

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

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

This and all Identity Manager providers are retrieved through ProviderAccessor.

Access to Admin Role Attributes

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

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

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

AdminRole	createAdminRole(java.lang.String name, java.lang.String description, boolean enabled, boolean assignable, boolean adminAssignable) Creates a configured admin role.
AdminRole	findAdminRole(java.lang.String friendlyName) Retrieves the specified admin role, using the role's friendly name.
AdminRole	getAdminRole(java.lang.String uniqueName) Retrieves the specified admin role, using the role's unique name.
java.util.Vector	getAdminRoles() Retrieves all the admin roles in the Identity Manager environment.
java.util.Vector	getAdminRolesAdminCanAssign(TSContext tsCtx) Retrieves the admin roles to which the subject of the task can be assigned by the current administrator.
java.util.Vector	getAdminRolesAdminCanGrantAdmin(TSContext tsCtx) Retrieves the admin roles for which the subject of the task can be assigned administrator rights by the current administrator.
java.util.Vector	getAdminRolesAdminCanGrantAdmin(TSContext tsCtx, java.util.Vector rolesToSearch) Returns roles from the given list that the admin can make users role admins.
java.util.Vector	getAdminRolesAdminCanManageAdmin(TSContext tsCtx) Retrieves the admin roles for which the current administrator can assign administrator rights.
java.util.Vector	getAdminRolesAdminCanManageMembers(TSContext tsCtx) Retrieves the admin roles for which the current administrator has administrator privileges.
java.util.Vector	getAdminRolesAdminCanManageMembers(TSContext tsCtx, java.util.Vector rolesToSearch) Returns roles from the given list that the admin can make users role members.
java.util.Vector	getAdminRolesAdminHasContainingTask(User admin, AdminTask task) Retrieves the admin roles that the specified administrator is assigned to and that contain the specified task.
java.util.Vector	getAdminRolesContainingTask(AdminTask task) Retrieves the admin roles that contain the specified admin task.
Role	getRole(java.lang.String uniqueName) Find any (admin/access/provisioning) role by unique name
java.util.Vector	searchAdminRoles(RoleObjectQuery query) Searches for a subset of the admin roles in the Identity Manager environment.

Method Detail

createAdminRole

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

Creates a configured admin role.

Parameters:

name - The friendly name for the role (must not be null).

description - The description of the role (can be null).

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 admin role.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminRole

AdminRole getAdminRole(java.lang.String uniqueName)
                       throws com.netegrity.sdk.apiutil.SmApiException,
                              NoSuchObjectException

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

Parameters:

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

Returns:

The specified admin role.

Throws:

NoSuchObjectException - if the object cannot be found.

com.netegrity.sdk.apiutil.SmApiException

findAdminRole

AdminRole findAdminRole(java.lang.String friendlyName)
                        throws SmApiException,
                               NoSuchObjectException

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

Parameters:

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

Returns:

The specified admin role.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

getAdminRoles

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

Retrieves all the admin roles in the Identity Manager environment.

Returns:

A Vector of the admin roles.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminRolesAdminCanGrantAdmin

java.util.Vector getAdminRolesAdminCanGrantAdmin(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 AdminRole objects obtained from the IM server.

Parameters:

tsCtx -

rolesToSearch - collection of AdminRoles to search for.

Returns:

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

Throws:

SmApiException

getAdminRolesAdminCanManageMembers

java.util.Vector getAdminRolesAdminCanManageMembers(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 AdminRole objects obtained from the IM server.

Parameters:

tsCtx -

rolesToSearch - collection of AdminRoles to search for.

Returns:

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

Throws:

SmApiException

searchAdminRoles

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

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

Parameters:

query - The search filter.

Returns:

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

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminRolesContainingTask

java.util.Vector getAdminRolesContainingTask(AdminTask task)
                                             throws com.netegrity.sdk.apiutil.SmApiException

Retrieves the admin roles that contain the specified admin task.

Parameters:

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

Returns:

The admin role objects that contain the specified admin task.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminRolesAdminHasContainingTask

java.util.Vector getAdminRolesAdminHasContainingTask(User admin,
                                                     AdminTask task)
                                                     throws com.netegrity.sdk.apiutil.SmApiException

Retrieves the admin roles that the specified administrator is assigned to and that contain the specified task.

This method disregards the subject of the current task.

Parameters:

admin - The administrator who is assigned to the roles to retrieve.

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

Returns:

The admin roles associated with the specified administrator and task.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminRolesAdminCanAssign

java.util.Vector getAdminRolesAdminCanAssign(TSContext tsCtx)
                                             throws com.netegrity.sdk.apiutil.SmApiException

Retrieves the admin 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 admin roles that the administrator can make the user a member of.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminRolesAdminCanManageMembers

java.util.Vector getAdminRolesAdminCanManageMembers(TSContext tsCtx)
                                                    throws com.netegrity.sdk.apiutil.SmApiException

Retrieves the admin roles for which the current administrator has administrator privileges.

Only admin roles that are member-assignable are returned.

Parameters:

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

Returns:

The admin roles that the current administrator can manage.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminRolesAdminCanGrantAdmin

java.util.Vector getAdminRolesAdminCanGrantAdmin(TSContext tsCtx)
                                                 throws com.netegrity.sdk.apiutil.SmApiException

Retrieves the admin 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 admin role objects.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminRolesAdminCanManageAdmin

java.util.Vector getAdminRolesAdminCanManageAdmin(TSContext tsCtx)
                                                  throws com.netegrity.sdk.apiutil.SmApiException

Retrieves the admin 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 admin roles for which the administrator can assign administrator rights.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getRole

Role getRole(java.lang.String uniqueName)
             throws com.netegrity.sdk.apiutil.SmApiException

Find any (admin/access/provisioning) role by unique name

Parameters:

uniqueName - unique name of the role to be retrieved

Returns:

an constructed AdminRole, AccessRole or ProvisioningRole appropriate to the supplied unique name

Throws:

SmApiException