Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> [ transformers overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mule.transformers
Class CompressionTransformer  

java.lang.Object
  org.mule.transformers.AbstractTransformer
      org.mule.transformers.CompressionTransformer

All Implemented Interfaces:

java.io.Serializable, org.mule.umo.transformer.UMOTransformer

Direct Known Subclasses:

JMSTransformer, ObjectToSOAP

---

public abstract class CompressionTransformer

extends AbstractTransformer

CompressionTransformer Is a base class for all transformers. Transformations transform one object into another. This base class provides facilities for compressing and uncompressing messages.

Version:

$Revision: 1.6 $

---

Field Summary
private  boolean	doCompression
private static org.apache.commons.logging.Log	log           logger used by this class
static java.lang.String	PROPERTY_DO_COMPRESSION

 

Fields inherited from class org.mule.transformers.AbstractTransformer

connector, name, props, returnClass, TRANSFORMER_DEFAULT, transformerSession, USE_MANAGER_PROPERTIES

 

Fields inherited from interface org.mule.umo.transformer.UMOTransformer

SERVICE_ID

 

Constructor Summary

CompressionTransformer()           default constructor required for discovery

 

Method Summary
protected  byte[]	compressMessage(java.lang.Object src)
boolean	getDoCompression()
void	processProperties()           A template method to allow deriving classes to do something with their properties once the setProperties method is invoked
void	setDoCompression(boolean doCompression)
java.lang.Object	transform(java.lang.Object src, boolean doCompression)           Transforms the object.
protected  byte[]	uncompressMessage(java.lang.Object src)           Uncompresses an Object into a byte[].

 

Methods inherited from class org.mule.transformers.AbstractTransformer

checkReturnClass, commitSession, doTransform, getConnector, getName, getProperties, getReturnClass, getSourceTypeClassesIterator, isInSession, isSourceTypeSupported, registerSourceType, rollbackSession, sessionTransform, setConnector, setName, setProperties, setReturnClass, startSession, transform, unregisterSourceType

 

Methods inherited from class java.lang.Object

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

 

Field Detail

PROPERTY_DO_COMPRESSION

public static final java.lang.String PROPERTY_DO_COMPRESSION

See Also:

Constant Field Values

---

log

private static transient org.apache.commons.logging.Log log

logger used by this class

---

doCompression

private boolean doCompression

Constructor Detail

CompressionTransformer

public CompressionTransformer()

default constructor required for discovery

Method Detail

processProperties

public void processProperties()
                       throws org.mule.umo.transformer.TransformerException

Description copied from class: AbstractTransformer

A template method to allow deriving classes to do something with their properties once the setProperties method is invoked

Specified by:

processProperties in class AbstractTransformer

---

transform

public java.lang.Object transform(java.lang.Object src,
                                  boolean doCompression)
                           throws org.mule.umo.transformer.TransformerException,
                                  org.mule.umo.transformer.TransformerException

Transforms the object.

---

compressMessage

protected byte[] compressMessage(java.lang.Object src)
                          throws org.mule.umo.transformer.TransformerException

---

uncompressMessage

protected byte[] uncompressMessage(java.lang.Object src)
                            throws org.mule.umo.transformer.TransformerException

Uncompresses an Object into a byte[].

---

getDoCompression

public boolean getDoCompression()

---

setDoCompression

public void setDoCompression(boolean doCompression)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> [ transformers overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---