com.wles.blm
Class SSMConfigurationManager

java.lang.Object
  com.wles.blm.SSMConfigurationManager

All Implemented Interfaces:

SSMProviderTypes

public class SSMConfigurationManager

extends java.lang.Object

implements SSMProviderTypes

Manages all operations on SSM objects. In addition to creating and deleting SSM's, the SSMConfigurationManager will bind a resource to an SSM and create SSM provider configurations.

See Also:

SSMProviderManager, SSMProviderTypes

Field Summary

Fields inherited from interface com.wles.blm.SSMProviderTypes

ADJUDICATION, AUDITING, AUTHENTICATION, AUTHORIZATION, CREDMAPPING, ROLEMAPPING

Method Summary

void	addResourceBinding(java.lang.String SSMName, java.lang.String Resource) Bind a resource to an SSM.
void	create(java.lang.String name) Create a new unbound SSM object for configuration.
SSMProviderManager	createProviderConfiguration(java.lang.String SSM, java.lang.String providername, java.lang.String providerType, java.lang.String mgmtinterface) Create a new provider configuration for an SSM.
java.lang.String	filter(java.lang.String findPattern) Find a set of SSM's based on a filter pattern.
boolean	find(java.lang.String cID, java.lang.String name) Checks that an SSM is in an SSM collection.
java.lang.String	getBoundResources(java.lang.String SSMName) Find a set of resources bound to a given SSM.
int	getCount(java.lang.String cID) Returns the size of the SSM collection.
SSMProviderManager	getProviderManager(java.lang.String SSM, java.lang.String providername, java.lang.String providerType) Get a provider instance configuration object to modify an existing provider.
SSMProviderManager[]	getProviderReport(java.lang.String cID) Returns a report on a Provider collection
SSMProviderManager[]	getProviderReport(java.lang.String cID, int iStart, int iCount) Returns a subset of a provider collection
java.lang.String	getProviders(java.lang.String SSMName) Find a set of providers based on an SSM's name.
java.lang.String[]	getReport(java.lang.String cID) Returns a report on an SSM collection
java.lang.String[]	getReport(java.lang.String cID, int iStart, int iCount) Returns a subset of an SSM collection
java.lang.String	getSCM(java.lang.String ssmName) Returns the SCM to which the SSM is bound.
void	release(java.lang.String cID) Releases an SSM collection.
void	releaseProviderReport(java.lang.String cID) Releases a provider collection.
void	remove(java.lang.String name) Remove an SSM object from the system.
void	removeProviderInstanceConfiguration(java.lang.String SSM, java.lang.String providername, java.lang.String providerType) Remove a provider from an SSM.
void	removeResourceBinding(java.lang.String SSMName, java.lang.String Resource) Unbind a resource from an SSM.

Methods inherited from class java.lang.Object

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

Method Detail

addResourceBinding

public void addResourceBinding(java.lang.String SSMName,
                               java.lang.String Resource)
                        throws com.wles.blm.BLMException

Bind a resource to an SSM.

Parameters:

SSMName - The name of the SSM to bind the resource to.

Resource - The resource to bind to the SSM

Throws:

com.wles.blm.BLMException

create

public void create(java.lang.String name)
            throws com.wles.blm.BLMException

Create a new unbound SSM object for configuration. This method will create a new SSM object that can then be configured.

Parameters:

name - The name of the SSM to create. This name should be unique

Throws:

com.wles.blm.BLMException

createProviderConfiguration

public SSMProviderManager createProviderConfiguration(java.lang.String SSM,
                                                      java.lang.String providername,
                                                      java.lang.String providerType,
                                                      java.lang.String mgmtinterface)
                                               throws com.wles.blm.BLMException,
                                                      BadParameterException

Create a new provider configuration for an SSM. This method will create a new provider configuration in the system and return a SSMProviderManager to further configure the provider.

Parameters:

SSM - The name of the SSM that this provider will be configured for.

providername - The name of the provider to add.

providerType - The type of provider to add. The provider type can be one of the values defined in the SSMProviderTypes class. For example: ADJUDICATION or AUTHORIZATION.

mgmtinterface - The full name of the management interface associated with this provider. Typically the management interface is the name of the mbean associated with the provider for example, the ASIAdjudicator has a management interface of com.bea.security.providers.authorization.ASIAdjudicator

Returns:

SSMProviderManager An SSMProviderManager for configuring the provider.

Throws:

com.wles.blm.BLMException

BadParameterException

See Also:

SSMProviderManager, SSMProviderTypes

filter

public java.lang.String filter(java.lang.String findPattern)
                        throws com.wles.blm.BLMException

Find a set of SSM's based on a filter pattern. Returns an SSM collection id.

Parameters:

findPattern - Pattern for the filter eg. "*" or "MySSM*"

Returns:

String unique String id to the collection found.

Throws:

com.wles.blm.BLMException

See Also:

getReport(String cID), getReport(String cID, int iStart, int iCount), getCount(String CID), release(String cID), find(String cID, String name)

find

public boolean find(java.lang.String cID,
                    java.lang.String name)
             throws com.wles.blm.BLMException

Checks that an SSM is in an SSM collection. Returns true if given SSM is found in the collection.

Parameters:

cID - collection ID of the collection.

name - Name of the SCM.

Returns:

boolean True if found, false if not.

Throws:

com.wles.blm.BLMException

getBoundResources

public java.lang.String getBoundResources(java.lang.String SSMName)
                                   throws com.wles.blm.BLMException

Find a set of resources bound to a given SSM. Returns a resource collection id. This collection should be used with the BLMApplicationManager's reporting capabilities.

Throws:

com.wles.blm.BLMException

See Also:

BLMApplicationManager.getReport(String cID), BLMApplicationManager.getReport(String cID, int iStart, int iCount), BLMApplicationManager.getCount(String CID), BLMApplicationManager.release(String cID), BLMApplicationManager.find(String cID, String name), BLMApplicationManager

getCount

public int getCount(java.lang.String cID)
             throws com.wles.blm.BLMException

Returns the size of the SSM collection.

Parameters:

cID - ID of the collection, either SSM or provider collection IDs may be used.

Returns:

int size of the collection

Throws:

com.wles.blm.BLMException

getProviderManager

public SSMProviderManager getProviderManager(java.lang.String SSM,
                                             java.lang.String providername,
                                             java.lang.String providerType)
                                      throws com.wles.blm.BLMException

Get a provider instance configuration object to modify an existing provider.

Parameters:

SSM - The name of the SSM the provider is associated with.

providername - The providername to edit.

providerType - The type of provider to add. The provider type can be one of the values defined in the SSMProviderTypes class. For example: SSMProviderTypes.ADJUDICATION. It consists of providertype/.

Returns:

SSMProviderManager

Throws:

com.wles.blm.BLMException

See Also:

SSMProviderManager, SSMProviderTypes

getProviderReport

public SSMProviderManager[] getProviderReport(java.lang.String cID)
                                       throws com.wles.blm.BLMException

Returns a report on a Provider collection

Parameters:

cID - ID of the collection

Returns:

SSMProviderManager[] An array of SSMProviderManagers names from the collection.

Throws:

com.wles.blm.BLMException

See Also:

SSMProviderManager

getProviderReport

public SSMProviderManager[] getProviderReport(java.lang.String cID,
                                              int iStart,
                                              int iCount)
                                       throws com.wles.blm.BLMException

Returns a subset of a provider collection

Parameters:

cID - ID of the collection

iStart - Start index in the providers collection.

iCount - The number of providers.

Returns:

SSMProviderManager[] An array of SSMProviderManagers.

Throws:

com.wles.blm.BLMException

See Also:

SSMProviderManager

getProviders

public java.lang.String getProviders(java.lang.String SSMName)
                              throws com.wles.blm.BLMException

Find a set of providers based on an SSM's name. Returns a provider collection id.

Throws:

com.wles.blm.BLMException

See Also:

getProviderReport(String cID), getProviderReport(String cID, int iStart, int iCount), getCount(String CID), release(String cID)

getReport

public java.lang.String[] getReport(java.lang.String cID)
                             throws com.wles.blm.BLMException

Returns a report on an SSM collection

Parameters:

cID - ID of the collection

Returns:

String[] A String array of SSM names from the collection

Throws:

com.wles.blm.BLMException

getReport

public java.lang.String[] getReport(java.lang.String cID,
                                    int iStart,
                                    int iCount)
                             throws com.wles.blm.BLMException

Returns a subset of an SSM collection

Parameters:

cID - ID of the collection

iStart - Start index in the collection.

iCount - The number of objects.

Returns:

String[] A String array of SSM names from the collection.

Throws:

com.wles.blm.BLMException

getSCM

public java.lang.String getSCM(java.lang.String ssmName)
                        throws com.wles.blm.BLMException

Returns the SCM to which the SSM is bound.

Parameters:

ssmName - name of the SSM. The name should not be fully qualified or contain any prefixes.

Returns:

SCM name to which the SSM is bound or null if the SSM is not bound

Throws:

com.wles.blm.BLMException

release

public void release(java.lang.String cID)
             throws com.wles.blm.BLMException

Releases an SSM collection. Supplying a null collection id will cause all held collections to be released.

Parameters:

cID - ID of the collection

Returns:

void

Throws:

com.wles.blm.BLMException

releaseProviderReport

public void releaseProviderReport(java.lang.String cID)
                           throws com.wles.blm.BLMException

Releases a provider collection. Supplying a null collection id will cause all held collections to be released.

Parameters:

cID - ID of the collection

Returns:

void

Throws:

com.wles.blm.BLMException

remove

public void remove(java.lang.String name)
            throws com.wles.blm.BLMException

Remove an SSM object from the system. The remove method will attempt to unbind any resource bound to the SSM, then unbind it from its SCM, then remove it.

Parameters:

name - The name of the SSM object that should be removed.

Throws:

com.wles.blm.BLMException

removeProviderInstanceConfiguration

public void removeProviderInstanceConfiguration(java.lang.String SSM,
                                                java.lang.String providername,
                                                java.lang.String providerType)
                                         throws com.wles.blm.BLMException

Remove a provider from an SSM.

Parameters:

SSM - The name of the SSM this provider will be removed from.

providername - The providername to remove.

providerType - The type of provider to remove. The provider type can be one of the values defined in the SSMProviderTypes class. For example: SSMProviderTypes.ADJUDICATION.

Returns:

void

Throws:

com.wles.blm.BLMException

See Also:

SSMProviderTypes

removeResourceBinding

public void removeResourceBinding(java.lang.String SSMName,
                                  java.lang.String Resource)
                           throws com.wles.blm.BLMException

Unbind a resource from an SSM.

Parameters:

SSMName - The name of the SSM to unbind the resource from.

Resource - The name of the resource to unbind from the SSM.

Throws:

com.wles.blm.BLMException