org.apache.nifi.remote.protocol

Interface ServerProtocol

All Superinterfaces:

VersionedRemoteResource

All Known Subinterfaces:

HttpFlowFileServerProtocol

All Known Implementing Classes:

AbstractFlowFileServerProtocol, SocketFlowFileServerProtocol, StandardHttpFlowFileServerProtocol

public interface ServerProtocol
extends VersionedRemoteResource

Method Summary

Modifier and Type	Method and Description
RootGroupPort	getPort()
FlowFileCodec	getPreNegotiatedCodec()
long	getRequestExpiration()
RequestType	getRequestType(Peer peer) Reads the Request Type of the next request from the Peer
void	handshake(Peer peer) Receives the handshake from the Peer
boolean	isHandshakeSuccessful()
boolean	isShutdown()
FlowFileCodec	negotiateCodec(Peer peer) Negotiates the FlowFileCodec that is to be used for transferring FlowFiles
int	receiveFlowFiles(Peer peer, ProcessContext context, ProcessSession session, FlowFileCodec codec) Receives FlowFiles from the specified peer
void	sendPeerList(Peer peer, java.util.Optional<ClusterNodeInformation> clusterNodeInfo, NodeInformation self) Sends a list of all nodes in the cluster to the specified peer.
void	setNodeInformant(NodeInformant nodeInformant) Optional operation.
void	setRootProcessGroup(ProcessGroup rootGroup)
void	shutdown(Peer peer)
int	transferFlowFiles(Peer peer, ProcessContext context, ProcessSession session, FlowFileCodec codec) Sends FlowFiles to the specified peer

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

getResourceName, getVersionNegotiator

Method Detail

setRootProcessGroup

void setRootProcessGroup(ProcessGroup rootGroup)

Parameters:

rootGroup - group

getPort

RootGroupPort getPort()

setNodeInformant

void setNodeInformant(NodeInformant nodeInformant)

Optional operation. Sets the NodeInformant to use in this Protocol, if a NodeInformant is supported. Otherwise, throws UnsupportedOperationException

Parameters:

nodeInformant - informant

handshake

void handshake(Peer peer)
        throws java.io.IOException,
               HandshakeException

Receives the handshake from the Peer

Parameters:

peer - peer

Throws:

java.io.IOException - ioe

HandshakeException - he

isHandshakeSuccessful

boolean isHandshakeSuccessful()

Returns:

true if the handshaking process was completed successfully, false if either the handshaking process has not happened or the handshake failed

negotiateCodec

FlowFileCodec negotiateCodec(Peer peer)
                      throws java.io.IOException,
                             ProtocolException

Negotiates the FlowFileCodec that is to be used for transferring FlowFiles

Parameters:

peer - peer

Returns:

the codec to use

Throws:

java.io.IOException - ioe

ProtocolException - pe

getPreNegotiatedCodec

FlowFileCodec getPreNegotiatedCodec()

Returns:

the codec that has already been negotiated by this Protocol, if any

getRequestType

RequestType getRequestType(Peer peer)
                    throws java.io.IOException

Reads the Request Type of the next request from the Peer

Parameters:

peer - peer

Returns:

the RequestType that the peer would like to happen - or null, if no data available

Throws:

java.io.IOException - ioe

transferFlowFiles

int transferFlowFiles(Peer peer,
                      ProcessContext context,
                      ProcessSession session,
                      FlowFileCodec codec)
               throws java.io.IOException,
                      ProtocolException

Sends FlowFiles to the specified peer

Parameters:

peer - peer

context - context

session - session

codec - codec

Returns:

the number of FlowFiles transferred

Throws:

java.io.IOException - ioe

ProtocolException - pe

receiveFlowFiles

int receiveFlowFiles(Peer peer,
                     ProcessContext context,
                     ProcessSession session,
                     FlowFileCodec codec)
              throws java.io.IOException,
                     ProtocolException

Receives FlowFiles from the specified peer

Parameters:

peer - peer

context - context

session - session

codec - codec

Returns:

the number of FlowFiles received

Throws:

java.io.IOException - ioe

ProtocolException - pe

getRequestExpiration

long getRequestExpiration()

Returns:

the number of milliseconds after a request is received for which the request is still valid. A valid of 0 indicates that the request will not expire

sendPeerList

void sendPeerList(Peer peer,
                  java.util.Optional<ClusterNodeInformation> clusterNodeInfo,
                  NodeInformation self)
           throws java.io.IOException

Sends a list of all nodes in the cluster to the specified peer. If not in a cluster, sends info about itself

Parameters:

peer - peer

clusterNodeInfo - the cluster information

self - the node which received the request

Throws:

java.io.IOException - ioe

shutdown

void shutdown(Peer peer)

isShutdown

boolean isShutdown()