com.sonicsw.esb.mgmtapi.config
Interface IEndpointConfig

All Superinterfaces:

IBaseConfig, IQos

All Known Subinterfaces:

IJMSEndpointConfig, IJMSQueueEndpointConfig, IJMSTopicEndpointConfig

public interface IEndpointConfig
extends IBaseConfig, IQos

Endpoint configuration is a typed bag of properties. Different types of endpoints have different required properties, and different semantics associated with them. The type identifies the interpretation of the properties. This interface provides a more meaningful representation of the properties. A typed interface can be obtained for supported endpoint types, which provides direct access for relevant attributes of the endpoint, for example IJMSEndpointConfig provides accessors and mutators for SONIC JMS based endpoints.

Nested Class Summary

static class	IEndpointConfig.EndpointDestinationType Type safe enum to represent destination types.
static class	IEndpointConfig.EndpointType A type safe enum identifying supported Endpoint configuration types.

Nested classes/interfaces inherited from interface com.sonicsw.esb.mgmtapi.config.IQos

IQos.QOSLevel

Field Summary

static IEndpointConfig.EndpointType	JMS_ENDPOINT_TYPE A constant representing a JMS based endpoint type.
static IEndpointConfig.EndpointDestinationType	JMS_QUEUE A constant representing a JMS based endpoint, who's underlying JMS destination is a queue.
static IEndpointConfig.EndpointDestinationType	JMS_TOPIC A constant representing a JMS based endpoint, who's underlying JMS destination is a topic.

Fields inherited from interface com.sonicsw.esb.mgmtapi.config.IQos

AT_LEAST_ONCE, BEST_EFFORT, EXACTLY_ONCE

Method Summary

java.lang.Object	getAdapter() Obtain a type specific interface according to endpoints currently configured type.
java.lang.Object	getAdapter(IEndpointConfig.EndpointDestinationType epType) Obtain a type specific interface according to the requested endpoint type
IAddress	getAsAddress() generate a representation of this endpoint suitable for use in the setting destinations for various artifacts, e.g.
java.lang.String	getConnection() Retrieve the connection name this endpoint is using.
IConnectionConfig	getConnectionConfig() Retrieve the connection configuration used by this endpoint.
IEndpointConfig.EndpointDestinationType	getDestinationType()
IEndpointConfig.EndpointType	getEndpointConfigType()
java.lang.String	getEndpointType()
IQos.QOSLevel	getQOSLevel() Retrieve the QOS associated with this endpoint.
java.lang.String	getWSDLUrl()
boolean	isInheritJMSDefaultConnection() Does this endpoint inherit the JMS default connection from the ESB container it's deployed in?
void	setConnectionConfig(IConnectionConfig connection) Set the connection over which this endpoint's communications will take place.
void	setDestinationType(IEndpointConfig.EndpointDestinationType type)
void	setEndpointTypeConfig(IEndpointConfig.EndpointType type) Set the endpoint type.
void	setQOSLevel(IQos.QOSLevel level) Set the QOS associated with this endpoint.
void	setWSDLUrl(java.lang.String url)

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

getName, getType

Field Detail

JMS_ENDPOINT_TYPE

static final IEndpointConfig.EndpointType JMS_ENDPOINT_TYPE

A constant representing a JMS based endpoint type.

JMS_TOPIC

static final IEndpointConfig.EndpointDestinationType JMS_TOPIC

A constant representing a JMS based endpoint, who's underlying JMS destination is a topic. This type is only meant to be used form getAdapter, not as an endpoint configuration type. The underling endpoint type is JMS_ENDPOINT_TYPE

JMS_QUEUE

static final IEndpointConfig.EndpointDestinationType JMS_QUEUE

A constant representing a JMS based endpoint, who's underlying JMS destination is a queue. This type is only meant to be used form getAdapter, not as an endpoint configuration type. The underling endpoint type is JMS_ENDPOINT_TYPE

Method Detail

getAdapter

java.lang.Object getAdapter(IEndpointConfig.EndpointDestinationType epType)

Obtain a type specific interface according to the requested endpoint type

Returns:

a subclass of this interface, which adds methods to fit the requested endpoint type.

getAdapter

java.lang.Object getAdapter()

Obtain a type specific interface according to endpoints currently configured type. If the type is not yet configured for the endpoint, then null is returned

Returns:

An instance of a type specific interface according to the endpoint type, e.g. IJMSEndpointConfig

getEndpointType

java.lang.String getEndpointType()

Returns:

the one of the constants identifying endpoint types.

getEndpointConfigType

IEndpointConfig.EndpointType getEndpointConfigType()

setEndpointTypeConfig

void setEndpointTypeConfig(IEndpointConfig.EndpointType type)

Set the endpoint type.

Parameters:

type - the type to associate with the endpoint

setConnectionConfig

void setConnectionConfig(IConnectionConfig connection)

Set the connection over which this endpoint's communications will take place.

Parameters:

connection - a new connection to be used by the endpoint

getConnectionConfig

IConnectionConfig getConnectionConfig()

Retrieve the connection configuration used by this endpoint.

Returns:

the connection configuration the endpoint is configured to use

getConnection

java.lang.String getConnection()

Retrieve the connection name this endpoint is using.

Returns:

the connection name this endpoint is configured to use

isInheritJMSDefaultConnection

boolean isInheritJMSDefaultConnection()

Does this endpoint inherit the JMS default connection from the ESB container it's deployed in?

Returns:

true if this endpoint inherits the JMS default connection; false otherwise.

getQOSLevel

IQos.QOSLevel getQOSLevel()

Retrieve the QOS associated with this endpoint.

Returns:

the QOS level associated with the endpoint

setQOSLevel

void setQOSLevel(IQos.QOSLevel level)

Set the QOS associated with this endpoint.

Parameters:

level - the new QOS level to associate with the endpoint

getAsAddress

IAddress getAsAddress()

generate a representation of this endpoint suitable for use in the setting destinations for various artifacts, e.g. Service Entry endpoint.

Returns:

an Address that can be used to configure services and processes.

getWSDLUrl

java.lang.String getWSDLUrl()

setWSDLUrl

void setWSDLUrl(java.lang.String url)

getDestinationType

IEndpointConfig.EndpointDestinationType getDestinationType()

setDestinationType

void setDestinationType(IEndpointConfig.EndpointDestinationType type)