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

java.lang.Object
  |
  +--com.ibm.itim.dataservices.model.DirectoryEntry
        |
        +--com.ibm.itim.dataservices.model.DirectoryObject
              |
              +--com.ibm.itim.dataservices.model.domain.Service
All Implemented Interfaces:
com.ibm.itim.util.xml.objectstream.Importable, ProtectedObject, java.io.Serializable
Direct Known Subclasses:
HostedService

public class Service
extends DirectoryObject
implements com.ibm.itim.util.xml.objectstream.Importable

Value Object class that holds the attribute information of a service in the data model.

See Also:
ServiceEntity, Serialized Form

Field Summary
static int COMPLIANCE_ALERT_ACCOUNT_CHANGE
          Constant identifying trigger compliance alert when account is modified.
static int COMPLIANCE_ALERT_IDENTITY_CHANGE
          Constant identifying trigger compliance alert when a person is modified.
static int COMPLIANCE_ALERT_POLICY_CHANGE
          Constant identifying trigger compliance alert when policy is modified.
static int COMPLIANCE_ALERT_RECONCILIATION
          Constant identifying trigger compliance alert when reconciliation is run.
static int CORRECT_NONCOMPLIANT
          Constant identifying the action for correcting a non compliant account.
static int MARK_NONCOMPLIANT
          Constant identifying the action for marking a non compliant account.
static int ON_ADD
          Constant identifying when a new account is detected.
static int ON_CHANGE
          Constant identifying when a changed account is detected.
static int ON_DELETE
          Constant identifying when a deleted account is detected.
static java.lang.String SERVICE_ATTR_ALERT_OPTION
          String constant for the password attribute name.
static java.lang.String SERVICE_ATTR_CHECK_POLICY
          Constant for the policy checking attribute name.
static java.lang.String SERVICE_ATTR_CONSTRAINT_VIOLATION_ACTION
          Deprecated.  
static java.lang.String SERVICE_ATTR_DESCRIPTION
          String constant that represents the LDAP attribute for storing service's description.
static java.lang.String SERVICE_ATTR_DISALLOWED_ACTION
          Deprecated.  
static java.lang.String SERVICE_ATTR_NAME
          Constant for the naming attribute name.
static java.lang.String SERVICE_ATTR_NONCOMPLIANCE_ACTION
          Constant for the noncompliance action attribute name.
static java.lang.String SERVICE_ATTR_PASSWORD
          String constant for the password attribute name.
static java.lang.String SERVICE_DSML_PROFILE_NAME
          String constant for DSMLInfor service's profile attribute name.
static java.lang.String SERVICE_DSML2_PROFILE_NAME
          String constant for DSML2 service's profile attribute name.
static java.lang.String SERVICE_ENROLE_PROFILE_NAME
          String constant for Enrole service's profile attribute name.
static int SUSPEND_NONCOMPLIANT
          Constant identifying the action for suspending a non compliant account.
static int USE_GLOBAL_SETTING
          Constant to specify that the global settings are to be applied.
static int USE_WORKFLOW_FOR_NONCOMPLIANT
          Constant identifying the action for using workflow to resove a non compliant account.
 
Fields inherited from class com.ibm.itim.dataservices.model.DirectoryObject
ATTR_ACCESS_RIGHT, ATTR_LIFECYCLE_ENABLE
 
Constructor Summary
Service()
          Default empty constructor
Service(java.lang.String profileName, AttributeValues attributes)
          Constructs object with profile and attribute information.
 
Method Summary
 java.util.Collection getAlertOptions()
          This method returns a collection containing the alert options.
 java.lang.String getConstraintViolationAction()
          Deprecated. Use getNonComplianceAction().
 java.lang.String getDescription()
          Returns the description of the service.
 java.lang.String getDisallowedAction()
          Deprecated. Use getNonComplianceAction().
 int getNonComplianceAction()
          Returns the non-compliance action of the service.
 DistinguishedName getOwnerDN()
          Returns the Distinguished name of service's owner.
 java.util.Collection getPrerequisiteDNs()
          Returns the list prerequisite services for this service (if any).
 java.lang.String getServiceProfileName()
          Returns the profile name identifying the type of the service, NT, Exchange, etc.
 boolean isCheckingPolicy()
          Determines whether to check policies when synchronizing accounts for a service.
 boolean isEnrole()
          Returns whether this service is enRole.
 void setAlertOptions(java.util.Collection alertOptions)
          This method sets the alert options given a collection of the same.
 void setCheckingPolicy(boolean checkPolicy)
          Changes the policy checking flag.
 void setConstraintViolationAction(java.lang.String constraintViolationAction)
          Deprecated. Use setNonComplianceAction().
 void setDescription(java.lang.String description)
          Sets the description field of the service.
 void setDisallowedAction(java.lang.String disallowedAction)
          Deprecated. Use setNonComplianceAction().
 void setNonComplianceAction(int action)
          Changes the non-compliance action for the service.
 void setOwnerDN(DistinguishedName owner)
          Sets the owner of the service.
 
Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObject
addAttribute, getAccessRights, getAttribute, getAttributes, getAuthorizationOwners, getMapAttributeNames, getMappedAttributes, getName, getNameAttribute, getOldMappedAttributes, getProfileName, getRawAttributes, getTenantDN, isLifecycleDefined, removeAttribute, 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

SERVICE_ATTR_NAME

public static final java.lang.String SERVICE_ATTR_NAME
Constant for the naming attribute name.

See Also:
Constant Field Values

SERVICE_ATTR_CHECK_POLICY

public static final java.lang.String SERVICE_ATTR_CHECK_POLICY
Constant for the policy checking attribute name.

See Also:
Constant Field Values

SERVICE_ATTR_CONSTRAINT_VIOLATION_ACTION

public static final java.lang.String SERVICE_ATTR_CONSTRAINT_VIOLATION_ACTION
Deprecated.  

Constant for the constraint violation action attribute name.

See Also:
Constant Field Values

SERVICE_ATTR_DISALLOWED_ACTION

public static java.lang.String SERVICE_ATTR_DISALLOWED_ACTION
Deprecated.  

Constant for the disallowed action attribute name.


SERVICE_ATTR_NONCOMPLIANCE_ACTION

public static java.lang.String SERVICE_ATTR_NONCOMPLIANCE_ACTION
Constant for the noncompliance action attribute name.


MARK_NONCOMPLIANT

public static final int MARK_NONCOMPLIANT
Constant identifying the action for marking a non compliant account.

See Also:
Constant Field Values

SUSPEND_NONCOMPLIANT

public static final int SUSPEND_NONCOMPLIANT
Constant identifying the action for suspending a non compliant account.

See Also:
Constant Field Values

CORRECT_NONCOMPLIANT

public static final int CORRECT_NONCOMPLIANT
Constant identifying the action for correcting a non compliant account.

See Also:
Constant Field Values

USE_WORKFLOW_FOR_NONCOMPLIANT

public static final int USE_WORKFLOW_FOR_NONCOMPLIANT
Constant identifying the action for using workflow to resove a non compliant account.

See Also:
Constant Field Values

USE_GLOBAL_SETTING

public static final int USE_GLOBAL_SETTING
Constant to specify that the global settings are to be applied.

See Also:
Constant Field Values

ON_ADD

public static final int ON_ADD
Constant identifying when a new account is detected.

See Also:
Constant Field Values

ON_CHANGE

public static final int ON_CHANGE
Constant identifying when a changed account is detected.

See Also:
Constant Field Values

ON_DELETE

public static final int ON_DELETE
Constant identifying when a deleted account is detected.

See Also:
Constant Field Values

SERVICE_DSML_PROFILE_NAME

public static java.lang.String SERVICE_DSML_PROFILE_NAME
String constant for DSMLInfor service's profile attribute name.


SERVICE_DSML2_PROFILE_NAME

public static final java.lang.String SERVICE_DSML2_PROFILE_NAME
String constant for DSML2 service's profile attribute name.

See Also:
Constant Field Values

SERVICE_ENROLE_PROFILE_NAME

public static java.lang.String SERVICE_ENROLE_PROFILE_NAME
String constant for Enrole service's profile attribute name.


SERVICE_ATTR_PASSWORD

public static final java.lang.String SERVICE_ATTR_PASSWORD
String constant for the password attribute name.

See Also:
Constant Field Values

SERVICE_ATTR_ALERT_OPTION

public static final java.lang.String SERVICE_ATTR_ALERT_OPTION
String constant for the password attribute name.

See Also:
Constant Field Values

COMPLIANCE_ALERT_RECONCILIATION

public static final int COMPLIANCE_ALERT_RECONCILIATION
Constant identifying trigger compliance alert when reconciliation is run.

See Also:
Constant Field Values

COMPLIANCE_ALERT_POLICY_CHANGE

public static final int COMPLIANCE_ALERT_POLICY_CHANGE
Constant identifying trigger compliance alert when policy is modified.

See Also:
Constant Field Values

COMPLIANCE_ALERT_IDENTITY_CHANGE

public static final int COMPLIANCE_ALERT_IDENTITY_CHANGE
Constant identifying trigger compliance alert when a person is modified.

See Also:
Constant Field Values

COMPLIANCE_ALERT_ACCOUNT_CHANGE

public static final int COMPLIANCE_ALERT_ACCOUNT_CHANGE
Constant identifying trigger compliance alert when account is modified.

See Also:
Constant Field Values

SERVICE_ATTR_DESCRIPTION

public static final java.lang.String SERVICE_ATTR_DESCRIPTION
String constant that represents the LDAP attribute for storing service's description.

See Also:
Constant Field Values
Constructor Detail

Service

public Service()
Default empty constructor


Service

public Service(java.lang.String profileName,
               AttributeValues attributes)
Constructs object with profile and 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 ServiceSearch object for achieving that.

Parameters:
profileName - Non-null name of the profile (NT, Exchange, etc.) identifying the type of this service as listed in Configuration > Service Types in IBM Tivoli Identity Manager UI.
attributes - AttributeValues holding the attributes of the service which are not null or empty.
Method Detail

isCheckingPolicy

public boolean isCheckingPolicy()
Determines whether to check policies when synchronizing accounts for a service.

Returns:
True if policy checking is required; else false. The default is true.

setCheckingPolicy

public void setCheckingPolicy(boolean checkPolicy)
Changes the policy checking flag. This flag determines whether to check policies during account synchronization.

Parameters:
checkPolicy - True to check policies, false to not.

getNonComplianceAction

public int getNonComplianceAction()
Returns the non-compliance action of the service. This is the action the platform will perform if an account is found to be non-compliant with policies in the system.

Returns:
Enumerated int of the action, MARK_NONCOMPLIANT, SUSPEND_NONCOMPLIANT, CORRECT_NONCOMPLIANT, USE_WORKFLOW_FOR_NONCOMPLIANT.

setNonComplianceAction

public void setNonComplianceAction(int action)
Changes the non-compliance action for the service. This is the action the platform will perform if an account is found to be non-compliant with policies within the system.

Parameters:
action - Enumerated int of the action, MARK_NONCOMPLIANT, SUSPEND_NONCOMPLIANT, CORRECT_NONCOMPLIANT, USE_WORKFLOW_FOR_NONCOMPLIANT.

getConstraintViolationAction

public java.lang.String getConstraintViolationAction()
Deprecated. Use getNonComplianceAction().

Returns the constraint violation action of the service. This is the action the platform will perform if an account is found to be non-compliant with policies when peforming an account synchronization.

Returns:
Enumerated String of the action.

setConstraintViolationAction

public void setConstraintViolationAction(java.lang.String constraintViolationAction)
Deprecated. Use setNonComplianceAction().

Changes the constraint violation actions for the service. This is the action the platform will perform if an account is found to be non-compliant with policies when peforming an account synchronization.

Parameters:
constraintViolationAction - Enumerated String of the action.

getDisallowedAction

public java.lang.String getDisallowedAction()
Deprecated. Use getNonComplianceAction().

Returns the disallowed action for the service. This is the action the platform will perform when an account is identified for a person who is not allowed an account for this service during account. synchronization.

Returns:
Enumerated String of the action.

setDisallowedAction

public void setDisallowedAction(java.lang.String disallowedAction)
Deprecated. Use setNonComplianceAction().

Changes the disallowed action for the service. This is the action the platform will perform when an account is identified for a person who is not allowed an account for this service during account.

Parameters:
disallowedAction - Enumerated String of the action.

getPrerequisiteDNs

public java.util.Collection getPrerequisiteDNs()
Returns the list prerequisite services for this service (if any).

Returns:
Collection of DistinguishedNames representing services that are prerequisites to this service.

getServiceProfileName

public java.lang.String getServiceProfileName()
Returns the profile name identifying the type of the service, NT, Exchange, etc.

Returns:
Profile name identifying the type of service.

isEnrole

public boolean isEnrole()
Returns whether this service is enRole.

Returns:
True if service is enRole; else false.

getAlertOptions

public java.util.Collection getAlertOptions()
This method returns a collection containing the alert options. COMPLIANCE_ALERT_RECONCILIATION = 0 COMPLIANCE_ALERT_POLICY_CHANGE = 1 COMPLIANCE_ALERT_IDENTITY_CHANGE = 2 COMPLIANCE_ALERT_ACCOUNT_CHANGE = 3 Only those alert options that have been enabled for the Service would be contained in the collection.

Returns:
Collection of alert options (String)

setAlertOptions

public void setAlertOptions(java.util.Collection alertOptions)
This method sets the alert options given a collection of the same. Accepted values: Service.COMPLIANCE_ALERT_RECONCILIATION, Service.COMPLIANCE_ALERT_POLICY_CHANGE, Service.COMPLIANCE_ALERT_IDENTITY_CHANGE, Service.COMPLIANCE_ALERT_ACCOUNT_CHANGE.

Parameters:
alertOptions - new compliance alert options for the service.

getDescription

public java.lang.String getDescription()
Returns the description of the service. Returns an empty string is there is no description for the service

Returns:
description of the service.
Since:
4.6

setDescription

public void setDescription(java.lang.String description)
Sets the description field of the service.

Parameters:
description - of the service.
Since:
4.6

getOwnerDN

public DistinguishedName getOwnerDN()
Returns the Distinguished name of service's owner. Returns NULL is there is no owner for the service.

Returns:
Distinguished name of service's owner.
Since:
4.6

setOwnerDN

public void setOwnerDN(DistinguishedName owner)
Sets the owner of the service.

Parameters:
owner - Distinguished name of the service's owner.
Since:
4.6


IBM Tivoli Identity Manager 4.6
© Copyright International Business Machines Corporation 2005. All rights reserved. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.