org.apache.nifi.remote.client.socket

Class EndpointConnectionPool

java.lang.Object

org.apache.nifi.remote.client.socket.EndpointConnectionPool

All Implemented Interfaces:

PeerStatusProvider

public class EndpointConnectionPool
extends Object
implements PeerStatusProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	EndpointConnectionPool.IdEnrichedRemoteDestination

Field Summary

Fields

Modifier and Type	Field and Description
private Set<EndpointConnection>	activeConnections
private int	commsTimeout
private ConcurrentMap<PeerDescription,BlockingQueue<EndpointConnection>>	connectionQueueMap
private EventReporter	eventReporter
private int	idleExpirationMillis
private InetAddress	localAddress
private static org.slf4j.Logger	logger
private PeerSelector	peerSelector
private RemoteDestination	remoteDestination
private boolean	shutdown
private SiteInfoProvider	siteInfoProvider
private SSLContext	sslContext
private ScheduledExecutorService	taskExecutor

Constructor Summary

Constructors

Constructor and Description
EndpointConnectionPool(RemoteDestination remoteDestination, int commsTimeoutMillis, int idleExpirationMillis, SSLContext sslContext, EventReporter eventReporter, PeerPersistence peerPersistence, SiteInfoProvider siteInfoProvider, InetAddress localAddress)

Method Summary

Modifier and Type	Method and Description
private void	cleanup(SocketClientProtocol protocol, Peer peer)
private void	cleanupExpiredSockets()
private CommunicationsSession	establishSiteToSiteConnection(PeerStatus peerStatus)
private CommunicationsSession	establishSiteToSiteConnection(String hostname, int port)
Set<PeerStatus>	fetchRemotePeerStatuses(PeerDescription peerDescription) Fetch peer statuses from a remote NiFi cluster.
PeerDescription	getBootstrapPeerDescription() Returns a PeerDescription instance, which represents a bootstrap remote NiFi node.
EndpointConnection	getEndpointConnection(TransferDirection direction)
EndpointConnection	getEndpointConnection(TransferDirection direction, SiteToSiteClientConfig config)
private String	getPortIdentifier(TransferDirection transferDirection)
String	getRemoteInstanceUris() Returns the remote instance URIs.
SiteToSiteTransportProtocol	getTransportProtocol() Returns the transport protocol being used.
boolean	offer(EndpointConnection endpointConnection)
void	shutdown()
void	terminate(EndpointConnection connection)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

connectionQueueMap

private final ConcurrentMap<PeerDescription,BlockingQueue<EndpointConnection>> connectionQueueMap

activeConnections

private final Set<EndpointConnection> activeConnections

eventReporter

private final EventReporter eventReporter

sslContext

private final SSLContext sslContext

taskExecutor

private final ScheduledExecutorService taskExecutor

idleExpirationMillis

private final int idleExpirationMillis

remoteDestination

private final RemoteDestination remoteDestination

commsTimeout

private volatile int commsTimeout

shutdown

private volatile boolean shutdown

siteInfoProvider

private final SiteInfoProvider siteInfoProvider

peerSelector

private final PeerSelector peerSelector

localAddress

private final InetAddress localAddress

Constructor Detail

EndpointConnectionPool

public EndpointConnectionPool(RemoteDestination remoteDestination,
                              int commsTimeoutMillis,
                              int idleExpirationMillis,
                              SSLContext sslContext,
                              EventReporter eventReporter,
                              PeerPersistence peerPersistence,
                              SiteInfoProvider siteInfoProvider,
                              InetAddress localAddress)

Method Detail

getPortIdentifier

private String getPortIdentifier(TransferDirection transferDirection)
                          throws IOException

Throws:

IOException

getEndpointConnection

public EndpointConnection getEndpointConnection(TransferDirection direction)
                                         throws IOException

Throws:

IOException

getEndpointConnection

public EndpointConnection getEndpointConnection(TransferDirection direction,
                                                SiteToSiteClientConfig config)
                                         throws IOException

Throws:

IOException

offer

public boolean offer(EndpointConnection endpointConnection)

cleanup

private void cleanup(SocketClientProtocol protocol,
                     Peer peer)

getBootstrapPeerDescription

public PeerDescription getBootstrapPeerDescription()
                                            throws IOException

Description copied from interface: PeerStatusProvider

Returns a PeerDescription instance, which represents a bootstrap remote NiFi node. The bootstrap node is always used to fetch remote peer statuses.

Once the PeerSelector successfully got remote peer statuses, it periodically fetches remote peer statuses, so that it can detect remote NiFi cluster topology changes such as addition or removal of nodes. To refresh remote peer statuses, PeerSelector calls PeerStatusProvider.fetchRemotePeerStatuses(org.apache.nifi.remote.PeerDescription) with one of query-able nodes lastly fetched from the remote NiFi cluster, until it gets a successful result, or throws IOException if none of them responds successfully.

This mechanism lets PeerSelector works even if the bootstrap remote NiFi node goes down.

Specified by:

getBootstrapPeerDescription in interface PeerStatusProvider

Returns:

peer description of a bootstrap remote NiFi node

Throws:

IOException - thrown when it fails to retrieve the bootstrap remote node information

fetchRemotePeerStatuses

public Set<PeerStatus> fetchRemotePeerStatuses(PeerDescription peerDescription)
                                        throws IOException

Description copied from interface: PeerStatusProvider

Fetch peer statuses from a remote NiFi cluster. Implementation of this method should fetch peer statuses from the node represented by the passed PeerDescription using its transport protocol.

Specified by:

fetchRemotePeerStatuses in interface PeerStatusProvider

Parameters:

peerDescription - a bootstrap node or one of query-able nodes lastly fetched successfully

Returns:

Remote peer statuses

Throws:

IOException - thrown when it fails to fetch peer statuses of the remote cluster from the specified peer

getRemoteInstanceUris

public String getRemoteInstanceUris()

Description copied from interface: PeerStatusProvider

Returns the remote instance URIs.

Specified by:

getRemoteInstanceUris in interface PeerStatusProvider

Returns:

the instance URIs

establishSiteToSiteConnection

private CommunicationsSession establishSiteToSiteConnection(PeerStatus peerStatus)
                                                     throws IOException

Throws:

IOException

establishSiteToSiteConnection

private CommunicationsSession establishSiteToSiteConnection(String hostname,
                                                            int port)
                                                     throws IOException

Throws:

IOException

cleanupExpiredSockets

private void cleanupExpiredSockets()

shutdown

public void shutdown()

terminate

public void terminate(EndpointConnection connection)

toString

public String toString()

Overrides:

toString in class Object

getTransportProtocol

public SiteToSiteTransportProtocol getTransportProtocol()

Description copied from interface: PeerStatusProvider

Returns the transport protocol being used.

Specified by:

getTransportProtocol in interface PeerStatusProvider

Returns:

the transport protocol