com.ibm.itim.apps.policy
Class ProvisioningPolicyManager

java.lang.Object
  com.ibm.itim.apps.policy.ProvisioningPolicyManager

public class ProvisioningPolicyManager
extends java.lang.Object

Provides aggregate provisioning policy management capabilities. These capabilities include the creation of policy.

Constructor Summary

ProvisioningPolicyManager(PlatformContext platform, javax.security.auth.Subject subject)
Constructs the manager with a platform context and a subject.

Method Summary

Request	createPolicy(OrganizationalContainerMO container, ProvisioningPolicy subject, java.util.Date scheduleTime) Creates a provisioning policy in the provisioning platform with the specified attributes within the given container.
Request	deletePolicy(OrganizationalContainerMO container, DistinguishedName subjectDN, java.util.Date scheduleTime) Deletes a provisioning policy in the provisioning platform
com.ibm.itim.apps.util.SearchResultsWrapper<ProvisioningPolicy>	findPoliciesForRole(DistinguishedName role, SearchParameters searchParams) Returns the provisioning policies(s) that the specified role and any role ancestors are using.
java.util.Collection	getPolicies(OrganizationalContainerMO container, java.lang.String name) Returns the provisioning policies(s) with the the name within the given parent container.
ProvisioningPolicyMO	getPolicyByURI(OrganizationalContainerMO container, java.lang.String uri) Returns the provisioning policy for the given Uniform Resource Identifier (URI) within the specified parent container.
Request	modifyPolicy(OrganizationalContainerMO container, ProvisioningPolicy subject, java.util.Date scheduleTime) Modifies a provisioning policy in the provisioning platform within the given container.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProvisioningPolicyManager

public ProvisioningPolicyManager(PlatformContext platform,
                                 javax.security.auth.Subject subject)

Constructs the manager with a platform context and a subject.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

Method Detail

createPolicy

public Request createPolicy(OrganizationalContainerMO container,
                            ProvisioningPolicy subject,
                            java.util.Date scheduleTime)
                     throws java.rmi.RemoteException,
                            AuthorizationException,
                            ApplicationException

Creates a provisioning policy in the provisioning platform with the specified attributes within the given container. This method does not validate if the new policy contains all required attribute values (name, membership, entitlement)

Parameters:

container - OrganizationalContainerMO within which the the provisioning policy will be placed.

subject - com.ibm.itim.apps.policy.ProvisioningPolicy value object defining the attributes the provisioning policy will have.

scheduleTime - The scheduled starting time of the process. If null, the process will start immediately. In case this method is invoked remotely, passing this parameter as the current date/time of the client machine is not a safe technique to use, since the date/time of the client machine may not be the same as the date/time of the ITIM server machine.

Returns:

Request representing the successfully submitted creation request.

Throws:

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

AuthorizationException - Thrown if client is unauthorized to create the policy in the given container.

ApplicationException - Thrown if unable to create the provisioning policy. This may possibly be caused by the container being removed by another client previous to this call.

modifyPolicy

public Request modifyPolicy(OrganizationalContainerMO container,
                            ProvisioningPolicy subject,
                            java.util.Date scheduleTime)
                     throws java.rmi.RemoteException,
                            AuthorizationException,
                            ApplicationException

Modifies a provisioning policy in the provisioning platform within the given container. This method does not validate if the modified policy contain all required attribute values (name, membership, entitlement)

Parameters:

container - OrganizationalContainerMO within which the provisioning policy resides.

subject - com.ibm.itim.apps.policy.ProvisioningPolicy value object defining the attributes the provisioning policy will have.

scheduleTime - The scheduled starting time of the process. If null, the process will start immediately. In case this method is invoked remotely, passing this parameter as the current date/time of the client machine is not a safe technique to use, since the date/time of the client machine may not be the same as the date/time of the ITIM server machine.

Returns:

Request representing the successfully submitted modify request.

Throws:

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

AuthorizationException - Thrown if client is unauthorized to modify the policy in the given container.

ApplicationException - Thrown if unable to modify the provisioning policy. This may possibly be caused by the container being removed by another client previous to this call.

deletePolicy

public Request deletePolicy(OrganizationalContainerMO container,
                            DistinguishedName subjectDN,
                            java.util.Date scheduleTime)
                     throws java.rmi.RemoteException,
                            AuthorizationException,
                            ApplicationException

Deletes a provisioning policy in the provisioning platform

Parameters:

container - OrganizationalContainerMO within which the the provisioning policy will be placed.

subjectDN - DistinguishedName of the provisioning policy to be deleted.

scheduleTime - The scheduled starting time of the process. If null, the process will start immediately. In case this method is invoked remotely, passing this parameter as the current date/time of the client machine is not a safe technique to use, since the date/time of the client machine may not be the same as the date/time of the ITIM server machine.

Returns:

Request representing the successfully submitted deletion request.

Throws:

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

AuthorizationException - Thrown if client is unauthorized to delete the policy in the given container.

ApplicationException - Thrown if unable to delete the provisioning policy. This may possibly be caused by the container being removed by another client previous to this call.

getPolicyByURI

public ProvisioningPolicyMO getPolicyByURI(OrganizationalContainerMO container,
                                           java.lang.String uri)
                                    throws java.rmi.RemoteException,
                                           ApplicationException

Returns the provisioning policy for the given Uniform Resource Identifier (URI) within the specified parent container.

Parameters:

container - OrganizationalContainerMO representing the parent container to scope the search.

uri - String representing the Provisioning policy URI.

Returns:

ProvisioningPolicyMO representing the matching provisioning policy

Throws:

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

ApplicationException - Thrown if unable to obtain the provisioning policy. This might be caused by the container being removed by another client previous to this call. This exception might also be thrown if the container object is null or represents the tenant, no provisioning policy is found for the given URI within the container, or more than one provisioning policy is found for the given URI within the container.

getPolicies

public java.util.Collection getPolicies(OrganizationalContainerMO container,
                                        java.lang.String name)
                                 throws java.rmi.RemoteException,
                                        ApplicationException

Returns the provisioning policies(s) with the the name within the given parent container. Note, if the client is unauthorized to view (search) a service that matches this criteria, it will be filtered out of the return list and no AuthorizationException will be thrown.

Parameters:

container - OrganizationalContainerMO representing the parent container to scope the search. An OrganizationalContainerMO object must be provided to represents the context of the search. The search will be sub-tree to the container.

name - Name of the provisioning policy(s) to return.

Returns:

Collection of com.ibm.itim.apps.policy.ProvisioningPolicy representing the matching policies.

Throws:

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

ApplicationException - Thrown if unable to obtain the provisioning policy. This may possibly be caused by the container being removed by another client previous to this call.

findPoliciesForRole

public com.ibm.itim.apps.util.SearchResultsWrapper<ProvisioningPolicy> findPoliciesForRole(DistinguishedName role,
                                                                                           SearchParameters searchParams)
                                                                                    throws java.rmi.RemoteException,
                                                                                           ApplicationException

Returns the provisioning policies(s) that the specified role and any role ancestors are using.

Parameters:

role - Specifies the distinguished name of the role.

searchParams - Specifies various search parameters.

Returns:

SearchResultsWrapper Includes the collection of ProvisioningPolicy objects and search status.

Throws:

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

ApplicationException - Thrown if unable to obtain the provisioning policy.