com.sonicsw.esb.mgmtapi.config
Interface IServiceConfig

All Superinterfaces:

IBaseConfig

public interface IServiceConfig
extends IBaseConfig

Represent a configured service instance of a particular service type.

Method Summary

void	addExitAddress(IAddress exit) Add the specified address to the set of exit endpoints for this service.
IServiceApplicationConfig	addToContainer(IContainerConfig container, int numListeners) Add to the container who's configuration was specified
void	clearExitAddresses() clear the set of exit endpoints.
IAddress	getAsAddress() Get the service's address for use in API calls which require an address.
IServiceTypeConfig.ClassLoaderConfiguration	getContainerClasspath()
IEndpointConfig	getEntryEndpointConfig()
IAddress[]	getExitAddresses()
IAddress	getFaultAddress()
IServiceTypeConfig.ClassLoaderConfiguration	getInstanceClasspath()
java.lang.String	getName() Get the name of the configuration.
IAddress	getRejectedMessageAddress()
IServiceTypeConfig	getServiceTypeConfig()
IServiceTypeConfig.ClassLoaderConfiguration	getTypeClasspath()
java.lang.String	getWSDLUrl()
IParameter[]	listInitParameters() Retrieve the initialization parameters defined by the service type.
IParameter[]	listRuntimeParameters() Retrieve the runtime parameters defined by the service type.
boolean	removeFromContainer(IContainerConfig container) Remove the service from the container, if it was deployed there.
void	setEntryEndpointConfig(IEndpointConfig endpointConfig) Set the entry endpoint configuration for this instance.
void	setExitAddress(IAddress[] exits)
void	setFaultAddress(IAddress fault) Set the fault endpoint for this service.
void	setName(java.lang.String name) Set the service instance's name.
void	setRejectedMessageAddress(IAddress rme) Set the RME endpoint for this service.
void	setServiceTypeConfig(IServiceTypeConfig serviceTypeConfig) Set the service type configuration this service is an instance of
void	setWSDLUrl(java.lang.String url) Set the WSDL associated with this service.

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

getType

Method Detail

getName

java.lang.String getName()

Description copied from interface: IBaseConfig

Get the name of the configuration.

Specified by:

getName in interface IBaseConfig

Returns:

Service instance name

setName

void setName(java.lang.String name)

Set the service instance's name.

Parameters:

name -

getServiceTypeConfig

IServiceTypeConfig getServiceTypeConfig()

Returns:

the service type configuration this service is an instance of

setServiceTypeConfig

void setServiceTypeConfig(IServiceTypeConfig serviceTypeConfig)

Set the service type configuration this service is an instance of

getEntryEndpointConfig

IEndpointConfig getEntryEndpointConfig()

Returns:

the entry endpoint configuration for this instance.

setEntryEndpointConfig

void setEntryEndpointConfig(IEndpointConfig endpointConfig)

Set the entry endpoint configuration for this instance.

Parameters:

endpointConfig - - the entry endpoint configuration for this instance.

getAsAddress

IAddress getAsAddress()

Get the service's address for use in API calls which require an address. The returned value represents the service's address, not it's entry endpoint.

getExitAddresses

IAddress[] getExitAddresses()

Returns:

a set of IAddress objects representing the exit endpoints of this service.

setExitAddress

void setExitAddress(IAddress[] exits)

Parameters:

exits - - a Set of IAdress objects, to be ysed as the exit endpoints of this service.

addExitAddress

void addExitAddress(IAddress exit)

Add the specified address to the set of exit endpoints for this service.

Parameters:

exit - - an IAdress

clearExitAddresses

void clearExitAddresses()

clear the set of exit endpoints.

getFaultAddress

IAddress getFaultAddress()

Returns:

an IAddress representing the configured fault endpoint for this service.

setFaultAddress

void setFaultAddress(IAddress fault)

Set the fault endpoint for this service.

getRejectedMessageAddress

IAddress getRejectedMessageAddress()

Returns:

an IAddress representing the configured RME endpoint for this service.

setRejectedMessageAddress

void setRejectedMessageAddress(IAddress rme)

Set the RME endpoint for this service.

getWSDLUrl

java.lang.String getWSDLUrl()

Returns:

the WSDL associated with this service.

setWSDLUrl

void setWSDLUrl(java.lang.String url)

Set the WSDL associated with this service.

Parameters:

url -

listInitParameters

IParameter[] listInitParameters()

Retrieve the initialization parameters defined by the service type.

Returns:

an array describing the init parameters and their values

listRuntimeParameters

IParameter[] listRuntimeParameters()

Retrieve the runtime parameters defined by the service type. Note that runtime parameters are assigned values only during using development tools, in the context of Processes. The parameters retrieved using this method should be considered read only.

Returns:

an array describing the runtime parameters a service can be configured with (no values).

addToContainer

IServiceApplicationConfig addToContainer(IContainerConfig container,
                                         int numListeners)

Add to the container who's configuration was specified

Parameters:

container - - ESB container to which to add this service.

numListeners - - the number of threads to configure for this service in the container.

Returns:

a IServiceApplication capturing the configuration of the deployed instance.

removeFromContainer

boolean removeFromContainer(IContainerConfig container)

Remove the service from the container, if it was deployed there.

Parameters:

container - the ESB container from which to remove this service.

Returns:

true if removed.

getContainerClasspath

IServiceTypeConfig.ClassLoaderConfiguration getContainerClasspath()

Returns:

the configuration of the container wide contribution of this service type.

getTypeClasspath

IServiceTypeConfig.ClassLoaderConfiguration getTypeClasspath()

Returns:

the configuration of the service type contribution of this service type.

getInstanceClasspath

IServiceTypeConfig.ClassLoaderConfiguration getInstanceClasspath()

Returns:

the configuration of the service Instance contribution of this service type.