com.sonicsw.esb.mgmtapi.config
Interface IProcessConfigAPI

public interface IProcessConfigAPI

A collection of methods to manipulate Process related artifacts.

Method Summary

void	deleteProcess(java.lang.String name)
java.lang.String	exportProcess(java.lang.String name)
IProcessConfig	getProcess(java.lang.String name)
IProcessConfig	importProcess(java.lang.String configurationContent, boolean overwrite)
java.lang.String[]	listDeployedContainers(java.lang.String processName) Search in the configured containers for deployed instances of the given process name.
java.lang.String[]	listProcesses()
void	saveProcess(IProcessConfig process) Persist changes made to the process into the DS.

Method Detail

listProcesses

java.lang.String[] listProcesses()

Returns:

an array with all the names of defined processes

getProcess

IProcessConfig getProcess(java.lang.String name)

Parameters:

name - the process's name

Returns:

a configuration object representing the process

deleteProcess

void deleteProcess(java.lang.String name)

Parameters:

name - - the process's name to be deleted

importProcess

IProcessConfig importProcess(java.lang.String configurationContent,
                             boolean overwrite)

Parameters:

configurationContent - the XML representation of the configuration. use utility classes to retrieve from external storage.

overwrite - - should existing configuration with same name be overwritten ? false - leave alone, true - overwrite

Returns:

the configuration object just imported

exportProcess

java.lang.String exportProcess(java.lang.String name)

Parameters:

name - the process's name to be exported

Returns:

XML representation of the configuration. use utility classes to retrieve from external storage. Use utility classes to persist to destination.

saveProcess

void saveProcess(IProcessConfig process)

Persist changes made to the process into the DS.

Parameters:

process - - the process to be persisted

listDeployedContainers

java.lang.String[] listDeployedContainers(java.lang.String processName)

Search in the configured containers for deployed instances of the given process name.

Parameters:

processName - - the process to search for

Returns:

an array of container names into which the specified process is deployed. This set might be empty if the process is not deployed into containers, but rather invoked using its Process address (as opposed to explicit endpoints)