com.ibm.itim.apps.policy

Class RecertificationPolicyMO

java.lang.Object

com.ibm.itim.apps.policy.RecertificationPolicyMO

public class RecertificationPolicyMO
extends java.lang.Object

Managed object representing a recertification policy.

Constructor Summary

Constructors

Constructor and Description
RecertificationPolicyMO(PlatformContext platform, javax.security.auth.Subject subject, DistinguishedName name) Constructs the managed object with a platform context, a subject, and the distinguished name of the object to manage.

Method Summary

Modifier and Type	Method and Description
void	execute() Runs or executes the recertification policy manually.
OrganizationalContainerMO	getContainer() Returns the current parent container of this policy.
RecertificationPolicy	getData() Returns a current snapshot of the recertification policy.
DistinguishedName	getDistinguishedName() Returns the distinguished name of the recertification policy.
OrganizationalContainerMO	getOrganization() Returns the organization that the policy is contained within.
boolean	isDeletable() Returns true if this object can be deleted by the authenticated subject, false otherwise.
boolean	isExecutable() Returns true if the authenticated subject has permission to execute or modify this recertification policy.
boolean	isUpdatable() Returns true if this object can be modified or updated by the authenticated subject, false otherwise.
void	remove() Removes the recertification policy object from the provisioning platform.
void	update(RecertificationPolicy newPolicy) Updates the recertification policy object.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecertificationPolicyMO

public RecertificationPolicyMO(PlatformContext platform,
                               javax.security.auth.Subject subject,
                               DistinguishedName name)

Constructs the managed object with a platform context, a subject, and the distinguished name of the object to manage.

Parameters:

platform - PlatformContext holding the platform connection information.

subject - Subject representing the authenticated caller.

name - DistinguishedName of the policy.

Method Detail

getDistinguishedName

public DistinguishedName getDistinguishedName()

Returns the distinguished name of the recertification policy.

Returns:

DistinguishedName of the recertification policy.

getData

public RecertificationPolicy getData()
                              throws java.rmi.RemoteException,
                                     ApplicationException

Returns a current snapshot of the recertification policy. If the policy is defined with the advanced workflow, then the policy object does not contain the value for the workflow specific attributes.

Returns:

RecertificationPolicy object holding the attribute information.

Throws:

java.rmi.RemoteException - Thrown if it is unable to communicate with the platform.

ApplicationException - Thrown if it is unable to retrieve data.

update

public void update(RecertificationPolicy newPolicy)
            throws java.rmi.RemoteException,
                   AuthorizationException,
                   ApplicationException

Updates the recertification policy object. A recertification policy value object is provided with the changes to make. This method cannot be used to define the advanced workflows for any simple recertification policy. For the recertification policies that have advanced workflows defined through Identity Governance user interface, this method cannot be used to update or define the advanced workflows. The recertification policy type cannot be changed using this method and is not supported. If the reject action of the recertification policy is changed, then the default notifications templates are set to the recertification policy based on the policy type and modified reject action.

Parameters:

policy - Policy value object with changes to make.

Throws:

java.rmi.RemoteException - Thrown if it is unable to communicate with the platform.

AuthorizationException - Thrown if the client is unauthorized to change the policy.

ApplicationException - Thrown if it is unable to submit the request. This might occur if another client removes the policy prior to the call. This exception is also thrown when RecertificatioPolicyMO contains a null DistinguishedName.

remove

public void remove()
            throws java.rmi.RemoteException,
                   AuthorizationException,
                   ApplicationException

Removes the recertification policy object from the provisioning platform.

Throws:

java.rmi.RemoteException - Thrown if it is unable to communicate with the platform.

AuthorizationException - Thrown if the client is unauthorized to remove the policy.

ApplicationException - Thrown if it is unable to submit the request. This might occur if another client removes the policy prior to the call. This exception is also thrown when RecertificationPolicyMO contains a null DistinguishedName.

execute

public void execute()
             throws java.rmi.RemoteException,
                    AuthorizationException,
                    ApplicationException

Runs or executes the recertification policy manually.

Throws:

java.rmi.RemoteException - Thrown if it is unable to communicate with the platform.

AuthorizationException - Thrown if the client is unauthorized to execute the policy.

ApplicationException - Thrown if it is unable to retrieve this object.

getContainer

public OrganizationalContainerMO getContainer()
                                       throws java.rmi.RemoteException,
                                              AuthorizationException,
                                              ApplicationException

Returns the current parent container of this policy.

Returns:

OrganizationalContainerMO representing the parent container.

Throws:

java.rmi.RemoteException - Thrown if it is unable to communicate with the platform.

AuthorizationException - Thrown if the client is unauthorized to view the container of the policy.

ApplicationException - Thrown if it is unable to retrieve the container of the policy.

getOrganization

public OrganizationalContainerMO getOrganization()
                                          throws java.rmi.RemoteException,
                                                 AuthorizationException,
                                                 ApplicationException

Returns the organization that the policy is contained within.

Returns:

OrganizationalContainerMO representing the organization.

Throws:

java.rmi.RemoteException - Thrown if it is unable to communicate with the platform.

AuthorizationException - Thrown if the client is unauthorized to view the container of the policy.

com.ibm.itim.apps.exception.AppProcessingException - Thrown if it is unable to retrieve the organization.

ApplicationException

isDeletable

public boolean isDeletable()
                    throws java.rmi.RemoteException,
                           ApplicationException

Returns true if this object can be deleted by the authenticated subject, false otherwise.

Throws:

java.rmi.RemoteException - Thrown if it is unable to communicate with the platform.

ApplicationException - Thrown if it is unable to retrieve this object.

isUpdatable

public boolean isUpdatable()
                    throws java.rmi.RemoteException,
                           ApplicationException

Returns true if this object can be modified or updated by the authenticated subject, false otherwise.

Throws:

java.rmi.RemoteException - Thrown if it is unable to communicate with the platform.

ApplicationException - Thrown if it is unable to update this object.

isExecutable

public boolean isExecutable()
                     throws java.rmi.RemoteException,
                            ApplicationException

Returns true if the authenticated subject has permission to execute or modify this recertification policy. If a user has permission to modify the recertification policy, then the user has permission to execute that policy.

Throws:

java.rmi.RemoteException - Thrown if it is unable to communicate with the platform.

ApplicationException - Thrown if it is unable to execute the policy.