org.apache.gobblin.codec

Interface StreamCodec

@Alpha
public interface StreamCodec

Interface for an object that can encrypt a bytestream.

Method Summary

Modifier and Type	Method and Description
InputStream	decodeInputStream(InputStream origStream) Wrap a bytestream and return a new stream that will decode any bytes from origStream when read from.
OutputStream	encodeOutputStream(OutputStream origStream) Wrap a bytestream and return a new stream that encodes the bytes written to it and writes the result into origStream
String	getTag() Get tag/file extension associated with encoder.

Method Detail

encodeOutputStream

OutputStream encodeOutputStream(OutputStream origStream)
                         throws IOException

Wrap a bytestream and return a new stream that encodes the bytes written to it and writes the result into origStream

Parameters:

origStream - Stream to wrap

Returns:

A wrapped stream for encoding

Throws:

IOException

decodeInputStream

InputStream decodeInputStream(InputStream origStream)
                       throws IOException

Wrap a bytestream and return a new stream that will decode any bytes from origStream when read from.

Parameters:

origStream - Stream to wrap

Returns:

A wrapped stream for decoding

Throws:

IOException

getTag

String getTag()

Get tag/file extension associated with encoder. This may be added to the file extension or other metadata by various writers in the system.