com.sonicsw.esb.mgmtapi.config
Interface IJMSEndpointConfig

All Superinterfaces:

IBaseConfig, IEndpointConfig, IQos

All Known Subinterfaces:

IJMSQueueEndpointConfig, IJMSTopicEndpointConfig

public interface IJMSEndpointConfig
extends IEndpointConfig

A facade on IEndpointConfig providing direct access to JMS related configuration values. To obtain an instance, use IEndpointConfig.getAdapter(com.sonicsw.esb.mgmtapi.config.IEndpointConfig.EndpointDestinationType) passing in one of:

• com.sonicsw.esb.mgmtapi.config.IEndpointConfig.JMS_QUEUE - for JMS queue based endpoints
• com.sonicsw.esb.mgmtapi.config.IEndpointConfig.JMS_TOPIC- for JMS topic based endpoints
• com.sonicsw.esb.mgmtapi.config.IEndpointConfig.JMS_ENDPOINT_TYPE - for access only to attributes applicable to both topics and queues

Nested Class Summary

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

IEndpointConfig.EndpointDestinationType, IEndpointConfig.EndpointType

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

IQos.QOSLevel

Field Summary

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

JMS_ENDPOINT_TYPE, JMS_QUEUE, JMS_TOPIC

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

AT_LEAST_ONCE, BEST_EFFORT, EXACTLY_ONCE

Method Summary

java.lang.String	getDestinationName()
boolean	getIsTemporary()
java.lang.String	getMessageSelector()
int	getPriority()
long	getSendTimeout()
long	getTimeToLive()
void	setDestinationName(java.lang.String destinationName) Set the TOPIC or Queue to which this endpoint is bound
void	setIsTemporary(boolean isTemporary) Internal use only
void	setMessageSelector(java.lang.String selector) Set the JMS message selector expression, if any, applied to messages. null disable message selector.
void	setPriority(int priority) Set the JMS priority that should be set for messages sent to this endpoint.
void	setSendTimeout(long sendTimeout) The time (in milliseconds) the framework will wait for a session to become available for sending to this endpoint.
void	setTimeToLive(long timeToLive) Set the JMS time to live value that should be set on messages sent to this endpoint.

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

getAdapter, getAdapter, getAsAddress, getConnection, getConnectionConfig, getDestinationType, getEndpointConfigType, getEndpointType, getQOSLevel, getWSDLUrl, isInheritJMSDefaultConnection, setConnectionConfig, setDestinationType, setEndpointTypeConfig, setQOSLevel, setWSDLUrl

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

getName, getType

Method Detail

getDestinationName

java.lang.String getDestinationName()

Returns:

the TOPIC or Queue to which this endpoint is bound

setDestinationName

void setDestinationName(java.lang.String destinationName)

Set the TOPIC or Queue to which this endpoint is bound

Parameters:

destinationName - - the destination's name

getMessageSelector

java.lang.String getMessageSelector()

Returns:

the JMS message selector expression, if any, applied to messages.

setMessageSelector

void setMessageSelector(java.lang.String selector)

Set the JMS message selector expression, if any, applied to messages. null disable message selector.

getPriority

int getPriority()

Returns:

the JMS priority assigned to messages sent to this endpoint.

setPriority

void setPriority(int priority)

Set the JMS priority that should be set for messages sent to this endpoint.

getTimeToLive

long getTimeToLive()

Returns:

the JMS time to live set on messages sent to this endpoint.

setTimeToLive

void setTimeToLive(long timeToLive)

Set the JMS time to live value that should be set on messages sent to this endpoint.

Parameters:

timeToLive -

getSendTimeout

long getSendTimeout()

Returns:

the send timeout for this endpoint.

setSendTimeout

void setSendTimeout(long sendTimeout)

The time (in milliseconds) the framework will wait for a session to become available for sending to this endpoint.

Parameters:

sendTimeout - - time

getIsTemporary

boolean getIsTemporary()

Returns:

true if the endpoint is temporary, false otherwise. Internal use only.

setIsTemporary

void setIsTemporary(boolean isTemporary)

Internal use only