|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.itim.dataservices.model.DirectoryEntry
com.ibm.itim.dataservices.model.DirectoryObject
com.ibm.itim.dataservices.model.policy.DirectoryPolicy
com.ibm.itim.dataservices.model.policy.ScopedPolicy
com.ibm.itim.dataservices.model.policy.ServicePolicy
com.ibm.itim.dataservices.model.policy.recert.RecertificationPolicy
public class RecertificationPolicy
This class provides a base implementation for the recertification policy value objects that support the scoping capabilities. If the policy is defined with the advanced workflow, then invoking the �get� methods related to the workflow specific attribute can return �null� or will not return a correct value, and the �set� method related to the workflow specific attribute cannot be used to modify the recertification policy. The recertification policy cannot be searched using the SearchMO object.
DirectoryPolicy
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ACCESS_TYPE
This constant specifies the valid value for the target type when the target type is Access. |
static java.lang.String |
ACCOUNT_TYPE
This constant specifies the valid value for the target type when the target type is Account. |
static java.lang.String |
ALL_USER_CLASS
This constant is used to specify the user type when the user type is ALL. |
static java.lang.String |
APPROVE_TIMEOUT_ACTION
Constant to specify an approval action when the recertification times out. |
static java.lang.String |
BPPERSON_USER_CLASS
This constant is used to specify the user type when the user type is BPPERSON. |
static java.lang.String |
CALENDAR_SCHEDULING_MODE
This constant specifies the valid value for the scheduling mode attribute when the scheduling mode of the policy is Calendar. |
static int |
DEFAULT_PARTICIPANT_RESPONSE_TIMEOUT
Default value for the participant response timeout in days. |
static java.lang.String |
DELETE_REJECT_ACTION
Constant to specify a delete action when the recertification is rejected. |
static java.lang.String |
DESCRIPTION_ATTRIBUTE_NAME
Constant that specifies the description attribute of the recertification policy. |
static java.lang.String |
ENABLED_ATTRIBUTE_NAME
Constant that specifies the enabled attribute of the recertification policy. |
static java.lang.String |
IDENTITY_TYPE
This constant specifies the valid value for the target type when the target type is User. |
static java.lang.String |
MARK_REJECT_ACTION
Constant to specify a mark action when the recertification is rejected. |
static java.lang.String |
NO_TIMEOUT_ACTION
Constant to specify a no action when the recertification times out. |
static java.lang.String |
PERSON_USER_CLASS
This constant is used to specify the user type when the user type is PERSON. |
static java.lang.String |
POLICY_ITEM_NAME_ATTRIBUTE_NAME
Constant that specifies the name attribute of the recertification policy. |
static java.lang.String |
POLICY_TARGET_ATTRIBUTE_NAME
Constant that specifies the target attribute of the recertification policy. |
static java.lang.String |
RECERTIFIER_ATTRIBUTE_NAME
Constant that specifies the recertifier attribute of the recertification policy. |
static java.lang.String |
REJECT_ACTION_ATTRIBUTE_NAME
String constant for the reject action attribute name. |
static java.lang.String |
REJECT_NOTIFTY_ATTRIBUTE_NAME
String constant for the reject notification attribute name. |
static java.lang.String |
REJECT_TIMEOUT_ACTION
Constant to specify a reject action when the recertification times out. |
static java.lang.String |
ROLLING_INTERVAL_ATTRIBUTE_NAME
String constant for the rolling interval attribute name. |
static java.lang.String |
ROLLING_SCHEDULE_MODE
This constant specifies the valid value for the scheduling mode attribute when the scheduling mode of the policy is rolling. |
static java.lang.String |
SCHEDULE_ATTRIBUTE_NAME
String constant for the schedule attribute name. |
static java.lang.String |
SCHEDULING_MODE_ATTRIBUTE_NAME
String constant for the scheduling mode attribute name. |
static java.lang.String |
SUSPEND_REJECT_ACTION
Constant to specify a suspend action when the recertification is rejected. |
static java.lang.String |
TIMEOUT_ACTION_ATTRIBUTE_NAME
String constant for the timeout action attribute name. |
static java.lang.String |
TIMEOUT_PERIOD_ATTRIBUTE_NAME
String constant for the timeout period attribute name. |
static java.lang.String |
USER_CLASS_ATTRIBUTE_NAME
String constant for the user class attribute name. |
Fields inherited from class com.ibm.itim.dataservices.model.policy.ServicePolicy |
---|
POLICY_ATTR_OBJECT_PROFILE_NAME, POLICY_ATTR_POLICY_TARGET, POLICY_ATTR_REQ_POLICY_TARGET |
Fields inherited from class com.ibm.itim.dataservices.model.policy.ScopedPolicy |
---|
ONELEVEL_SCOPE, POLICY_ATTR_SCOPE, SUBTREE_SCOPE |
Fields inherited from class com.ibm.itim.dataservices.model.policy.DirectoryPolicy |
---|
POLICY_ATTR_CAPTION, POLICY_ATTR_DESCRIPTION, POLICY_ATTR_ENABLED, POLICY_ATTR_ISDRAFT, POLICY_ATTR_KEY_WORDS, POLICY_ATTR_NAME, POLICY_ATTR_PRIORITY |
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 | |
---|---|
RecertificationPolicy(java.lang.String policyName,
int scope,
boolean enable,
java.lang.String policyType,
java.util.Collection<IPolicyTarget> policyTargets,
RecurringTimeSchedule schedule,
RecertificationParticipant recertifier,
java.lang.String userType,
int timeOutPeriod,
java.lang.String rejectAction,
java.lang.String timeoutAction)
The recertification policy value object constructor. |
|
RecertificationPolicy(java.lang.String policyName,
java.lang.String policyType,
java.util.Collection<IPolicyTarget> policyTargets,
RecertificationParticipant recertifier,
java.lang.String rejectAction)
The recertification policy value object constructor. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object policy)
Compares the given object with this RecertificationPolicy object for equality. |
RecertificationParticipant |
getRecertificationParticipant()
Returns the recertification participants of the policy. |
java.lang.String |
getRejectAction()
Returns action when the recertification is rejected. |
RecertificationParticipant |
getRejectionNotificationParticipant()
Returns the recertification rejection e-mail participants of the policy. |
int |
getRollingInterval()
Returns a rolling interval of the recertification policy in days. |
RecurringTimeSchedule |
getSchedule()
Returns schedule of the recertification policy. |
java.lang.String |
getScheduleMode()
Returns the scheduling mode of the recertification policy. |
java.util.Collection<IPolicyTarget> |
getTargets()
Returns the value of the Targets attribute. |
java.lang.String |
getTimeoutAction()
Returns an action when the recertification is timeout. |
int |
getTimeoutPeriod()
Returns the timeout period of the recertification in days. |
java.lang.String |
getType()
Returns the target type of the recertification policy. |
java.lang.String |
getUserClass()
Returns the target users of the recertification policy. |
boolean |
isCustomWorkflow()
Returns a value for the erIsCustom attribute. |
void |
setAccessRights(java.util.Collection rights)
A recertificationPolicy object does not support the access rights from the ManagableProfile interface. |
void |
setAuthorizationOwners(java.util.Collection owners)
A recertificationPolicy object does not support the authorization owners from the ManagableProfile interface. |
void |
setRecertificationParticipant(RecertificationParticipant recertifier)
Sets or changes the recertification policy participants. Type RecertificationParticipant.TYPE_SERVICE_OWNER is valid for the
account and access type recertification policy only. |
void |
setRejectAction(java.lang.String rejectAction)
Sets or changes the action on the target entities when the recertification is rejected. |
void |
setRejectionNotificationParticipant(RecertificationParticipant participant)
Sets or changes the recertification rejection e-mail participants. |
void |
setRollingInterval(int interval)
Sets or changes the rolling interval of the recertification policy in days. |
void |
setSchedule(RecurringTimeSchedule schedule)
Sets or changes the schedule of the recertification policy. |
void |
setScheduleMode(java.lang.String scheduleMode)
Sets or changes the schedule mode of the recertification policy. |
void |
setTargets(java.util.Collection<IPolicyTarget> newTargets)
Sets the value of the Targets attribute. |
void |
setTimeoutAction(java.lang.String timeoutAction)
Sets or changes the action when the recertification todo times out. |
void |
setTimeoutPeriod(int period)
Sets or changes the timeout period of the recertification in days. |
void |
setUserClass(java.lang.String ownerPersonClass)
Sets or changes the target users of the recertification policy. |
Methods inherited from class com.ibm.itim.dataservices.model.policy.ServicePolicy |
---|
addTarget, removeTarget, removeTarget |
Methods inherited from class com.ibm.itim.dataservices.model.policy.ScopedPolicy |
---|
getScope, setScope |
Methods inherited from class com.ibm.itim.dataservices.model.policy.DirectoryPolicy |
---|
getCaption, getDescription, getKeywords, getName, getParentDN, isEnabled, setCaption, setDescription, setEnabled, setKeywords, setName |
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, setAttribute, setAttributes, 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 |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ROLLING_SCHEDULE_MODE
SCHEDULING_MODE_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String CALENDAR_SCHEDULING_MODE
SCHEDULING_MODE_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String ACCOUNT_TYPE
public static final java.lang.String ACCESS_TYPE
public static final java.lang.String IDENTITY_TYPE
public static final java.lang.String APPROVE_TIMEOUT_ACTION
TIMEOUT_ACTION_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String REJECT_TIMEOUT_ACTION
TIMEOUT_ACTION_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String NO_TIMEOUT_ACTION
TIMEOUT_ACTION_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String MARK_REJECT_ACTION
REJECT_ACTION_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String SUSPEND_REJECT_ACTION
REJECT_ACTION_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String DELETE_REJECT_ACTION
REJECT_ACTION_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String ALL_USER_CLASS
USER_CLASS_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String PERSON_USER_CLASS
USER_CLASS_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final java.lang.String BPPERSON_USER_CLASS
USER_CLASS_ATTRIBUTE_NAME
,
Constant Field Valuespublic static final int DEFAULT_PARTICIPANT_RESPONSE_TIMEOUT
public static final java.lang.String POLICY_ITEM_NAME_ATTRIBUTE_NAME
public static final java.lang.String DESCRIPTION_ATTRIBUTE_NAME
public static final java.lang.String ENABLED_ATTRIBUTE_NAME
public static final java.lang.String POLICY_TARGET_ATTRIBUTE_NAME
public static final java.lang.String RECERTIFIER_ATTRIBUTE_NAME
public static final java.lang.String SCHEDULING_MODE_ATTRIBUTE_NAME
public static final java.lang.String ROLLING_INTERVAL_ATTRIBUTE_NAME
public static final java.lang.String TIMEOUT_ACTION_ATTRIBUTE_NAME
public static final java.lang.String TIMEOUT_PERIOD_ATTRIBUTE_NAME
public static final java.lang.String REJECT_ACTION_ATTRIBUTE_NAME
public static final java.lang.String REJECT_NOTIFTY_ATTRIBUTE_NAME
public static final java.lang.String USER_CLASS_ATTRIBUTE_NAME
public static final java.lang.String SCHEDULE_ATTRIBUTE_NAME
Constructor Detail |
---|
public RecertificationPolicy(java.lang.String policyName, int scope, boolean enable, java.lang.String policyType, java.util.Collection<IPolicyTarget> policyTargets, RecurringTimeSchedule schedule, RecertificationParticipant recertifier, java.lang.String userType, int timeOutPeriod, java.lang.String rejectAction, java.lang.String timeoutAction)
policyName
- Name of the recertification policy.scope
- Scope of the recertification policy. One level scope or
subtree tree level scope. Possible values are
enable
- Boolean variable for the recertification policy status. Policy
status can be enabled or disabled.policyType
- Type of the recertification policy. Possible values are
policyTargets
- Collection of the targets for the policy. The account and access
recertification policy must contain a collection of
ServiceTarget
objects and user recertification policy
can contain a collection of ServiceTarget
,
GroupTarget
, and RoleTarget
objects. Valid
values for the service targets are: Recertification Policy Type | Valid ServiceTarget Types |
Account (ACCOUNT_TYPE ) |
ServiceTarget.TYPE_SERVICE_NAME |
Access (ACCESS_TYPE ) |
ServiceTarget.TYPE_ACCESS_NAME |
User (IDENTITY_TYPE ) |
ServiceTarget.TYPE_SERVICE_NAME ,ServiceTarget.TYPE_ALL |
schedule
- Calendar schedule to evaluate a recertification policy at a
specific date and time.recertifier
- System users who approves the recertification. Type
RecertificationParticipant.TYPE_SERVICE_OWNER
is valid
for the account and access type recertification policy only.
Type RecertificationParticipant.TYPE_ACCESS_OWNER
is
valid for the access type recertification policy only.userType
- User type of the recertification policy. Possible values are
timeOutPeriod
- Days until recertification is due.rejectAction
- Action when recertification is rejected. Possible values are
SUSPEND_REJECT_ACTION
is not valid reject action for
access type recertification policy.timeoutAction
- Action when recertification is timeout. Possible values are
NO_TIMEOUT_ACTION
is valid only for user type
recertification policy.public RecertificationPolicy(java.lang.String policyName, java.lang.String policyType, java.util.Collection<IPolicyTarget> policyTargets, RecertificationParticipant recertifier, java.lang.String rejectAction)
policyName
- Name of the recertification policy.policyType
- Type of the recertification policy. Possible values are
policyTargets
- Collection of the targets for the policy. The account and
access recertification policy must contain a collection of
ServiceTarget
and the user recertification policy can
contain a collection of ServiceTarget
,
GroupTarget
and RoleTarget
. Valid values for
service targets are: Recertification Policy Type | Valid ServiceTarget Types |
Account (ACCOUNT_TYPE ) |
ServiceTarget.TYPE_SERVICE_NAME |
Access (ACCESS_TYPE ) |
ServiceTarget.TYPE_ACCESS_NAME |
User (IDENTITY_TYPE ) |
ServiceTarget.TYPE_SERVICE_NAME ,ServiceTarget.TYPE_ALL |
recertifier
- System user who approves recertification. Type
RecertificationParticipant.TYPE_SERVICE_OWNER
is valid
for the account and access type recertification policy only.
Type RecertificationParticipant.TYPE_ACCESS_OWNER
is
valid for the access type recertification policy only.rejectAction
- Action when the recertification is rejected. Possible values are
SUSPEND_REJECT_ACTION
is not valid reject action for
access type recertification policy.Method Detail |
---|
public java.lang.String getType()
public boolean isCustomWorkflow()
public void setRecertificationParticipant(RecertificationParticipant recertifier)
RecertificationParticipant.TYPE_SERVICE_OWNER
is valid for the
account and access type recertification policy only. Type
RecertificationParticipant.TYPE_ACCESS_OWNER
is valid for the access
type recertification policy only. If the recertification policy is
defined with the advanced workflow (method isCustomWorkflow()
returns
true), then the participant value set to the recertification policy object is
ignored during the policy modification.
recertifier
- Recertification policy participant.public RecertificationParticipant getRecertificationParticipant()
isCustomWorkflow()
returns true), then this method might not return a correct value or it returns null.
public void setScheduleMode(java.lang.String scheduleMode)
ROLLING_SCHEDULE_MODE
is valid for the account and user type
recertification policy.
scheduleMode
- Schedule mode of the recertification policy.public java.lang.String getScheduleMode()
public void setRollingInterval(int interval)
interval
- Rolling interval of the recertification policy in days.public int getRollingInterval()
public void setTimeoutAction(java.lang.String timeoutAction)
NO_TIMEOUT_ACTION
is valid only for user type
recertification policy.
If the recertification policy is defined with the advance workflow (method
isCustomWorkflow()
returns true), then the timeout action value set
to the recertification policy object is ignored during the policy
modification.
timeoutAction
- Action when recertification is timeout.public java.lang.String getTimeoutAction()
isCustomWorkflow()
returns true), then this method might not return a correct value or it returns null.
public void setTimeoutPeriod(int period)
isCustomWorkflow()
returns true), then the timeout period value set
to the recertification policy object is ignored during the policy
modification.
period
- Timeout period of the recertification in days.public int getTimeoutPeriod()
isCustomWorkflow()
returns true), then this method might not return
a correct value.
public void setRejectAction(java.lang.String rejectAction)
SUSPEND_REJECT_ACTION
is not valid reject action for access
type recertification policy. isCustomWorkflow()
returns true), then the reject action
value set to the recertification policy object is ignored during the
policy modification.
rejectAction
- Action when recertification is rejected.public java.lang.String getRejectAction()
isCustomWorkflow()
returns true), then this method might not return a correct value or it returns null.
public void setRejectionNotificationParticipant(RecertificationParticipant participant)
RecertificationParticipant.TYPE_SERVICE_OWNER
is valid for the
account and access type recertification policy only. Type
RecertificationParticipant.TYPE_ACCESS_OWNER
is valid for the access
type recertification policy only. If the recertification policy is
defined with the advance workflow (method isCustomWorkflow()
returns
true), then the participant value set to the recertification policy object is
ignored during the policy modification.
recertifier
- Recertification rejection e-mail participant.public RecertificationParticipant getRejectionNotificationParticipant()
isCustomWorkflow()
returns true), then this method might not return
a correct value or it returns null.
public void setUserClass(java.lang.String ownerPersonClass)
ownerPersonClass
- Target users of the recertification policy.public java.lang.String getUserClass()
public void setSchedule(RecurringTimeSchedule schedule)
schedule
- Schedule of the recertification policy.public RecurringTimeSchedule getSchedule()
public void setTargets(java.util.Collection<IPolicyTarget> newTargets)
ServiceTarget
and user recertification policy can contain a collection of
ServiceTarget
, GroupTarget
, and RoleTarget
.
Valid values for service targets are: Recertification Policy Type | Valid ServiceTarget Types |
Account (ACCOUNT_TYPE ) |
ServiceTarget.TYPE_SERVICE_NAME |
Access (ACCESS_TYPE ) |
ServiceTarget.TYPE_ACCESS_NAME |
User (IDENTITY_TYPE ) |
ServiceTarget.TYPE_SERVICE_NAME , ServiceTarget.TYPE_ALL
|
setTargets
in class ServicePolicy
newTargets
- The new value of the Targets attribute.public java.util.Collection<IPolicyTarget> getTargets()
getTargets
in class ServicePolicy
public void setAccessRights(java.util.Collection rights)
setAccessRights
in interface ProtectedObject
setAccessRights
in class DirectoryObject
rights
- Collection of AccessRight objects.ProtectedObject.setAccessRights(java.util.Collection)
public void setAuthorizationOwners(java.util.Collection owners)
setAuthorizationOwners
in interface ProtectedObject
setAuthorizationOwners
in class DirectoryObject
owners
- Collection of AuthorizationOwner objects.ProtectedObject.setAuthorizationOwners(java.util.Collection)
public boolean equals(java.lang.Object policy)
equals
in class java.lang.Object
policy
- the object to be compared for equality with this
RecertificationPolicy.
Object.equals(java.lang.Object)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |