com.netegrity.llsdk6.imsapi.abstractinterface
Interface Grantor

All Superinterfaces:

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

All Known Subinterfaces:

User

public interface Grantor
extends ManagedObject

Defines an object that can act as role manager for a specified role. A role administrator can manage role members and other administrators as configured in the role -- for example, a role administrator can assign other objects to the role.

Since:

IdentityMinder 6.0

Nested Class Summary

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

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

Method Summary

void	bindRoleGrantRights(Role role) Deprecated. Deprecated in IdentityMinder 6.0. Use makeRoleAdministrator().
boolean	hasRoleGrantRights(Role role) Deprecated. Deprecated in IdentityMinder 6.0. Use isRoleAdministrator().
boolean	isRoleAdministrator(Role role) Determines whether the current user is role administrator for the specified role.
void	makeRoleAdministrator(Role role) Allows the current user to act as role admnistrator for the specified role.
void	removeFromRoleAdministration(Role role) Removes the current user as role administrator for the specified role.
void	unbindRoleGrantRights(Role role) Deprecated. Deprecated in IdentityMinder 6.0. Use removeFromRoleAdministration().

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

Method Detail

bindRoleGrantRights

void bindRoleGrantRights(Role role)
                         throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use makeRoleAdministrator().

Bind rights to grant the specified role to this object

Parameters:

role - The role for which the current object will have grant rights.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Grantor has already been deleted

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Grantor is not connected to a session (i.e. isConnected() would return false).

SmApiException

makeRoleAdministrator

void makeRoleAdministrator(Role role)
                           throws SmApiException

Allows the current user to act as role admnistrator for the specified role.

A role administrator can manage role members and administrators as configured in the specified role.

Parameters:

role - The role for which the user is being designated as role administrator.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Grantor has already been deleted

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Grantor is not connected to a session (i.e. isConnected() would return false).

SmApiException

unbindRoleGrantRights

void unbindRoleGrantRights(Role role)
                           throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use removeFromRoleAdministration().

Unbind rights to grant this role from a given user.

Parameters:

role - The Role from which this object is to be removed as a grantor.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Grantor has already been deleted

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Grantor is not connected to a session (i.e. isConnected() would return false).

SmApiException

removeFromRoleAdministration

void removeFromRoleAdministration(Role role)
                                  throws SmApiException

Removes the current user as role administrator for the specified role.

Parameters:

role - The role from which the current user is being removed as role administrator.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Grantor has already been deleted

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Grantor is not connected to a session (i.e. isConnected() would return false).

SmApiException

hasRoleGrantRights

boolean hasRoleGrantRights(Role role)
                           throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use isRoleAdministrator().

Find out if this occupant has grant rights to a specific role

Parameters:

role - The Role to check grantor status on

Returns:

A boolean representing the occupancy of this Role

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Grantor has already been deleted

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Grantor is not connected to a session (i.e. isConnected() would return false).

SmApiException

isRoleAdministrator

boolean isRoleAdministrator(Role role)
                            throws SmApiException

Determines whether the current user is role administrator for the specified role.

Parameters:

role - The role in question.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this Grantor has already been deleted

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this Grantor is not connected to a session (i.e. isConnected() would return false).

SmApiException