org.apache.nifi.remote.protocol

Class AbstractFlowFileServerProtocol

java.lang.Object

org.apache.nifi.remote.protocol.AbstractFlowFileServerProtocol

All Implemented Interfaces:

ServerProtocol, VersionedRemoteResource

Direct Known Subclasses:

SocketFlowFileServerProtocol, StandardHttpFlowFileServerProtocol

public abstract class AbstractFlowFileServerProtocol
extends Object
implements ServerProtocol

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	DEFAULT_BATCH_NANOS
protected boolean	handshakeCompleted
protected HandshakeProperties	handshakeProperties
protected org.slf4j.Logger	logger
protected org.apache.nifi.remote.codec.FlowFileCodec	negotiatedFlowFileCodec
protected PublicPort	port
protected ProcessGroup	rootGroup
protected boolean	shutdown

Constructor Summary

Constructors

Constructor and Description
AbstractFlowFileServerProtocol()

Method Summary

Modifier and Type	Method and Description
protected void	checkPortStatus(Peer peer, String portId)
protected int	commitReceiveTransaction(Peer peer, FlowFileTransaction transaction)
protected int	commitTransferTransaction(Peer peer, FlowFileTransaction transaction)
protected String	createTransitUri(Peer peer, String sourceFlowFileIdentifier)
protected abstract HandshakeProperties	doHandshake(Peer peer)
PublicPort	getPort()
org.apache.nifi.remote.codec.FlowFileCodec	getPreNegotiatedCodec()
long	getRequestExpiration()
void	handshake(Peer peer)
boolean	isHandshakeSuccessful()
boolean	isShutdown()
protected Response	readTransactionResponse(boolean isTransfer, CommunicationsSession commsSession)
int	receiveFlowFiles(Peer peer, ProcessContext context, ProcessSession session, org.apache.nifi.remote.codec.FlowFileCodec codec)
void	setNodeInformant(NodeInformant nodeInformant)
void	setRootProcessGroup(ProcessGroup group)
void	shutdown(Peer peer)
String	toString()
int	transferFlowFiles(Peer peer, ProcessContext context, ProcessSession session, org.apache.nifi.remote.codec.FlowFileCodec codec)
protected void	validateHandshakeRequest(HandshakeProperties confirmed, Peer peer, Map<String,String> properties)
protected void	writeTransactionResponse(boolean isTransfer, ResponseCode response, CommunicationsSession commsSession)
protected void	writeTransactionResponse(boolean isTransfer, ResponseCode response, CommunicationsSession commsSession, String explanation)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.remote.protocol.ServerProtocol

getRequestType, negotiateCodec, sendPeerList

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

getResourceName, getVersionNegotiator

Field Detail

rootGroup

protected ProcessGroup rootGroup

port

protected PublicPort port

handshakeCompleted

protected boolean handshakeCompleted

shutdown

protected boolean shutdown

negotiatedFlowFileCodec

protected org.apache.nifi.remote.codec.FlowFileCodec negotiatedFlowFileCodec

handshakeProperties

protected HandshakeProperties handshakeProperties

DEFAULT_BATCH_NANOS

protected static final long DEFAULT_BATCH_NANOS

logger

protected final org.slf4j.Logger logger

Constructor Detail

AbstractFlowFileServerProtocol

public AbstractFlowFileServerProtocol()

Method Detail

setRootProcessGroup

public void setRootProcessGroup(ProcessGroup group)

Specified by:

setRootProcessGroup in interface ServerProtocol

isHandshakeSuccessful

public boolean isHandshakeSuccessful()

Specified by:

isHandshakeSuccessful in interface ServerProtocol

validateHandshakeRequest

protected void validateHandshakeRequest(HandshakeProperties confirmed,
                                        Peer peer,
                                        Map<String,String> properties)
                                 throws HandshakeException

Throws:

HandshakeException

checkPortStatus

protected void checkPortStatus(Peer peer,
                               String portId)
                        throws HandshakeException

Throws:

HandshakeException

getPort

public PublicPort getPort()

Specified by:

getPort in interface ServerProtocol

getPreNegotiatedCodec

public org.apache.nifi.remote.codec.FlowFileCodec getPreNegotiatedCodec()

Specified by:

getPreNegotiatedCodec in interface ServerProtocol

handshake

public final void handshake(Peer peer)
                     throws IOException,
                            HandshakeException

Specified by:

handshake in interface ServerProtocol

Throws:

IOException

HandshakeException

doHandshake

protected abstract HandshakeProperties doHandshake(Peer peer)
                                            throws IOException,
                                                   HandshakeException

Throws:

IOException

HandshakeException

transferFlowFiles

public int transferFlowFiles(Peer peer,
                             ProcessContext context,
                             ProcessSession session,
                             org.apache.nifi.remote.codec.FlowFileCodec codec)
                      throws IOException,
                             ProtocolException

Specified by:

transferFlowFiles in interface ServerProtocol

Throws:

IOException

ProtocolException

createTransitUri

protected String createTransitUri(Peer peer,
                                  String sourceFlowFileIdentifier)

commitTransferTransaction

protected int commitTransferTransaction(Peer peer,
                                        FlowFileTransaction transaction)
                                 throws IOException

Throws:

IOException

readTransactionResponse

protected Response readTransactionResponse(boolean isTransfer,
                                           CommunicationsSession commsSession)
                                    throws IOException

Throws:

IOException

writeTransactionResponse

protected final void writeTransactionResponse(boolean isTransfer,
                                              ResponseCode response,
                                              CommunicationsSession commsSession)
                                       throws IOException

Throws:

IOException

writeTransactionResponse

protected void writeTransactionResponse(boolean isTransfer,
                                        ResponseCode response,
                                        CommunicationsSession commsSession,
                                        String explanation)
                                 throws IOException

Throws:

IOException

receiveFlowFiles

public int receiveFlowFiles(Peer peer,
                            ProcessContext context,
                            ProcessSession session,
                            org.apache.nifi.remote.codec.FlowFileCodec codec)
                     throws IOException,
                            ProtocolException

Specified by:

receiveFlowFiles in interface ServerProtocol

Throws:

IOException

ProtocolException

commitReceiveTransaction

protected int commitReceiveTransaction(Peer peer,
                                       FlowFileTransaction transaction)
                                throws IOException

Throws:

IOException

shutdown

public void shutdown(Peer peer)

Specified by:

shutdown in interface ServerProtocol

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface ServerProtocol

setNodeInformant

public void setNodeInformant(NodeInformant nodeInformant)

Specified by:

setNodeInformant in interface ServerProtocol

getRequestExpiration

public long getRequestExpiration()

Specified by:

getRequestExpiration in interface ServerProtocol

toString

public String toString()

Overrides:

toString in class Object