com.ibm.itim.apps.pim
Class CredentialPoolMO

java.lang.Object
  com.ibm.itim.apps.pim.CredentialPoolMO

All Implemented Interfaces:

java.io.Serializable

public class CredentialPoolMO
extends java.lang.Object
implements java.io.Serializable

Managed object representing a credential pool. Credential pools provide a way to group credentials with similar access privileges.

Since:

ISIM 6.0

See Also:

CredentialPool, Credential, Serialized Form

Constructor Summary

CredentialPoolMO(PlatformContext platform, javax.security.auth.Subject subject, DistinguishedName name)
This API constructs the the managed object with a platform context, a subject, and the distinguished name of the object to manage.

Method Summary

OrganizationalContainerMO	getContainer() Returns the current parent container in the tree.
CredentialPool	getData() This API returns a current snapshot of the credential pool.
DistinguishedName	getDistinguishedName() Returns the distinguished name of the managed object
ServiceMO	getService() Returns the service of the credential pool.
void	remove() This API removes the credential pool.
void	update(CredentialPool credentialPool) This API updates the credential pool with the given CredentialPool value object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialPoolMO

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

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

Parameters:

platform - specifies the PlatformContext that holds platform connection information.

subject - specifies the Subject that represents the authenticated caller.

name - specifies the DistinguishedName of the credential pool.

Method Detail

getDistinguishedName

public DistinguishedName getDistinguishedName()

Returns the distinguished name of the managed object

Returns:

DistinguishedName of the managed object.

getData

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

This API returns a current snapshot of the credential pool.

Returns:

the CredentialPool object that holds attribute information.

Throws:

java.rmi.RemoteException - This exception is thrown if the API cannot communicate with platform.

ApplicationException - This exception is thrown if the API cannot retrieve data.

getContainer

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

Returns the current parent container in the tree.

Returns:

OrganizationalContainerMO representing the parent container.

Throws:

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

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

ApplicationException - Thrown if unable to retrieve the credential pool's container. This may possibly be caused by the credential pool being removed by another client previous to this call.

getService

public ServiceMO getService()
                     throws java.rmi.RemoteException,
                            ApplicationException,
                            AuthorizationException

Returns the service of the credential pool.

Returns:

ServiceMO representing the credential pool's service.

Throws:

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

AuthorizationException - Thrown if client is unauthorized to view the service of the credential pool.

ApplicationException - Thrown if unable to retrieve the credential pool's service. This may possibly be caused by the credential pool being removed by another client previous to this call.

update

public void update(CredentialPool credentialPool)
            throws java.rmi.RemoteException,
                   AuthorizationException,
                   SchemaViolationException,
                   ApplicationException

This API updates the credential pool with the given CredentialPool value object.

Parameters:

credentialPool - specifies the CredentialPool object that contains the changes that need to be made.

Throws:

java.rmi.RemoteException - This exception is thrown if the API cannot communicate with the platform.

AuthorizationException - This exception is thrown if the user is not authorized to change the credential pool.

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 - This exception is thrown if the API cannot change the credential pool. This might be caused by the pool is removed by another client before this call.

java.lang.IllegalArgumentException - This exception is thrown if credentialPool parameter is null or if it does not have a distinguished name.

remove

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

This API removes the credential pool. If the credential pool is referenced by any shared access policies, an ApplicationException is thrown.

Throws:

java.rmi.RemoteException - This exception is thrown if the API cannot communicate with platform.

AuthorizationException - This exception is thrown if the user does not have the authority to remove the credential pool.

ApplicationException - This exception is thrown if the credential pool is referenced by any shared access policies or if an error occurs when removing the credential pool.