com.ibm.itim.policy.analysis

Class ProvisioningPolicyAnalysis

java.lang.Object

com.ibm.itim.policy.analysis.ProvisioningPolicyAnalysis

public class ProvisioningPolicyAnalysis
extends java.lang.Object

This class provides methods that can be used in the analysis of policy enforcement being performed in the system. For example, it provides methods that allow someone to:

• Determine provisioning policies that apply to a given role.
• Determine entitlements granted by a given policy.
• Determine entitlements granted an individual.

Method Summary

Modifier and Type	Method and Description
static PPAEntitlement	getEntitlement(PersonEntity person, ServiceEntity service) Returns the entitlement, defined with Individual ownership type, for the specified person and service instance.
static PPAEntitlement	getEntitlement(PersonEntity person, ServiceEntity service, java.lang.String ownershipType) Returns the entitlement for the specified person, service and ownership type.
static java.util.Collection<PPAEntitlement>	getEntitlements(PersonEntity person) Returns the entitlements for the specified person.
static java.util.Collection<PPAProvisioningParameter>	getProvisioningParameters(PersonEntity person, ServiceEntity service, java.util.Collection<java.lang.String> parameters) Returns the provisioning parameters that apply to the specified person, service instance and Individual ownership type.
static java.util.Collection<PPAProvisioningParameter>	getProvisioningParameters(PersonEntity person, ServiceEntity service, java.lang.String ownershipType, java.util.Collection<java.lang.String> parameters) Returns the provisioning parameters that apply to the specified person, ownership type and service instance.
static java.util.Collection<PPAProvisioningPolicy>	getProvisioningPolicies(RoleEntity role, boolean wildcard) Returns the provisioning policies that apply to the specified role.

Methods inherited from class java.lang.Object

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

Method Detail

getEntitlement

public static PPAEntitlement getEntitlement(PersonEntity person,
                                            ServiceEntity service)
                                     throws PPAException

Returns the entitlement, defined with Individual ownership type, for the specified person and service instance.

All script based values contained in the entitlement's provisioning parameters will be resolved. If more that one provisioning policy applies to the specified person and service instance, a single entitlement is returned representing the joined provisioning policies.

Parameters:

person - The person for whom the entitlement should be returned.

service - The service instance for which the entitlement should be returned.

Returns:

The entitlement with Individual ownership type for the specified person and service instance.

Throws:

PPAException - Thrown if an error occurs.

See Also:

PPAEntitlement

getEntitlement

public static PPAEntitlement getEntitlement(PersonEntity person,
                                            ServiceEntity service,
                                            java.lang.String ownershipType)
                                     throws PPAException

Returns the entitlement for the specified person, service and ownership type.

All script based values contained in the entitlement's provisioning parameters will be resolved. If more that one provisioning policy applies to the specified person, service and ownership type, a single entitlement is returned representing the joined provisioning policies.

Parameters:

person - The person for whom the entitlement should be returned.

service - The service instance for which the entitlement should be returned.

ownershipType - The ownership type for which the entitlement should be returned.

Returns:

The entitlement for the specified person, service and ownership type.

Throws:

PPAException - Thrown if an error occurs.

See Also:

PPAEntitlement

getEntitlements

public static java.util.Collection<PPAEntitlement> getEntitlements(PersonEntity person)
                                                            throws PPAException

Returns the entitlements for the specified person.

All script based values contained in the entitlements' provisioning parameters will be resolved. If more that one provisioning policy applies to the specified person for a given ownership type and service instance, the provisioning policies for that service instance are joined to produce a single entitlement for that ownership type and service instance.

Parameters:

person - The person for whom the entitlements should be returned.

Returns:

The collection of PPAEntitlement objects for the specified person.

Throws:

PPAException - Thrown if an error occurs.

See Also:

PPAEntitlement

getProvisioningParameters

public static java.util.Collection<PPAProvisioningParameter> getProvisioningParameters(PersonEntity person,
                                                                                       ServiceEntity service,
                                                                                       java.util.Collection<java.lang.String> parameters)
                                                                                throws PPAException

Returns the provisioning parameters that apply to the specified person, service instance and Individual ownership type. Optionally, the provisioning parameters returned can be scaled down by specifying the collection of parameter names for which provisioning parameters should be returned.

All script based values contained in the provisioning parameters will be resolved. If more that one provisioning policy applies to the specified person and service instance, a set of provisioning parameters is returned representing the joined provisioning policies of individual ownership types.

Parameters:

person - The person for whom the provisioning parameters should be returned.

service - The service instance for which the provisioning parameters should be returned.

parameters - The collection of parameter names for which provisioning parameters should be returned. If null, all provisioning parameters for the specified person and service instance will be returned.

Returns:

The collection of PPAProvisioningParameter objects for the specified person and service instance.

Throws:

PPAException - Thrown if an error occurs.

See Also:

PPAProvisioningParameter

getProvisioningParameters

public static java.util.Collection<PPAProvisioningParameter> getProvisioningParameters(PersonEntity person,
                                                                                       ServiceEntity service,
                                                                                       java.lang.String ownershipType,
                                                                                       java.util.Collection<java.lang.String> parameters)
                                                                                throws PPAException

Returns the provisioning parameters that apply to the specified person, ownership type and service instance. Optionally, the provisioning parameters returned can be scaled down by specifying the collection of parameter names for which provisioning parameters should be returned.

All script based values contained in the provisioning parameters will be resolved. If more that one provisioning policy applies to the specified person and service instance, a set of provisioning parameters is returned representing the joined provisioning policies.

Parameters:

person - The person for whom the provisioning parameters should be returned.

service - The service instance for which the provisioning parameters should be returned.

service - The ownership type for which the provisioning parameters should be returned.

parameters - The collection of parameter names for which provisioning parameters should be returned. If null, all provisioning parameters for the specified person, ownership type and service instance will be returned.

Returns:

The collection of PPAProvisioningParameter objects for the specified person and service instance.

Throws:

PPAException - Thrown if an error occurs.

See Also:

PPAProvisioningParameter

getProvisioningPolicies

public static java.util.Collection<PPAProvisioningPolicy> getProvisioningPolicies(RoleEntity role,
                                                                                  boolean wildcard)
                                                                           throws PPAException

Returns the provisioning policies that apply to the specified role.

Parameters:

role - The role for which the provisioning policies should be returned.

wildcard - Indicates whether or not wildcard provisioning policies should be included in the provisioning policies that are returned.

Returns:

The collection of PPAProvisioningPolicy objects for the specified role.

Throws:

PPAException - Thrown if an error occurs.

See Also:

PPAProvisioningPolicy