com.sun.jbi.util

Class ComponentConfigurationHelper

java.lang.Object

com.sun.jbi.util.ComponentConfigurationHelper

public class ComponentConfigurationHelper
extends Object

This is a utility class to convert a set of properties into application variables or application configuration and vice versa.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURATION_NS Configuration NS
static String	DEFAULT_APP_VAR_TYPE

Constructor Summary

Constructors

Constructor and Description
ComponentConfigurationHelper() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
Properties	convertCompositeDataToProperties(CompositeData cd) Convert a CompositeData to Properties.
CompositeData	convertPropertiesToCompositeData(Properties props, CompositeType appConfigType)
Properties	convertToApplicationVariableProperty(CompositeData appVar) Convert Apllication Variables CompositeData to a set of Properties.
Properties	convertToApplicationVariablesProperties(TabularData appVars) Convert Apllication Variables TabularData to a set of Properties.
TabularData	convertToApplicationVariablesTable(Properties props) Convert a Properties Object to a Application Variable TabularData.
protected String	convertToString(Collection colxn) Convert the objects in the collection to string.
CompositeData	createApplicationVariableComposite(String name, String typeAndValueStr) Create a Application Variable Composite from the passed in name, and the property value string which is of format : [type]value
CompositeData	createApplicationVariableComposite(String name, String value, String type) Create a Application Variable Composite from the passed in name, value and type
String	getActualAttributeName(String name)
String[]	getApplicationVariableItemNames()
CompositeType	getApplicationVariablesType()
TabularType	getApplicationVariableTabularType()
String	getAppVarType(String str, String defStr)
String	getAppVarValue(String str)
boolean	isAppConfigSupported(Document configDoc)
boolean	isAppVarsSupported(Document configDoc)
boolean	isComponentConfigSupported(Document configDoc)
boolean	isPassword(String attributeName, Document configDoc)
boolean	isRequired(String attributeName, Document configDoc)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_APP_VAR_TYPE

public static final String DEFAULT_APP_VAR_TYPE

See Also:

Constant Field Values

CONFIGURATION_NS

public static final String CONFIGURATION_NS

Configuration NS

See Also:

Constant Field Values

Constructor Detail

ComponentConfigurationHelper

public ComponentConfigurationHelper()

Constructor

Method Detail

getApplicationVariablesType

public CompositeType getApplicationVariablesType()

Returns:

the CompositeType for Application Variables.

getApplicationVariableTabularType

public TabularType getApplicationVariableTabularType()

Returns:

the Application Variables Tabular Type

getApplicationVariableItemNames

public String[] getApplicationVariableItemNames()

Returns:

the application variables item names

convertToApplicationVariablesTable

public TabularData convertToApplicationVariablesTable(Properties props)
                                               throws Exception

Convert a Properties Object to a Application Variable TabularData. The property name is the name of the Property and the value is of the Pattern "[type]value"

Parameters:

props - - the properties to convert to TabularData.

Returns:

the TabularData constructed from the Properties

Throws:

Exception

convertToApplicationVariablesProperties

public Properties convertToApplicationVariablesProperties(TabularData appVars)
                                                   throws Exception

Convert Apllication Variables TabularData to a set of Properties.

Throws:

Exception

convertToApplicationVariableProperty

public Properties convertToApplicationVariableProperty(CompositeData appVar)
                                                throws Exception

Convert Apllication Variables CompositeData to a set of Properties.

Parameters:

appVar - - application variable composite

Throws:

Exception

createApplicationVariableComposite

public CompositeData createApplicationVariableComposite(String name,
                                               String value,
                                               String type)
                                                 throws Exception

Create a Application Variable Composite from the passed in name, value and type

Parameters:

name - - the name

type - - the type string

value - - the value

Returns:

the CompositeData constructed from the parameters

Throws:

Exception

createApplicationVariableComposite

public CompositeData createApplicationVariableComposite(String name,
                                               String typeAndValueStr)
                                                 throws Exception

Create a Application Variable Composite from the passed in name, and the property value string which is of format : [type]value

Parameters:

name - - the name

typeAndValueStr - - string which is of format : [type]value

Returns:

the CompositeData constructed from the parameters

Throws:

Exception

getAppVarType

public String getAppVarType(String str,
                   String defStr)
                     throws Exception

Returns:

the "type" from the "[type]value" string.

Throws:

Exception

getAppVarValue

public String getAppVarValue(String str)
                      throws Exception

Returns:

the "value" from the "[type]value" string.

Throws:

Exception

convertCompositeDataToProperties

public Properties convertCompositeDataToProperties(CompositeData cd)

Convert a CompositeData to Properties.

Parameters:

cd - the composite data to convert to Properties

Returns:

the properties representation of the CompositeData

convertPropertiesToCompositeData

public CompositeData convertPropertiesToCompositeData(Properties props,
                                             CompositeType appConfigType)
                                               throws Exception

Parameters:

props - the properties to convert to a CompositeType

appConfigType - application configuration CompositeType

Throws:

Exception - if the properties cannot be completely mapped into the CompositeType

isPassword

public boolean isPassword(String attributeName,
                 Document configDoc)
                   throws Exception

Parameters:

attributeName - - name of the property

configDoc - - configuration xml document

Returns:

true if a component configuration attribute is a passwordfiled

Throws:

Exception

isRequired

public boolean isRequired(String attributeName,
                 Document configDoc)
                   throws Exception

Parameters:

attributeName - - name of the property

configDoc - - configuration xml document

Returns:

true if a component configuration attribute is a required field

Throws:

Exception

isComponentConfigSupported

public boolean isComponentConfigSupported(Document configDoc)

Parameters:

configDoc - - configuration xml document

Returns:

true if the components configuration document declares support for component configuration attributes

isAppVarsSupported

public boolean isAppVarsSupported(Document configDoc)

Parameters:

configDoc - - configuration xml document

Returns:

true if the components configuration document declares support for application variables

isAppConfigSupported

public boolean isAppConfigSupported(Document configDoc)

Parameters:

configDoc - - configuration xml document

Returns:

true if the components configuration document declares support for application configuration

getActualAttributeName

public String getActualAttributeName(String name)

convertToString

protected String convertToString(Collection colxn)

Convert the objects in the collection to string.

Parameters:

set - a non-empty set