org.objectweb.fractal.bf.connectors.jms
Interface JmsAttributes

All Known Subinterfaces:
JmsSkeletonContentAttributes, JmsStubContentAttributes
All Known Implementing Classes:
JmsSkeletonContent, JmsStubContent

public interface JmsAttributes

JMS specific attributes.


Method Summary
 String getCorrelationScheme()
          Gets the correlation scheme used by the stub/skeleton: messageID, correlationID or none
 String getCreateDestinationMode()
          Gets the mode used to create destination: always, never, or ifNotExist
 String getDestinationType()
          Gets the type of the created destination: queue or topic.
 String getJndiConnectionFactoryName()
          Gets the JNDI name of the connection factory to use.
 String getJndiDestinationName()
          Gets the JNDI name of the destination to use.
 String getJndiInitialContextFactory()
          Gets the JNDI initial context factory.
 String getJndiResponseDestinationName()
          Gets the JNDI name of the destination on which responses will be send.
 String getJndiURL()
          Get the jndiURL used to configure the stub/skeleton.
 boolean getPersistent()
          Gets if messages sent by the stub/skeleton are persistent.
 int getPriority()
          Gets the priority of messages sent by the stub/skeleton.
 String getSelector()
          Gets the selector used to consume messages.
 long getTimeToLive()
          Gets the living time of messages sent by the stub/skeleton.
 void setCorrelationScheme(String scheme)
          Sets the correlation scheme used by the stub/skeleton: messageID, correlationID or none
 void setCreateDestinationMode(String mode)
          Sets the mode used to create destination always, never, or ifNotExist
 void setDestinationType(String type)
          Sets the type of the created destination: queue or topic.
 void setJndiConnectionFactoryName(String jndiConnFactName)
          Sets the JNDI name of the connection factory to use.
 void setJndiDestinationName(String jndiDestinationName)
          Sets the JNDI name of the destination to use.
 void setJndiInitialContextFactory(String jndiInitialContextFactory)
          Sets the JNDI initial context factory.
 void setJndiResponseDestinationName(String name)
          Sets the JNDI name of the destination on which responses will be send.
 void setJndiURL(String jndiURL)
          Set the jndiURL used to configure the stub/skeleton.
 void setPersistent(boolean persistent)
          Sets the persistence of messages sent by the stub/skeleton.
 void setPriority(int priority)
          Sets the priority of messages sent by the stub/skeleton.
 void setSelector(String selector)
          Sets the selector used to consume messages.
 void setTimeToLive(long timeToLive)
          Sets the living time of messages sent by the stub/skeleton.
 

Method Detail

getJndiURL

String getJndiURL()
Get the jndiURL used to configure the stub/skeleton.

Returns:
the jndiURL used to configure the stub/skeleton.

setJndiURL

void setJndiURL(String jndiURL)
Set the jndiURL used to configure the stub/skeleton.

Parameters:
jndiURL -

getJndiDestinationName

String getJndiDestinationName()
Gets the JNDI name of the destination to use.

Returns:
the JNDI name of the destination to use.

setJndiDestinationName

void setJndiDestinationName(String jndiDestinationName)
Sets the JNDI name of the destination to use.

Parameters:
jndiDestinationName - the JNDI name of the destination.

getJndiInitialContextFactory

String getJndiInitialContextFactory()
Gets the JNDI initial context factory.

Returns:
the JNDI initial context factory.

setJndiInitialContextFactory

void setJndiInitialContextFactory(String jndiInitialContextFactory)
Sets the JNDI initial context factory.

Parameters:
jndiInitialContextFactory - the JNDI initial context factory.

getJndiConnectionFactoryName

String getJndiConnectionFactoryName()
Gets the JNDI name of the connection factory to use.

Returns:
the JNDI name of the connection factory to use.

setJndiConnectionFactoryName

void setJndiConnectionFactoryName(String jndiConnFactName)
Sets the JNDI name of the connection factory to use.

Parameters:
jndiConnFactName - the JNDI name of the connection factory.

getPriority

int getPriority()
Gets the priority of messages sent by the stub/skeleton.

Returns:
the priority of messages sent by the stub/skeleton.

setPriority

void setPriority(int priority)
Sets the priority of messages sent by the stub/skeleton.

Parameters:
priority - the priority of messages sent by the stub/skeleton.

getTimeToLive

long getTimeToLive()
Gets the living time of messages sent by the stub/skeleton.

Returns:
the living time of messages sent by the stub/skeleton.

setTimeToLive

void setTimeToLive(long timeToLive)
Sets the living time of messages sent by the stub/skeleton.

Parameters:
timeToLive - the living time of messages sent by the stub/skeleton.

getSelector

String getSelector()
Gets the selector used to consume messages.

Returns:
the selector used when consume messages.

setSelector

void setSelector(String selector)
Sets the selector used to consume messages.

Parameters:
selector - the selector used to consume messages.

getPersistent

boolean getPersistent()
Gets if messages sent by the stub/skeleton are persistent.

Returns:
true if messages sent by the stub/skeleton are persistent.

setPersistent

void setPersistent(boolean persistent)
Sets the persistence of messages sent by the stub/skeleton.

Parameters:
persistent - true if messages sent by the stub/skeleton must be persistent.

getCreateDestinationMode

String getCreateDestinationMode()
Gets the mode used to create destination: always, never, or ifNotExist

Returns:
the mode used to create destination.
See Also:
JmsConnectorConstants.CREATE_ALWAYS, JmsConnectorConstants.CREATE_NEVER, JmsConnectorConstants.CREATE_IFNOTEXIST

setCreateDestinationMode

void setCreateDestinationMode(String mode)
Sets the mode used to create destination always, never, or ifNotExist

Parameters:
mode - the mode used to create destination.
See Also:
JmsConnectorConstants.CREATE_ALWAYS, JmsConnectorConstants.CREATE_NEVER, JmsConnectorConstants.CREATE_IFNOTEXIST

getDestinationType

String getDestinationType()
Gets the type of the created destination: queue or topic.

Returns:
the type of the created destination.
See Also:
JmsConnectorConstants.TYPE_QUEUE, JmsConnectorConstants.TYPE_TOPIC

setDestinationType

void setDestinationType(String type)
Sets the type of the created destination: queue or topic.

Parameters:
type - the type of the created destination.
See Also:
JmsConnectorConstants.TYPE_QUEUE, JmsConnectorConstants.TYPE_TOPIC

getJndiResponseDestinationName

String getJndiResponseDestinationName()
Gets the JNDI name of the destination on which responses will be send.

Returns:
the JNDI name of the response destination

setJndiResponseDestinationName

void setJndiResponseDestinationName(String name)
Sets the JNDI name of the destination on which responses will be send.

Parameters:
name - the JNDI name of the response destination

getCorrelationScheme

String getCorrelationScheme()
Gets the correlation scheme used by the stub/skeleton: messageID, correlationID or none

Returns:
the correlation scheme
See Also:
JmsConnectorConstants.MESSAGE_ID_SCHEME, JmsConnectorConstants.CORRELATION_ID_SCHEME

setCorrelationScheme

void setCorrelationScheme(String scheme)
Sets the correlation scheme used by the stub/skeleton: messageID, correlationID or none

Parameters:
scheme - the correlation scheme
See Also:
JmsConnectorConstants.MESSAGE_ID_SCHEME, JmsConnectorConstants.CORRELATION_ID_SCHEME


Copyright © 2007-2011 OW2 Consortium. All Rights Reserved.