org.apache.hadoop.chukwa.datacollection.adaptor.jms

Class JMSAdaptor

java.lang.Object

org.apache.hadoop.chukwa.datacollection.adaptor.AbstractAdaptor

org.apache.hadoop.chukwa.datacollection.adaptor.jms.JMSAdaptor

All Implemented Interfaces:

Adaptor

public class JMSAdaptor
extends AbstractAdaptor

Adaptor that is able to listen to a JMS topic or queue for messages, receive the message, and transform it to a Chukwa chunk. Transformation is handled by a JMSMessageTransformer. The default JMSMessageTransformer used is the JMSTextMessageTransformer.

This adaptor is added to an Agent like so: add JMSAdaptor <dataType> <brokerURL> <-t <topicName> |-q <queueName> [-s <JMSSelector>] [-x <transformerName>] [-p <transformerConfigs>] <offset>

• dataType - The chukwa data type.
• brokerURL - The JMS broker URL to bind to.
• topicName - The JMS topic to listen on.
• queueName - The JMS queue to listen on.
• JMSSelector - The JMS selector to filter with. Surround with quotes if selector contains multiple words.
• transformerName - Class name of the JMSMessageTransformer to use.
• transformerConfigs - Properties to be passed to the JMSMessageTransformer to use. Surround with quotes if configs contain multiple words.

See Also:

JMSMessageTransformer, JMSTextMessageTransformer

Constructor Summary

Constructors

Constructor and Description
JMSAdaptor()

Method Summary

Modifier and Type	Method and Description
String	getCurrentStatus() Status is used to write checkpoints.
String	parseArgs(String s) This adaptor received configuration like this: <brokerURL> <-t <topicName>|-q <queueName>> [-s <JMSSelector>] [-x <transformerName>] [-p <transformerProperties>]
long	shutdown(AdaptorShutdownPolicy shutdownPolicy) Signals this adaptor to come to an orderly stop.
void	start(long offset)

Methods inherited from class org.apache.hadoop.chukwa.datacollection.adaptor.AbstractAdaptor

deregisterAndStop, getType, hardStop, parseArgs, shutdown, start

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMSAdaptor

public JMSAdaptor()

Method Detail

parseArgs

public String parseArgs(String s)

This adaptor received configuration like this: <brokerURL> <-t <topicName>|-q <queueName>> [-s <JMSSelector>] [-x <transformerName>] [-p <transformerProperties>]

Specified by:

parseArgs in class AbstractAdaptor

Parameters:

s - is a list of parameters

Returns:

Adaptor ID

start

public void start(long offset)
           throws AdaptorException

Specified by:

start in class AbstractAdaptor

Throws:

AdaptorException

getCurrentStatus

public String getCurrentStatus()

Status is used to write checkpoints. Checkpoints are written as: ADD <adaptorKey> = <adaptorClass> <currentStatus> <offset> Once they're reloaded, adaptors are re-initialized with <adaptorClass> <currentStatus> <offset> While doing so, this gets passed by to the parseArgs method: <currentStatus> Without the first token in <currentStatus>, which is expected to be <dataType>.

Returns:

Adaptor status

shutdown

public long shutdown(AdaptorShutdownPolicy shutdownPolicy)
              throws AdaptorException

Description copied from interface: Adaptor

Signals this adaptor to come to an orderly stop. The adaptor ought to push out all the data it can before exiting depending of the shutdown policy

Parameters:

shutdownPolicy - is defined as forcefully or gracefully

Returns:

the logical offset at which the adaptor was when the method return

Throws:

AdaptorException - Exception on shutdown