com.sonicsw.esb.mgmtapi.config
Interface IEndpointConfigAPI

public interface IEndpointConfigAPI

A collection of methods to manipulate Endpoints and Connections.

Method Summary

IConnectionConfig	createConnectionConfig(java.lang.String name) Create a new un-configured connection configuration.
IEndpointConfig	createEndpoint(java.lang.String name) Create a new Endpoint configuration
void	deleteConnectionConfig(java.lang.String name) Delete the given connection configuration.
void	deleteEndpoint(java.lang.String name) Delete the specified endpoint from the dS
java.lang.String	exportConnection(java.lang.String name) Export the specified connection configuration
java.lang.String	exportEndpoint(java.lang.String name) Export the specified endpoint configuration
IConnectionConfig	getConnectionConfig(java.lang.String name)
java.lang.String[]	getContainersUsingConection(java.lang.String name) Retrieve a list of all the containers configured to use the named connection as one of their connections (i.e.
IEndpointConfig	getEndpoint(java.lang.String name) Retrieve the configuration details for a given endpoint.
java.lang.String[]	getEndpointsUsingConnection(java.lang.String name) Retrieve a list of all the endpoints configured to use the named connection.
IConnectionConfig	importConnection(java.lang.String configurationContent, boolean overwrite) Import the specified connection configuration into the DS
IEndpointConfig	importEndpoint(java.lang.String configurationContent, boolean overwrite) Import the specified endpoint configuration into the DS
java.lang.String[]	listConnections() List the define connection configurations' names
IConnectionConfig.ConnectionType[]	listConnectionTypes()
java.lang.String[]	listEndpoints() List the names of all known endpoints
void	saveConnection(IConnectionConfig connection) Persist the changes made to the connection configuration.
void	saveEndpoint(IEndpointConfig endpoint) Persist the changes made to the endpoint.

Method Detail

createEndpoint

IEndpointConfig createEndpoint(java.lang.String name)

Create a new Endpoint configuration

Parameters:

name - The name for the Endpoint

Returns:

A new Endpoint configuration structure

deleteEndpoint

void deleteEndpoint(java.lang.String name)

Delete the specified endpoint from the dS

Parameters:

name - The name of the endpoint to be deleted

importEndpoint

IEndpointConfig importEndpoint(java.lang.String configurationContent,
                               boolean overwrite)

Import the specified endpoint configuration into the DS

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

exportEndpoint

java.lang.String exportEndpoint(java.lang.String name)

Export the specified endpoint configuration

Parameters:

name - - the endpoint name to be exported.

Returns:

the XML representation of an XQ configuration.

saveEndpoint

void saveEndpoint(IEndpointConfig endpoint)

Persist the changes made to the endpoint.

Parameters:

endpoint - the endpoint to be persisted

listEndpoints

java.lang.String[] listEndpoints()

List the names of all known endpoints

Returns:

an array of strings, each representing the name of an endpoint

getEndpoint

IEndpointConfig getEndpoint(java.lang.String name)

Retrieve the configuration details for a given endpoint.

Parameters:

name - the endpoint's name to be fetched

Returns:

the requested endpoint

listConnectionTypes

IConnectionConfig.ConnectionType[] listConnectionTypes()

Returns:

An array of the supported connection types.

listConnections

java.lang.String[] listConnections()

List the define connection configurations' names

Returns:

all configured connections' names

getConnectionConfig

IConnectionConfig getConnectionConfig(java.lang.String name)

Parameters:

name - - the desired connection configuration's name

Returns:

an object representing the connection configuration.

deleteConnectionConfig

void deleteConnectionConfig(java.lang.String name)

Delete the given connection configuration. No validation is performed - if any entities (e.g. endpoints, containers) are using the connection for their definition, the system configuration might be compromised.

Parameters:

name - - the configuraion's name which is to be deleted.

importConnection

IConnectionConfig importConnection(java.lang.String configurationContent,
                                   boolean overwrite)

Import the specified connection configuration into the DS

Parameters:

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

exportConnection

java.lang.String exportConnection(java.lang.String name)

Export the specified connection configuration

Parameters:

name - - the connection name to be exported.

Returns:

the XML representation of a the configuration.

saveConnection

void saveConnection(IConnectionConfig connection)

Persist the changes made to the connection configuration.

Parameters:

connection - the connection to be persisted

createConnectionConfig

IConnectionConfig createConnectionConfig(java.lang.String name)

Create a new un-configured connection configuration.

Parameters:

name - - the name to be assigned to this configuration.

Returns:

the named connection configuraiton

getContainersUsingConection

java.lang.String[] getContainersUsingConection(java.lang.String name)

Retrieve a list of all the containers configured to use the named connection as one of their connections (i.e. HTTP or Bus connection).

Parameters:

name - a connection name

Returns:

an array of container names' configured to use the connection

getEndpointsUsingConnection

java.lang.String[] getEndpointsUsingConnection(java.lang.String name)

Retrieve a list of all the endpoints configured to use the named connection.

Parameters:

name - the connection name

Returns:

an array of endpoint names configured to use the named connection