com.sonicsw.esb.mgmtapi.config
Interface IContainerConfigAPI

public interface IContainerConfigAPI

This interface provides a collection of methods to manipulate and query containers configured in the ESB domain.

Method Summary

void	addESBContainerToMFContainer(java.lang.String mfContainerName, java.lang.String ESBContaienrName) add an ESB container to the MF container identified by name
IContainerConfig	createESBContainer(java.lang.String name) Create a new XQ Container configuration
void	deleteESBContainer(java.lang.String name) Delete the specified XQ Container from the dS
java.lang.String	exportESBContainer(java.lang.String name) Export the specified ESBContainer configuration
IContainerConfig	getESBContainer(java.lang.String name) Retrieve the configuration details for a given ESB container.
IContainerBean	getMFContainer(java.lang.String name) Retrieve the Management Bean for a given MF container.
IContainerConfig	importESBContainer(java.lang.String configurationContent, boolean overwrite) Import the specified ESB Container configuration into the DS
java.lang.String[]	listESBContainers() List the names of all known ESB Containers.
java.lang.String[]	listESBContainersInMFContainer(java.lang.String mfContainerName) list the ESB containers configured in the MF container
java.lang.String[]	listMFContainerLogicalIDsWithESBContainer(java.lang.String ESBContainerName) list logical IDs of all the MF containers an ESB container is deployed in.
java.lang.String[]	listMFContainersWithESBContainer(java.lang.String ESBContainerName) list the names of all MF containers an ESB container is deployed in.
void	removeESBContainerFromMFContainer(java.lang.String mfContainerName, java.lang.String ESBContaienrName) Remove an ESB container from the MF container identified by name
void	saveESBContainer(IContainerConfig container) save the changes applied to the container configuration.

Method Detail

createESBContainer

IContainerConfig createESBContainer(java.lang.String name)

Create a new XQ Container configuration

Parameters:

name - The name for the XQ Container

Returns:

A new XQ Container configuration structure

deleteESBContainer

void deleteESBContainer(java.lang.String name)

Delete the specified XQ Container from the dS

Parameters:

name - The name of the ESB Container

importESBContainer

IContainerConfig importESBContainer(java.lang.String configurationContent,
                                    boolean overwrite)

Import the specified ESB Container configuration into the DS

Parameters:

configurationContent - - the XML representation of an ESB configuration. use utility classes to retreive for external storage.

exportESBContainer

java.lang.String exportESBContainer(java.lang.String name)

Export the specified ESBContainer configuration

Parameters:

name - - the container name to be exported.

Returns:

the XML representation of an ESB configuration.

listESBContainers

java.lang.String[] listESBContainers()

List the names of all known ESB Containers.

Returns:

an array of strings, each representing the name of an ESB Container.

getESBContainer

IContainerConfig getESBContainer(java.lang.String name)

Retrieve the configuration details for a given ESB container.

Parameters:

name - the ESB container's name

Returns:

an object representing the containre's configuration.

getMFContainer

IContainerBean getMFContainer(java.lang.String name)

Retrieve the Management Bean for a given MF container. Some configuration elements relating to a deployed ESB container can only be performed by interacting with the MF container.

Parameters:

name - - the MF container's logical ID

Returns:

a Configuration Bean representing the container.

saveESBContainer

void saveESBContainer(IContainerConfig container)

save the changes applied to the container configuration.

Parameters:

container - - the container to be saved

addESBContainerToMFContainer

void addESBContainerToMFContainer(java.lang.String mfContainerName,
                                  java.lang.String ESBContaienrName)

add an ESB container to the MF container identified by name

Parameters:

mfContainerName - - the MF container full path (e.g /Containers/dev_ESBCore). The name must start with a / character. If not existing, a new one is created

ESBContaienrName - - the ESB container's name. Must exist

removeESBContainerFromMFContainer

void removeESBContainerFromMFContainer(java.lang.String mfContainerName,
                                       java.lang.String ESBContaienrName)

Remove an ESB container from the MF container identified by name

Parameters:

mfContainerName - - the MF container full path (e.g /Containers/dev_ESBCore). The name must start with a / character. The MF container must exist

ESBContaienrName - - the ESB container name. Must be in the MF container

listESBContainersInMFContainer

java.lang.String[] listESBContainersInMFContainer(java.lang.String mfContainerName)

list the ESB containers configured in the MF container

Parameters:

mfContainerName - the mf Container logical ID to inspect

Returns:

an array of ESB container names which are deployed in the MF container

listMFContainersWithESBContainer

java.lang.String[] listMFContainersWithESBContainer(java.lang.String ESBContainerName)

list the names of all MF containers an ESB container is deployed in.

Parameters:

ESBContainerName - - the ESB container to search for

Returns:

an array of MF container names in which the ESB container is deployed in.

listMFContainerLogicalIDsWithESBContainer

java.lang.String[] listMFContainerLogicalIDsWithESBContainer(java.lang.String ESBContainerName)

list logical IDs of all the MF containers an ESB container is deployed in.

Parameters:

ESBContainerName - - the ESB container to search for

Returns:

an array of MF container names in which the ESB container is deployed in.