org.apache.nifi.remote.protocol

Interface ClientProtocol

All Superinterfaces:

VersionedRemoteResource

All Known Implementing Classes:

SocketClientProtocol

public interface ClientProtocol
extends VersionedRemoteResource

Method Summary

Modifier and Type	Method and Description
Set<PeerStatus>	getPeerStatuses(Peer currentPeer)
void	handshake(Peer peer)
boolean	isDestinationFull()
boolean	isPortInvalid()
boolean	isPortUnknown()
FlowFileCodec	negotiateCodec(Peer peer)
void	shutdown(Peer peer)
Transaction	startTransaction(Peer peer, FlowFileCodec codec, TransferDirection direction)

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

getResourceName, getVersionNegotiator

Method Detail

handshake

void handshake(Peer peer)
        throws IOException,
               HandshakeException,
               UnknownPortException,
               PortNotRunningException

Throws:

IOException

HandshakeException

UnknownPortException

PortNotRunningException

getPeerStatuses

Set<PeerStatus> getPeerStatuses(Peer currentPeer)
                         throws IOException,
                                ProtocolException

Throws:

IOException

ProtocolException

negotiateCodec

FlowFileCodec negotiateCodec(Peer peer)
                      throws IOException,
                             ProtocolException

Throws:

IOException

ProtocolException

shutdown

void shutdown(Peer peer)
       throws IOException,
              ProtocolException

Throws:

IOException

ProtocolException

startTransaction

Transaction startTransaction(Peer peer,
                             FlowFileCodec codec,
                             TransferDirection direction)
                      throws IOException

Throws:

IOException

isPortInvalid

boolean isPortInvalid()
               throws IllegalStateException

Returns:

true if remote instance indicates that the port is invalid

Throws:

IllegalStateException - if a handshake has not successfully completed

isPortUnknown

boolean isPortUnknown()

Returns:

true if remote instance indicates that the port is unknown

Throws:

IllegalStateException - if a handshake has not successfully completed

isDestinationFull

boolean isDestinationFull()

Returns:

true if remote instance indicates that the port's destination is full

Throws:

IllegalStateException - if a handshake has not successfully completed