com.ibm.itim.apps.pim

Class CredentialPoolManager

java.lang.Object

com.ibm.itim.apps.pim.CredentialPoolManager

public class CredentialPoolManager
extends java.lang.Object

This class provides credential pool administration capabilities. These capabilities include the creation of credential pools.

Since:

ISIM 6.0

See Also:

CredentialPoolMO

Constructor Summary

Constructors

Constructor and Description
CredentialPoolManager(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
CredentialPoolMO	createPool(OrganizationalContainerMO orgContainer, ServiceMO service, CredentialPool credentialPool) Creates a credential pool for the given service in an organizational container.
CredentialPoolMO	createPool(ServiceMO service, CredentialPool credentialPool) Creates a credential pool for the given service.
java.util.Collection<CredentialComponent>	getCredentialPools(OrganizationalContainerMO parent, java.lang.String serviceProfileName, java.lang.String serviceNamePattern, java.lang.String poolNamePattern, SearchResultsStatus resultStatus) This API returns the credential pools that matches the given name and service name search pattern within the given container.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialPoolManager

public CredentialPoolManager(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

createPool

public CredentialPoolMO createPool(OrganizationalContainerMO orgContainer,
                          ServiceMO service,
                          CredentialPool credentialPool)
                            throws java.rmi.RemoteException,
                                   AuthorizationException,
                                   SchemaViolationException,
                                   ApplicationException

Creates a credential pool for the given service in an organizational container.

Parameters:

orgContainer - OrganizationalContainerMO the organizational container where the credential pool will be created.

service - ServiceMO the service that the credential pool is associated with.

credentialPool - CredentialPool value object defining the attributes the credential pool will have.

Returns:

CredentialPoolMO representing the successfully created pool.

Throws:

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

AuthorizationException - Thrown if client is not authorized to create a credential pool 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, service or subject parameters are null.

createPool

public CredentialPoolMO createPool(ServiceMO service,
                          CredentialPool credentialPool)
                            throws java.rmi.RemoteException,
                                   AuthorizationException,
                                   SchemaViolationException,
                                   ApplicationException

Creates a credential pool for the given service. The organizational container where the service resides is treated as the organizational container for the credential pool.

Parameters:

service - ServiceMO the service that the credential pool is associated with.

credentialPool - CredentialPool value object defining the attributes the credential pool will have.

Returns:

CredentialPoolMO representing the successfully created pool.

Throws:

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

AuthorizationException - Thrown if client is not authorized to create a credential pool for the specified service.

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 service being removed by another client previous to this call.

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

getCredentialPools

public java.util.Collection<CredentialComponent> getCredentialPools(OrganizationalContainerMO parent,
                                                           java.lang.String serviceProfileName,
                                                           java.lang.String serviceNamePattern,
                                                           java.lang.String poolNamePattern,
                                                           SearchResultsStatus resultStatus)
                                                             throws java.rmi.RemoteException,
                                                                    ApplicationException

This API returns the credential pools that matches the given name and service name search pattern within the given container. Note: if the client is unauthorized to view (search) a credential that matches this criteria, the credential pool is filtered out of the return list. An AuthorizationException is not thrown.

Parameters:

parent - OrganizationalContainerMO specifies the parent container that is the scope of the search for services and accounts. In a single-tenant deployment, null can be specified to search the entire tree. In a multi-tenant deployment, an OrganizationalContainerMO object must be provided that represents the root of the tenant.

serviceProfileName - specifies the name of service type. Use an empty string to specify a search for all service types.

serviceNamePattern - specifies the name pattern of the service to match. Use an asterisk (*) to specify a wildcard search. Use an asterisk (*) ss the first and last character of a string value for a "contains" search. Use an empty string to specify a search for all services.

poolNamePattern - specifies the name pattern of the credential pool to match. Use an asterisk (*) to specify a wildcard search. Use an asterisk (*) as the first and last character of a string value for a "contains" search. Use an empty string to specify a search for all credential pools.

resultStatus - SearchResultsStatus indicating if the search has exceeded size limit.

Returns:

Collection of CredentialComponent representing the matching credential pools.

Throws:

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

ApplicationException - This exception is thrown if the API cannot obtain the credentials. This error may be caused if the parent container is removed by another client before this call.