org.apache.nifi.remote.protocol

Interface CommunicationsSession

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractCommunicationsSession, HttpCommunicationsSession, HttpServerCommunicationsSession, SocketCommunicationsSession

public interface CommunicationsSession
extends Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	MAGIC_BYTES

Method Summary

Modifier and Type	Method and Description
String	createTransitUri(String communicantUrl, String sourceFlowFileIdentifier)
long	getBytesRead()
long	getBytesWritten()
CommunicationsInput	getInput()
CommunicationsOutput	getOutput()
int	getTimeout()
String	getUserDn()
void	interrupt() Asynchronously interrupts this FlowFileCodec.
boolean	isClosed()
boolean	isDataAvailable()
void	setTimeout(int millis)
void	setUserDn(String dn)

Methods inherited from interface java.io.Closeable

close

Field Detail

MAGIC_BYTES

static final byte[] MAGIC_BYTES

Method Detail

getInput

CommunicationsInput getInput()

getOutput

CommunicationsOutput getOutput()

setTimeout

void setTimeout(int millis)
         throws IOException

Throws:

IOException

getTimeout

int getTimeout()
        throws IOException

Throws:

IOException

getUserDn

String getUserDn()

setUserDn

void setUserDn(String dn)

isDataAvailable

boolean isDataAvailable()

getBytesWritten

long getBytesWritten()

getBytesRead

long getBytesRead()

interrupt

void interrupt()

Asynchronously interrupts this FlowFileCodec. Implementations must ensure that they stop sending and receiving data as soon as possible after this method has been called, even if doing so results in sending only partial data to the peer. This will usually result in the peer throwing a SocketTimeoutException.

isClosed

boolean isClosed()

Returns:

true if the connection is closed, false otherwise

createTransitUri

String createTransitUri(String communicantUrl,
                        String sourceFlowFileIdentifier)

Parameters:

communicantUrl - Communicant's url that this session is assigned to.

sourceFlowFileIdentifier - Source Flow-file's uuid.

Returns:

A transit uri to be used in a provenance event.