com.wles.blm
Class SSMProviderManager

java.lang.Object
  com.wles.blm.SSMProviderManager

public class SSMProviderManager

extends java.lang.Object

Manages all operations on a single provider object.

Method Summary

java.lang.String	getProperties() Get a list of all properties currently set for this provider.
SSMProviderConfigElement	getProperty(java.lang.String propname) Get a provider propert to operate on.
SSMProviderConfigElement[]	getPropertyReport(java.lang.String cID) Returns a report on a provider properties collection.
SSMProviderConfigElement[]	getPropertyReport(java.lang.String cID, int iStart, int iCount) Returns a subset of a provider properties collection.
java.lang.String	getProviderName() Return the name of the provider.
java.lang.String	getProviderType() Return the string representation of the provider type.
void	release(java.lang.String cID) Releases an SSM collection.
void	removeProperty(java.lang.String prop) Remove a configuration property for this provider.
void	setProperty(SSMProviderConfigElement config) Set a configuration property for this particular provider.

Methods inherited from class java.lang.Object

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

Method Detail

getProperties

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

Get a list of all properties currently set for this provider. If a property has not yet been set it will use it's default value and not be returned in the BLMConfigElemet list. Provider properties are documented in the Programming Adminstration Reference document.

Returns:

String unique String id to the collection found.

Throws:

BLMException

getProperty

public SSMProviderConfigElement getProperty(java.lang.String propname)
                                     throws com.wles.blm.BLMException,
                                            BadParameterException

Get a provider propert to operate on.

Parameters:

propname - The name of the property you want.

Returns:

SSMProviderConfigElement.

Throws:

BLMException

BadParameterException

See Also:

SSMProviderConfigElement

getPropertyReport

public SSMProviderConfigElement[] getPropertyReport(java.lang.String cID)
                                             throws com.wles.blm.BLMException,
                                                    BadParameterException

Returns a report on a provider properties collection. Attributes that have not been set in the system will use their default values and not be displayed in the system. Provider properties are documented in the Programming Administration Reference document.

Parameters:

cID - ID of the collection

Returns:

SSMProviderConfigElement[] An array of SSMProviderConfigElement objects.

Throws:

BLMException

BadParameterException

getPropertyReport

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

Returns a subset of a provider properties collection. Attributes that have not been set in the system will use their default values and not be displayed in the system. Provider properties are documented in the Programming Administration Reference document.

Parameters:

cID - ID of the collection

iStart - Start index in the collection.

iCount - The number of objects.

Returns:

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

Throws:

BLMException

BadParameterException

getProviderName

public java.lang.String getProviderName()

Return the name of the provider.

Returns:

String The name of the provider

getProviderType

public java.lang.String getProviderType()

Return the string representation of the provider type. These same representations can be found in the ProviderTypes object.

Returns:

String The type of provider.

See Also:

SSMProviderTypes

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:

BLMException

removeProperty

public void removeProperty(java.lang.String prop)
                    throws com.wles.blm.BLMException,
                           BadParameterException

Remove a configuration property for this provider. This property will be reset to its default value.

Parameters:

prop - The name of the property to remove

Returns:

void

Throws:

BLMException

BadParameterException

setProperty

public void setProperty(SSMProviderConfigElement config)
                 throws com.wles.blm.BLMException,
                        BadParameterException

Set a configuration property for this particular provider. The properties for each provider are documented in the Programming Administration Reference.

Parameters:

config - A populated configuration element to set for this provider.

Returns:

void

Throws:

BLMException

BadParameterException