com.emc.vipr.transform

Class OutputTransform

java.lang.Object

com.emc.vipr.transform.OutputTransform

Direct Known Subclasses:

CompressionOutputTransform, EncryptionOutputTransform

public abstract class OutputTransform
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutputTransform.StreamMode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	metadataToEncode
protected java.io.InputStream	pullStream
protected java.io.OutputStream	pushStream

Constructor Summary

Constructors

Constructor and Description
OutputTransform(java.io.InputStream streamtoEncode, java.util.Map<java.lang.String,java.lang.String> metadataToEncode, java.lang.String transformConfig)
OutputTransform(java.io.OutputStream streamToEncode, java.util.Map<java.lang.String,java.lang.String> metadataToEncode, java.lang.String transformConfig)

Method Summary

Methods

Modifier and Type	Method and Description
java.io.InputStream	getEncodedInputStream()
abstract java.util.Map<java.lang.String,java.lang.String>	getEncodedMetadata() Encodes the object's metadata.
java.io.OutputStream	getEncodedOutputStream() Wraps the output stream with an encoder that will apply this transformation to the stream.
OutputTransform.StreamMode	getStreamMode()
java.lang.String	getTransformConfig() Gets this transformation's mode string, e.g.

Methods inherited from class java.lang.Object

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

Field Detail

pushStream

protected java.io.OutputStream pushStream

pullStream

protected java.io.InputStream pullStream

metadataToEncode

protected java.util.Map<java.lang.String,java.lang.String> metadataToEncode

Constructor Detail

OutputTransform

public OutputTransform(java.io.OutputStream streamToEncode,
               java.util.Map<java.lang.String,java.lang.String> metadataToEncode,
               java.lang.String transformConfig)

OutputTransform

public OutputTransform(java.io.InputStream streamtoEncode,
               java.util.Map<java.lang.String,java.lang.String> metadataToEncode,
               java.lang.String transformConfig)

Method Detail

getStreamMode

public OutputTransform.StreamMode getStreamMode()

getEncodedOutputStream

public java.io.OutputStream getEncodedOutputStream()

Wraps the output stream with an encoder that will apply this transformation to the stream.

Returns:

a new output stream object that encodes the source stream.

getEncodedInputStream

public java.io.InputStream getEncodedInputStream()

getEncodedMetadata

public abstract java.util.Map<java.lang.String,java.lang.String> getEncodedMetadata()

Encodes the object's metadata. Usually, this is called after the output stream has been closed to get the updated object metadata but could also somehow transform existing metadata like encrypting it.

Returns:

the "encoded" metadata

getTransformConfig

public java.lang.String getTransformConfig()

Gets this transformation's mode string, e.g. "COMP:LZMA/3"

Returns:

the mode string.