org.mule.transport.jms.transformers
Class AbstractJmsTransformer

java.lang.Object
  org.mule.transformer.AbstractTransformer
      org.mule.transformer.AbstractMessageTransformer
          org.mule.transport.jms.transformers.AbstractJmsTransformer

All Implemented Interfaces:

AnnotatedObject, MuleContextAware, Disposable, Initialisable, NameableObject, NamedObject, MessageProcessor, Converter, DiscoverableTransformer, MessageTransformer, Transformer, EndpointAware

Direct Known Subclasses:

JMSMessageToObject, ObjectToJMSMessage

public abstract class AbstractJmsTransformer
extends AbstractMessageTransformer
implements DiscoverableTransformer

AbstractJmsTransformer is an abstract class that should be used for all transformers where a JMS message will be the transformed or transformee object. It provides services for compressing and uncompressing messages.

Field Summary

Fields inherited from class org.mule.transformer.AbstractTransformer

encoding, endpoint, logger, mimeType, MULE_MESSAGE_DATA_TYPE, muleContext, name, returnType, sourceTypes

Fields inherited from interface org.mule.api.transformer.Converter

DEFAULT_PRIORITY_WEIGHTING, MAX_PRIORITY_WEIGHTING, MIN_PRIORITY_WEIGHTING

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.api.AnnotatedObject

PROPERTY_NAME

Constructor Summary

AbstractJmsTransformer()

Method Summary

protected abstract void	declareInputOutputClasses()
int	getPriorityWeighting() If two or more discoverable transformers are equal, this value can be used to select the correct one
protected Session	getSession()
void	setJmsProperties(MuleMessage message, Message msg)
protected void	setJmsPropertySanitizeKeyIfNecessary(Message msg, String key, Object value)
void	setPriorityWeighting(int priorityWeighting) If 2 or more discoverable transformers are equal, this value can be used to select the correct one
protected Object	transformFromMessage(Message source, String outputEncoding)
protected Message	transformToMessage(MuleMessage message)

Methods inherited from class org.mule.transformer.AbstractMessageTransformer

checkReturnClass, doTransform, isSourceDataTypeSupported, transform, transform, transform, transformMessage

Methods inherited from class org.mule.transformer.AbstractTransformer

dispose, generateTransformerName, getAnnotation, getAnnotations, getEncoding, getEncoding, getEndpoint, getMimeType, getName, getReturnClass, getReturnDataType, getSourceDataTypes, getSourceTypes, initialise, isAcceptNull, isAllowNullReturn, isConsumed, isIgnoreBadInput, isSourceDataTypeSupported, isSourceTypeSupported, isSourceTypeSupported, process, registerSourceType, registerSourceType, setAllowNullReturn, setAnnotations, setEncoding, setEndpoint, setIgnoreBadInput, setMimeType, setMuleContext, setName, setReturnClass, setReturnDataType, toString, transform, unregisterSourceType, unregisterSourceType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transformer.Transformer

getEncoding, getEndpoint, getMimeType, getReturnClass, getReturnDataType, getSourceDataTypes, getSourceTypes, isAcceptNull, isIgnoreBadInput, isSourceDataTypeSupported, isSourceTypeSupported, setReturnClass, setReturnDataType, transform, transform

Methods inherited from interface org.mule.api.processor.MessageProcessor

process

Methods inherited from interface org.mule.api.lifecycle.Initialisable

initialise

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.api.NameableObject

setName

Methods inherited from interface org.mule.api.NamedObject

getName

Methods inherited from interface org.mule.api.context.MuleContextAware

setMuleContext

Methods inherited from interface org.mule.endpoint.EndpointAware

setEndpoint

Constructor Detail

AbstractJmsTransformer

public AbstractJmsTransformer()

Method Detail

declareInputOutputClasses

protected abstract void declareInputOutputClasses()

transformToMessage

protected Message transformToMessage(MuleMessage message)
                              throws Exception

Throws:

Exception

transformFromMessage

protected Object transformFromMessage(Message source,
                                      String outputEncoding)
                               throws IOException,
                                      JMSException

Throws:

IOException

JMSException

setJmsProperties

public void setJmsProperties(MuleMessage message,
                             Message msg)
                      throws JMSException

Throws:

JMSException

setJmsPropertySanitizeKeyIfNecessary

protected void setJmsPropertySanitizeKeyIfNecessary(Message msg,
                                                    String key,
                                                    Object value)

getSession

protected Session getSession()
                      throws Exception

Throws:

Exception

getPriorityWeighting

public int getPriorityWeighting()

Description copied from interface: Converter

If two or more discoverable transformers are equal, this value can be used to select the correct one

Specified by:

getPriorityWeighting in interface Converter

Returns:

the priority weighting for this transformer. This is a value between Converter.MIN_PRIORITY_WEIGHTING and Converter.MAX_PRIORITY_WEIGHTING.

setPriorityWeighting

public void setPriorityWeighting(int priorityWeighting)

Description copied from interface: Converter

If 2 or more discoverable transformers are equal, this value can be used to select the correct one

Specified by:

setPriorityWeighting in interface Converter

Parameters:

priorityWeighting - the priority weighting for this transformer. This is a value between Converter.MIN_PRIORITY_WEIGHTING and Converter.MAX_PRIORITY_WEIGHTING.