com.ibm.itim.apps.pim

Class SharedAccessPolicyManager

java.lang.Object

com.ibm.itim.apps.pim.SharedAccessPolicyManager

public class SharedAccessPolicyManager
extends java.lang.Object

This class provides shared access policy administration capabilities. These capabilities include the creation of policies.

Since:

ISIM 6.0

See Also:

SharedAccessPolicyMO

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
SharedAccessPolicyMO	createPolicy(OrganizationalContainerMO container, SharedAccessPolicy policy) Creates a shared access policy with the no memberships and no entitlements in an organizational container.
SharedAccessPolicyMO	createPolicy(OrganizationalContainerMO container, SharedAccessPolicy policy, java.util.Collection<SAMembership> memberships, java.util.Collection<SAEntitlement> entitlements) Creates a shared access policy with the given memberships and entitlements in an organizational container.
java.util.Collection<SharedAccessPolicyMO>	getPolicies(OrganizationalContainerMO container, java.lang.String policySearchInfo, SearchResultsStatus resultStatus) This method returns the shared access policies(s) with the the name or description within the given parent container.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedAccessPolicyManager

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

Constructs the manager with a platform context and a subject.

Parameters:

platform - PlatformContext that holds the platform connection information.

subject - Subject that represents the authenticated caller.

Throws:

java.lang.IllegalArgumentException - Thrown if the platform or the subject parameter is null.

Method Detail

createPolicy

public SharedAccessPolicyMO createPolicy(OrganizationalContainerMO container,
                                SharedAccessPolicy policy)
                                  throws java.rmi.RemoteException,
                                         AuthorizationException,
                                         SchemaViolationException,
                                         ApplicationException

Creates a shared access policy with the no memberships and no entitlements in an organizational container.

Parameters:

container - OrganizationalContainerMO the organizational container where the shared access policy will be created.

policy - SharedAccessPolicy value object defining the attributes the shared access policy will have.

Returns:

SharedAccessPolicyMO representing the successfully created policy.

Throws:

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

AuthorizationException - Thrown if client is not authorized to create a shared access policy under the specified organizational container.

SchemaViolationException - Thrown if any of the attributes in the value object violates the managed object's schema. This may be caused by an invalid attribute or if a required attribute is missing entirely.

ApplicationException - Thrown if unable to submit the request. This might be caused by the container being removed by another client previous to this call.

java.lang.IllegalArgumentException - Thrown if container or subject parameters are null.

createPolicy

public SharedAccessPolicyMO createPolicy(OrganizationalContainerMO container,
                                SharedAccessPolicy policy,
                                java.util.Collection<SAMembership> memberships,
                                java.util.Collection<SAEntitlement> entitlements)
                                  throws java.rmi.RemoteException,
                                         AuthorizationException,
                                         SchemaViolationException,
                                         ApplicationException

Creates a shared access policy with the given memberships and entitlements in an organizational container.

Parameters:

container - OrganizationalContainerMO the organizational container where the shared access policy will be created.

policy - SharedAccessPolicy value object defining the attributes the shared access policy will have.

memberships - Collection of SAMembership value objects.

entitlements - Collection of SAEntitlement value objects.

Returns:

SharedAccessPolicyMO representing the successfully created policy.

Throws:

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

AuthorizationException - Thrown if client is not authorized to create a shared access policy under the specified organizational container.

SchemaViolationException - Thrown if any of the attributes in the value object violates the managed object's schema. This may be caused by an invalid attribute or if a required attribute is missing entirely.

ApplicationException - Thrown if unable to submit the request. This might be caused by the container being removed by another client previous to this call.

java.lang.IllegalArgumentException - Thrown if container or subject parameters are null.

getPolicies

public java.util.Collection<SharedAccessPolicyMO> getPolicies(OrganizationalContainerMO container,
                                                     java.lang.String policySearchInfo,
                                                     SearchResultsStatus resultStatus)
                                                       throws java.rmi.RemoteException,
                                                              ApplicationException

This method returns the shared access policies(s) with the the name or description within the given parent container. Note, if the client is unauthorized to view (search) a policy that matches this criteria, it is filtered out of the return list and no AuthorizationException is thrown.

Parameters:

container - OrganizationalContainerMO The parameter represents the parent container used to scope the search. An OrganizationalContainerMO object must be provided to represent the context of the search. This method uses sub-tree search of the container.

policySearchInfo - This parameter specifies the name or description of the shared access policies to return.

Returns:

Collection of com.ibm.itim.apps.pim.SharedAccessPolicyMO The return is a collection that contains the matching policies.

Throws:

java.rmi.RemoteException - This exception is thrown if the method is unable to communicate with platform.

ApplicationException - This exception is thrown if the method is unable to obtain the provisioning policy. This might be caused by another client removing the container before this call.

See Also:

SharedAccessPolicyMO