com.ibm.itim.dataservices.model.domain
Class Role

java.lang.Object
  com.ibm.itim.dataservices.model.DirectoryEntry
      com.ibm.itim.dataservices.model.DirectoryObject
          com.ibm.itim.dataservices.model.domain.Role

All Implemented Interfaces:

ProtectedObject, com.ibm.itim.util.Sortable, com.ibm.itim.util.xml.objectstream.Importable, java.io.Serializable

Direct Known Subclasses:

DynamicRole

public class Role
extends DirectoryObject

Value Object class that holds the attribute information of a role in the data model. This class describes the attributes and behaviors associated with any role (static or dynamic). A static role is sufficiently represented by this class. A dynamic role is represented by the sub-class DynamicRole.

See Also:

RoleEntity, DynamicRole, Serialized Form

Field Summary

static java.lang.String	HELPDESK_ROLE
static java.lang.String	OWNER The attribute for storing the owners of the role
static java.lang.String	PROFILE_NAME The profile name for Role
static java.lang.String	ROLE_ATTR_CLASSIFICATION The name of the attribute for storing the role classification
static java.lang.String	ROLE_ATTR_DESCRIPTION String constant for the description attribute name.
static java.lang.String	ROLE_ATTR_NAME String constant for the naming attribute name.
static java.lang.String	ROLE_ATTR_POLICY_TARGET String constant for the policy target attribute (Separation of Duty policies which reference this role)
static java.lang.String	ROLE_ATTR_SUBROLES String constant for the member role attribute.
static java.lang.String	ROLE_CLASSIFICATION_NONE A no-value options of the attribute for role classification
static java.lang.String	SERVICEOWNER_ROLE
static java.lang.String	SUPERVISOR_ROLE
static java.lang.String	SYSTEMADMIN_ROLE

Fields inherited from class com.ibm.itim.dataservices.model.DirectoryObject

ATTR_ACCESS_RIGHT, ATTR_LIFECYCLE_ENABLE, DESCRIPTION, NAME

Fields inherited from interface com.ibm.itim.util.Sortable

ATTR_NAME

Constructor Summary

Role()
Default empty constructor

Role(AttributeValues attrs)
Constructs object with attribute information.

Role(DirectoryObject dirObj)
Copy constructor for directory object

Method Summary

java.lang.String	getClassification() Returns the role classification or an empty string if it is null.
java.lang.String	getDescription() Returns the description of the role.
java.util.Collection<DistinguishedName>	getOwnerDNs() Returns the collection of DistinguishedName that are defined as the owner(s) for this role
java.util.Collection<java.lang.String>	getPolicyTarget() Returns the collection of DNs(String) of policies (SoD) which reference this role.
void	removeOwnerDNs() Removes the owner(s) of the role.
void	setClassification(java.lang.String classification) Sets the role classification.
void	setDescription(java.lang.String description) Changes the description of the role.
void	setOwnerDNs(java.util.Collection<DistinguishedName> owners) Sets the value of the owner attribute.
void	setPolicyTarget(java.util.Collection<java.lang.String> targets) Sets the collection of DNs(String) of policies (SoD) which reference this role.

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObject

addAttribute, getAccessRights, getAttribute, getAttributes, getAuthorizationOwners, getMapAttributeNames, getMappedAttributes, getName, getNameAttribute, getOldMappedAttributes, getProfileName, getRawAttributes, getSortValue, getTenantDN, isLifecycleDefined, removeAttribute, removeAttribute, setAccessRights, setAttribute, setAttributes, setAuthorizationOwners, setProfileName, setTenantDN, toString

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryEntry

clearChange, clearChanges, getChanges, getDistinguishedName, getLastModified, getObjectClasses, getOldAttributes, setDistinguishedName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ROLE_ATTR_NAME

public static java.lang.String ROLE_ATTR_NAME

String constant for the naming attribute name.

ROLE_ATTR_DESCRIPTION

public static java.lang.String ROLE_ATTR_DESCRIPTION

String constant for the description attribute name.

ROLE_ATTR_SUBROLES

public static java.lang.String ROLE_ATTR_SUBROLES

String constant for the member role attribute.

ROLE_ATTR_POLICY_TARGET

public static java.lang.String ROLE_ATTR_POLICY_TARGET

String constant for the policy target attribute (Separation of Duty policies which reference this role)

OWNER

public static final java.lang.String OWNER

The attribute for storing the owners of the role

See Also:

Constant Field Values

ROLE_ATTR_CLASSIFICATION

public static final java.lang.String ROLE_ATTR_CLASSIFICATION

The name of the attribute for storing the role classification

See Also:

Constant Field Values

ROLE_CLASSIFICATION_NONE

public static final java.lang.String ROLE_CLASSIFICATION_NONE

A no-value options of the attribute for role classification

See Also:

Constant Field Values

SYSTEMADMIN_ROLE

public static final java.lang.String SYSTEMADMIN_ROLE

See Also:

Constant Field Values

SUPERVISOR_ROLE

public static final java.lang.String SUPERVISOR_ROLE

See Also:

Constant Field Values

HELPDESK_ROLE

public static final java.lang.String HELPDESK_ROLE

See Also:

Constant Field Values

SERVICEOWNER_ROLE

public static final java.lang.String SERVICEOWNER_ROLE

See Also:

Constant Field Values

PROFILE_NAME

public static java.lang.String PROFILE_NAME

The profile name for Role

Constructor Detail

Role

public Role()

Default empty constructor

Role

public Role(AttributeValues attrs)

Constructs object with attribute information. Warning: the purpose of this constructor is to provide clients with the ability to create value objects for creation in the data store. Do not use this constructor to create value objects that represent existing entities. See the RoleSearch object for achieving that.

Parameters:

attrs - AttributeValues holding the attributes of the role.

Role

public Role(DirectoryObject dirObj)

Copy constructor for directory object

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description of the role.

Returns:

Description of the role (String).

getOwnerDNs

public java.util.Collection<DistinguishedName> getOwnerDNs()

Returns the collection of DistinguishedName that are defined as the owner(s) for this role

Returns:

Collection of DistinguishedName that contains the owners that are defined for this role. This collection contains a collection of role DNs and / or a collection of person DNs. There is no referential integrity checking for the DNs returned by this call.

setOwnerDNs

public void setOwnerDNs(java.util.Collection<DistinguishedName> owners)

Sets the value of the owner attribute. Only collections of Org Role DNs and/or collections of Person DNs should be used (can be a mix)

Parameters:

rules - The collection of DistinguishedNames to set as the owners for this role.

removeOwnerDNs

public void removeOwnerDNs()

Removes the owner(s) of the role.

setDescription

public void setDescription(java.lang.String description)

Changes the description of the role.

Parameters:

description - New String description of the role.

getPolicyTarget

public java.util.Collection<java.lang.String> getPolicyTarget()

Returns the collection of DNs(String) of policies (SoD) which reference this role.

Returns:

DNs of polices which reference this role Collection.

setPolicyTarget

public void setPolicyTarget(java.util.Collection<java.lang.String> targets)

Sets the collection of DNs(String) of policies (SoD) which reference this role.

Parameters:

targets - Collection of DNs (String) of polices which reference this role.

getClassification

public java.lang.String getClassification()

Returns the role classification or an empty string if it is null.

Returns:

A string value

setClassification

public void setClassification(java.lang.String classification)

Sets the role classification.

Parameters:

roleClassification - the role classification