com.sonicsw.esb.mgmtapi.config
Interface IContainerConfig

All Superinterfaces:

IBaseConfig

public interface IContainerConfig
extends IBaseConfig

A container holds service instances and deployed processes. The methods in this interface allow the user to manipulate both the container configuration, and the set of services and configurations deployed within it . Note: since multiple ESB containers in an MF container are supported, but not the distinction between MF and ESB containers is not fully exposed in this API, the following are not exposed: Deployment parameters, JVM args, working directory. To modify any of the aforementioned values com.sonicsw.mf.mgmtapi.config.impl.ContainerBean and related API's must be used.

Method Summary

void	addProcess(IProcessConfig process, int listeners) Deploy a process into this container.
void	addService(IServiceApplicationConfig config) Deploy a service or process into this container (Advanced Use).
void	addService(java.lang.String name, int listeners) Deploy a service into this container.
IActionalConfig	getActionalConfig() Retrieve the Actional related configuration.
java.lang.String	getArchiveName() Get the archive name containing the container implementation (Advanced use!).
java.lang.String[]	getClasspathElements() Get the prepend classpath elements.
java.lang.String	getHTTPDefaultConnection() Get the connection name used by the container for HTTP requests.
IConnectionConfig	getHTTPDefaultConnectionConfig() Get the connection configuration used by the container for HTTP requests.
java.lang.String	getJMSDefaultConnection() Get the Bus connection name used by the container.
IConnectionConfig	getJMSDefaultConnectionConfig() Get the Bus connection configuration used by the container.
java.lang.String	getLog4jConfiguration() Get the optional log4j configuration.
java.lang.String[]	getProcessNames()
IServiceApplicationConfig	getService(java.lang.String name) Retrieve the configuration for a particular service or process deployed in the container.
java.lang.String[]	getServiceNames()
java.lang.String	getSpringConfiguration() Get the optional spring configuration files.
java.lang.String	getXQContainerName()
boolean	removeProcess(java.lang.String processName) Remove a deployed process from the container.
boolean	removeService(java.lang.String serviceConfigName) Remove a deployed service from the container.
void	setActionalConfig(IActionalConfig actionalConfig) Set the Actional related configuration.
void	setArchiveName(java.lang.String name) Set the archive name containing the container implementation (Advanced use!).
void	setClasspathElements(java.lang.String[] classpath) Set (in an ordered list) the container wide configured classpath entries.
void	setHTTPDefaultConnection(java.lang.String connectionName) Set the connection configuration use by the container for HTTP requests.
void	setHTTPDefaultConnectionConfig(IConnectionConfig connectionConfig) Set the connection configuration use by the container for HTTP requests.
void	setJMSDefaultConnection(java.lang.String connectionName) Set the Bus connection name for the container.
void	setJMSDefaultConnectionConfig(IConnectionConfig connectionConfig) Set the Bus connection configuration for the container.
void	setLog4jConfiguration(java.lang.String name) Set the optional log4j configuration.
void	setSpringConfiguration(java.lang.String config) Set the optional spring configuration files.
void	setUseIntraContainer(boolean uic) Enable or disable intra-container messaging.
boolean	useIntraContainer() Get if if intra-container messaging is enabled.

Methods inherited from interface com.sonicsw.esb.mgmtapi.config.IBaseConfig

getName, getType

Method Detail

getClasspathElements

java.lang.String[] getClasspathElements()

Get the prepend classpath elements.

Returns:

an ordered list of container wide configured classpath entries

setClasspathElements

void setClasspathElements(java.lang.String[] classpath)

Set (in an ordered list) the container wide configured classpath entries.

getArchiveName

java.lang.String getArchiveName()

Get the archive name containing the container implementation (Advanced use!).

Returns:

the archive name.

setArchiveName

void setArchiveName(java.lang.String name)

Set the archive name containing the container implementation (Advanced use!).

useIntraContainer

boolean useIntraContainer()

Get if if intra-container messaging is enabled.

Returns:

true if intra-container messaging is enabled. False otherwise.

setUseIntraContainer

void setUseIntraContainer(boolean uic)

Enable or disable intra-container messaging.

Parameters:

uic -

getActionalConfig

IActionalConfig getActionalConfig()

Retrieve the Actional related configuration.

setActionalConfig

void setActionalConfig(IActionalConfig actionalConfig)

Set the Actional related configuration.

getJMSDefaultConnection

java.lang.String getJMSDefaultConnection()

Get the Bus connection name used by the container.

Returns:

the Bus connection name used by the container

setJMSDefaultConnection

void setJMSDefaultConnection(java.lang.String connectionName)

Set the Bus connection name for the container.

getJMSDefaultConnectionConfig

IConnectionConfig getJMSDefaultConnectionConfig()

Get the Bus connection configuration used by the container.

Returns:

the Bus connection configuration used by the container

setJMSDefaultConnectionConfig

void setJMSDefaultConnectionConfig(IConnectionConfig connectionConfig)

Set the Bus connection configuration for the container.

getHTTPDefaultConnection

java.lang.String getHTTPDefaultConnection()

Get the connection name used by the container for HTTP requests.

Returns:

the connection name used by the container for HTTP requests.

setHTTPDefaultConnection

void setHTTPDefaultConnection(java.lang.String connectionName)

Set the connection configuration use by the container for HTTP requests.

getHTTPDefaultConnectionConfig

IConnectionConfig getHTTPDefaultConnectionConfig()

Get the connection configuration used by the container for HTTP requests.

Returns:

the connection configuration used by the container for HTTP requests.

setHTTPDefaultConnectionConfig

void setHTTPDefaultConnectionConfig(IConnectionConfig connectionConfig)

Set the connection configuration use by the container for HTTP requests.

getXQContainerName

java.lang.String getXQContainerName()

Returns:

the container name

getServiceNames

java.lang.String[] getServiceNames()

Returns:

an array containing the names of all services deployed in the container

getProcessNames

java.lang.String[] getProcessNames()

Returns:

an array containing the names of all processes deployed in the container

getService

IServiceApplicationConfig getService(java.lang.String name)

Retrieve the configuration for a particular service or process deployed in the container.

Parameters:

name - the service's or processe's name

Returns:

a configuration record for the service/process deployment.

addService

void addService(IServiceApplicationConfig config)

Deploy a service or process into this container (Advanced Use).

Parameters:

config - - the deployment configuration.

addService

void addService(java.lang.String name,
                int listeners)

Deploy a service into this container.

Parameters:

name - - the service instance's name

listeners - - the number of instances for the service

addProcess

void addProcess(IProcessConfig process,
                int listeners)

Deploy a process into this container. The process must have a configured entry endpoint.

Parameters:

process - - the processe's configuration

listeners - - the number of instances for the service

removeService

boolean removeService(java.lang.String serviceConfigName)

Remove a deployed service from the container.

Parameters:

serviceConfigName - - the service's name

Returns:

true if removed, false if it wasn't present.

removeProcess

boolean removeProcess(java.lang.String processName)

Remove a deployed process from the container.

Parameters:

processName - - the process's name

Returns:

true if removed, false if it wasn't present.

getSpringConfiguration

java.lang.String getSpringConfiguration()

Get the optional spring configuration files.

Returns:

A ';' delimited list of spring bean configuration files (.properties or XML) that will be applied in order to the container's application context

setSpringConfiguration

void setSpringConfiguration(java.lang.String config)

Set the optional spring configuration files.

Parameters:

config - - A ';' delimited list of spring bean configuration files (.properties or XML) that will be applied in order to the container's application context

getLog4jConfiguration

java.lang.String getLog4jConfiguration()

Get the optional log4j configuration.

Returns:

the URL for the container's log4j configuration file

setLog4jConfiguration

void setLog4jConfiguration(java.lang.String name)

Set the optional log4j configuration.

Parameters:

name - - the log4j configuration file URL