com.northconcepts.datapipeline.jms

Class JmsSettings

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.jms.JmsSettings

public class JmsSettings
extends DataObject

The configuration used to connect to a JmsReader or JmsWriter.

Field Summary

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
JmsSettings(String name, JmsDestinationType type)
JmsSettings(String instanceName, JmsDestinationType type, Properties properties)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this object's current state to a DataException.
JmsAcknowledgeMode	getAcknowledgeMode() Indicates how received messages should be acknowledged (default to JmsAcknowledgeMode.AUTO).
String	getClientId()
String	getInstanceName()
String	getJndiFactoryName() Indicates the JNDI name to use when looking up the ConnectionFactory (defaults to "ConnectionFactory").
Properties	getProperties()
String	getProperty(String key)
JmsDestinationType	getType()
boolean	isTransacted()
JmsSettings	setAcknowledgeMode(JmsAcknowledgeMode acknowledgeMode) Indicates how received messages should be acknowledged (default to JmsAcknowledgeMode.AUTO).
JmsSettings	setClientId(String clientId)
JmsSettings	setJndiFactoryName(String jndiFactoryName)
JmsSettings	setProperty(String key, String value)
JmsSettings	setTransacted(boolean transacted)

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JmsSettings

public JmsSettings(String instanceName,
                   JmsDestinationType type,
                   Properties properties)

Parameters:

instanceName - the name of the Topic or Queue

type - the type of messaging used

JmsSettings

public JmsSettings(String name,
                   JmsDestinationType type)

Parameters:

name - the name of the Topic or Queue

type - the type of messaging used

Method Detail

getProperties

public Properties getProperties()

setProperty

public JmsSettings setProperty(String key,
                               String value)

getProperty

public String getProperty(String key)

getInstanceName

public String getInstanceName()

getType

public JmsDestinationType getType()

isTransacted

public boolean isTransacted()

setTransacted

public JmsSettings setTransacted(boolean transacted)

getAcknowledgeMode

public JmsAcknowledgeMode getAcknowledgeMode()

Indicates how received messages should be acknowledged (default to JmsAcknowledgeMode.AUTO).

setAcknowledgeMode

public JmsSettings setAcknowledgeMode(JmsAcknowledgeMode acknowledgeMode)

Indicates how received messages should be acknowledged (default to JmsAcknowledgeMode.AUTO).

getJndiFactoryName

public String getJndiFactoryName()

Indicates the JNDI name to use when looking up the ConnectionFactory (defaults to "ConnectionFactory").

Returns:

setJndiFactoryName

public JmsSettings setJndiFactoryName(String jndiFactoryName)

getClientId

public String getClientId()

setClientId

public JmsSettings setClientId(String clientId)

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: DataObject

Adds this object's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Overrides:

addExceptionProperties in class DataObject