com.northconcepts.datapipeline.jms

Class JmsReader

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataReader

com.northconcepts.datapipeline.internal.lang.IntegrationReader

com.northconcepts.datapipeline.jms.JmsReader

public class JmsReader
extends IntegrationReader

Read Records from a Java Message Service (JMS) provider.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

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

fieldLineage, recordLineage

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

lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

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

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

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

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
JmsReader(JmsSettings settings) Connects to a Java Message Service server. Apache ActiveMQ Example: Properties props = new Properties(); props.setProperty(Context.INITIAL_CONTEXT_FACTORY,"org.apache.activemq.jndi.ActiveMQInitialContextFactory"); props.setProperty(Context.PROVIDER_URL,"tcp://localhost:61616"); DataReader reader = new JmsReader(props, JmsDestinationType.QUEUE, "queueName");

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
protected void	addMessageHeader(Message message, Record record)
void	close() Indicates that this endpoint has finished reading or writing.
JmsConnection	getConnection()
Long	getReceiveTimeout() Returns the timeout interval for receiving messages or null if reads should not timeout (default to null).
JmsSettings	getSettings()
protected Record	onBytesMessage(BytesMessage message)
protected Record	onMapMessage(MapMessage message)
protected Record	onMessage(Message message)
protected Record	onObjectMessage(ObjectMessage message)
protected Record	onStreamMessage(StreamMessage message)
protected Record	onTextMessage(TextMessage message)
void	open() Makes this endpoint ready for reading or writing.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
JmsReader	setReceiveTimeout(Long timeout) Sets the timeout interval for receiving messages or null if reads should not timeout (default to null).

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

addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, setSaveLineage, skip

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

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

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

addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

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

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsReader

public JmsReader(JmsSettings settings)

Connects to a Java Message Service server.
Apache ActiveMQ Example:
Properties props = new Properties();
props.setProperty(Context.INITIAL_CONTEXT_FACTORY,"org.apache.activemq.jndi.ActiveMQInitialContextFactory");
props.setProperty(Context.PROVIDER_URL,"tcp://localhost:61616");
DataReader reader = new JmsReader(props, JmsDestinationType.QUEUE, "queueName");


Read your JMS provider manual for more details

Parameters:

properties - the properties required by the JMS server

type - the type of messaging used

destinationName - the name of the Topic or Queue

See Also:

JmsDestinationType

Method Detail

getSettings

public JmsSettings getSettings()

getConnection

public JmsConnection getConnection()

getReceiveTimeout

public Long getReceiveTimeout()

Returns the timeout interval for receiving messages or null if reads should not timeout (default to null).

Returns:

the timeout interval

setReceiveTimeout

public JmsReader setReceiveTimeout(Long timeout)

Sets the timeout interval for receiving messages or null if reads should not timeout (default to null).

Parameters:

timeout - timeout interval for receiving messages

Returns:

the JmsReader instance

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class IntegrationReader

Throws:

DataException

close

public void close()
           throws DataException

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

Throws:

DataException

readImpl

protected Record readImpl()
                   throws Throwable

Description copied from class: DataReader

Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

If no record is available, null will be returned.

Specified by:

readImpl in class DataReader

Throws:

Throwable

onMessage

protected Record onMessage(Message message)
                    throws Throwable

Throws:

Throwable

addMessageHeader

protected void addMessageHeader(Message message,
                                Record record)
                         throws Throwable

Throws:

Throwable

onMapMessage

protected Record onMapMessage(MapMessage message)
                       throws JMSException

Throws:

JMSException

onBytesMessage

protected Record onBytesMessage(BytesMessage message)
                         throws JMSException

Throws:

JMSException

onObjectMessage

protected Record onObjectMessage(ObjectMessage message)
                          throws JMSException

Throws:

JMSException

onStreamMessage

protected Record onStreamMessage(StreamMessage message)
                          throws JMSException

Throws:

JMSException

onTextMessage

protected Record onTextMessage(TextMessage message)
                        throws JMSException

Throws:

JMSException

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: Endpoint

Adds this endpoint'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 DataReader