com.wles.blm
Class SCMManager

java.lang.Object
  com.wles.blm.SCMManager

public class SCMManager

extends java.lang.Object

Manages all operations on SCMs. In addition to creating and deleting SCM's, the SCM manager will also bind and unbind SSMs to an SCM.... Use the BLMContextManager to obtain an instance of an SCMManager.

See Also:

BLMContextManager

Method Summary

void	addConfigurationBinding(java.lang.String SCMName, java.lang.String SSMName) Binds an SSM to an SCM.
void	create(java.lang.String name) Creates a new SCM.
int	distributeConfiguration(java.lang.String[] SSMNames, PolicyAvailableForEnum returnWhen) Distributes the configuration for a given SSM.
java.lang.String	filter(java.lang.String filterPattern) Finds a set of SCM's based on a filter pattern.
boolean	find(java.lang.String name) Checks that an SCM is in the policy store..
java.lang.String	getBoundSSMs(java.lang.String SCMName) Finds all SSMs bound to a specified SCM.
int	getCount(java.lang.String cID) Returns the size of the SCM collection.
java.lang.String[]	getReport(java.lang.String cID) Returns a report on an SCM collection
java.lang.String[]	getReport(java.lang.String cID, int iStart, int iCount) Returns a subset of an SCM collection
java.lang.String	getUnboundSSMs() Finds all unbound SSMs.
void	release(java.lang.String cID) Releases the SCM collection.
void	remove(java.lang.String name) Removes an SCM and unbinds any SSM's bound to it.
void	removeConfigurationBinding(java.lang.String SCMName, java.lang.String SSMName) Unbinds an SSM from an SCM.

Methods inherited from class java.lang.Object

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

Method Detail

addConfigurationBinding

public void addConfigurationBinding(java.lang.String SCMName,
                                    java.lang.String SSMName)
                             throws com.wles.blm.BLMException

Binds an SSM to an SCM.

Parameters:

SCMName - The name of an existing SCM.

SSMName - The name of an existing SSM.

Returns:

void

Throws:

BLMException

create

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

Creates a new SCM. This method will create a new SCM that can be used to bind SSM's to.

Parameters:

name - Unique name of an SCM to create.

Returns:

void

Throws:

com.wles.blm.BLMException

distributeConfiguration

public int distributeConfiguration(java.lang.String[] SSMNames,
                                   PolicyAvailableForEnum returnWhen)
                            throws com.wles.blm.BLMException

Distributes the configuration for a given SSM. The value of null will distribute all SSM configurations. Returns a distribution id that should be used with the BLMPolicyDistributor to check the distribution status

Parameters:

SSMNames - String array containing an SSMname per element to distribute.

returnWhen - specifies how long the call will block, one of: PolicyAvailableForEnum.READ, PolicyAvailableForEnum.WRITE, PolicyAvailableForEnum.DISTRIBUTE. The value of null will distribute for all SSMs.

Returns:

int a distribution Id.

Throws:

BLMException

filter

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

Finds a set of SCM's based on a filter pattern. Returns a SCM collection id.

Parameters:

filterPattern - Pattern for the filter eg. "*" or "MySCM*"

Returns:

String unique String id to the collection found.

Throws:

BLMException

See Also:

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

find

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

Checks that an SCM is in the policy store..

Parameters:

name - Name of the SCM.

Returns:

boolean

Throws:

BLMException

getBoundSSMs

public java.lang.String getBoundSSMs(java.lang.String SCMName)
                              throws com.wles.blm.BLMException

Finds all SSMs bound to a specified SCM. Returns a SSM collection ID. This collection should be used with the SSMConfigurationManager's report method.

Parameters:

SCMName - The name of the SCM to search for bound SSMs

Returns:

String Unique collection ID.

Throws:

BLMException.

com.wles.blm.BLMException

See Also:

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

getCount

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

Returns the size of the SCM collection.

Parameters:

cID - ID of the collection.

Returns:

int The size of the collection

Throws:

BLMException

getReport

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

Returns a report on an SCM collection

Parameters:

cID - ID of the collection

Returns:

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

Throws:

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 SCM collection

Parameters:

cID - ID of the collection

iStart - Start index in the collection.

iCount - The number of objects.

Returns:

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

Throws:

BLMException

getUnboundSSMs

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

Finds all unbound SSMs. Returns a SSM collection ID. This collection should be used with the SSMConfigurationManager's report method.

Returns:

String Unique collection ID.

Throws:

BLMException.

com.wles.blm.BLMException

See Also:

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

release

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

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

Parameters:

cID - ID of the collection

Returns:

void

Throws:

BLMException

remove

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

Removes an SCM and unbinds any SSM's bound to it.

Parameters:

name - The name of the SCM to remove.

Returns:

void

Throws:

BLMException

removeConfigurationBinding

public void removeConfigurationBinding(java.lang.String SCMName,
                                       java.lang.String SSMName)
                                throws com.wles.blm.BLMException

Unbinds an SSM from an SCM.

Parameters:

SCMName - The name of an existing SCM.

SSMName - The name of an existing SSM bound to the SCM passed in.

Returns:

void

Throws:

BLMException