com.emc.vipr.transform

Class TransformFactory<T extends OutputTransform,U extends InputTransform>

java.lang.Object

com.emc.vipr.transform.TransformFactory<T,U>

Type Parameters:

T - the class of transform that this class produces.

All Implemented Interfaces:

java.lang.Comparable<TransformFactory<OutputTransform,InputTransform>>

Direct Known Subclasses:

CompressionTransformFactory, EncryptionTransformFactory

public abstract class TransformFactory<T extends OutputTransform,U extends InputTransform>
extends java.lang.Object
implements java.lang.Comparable<TransformFactory<OutputTransform,InputTransform>>

Abstract base class that produces both "output" transformers that encode data and "output" transforms that decode data.

Constructor Summary

Constructors

Constructor and Description
TransformFactory()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDecode(java.lang.String transformConfig, java.util.Map<java.lang.String,java.lang.String> metadata) Checks whether this class can decode the given transformation configuration.
int	compareTo(TransformFactory<OutputTransform,InputTransform> other)
abstract U	getInputTransform(java.lang.String transformConfig, java.io.InputStream streamToDecode, java.util.Map<java.lang.String,java.lang.String> metadata) Gets the "input" transform for the given class and metadata.
abstract T	getOutputTransform(java.io.InputStream streamToEncode, java.util.Map<java.lang.String,java.lang.String> metadataToEncode) Gets an "output" transform for the factory in its current state.
abstract T	getOutputTransform(java.io.OutputStream streamToEncode, java.util.Map<java.lang.String,java.lang.String> metadataToEncode) Gets an "output" transform for the factory in its current state.
int	getPriority() Gets the priority of this factory.
abstract java.lang.String	getTransformClass() Gets the high-level class of transform that this factory provides.
void	setPriority(int priority) Sets the priority for this factory.
protected java.lang.String[]	splitTransformConfig(java.lang.String transformConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformFactory

public TransformFactory()

Method Detail

getOutputTransform

public abstract T getOutputTransform(java.io.OutputStream streamToEncode,
                   java.util.Map<java.lang.String,java.lang.String> metadataToEncode)
                                                      throws java.io.IOException,
                                                             TransformException

Gets an "output" transform for the factory in its current state. This will be used to transform raw data on its way "out" to the server.

Returns:

a transform that can encode the outbound object stream.

Throws:

java.io.IOException

TransformException

getOutputTransform

public abstract T getOutputTransform(java.io.InputStream streamToEncode,
                   java.util.Map<java.lang.String,java.lang.String> metadataToEncode)
                                                      throws java.io.IOException,
                                                             TransformException

Gets an "output" transform for the factory in its current state. This will be used to transform raw data on its way "out" to the server. This version gets an output transform in "pull" mode that uses an input stream to filter the data. This is useful for situations where you need to pump data to an output stream like when using an HTTP output stream.

Returns:

a transform that can encode the outbound object stream.

Throws:

java.io.IOException

TransformException

getInputTransform

public abstract U getInputTransform(java.lang.String transformConfig,
                  java.io.InputStream streamToDecode,
                  java.util.Map<java.lang.String,java.lang.String> metadata)
                                                    throws java.io.IOException,
                                                           TransformException

Gets the "input" transform for the given class and metadata.

Parameters:

transformConfig - the configuration of the transformClass.

metadata - metadata extracted from the inbound object (used to fine-tune the transformation and/or provide metadata to also be transformed).

Returns:

a transform that can decode the inbound object stream.

Throws:

java.io.IOException

TransformException

getTransformClass

public abstract java.lang.String getTransformClass()

Gets the high-level class of transform that this factory provides. The transform engine will use this to test whether the registered factory can decode the given object.

Returns:

the transformation class, e.g. "COMP" for compression or "ENC" for encryption.

canDecode

public boolean canDecode(java.lang.String transformConfig,
                java.util.Map<java.lang.String,java.lang.String> metadata)

Checks whether this class can decode the given transformation configuration.

Parameters:

metadata - the additional metadata from the object in case additional fields need to be checked.

Returns:

true if this factory can decode the given object stream.

splitTransformConfig

protected java.lang.String[] splitTransformConfig(java.lang.String transformConfig)

getPriority

public int getPriority()

Gets the priority of this factory. For output configurations, higher priority transformations will be applied first (e.g. compression should be applied before encryption and therefore higher priority). For input configurations, there may be multiple factories that can handle an object and the one with higher priority will take precedence.

Returns:

this factory's priority.

setPriority

public void setPriority(int priority)

Sets the priority for this factory.

compareTo

public int compareTo(TransformFactory<OutputTransform,InputTransform> other)

Specified by:

compareTo in interface java.lang.Comparable<TransformFactory<OutputTransform,InputTransform>>