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

Class JMSMessagePropertyTransformer

java.lang.Object

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

All Implemented Interfaces:

JMSMessageTransformer

public class JMSMessagePropertyTransformer
extends Object
implements JMSMessageTransformer

JMSMessageTransformer that uses the properties of a JMS Message to build a Chukwa record payload. The value for each property configured will be used to create the record, with the delimiter value between each. The default delimiter is a tab (i.e., '\t').

To configure this transformer, set the -p field of the adaptor to the following (surrounded with double quotes): [-d ] [-r ]

• propertyNames - Comma-separated list of JMS properties.
• delimiter - Delimiter to use, in single quotes.
• requiredPropertyNames - Comma-separated list of required JMS properties. Default behavior is that all properties are required.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
JMSMessagePropertyTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
String	parseArgs(String args) Parse any transformer-specific args to initialize the transformer.
byte[]	transform(javax.jms.Message message) Transforms message propertes into a byte array delimtied by delimiter.
protected String	transformValue(String propertyName, Object propertyValue) Transforms the propertyValue found into the string that should be used for the message.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

Constructor Detail

JMSMessagePropertyTransformer

public JMSMessagePropertyTransformer()

Method Detail

parseArgs

public String parseArgs(String args)

Description copied from interface: JMSMessageTransformer

Parse any transformer-specific args to initialize the transformer. Return a null if the arguments could not be parsed. This method will always be invoked before transform is called only if transformer arguments were passed. If they weren't, this method will never be called.

Specified by:

parseArgs in interface JMSMessageTransformer

Parameters:

args - Arguments needed to configur the transformer.

Returns:

transform

public byte[] transform(javax.jms.Message message)
                 throws javax.jms.JMSException

Transforms message propertes into a byte array delimtied by delimiter. If all of the configured message properties are not found, returns null.

The could be enhanced to support the concept of optional/required properties.

Specified by:

transform in interface JMSMessageTransformer

Parameters:

message -

Returns:

Throws:

javax.jms.JMSException

transformValue

protected String transformValue(String propertyName,
                    Object propertyValue)

Transforms the propertyValue found into the string that should be used for the message. Can handle String values and Number values. Override this method to handle other Java types, or to apply other value transformation logic.

Parameters:

propertyName - The name of the JMS property

propertyValue - The value of the property, which might be null.

Returns: