org.apache.nifi.remote.codec

Interface FlowFileCodec

All Superinterfaces:

VersionedRemoteResource

All Known Implementing Classes:

StandardFlowFileCodec

public interface FlowFileCodec
extends VersionedRemoteResource

Provides a mechanism for encoding and decoding FlowFiles as streams so that they can be transferred remotely.

Method Summary

Modifier and Type	Method and Description
DataPacket	decode(InputStream stream) Decodes the contents of the InputStream, interpreting the data to determine the next DataPacket's attributes and content.
void	encode(DataPacket dataPacket, OutputStream outStream) Encodes a DataPacket and its content as a single stream of data and writes that stream to the output.
List<Integer>	getSupportedVersions() Returns a List of all versions that this codec is able to support, in the order that they are preferred by the codec

Methods inherited from interface org.apache.nifi.remote.VersionedRemoteResource

getResourceName, getVersionNegotiator

Method Detail

getSupportedVersions

List<Integer> getSupportedVersions()

Returns a List of all versions that this codec is able to support, in the order that they are preferred by the codec

Returns:

all supported versions

encode

void encode(DataPacket dataPacket,
            OutputStream outStream)
     throws IOException,
            TransmissionDisabledException

Encodes a DataPacket and its content as a single stream of data and writes that stream to the output.

Parameters:

dataPacket - the data to serialize

outStream - the stream to write the data to

Throws:

IOException - if there is a communications issue

TransmissionDisabledException - if a user terminates the connection

decode

DataPacket decode(InputStream stream)
           throws IOException,
                  ProtocolException,
                  TransmissionDisabledException

Decodes the contents of the InputStream, interpreting the data to determine the next DataPacket's attributes and content.

Parameters:

stream - an InputStream containing DataPacket's content and attributes

Returns:

the DataPacket that was created, or null if the stream was out of data

Throws:

IOException - if unable to read stream

ProtocolException - if the input is malformed

TransmissionDisabledException - if a user terminates the connection