com.ibm.itim.dataservices.model.system
Class SystemRole

java.lang.Object
  extended by com.ibm.itim.dataservices.model.DirectoryEntry
      extended by com.ibm.itim.dataservices.model.DirectoryObject
          extended by com.ibm.itim.dataservices.model.system.SystemRole
All Implemented Interfaces:
ProtectedObject, com.ibm.itim.util.Sortable, com.ibm.itim.util.xml.objectstream.Importable, java.io.Serializable

public class SystemRole
extends DirectoryObject

Value Object class that holds the attribute information of a system role (group) in the data model.

See Also:
SystemRoleEntity, Serialized Form

Field Summary
static int AUDITOR_CATEGORY
          Constant for the auditor category.
static java.lang.String AUDITOR_GROUP
           
static int ENDUSER_CATEGORY
          Constant for the end user category.
static int HELPDESK_CATEGORY
          Constant for the help desk category.
static java.lang.String HELPDESK_GROUP
           
static int SERVICEOWNER_CATEGORY
          Constant for the service owner category.
static java.lang.String SERVICEOWNER_GROUP
           
static int SUPERVISOR_CATEGORY
          Constant for the supervisor category.
static java.lang.String SUPERVISOR_GROUP
           
static java.lang.String SYSTEM_ROLE_ATTR_CAT
          String constant for the category attribute name.
static java.lang.String SYSTEM_ROLE_ATTR_DESCRIPTION
          String constant for the description attribute name.
static java.lang.String SYSTEM_ROLE_ATTR_NAME
          String constant for the naming attribute name.
static int SYSTEMADMIN_CATEGORY
          Constant for the system administrator category.
static java.lang.String SYSTEMADMIN_GROUP
          Constants for the system role DNs defined in tenant.tmpl file
 
Fields inherited from class com.ibm.itim.dataservices.model.DirectoryObject
ATTR_ACCESS_RIGHT, ATTR_LIFECYCLE_ENABLE, ATTR_URI, DESCRIPTION, NAME
 
Fields inherited from interface com.ibm.itim.util.Sortable
ATTR_NAME
 
Constructor Summary
SystemRole()
          Default empty constructor
SystemRole(AttributeValues attributes)
          Constructs object with attribute information.
 
Method Summary
 int getCategory()
          Returns the system role category.
 java.lang.String getDescription()
          Returns the description of the system role.
 java.lang.String getName()
          Returns the name of the system role.
 void setCategory(int category)
          Changes the system role category.
 void setDescription(java.lang.String description)
          Changes the description of the system role.
 void setName(java.lang.String name)
          Changes the name of the system role.
 
Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObject
addAttribute, addAttributeValues, getAccessRights, getAttribute, getAttributes, getAuthorizationOwners, getMapAttributeNames, getMappedAttributes, 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

SYSTEM_ROLE_ATTR_NAME

public static final java.lang.String SYSTEM_ROLE_ATTR_NAME
String constant for the naming attribute name.

See Also:
Constant Field Values

SYSTEM_ROLE_ATTR_DESCRIPTION

public static final java.lang.String SYSTEM_ROLE_ATTR_DESCRIPTION
String constant for the description attribute name.

See Also:
Constant Field Values

SYSTEM_ROLE_ATTR_CAT

public static final java.lang.String SYSTEM_ROLE_ATTR_CAT
String constant for the category attribute name.

See Also:
Constant Field Values

ENDUSER_CATEGORY

public static final int ENDUSER_CATEGORY
Constant for the end user category.

See Also:
Constant Field Values

SUPERVISOR_CATEGORY

public static final int SUPERVISOR_CATEGORY
Constant for the supervisor category.

See Also:
Constant Field Values

SYSTEMADMIN_CATEGORY

public static final int SYSTEMADMIN_CATEGORY
Constant for the system administrator category.

See Also:
Constant Field Values

HELPDESK_CATEGORY

public static final int HELPDESK_CATEGORY
Constant for the help desk category.

See Also:
Constant Field Values

SERVICEOWNER_CATEGORY

public static final int SERVICEOWNER_CATEGORY
Constant for the service owner category.

See Also:
Constant Field Values

AUDITOR_CATEGORY

public static final int AUDITOR_CATEGORY
Constant for the auditor category.

See Also:
Constant Field Values

SYSTEMADMIN_GROUP

public static final java.lang.String SYSTEMADMIN_GROUP
Constants for the system role DNs defined in tenant.tmpl file

See Also:
Constant Field Values

SUPERVISOR_GROUP

public static final java.lang.String SUPERVISOR_GROUP
See Also:
Constant Field Values

HELPDESK_GROUP

public static final java.lang.String HELPDESK_GROUP
See Also:
Constant Field Values

SERVICEOWNER_GROUP

public static final java.lang.String SERVICEOWNER_GROUP
See Also:
Constant Field Values

AUDITOR_GROUP

public static final java.lang.String AUDITOR_GROUP
See Also:
Constant Field Values
Constructor Detail

SystemRole

public SystemRole()
Default empty constructor


SystemRole

public SystemRole(AttributeValues attributes)
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 SystemRoleSearch object for achieving that.

Parameters:
attributes - AttributeValues holding the attributes of the system role.
Method Detail

getName

public java.lang.String getName()
Returns the name of the system role.

Overrides:
getName in class DirectoryObject
Returns:
Name of the system role (String).

setName

public void setName(java.lang.String name)
Changes the name of the system role.

Parameters:
name - New name of the system role.

getDescription

public java.lang.String getDescription()
Returns the description of the system role.

Returns:
Description of the system role (String).

setDescription

public void setDescription(java.lang.String description)
Changes the description of the system role.

Parameters:
description - New String description of the system role.

getCategory

public int getCategory()
Returns the system role category.

Returns:
Enumeration of the category, ENDUSER_CATEGORY, SUPERVISOR_CATEGORY, SYSTEMADMIN_CATEGORY, HELPDESK_CATEGORY, SERVICEOWNER_CATEGORY, AUDITOR_CATEGORY etc. or an integer value representing a custom-defined View in ITIM 5.0.

setCategory

public void setCategory(int category)
Changes the system role category.

Parameters:
category - Enumeration of the category, ENDUSER_CATEGORY, SUPERVISOR_CATEGORY, SYSTEMADMIN_CATEGORY, HELPDESK_CATEGORY, SERVICEOWNER_CATEGORY, AUDITOR_CATEGORY etc. or an integer value representing a custom-defined View in ITIM 5.0.

One way to find valid values for category is demonstrated in the code below.

This code is used as one of the public APIs. See the examples in ITIM_HOME/extensions/examples for more details on how to obtain the platform and subject variables used below.
 
 SystemRoleManager manager = new SystemRoleManager(platform, subject);
 Collection<SystemRoleManager.ViewCategory> categories = manager
                .getSystemRoleCategories();
 // Will print out a lines that looks like:
 // 1:End User View:Default view for users needing self-care capabilities
 for (ViewCategory cat : categories) {
        System.out.println(cat.getCategory() + ":" + cat.getName() + ":"
                        + cat.getDescription());
 }
 
 


IBM Security Identity Manager 6.0.0
© Copyright International Business Machines Corporation 2007, 2012. All rights reserved. US Government Users Restricited Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.