it.imolinfo.jbi4corba.jbi.component.runtime
Interface RuntimeConfigurationMBean

All Known Implementing Classes:

RuntimeConfiguration

public interface RuntimeConfigurationMBean

MBean interface for run-time configuration

Field Summary

static String	CONFIG_APPLICATION_CONFIGURATIONS
static String	CONFIG_THREADS

Method Summary

void	addApplicationConfiguration(String name, CompositeData appConfig) Add an application configuration.
void	addApplicationVariable(String name, CompositeData appVar) This operation adds a new applicationvariable.
int	countVariables()
void	deleteApplicationConfiguration(String name) Delete an application configuration.
void	deleteApplicationVariable(String name) This operation deletes an application variable, if a variable with the specified name does not exist, it's an error.
TabularData	getApplicationConfigurations() Get a Map of all application configurations for the component.
TabularData	getApplicationVariables() Get the Application Variable set for a component.
Integer	getOutboundThreads()
CompositeType	queryApplicationConfigurationType() Get the CompositeType definition for the components application configuration
Map	retrieveApplicationConfigurationsMap() Retrieves the application configuration map.
Map<String,String[]>	retrieveApplicationVariablesMap() Retrieves the application variables map.
String	retrieveConfigurationDisplayData() Retrieves the Configuration Display Data
String	retrieveConfigurationDisplaySchema() Retrieves the Configuration Display Schema
void	setApplicationConfiguration(String name, CompositeData appConfig) Update a application configuration.
void	setApplicationVariable(String name, CompositeData appVar) This operation sets an application variable.
void	setOutboundThreads(Integer val)
void	updateApplicationConfigurationsMap(Map val) Updates the application configuration map.
void	updateApplicationVariablesMap(Map<String,String[]> map) Updates the application variable map.

Field Detail

CONFIG_THREADS

static final String CONFIG_THREADS

See Also:

Constant Field Values

CONFIG_APPLICATION_CONFIGURATIONS

static final String CONFIG_APPLICATION_CONFIGURATIONS

See Also:

Constant Field Values

Method Detail

getOutboundThreads

Integer getOutboundThreads()

setOutboundThreads

void setOutboundThreads(Integer val)
                        throws InvalidAttributeValueException,
                               MBeanException

Throws:

InvalidAttributeValueException

MBeanException

queryApplicationConfigurationType

CompositeType queryApplicationConfigurationType()

Get the CompositeType definition for the components application configuration

Returns:

the CompositeType for the components application configuration.

addApplicationConfiguration

void addApplicationConfiguration(String name,
                                 CompositeData appConfig)
                                 throws InvalidAttributeValueException,
                                        MBeanException

Add an application configuration. The configuration name is a part of the CompositeData. The itemName for the configuration name is "configurationName" and the type is SimpleType.STRING

Parameters:

name - - configuration name, must match the value of the field "name" in the namedConfig

appConfig - - application configuration composite

Throws:

MBeanException - if the application configuration cannot be added.

InvalidAttributeValueException

deleteApplicationConfiguration

void deleteApplicationConfiguration(String name)
                                    throws MBeanException

Delete an application configuration.

Parameters:

name - - identification of the application configuration to be deleted

Throws:

MBeanException - if the configuration cannot be deleted.

setApplicationConfiguration

void setApplicationConfiguration(String name,
                                 CompositeData appConfig)
                                 throws InvalidAttributeValueException,
                                        MBeanException

Update a application configuration. The configuration name is a part of the CompositeData. The itemName for the configuration name is "configurationName" and the type is SimpleType.STRING

Parameters:

name - - configuration name, must match the value of the field "configurationName" in the appConfig

appConfig - - application configuration composite

Throws:

MBeanException - if there are errors encountered when updating the configuration.

InvalidAttributeValueException

getApplicationConfigurations

TabularData getApplicationConfigurations()

Get a Map of all application configurations for the component.

Returns:

a TabularData of all the application configurations for a component keyed by the configuration name.

retrieveApplicationConfigurationsMap

Map retrieveApplicationConfigurationsMap()

Retrieves the application configuration map. The map key is the configuration name, the value is a String representing a HTTP URL. This method is used to communicate application configuration data within the component and is not intended for MBean clients.

Returns:

a Map containing application configuration information

updateApplicationConfigurationsMap

void updateApplicationConfigurationsMap(Map val)
                                        throws MBeanException

Updates the application configuration map. This method is used to communicate application configuration data within the component, and not intended for MBean clients

Parameters:

a - Map containing application variable information

Throws:

MBeanException

retrieveApplicationVariablesMap

Map<String,String[]> retrieveApplicationVariablesMap()

Retrieves the application variables map. The map key is the application variable name, the value is a String[] containing detailed information about the application variable. This method is used to communicate application variable data with in the component and is not intended for MBean clients

Returns:

a Map containing application variable information

updateApplicationVariablesMap

void updateApplicationVariablesMap(Map<String,String[]> map)
                                   throws MBeanException

Updates the application variable map. This method is used to communicate application configuration data within the component, and not intended for MBean clients

Parameters:

a - Map containing application variable information

Throws:

MBeanException

countVariables

int countVariables()

addApplicationVariable

void addApplicationVariable(String name,
                            CompositeData appVar)
                            throws MBeanException

This operation adds a new applicationvariable. If a variable already exists with the same name as that specified then the operation fails.

Parameters:

name - - name of the application variable

appVar - - this is the application variable compoiste

Throws:

MBeanException - if an error occurs in adding the application variables to the component.

setApplicationVariable

void setApplicationVariable(String name,
                            CompositeData appVar)
                            throws MBeanException

This operation sets an application variable. If a variable does not exist with the same name, its an error.

Parameters:

name - - name of the application variable

appVar - - this is the application variable compoiste to be updated.

Throws:

MBeanException - if one or more application variables cannot be deleted

deleteApplicationVariable

void deleteApplicationVariable(String name)
                               throws MBeanException

This operation deletes an application variable, if a variable with the specified name does not exist, it's an error.

Parameters:

name - - name of the application variable

Throws:

MBeanException - on errors.

getApplicationVariables

TabularData getApplicationVariables()

Get the Application Variable set for a component.

Returns:

a TabularData which has all the applicationvariables set on the component.

retrieveConfigurationDisplaySchema

String retrieveConfigurationDisplaySchema()

Retrieves the Configuration Display Schema

retrieveConfigurationDisplayData

String retrieveConfigurationDisplayData()

Retrieves the Configuration Display Data