Package org.apache.nifi.remote

Class StandardRemoteProcessGroup

java.lang.Object

org.apache.nifi.remote.StandardRemoteProcessGroup

All Implemented Interfaces:

Authorizable, ComponentAuthorizable, VersionedComponent, Positionable, RemoteProcessGroup

public class StandardRemoteProcessGroup
extends Object
implements RemoteProcessGroup

Represents the Root Process Group of a remote NiFi Instance. Holds information about that remote instance, as well as Incoming Ports and Outgoing Ports for communicating with the remote instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	StandardRemoteProcessGroup.InitializationTask

Field Summary

Fields

Modifier and Type	Field	Description
private String	authorizationIssue
private final ScheduledExecutorService	backgroundThreadExecutor
private final AtomicReference<String>	comments
private String	communicationsTimeout
private final AtomicBoolean	configuredToTransmit
private RemoteProcessGroupCounts	counts
private Boolean	destinationSecure
private final EventReporter	eventReporter
private static final int	FORBIDDEN_STATUS_CODE
private final String	id
private boolean	initialized
private final Map<String,StandardRemoteGroupPort>	inputPorts
private Integer	listeningHttpPort
private Integer	listeningPort
private InetAddress	localAddress
private static final org.slf4j.Logger	logger
private final AtomicReference<String>	name
private String	networkInterfaceName
private ValidationResult	nicValidationResult
private final Map<String,StandardRemoteGroupPort>	outputPorts
private final AtomicReference<Position>	position
private final AtomicReference<ProcessGroup>	processGroup
private String	proxyHost
private String	proxyPassword
private Integer	proxyPort
private String	proxyUser
private final Lock	readLock
private Long	refreshContentsTimestamp
private final long	remoteContentsCacheExpiration
private final ReadWriteLock	rwLock
private final ProcessScheduler	scheduler
private final SSLContext	sslContext
private final StateManager	stateManager
private String	targetId
private String	targetUris
private final AtomicBoolean	transmitting
private SiteToSiteTransportProtocol	transportProtocol
private static final int	UNAUTHORIZED_STATUS_CODE
private final AtomicReference<String>	versionedComponentId
private final Lock	writeLock
private String	yieldDuration

Constructor Summary

Constructors

Constructor	Description
StandardRemoteProcessGroup(String id, String targetUris, ProcessGroup processGroup, ProcessScheduler processScheduler, BulletinRepository bulletinRepository, SSLContext sslContext, StateManager stateManager, long remoteContentsCacheExpirationMillis)

Method Summary

Modifier and Type	Method	Description
private StandardRemoteGroupPort	addInputPort(RemoteProcessGroupPortDescriptor descriptor)	Adds an InputPort to this ProcessGroup that is described by the given DTO.
private StandardRemoteGroupPort	addOutputPort(RemoteProcessGroupPortDescriptor descriptor)	Adds an Output Port to this Remote Process Group that is described by this DTO.
boolean	containsInputPort(String id)
boolean	containsOutputPort(String id)	Returns a boolean indicating whether or not an Output Port exists with the given ID
private Set<RemoteProcessGroupPortDescriptor>	convertRemotePort(Set<PortDTO> ports)	Converts a set of ports into a set of remote process group ports.
private String	generatePortId(String targetId)
String	getAuthorizationIssue()
String	getComments()
String	getCommunicationsTimeout()
int	getCommunicationsTimeout(TimeUnit timeUnit)
RemoteProcessGroupCounts	getCounts()
EventReporter	getEventReporter()
String	getIdentifier()
RemoteGroupPort	getInputPort(String portIdentifier)
int	getInputPortCount()
Set<RemoteGroupPort>	getInputPorts()
Date	getLastRefreshTime()
InetAddress	getLocalAddress()
String	getName()
String	getNetworkInterface()
RemoteGroupPort	getOutputPort(String portIdentifier)
int	getOutputPortCount()
Set<RemoteGroupPort>	getOutputPorts()
Authorizable	getParentAuthorizable()
Position	getPosition()
ProcessGroup	getProcessGroup()
String	getProcessGroupIdentifier()
String	getProxyHost()
String	getProxyPassword()
Integer	getProxyPort()
String	getProxyUser()
Resource	getResource()
Boolean	getSecureFlag()
private SiteToSiteRestApiClient	getSiteToSiteRestApiClient()
StateManager	getStateManager()
String	getTargetId()
String	getTargetUri()
String	getTargetUris()
SiteToSiteTransportProtocol	getTransportProtocol()
Optional<String>	getVersionedComponentId()
String	getYieldDuration()
void	initialize()
boolean	isConfiguredToTransmit()
private boolean	isConnectionTimeoutError(Exception e)	Returns true if the exception indicates the root cause is a connection timeout error.
boolean	isSecure()
boolean	isSiteToSiteEnabled()
boolean	isTransmitting()
void	onRemove()
void	refreshFlowContents()
void	reinitialize(boolean isClustered)
void	removeNonExistentPort(RemoteGroupPort port)	Shuts down and removes the given port
void	setComments(String comments)
void	setCommunicationsTimeout(String timePeriod)
private void	setCounts(RemoteProcessGroupCounts counts)
void	setInputPorts(Set<RemoteProcessGroupPortDescriptor> ports, boolean pruneUnusedPorts)	Changes the currently configured input ports to the ports described in the given set.
void	setName(String name)
void	setNetworkInterface(String interfaceName)
void	setOutputPorts(Set<RemoteProcessGroupPortDescriptor> ports, boolean pruneUnusedPorts)	Changes the currently configured output ports to the ports described in the given set.
void	setPosition(Position position)
void	setProcessGroup(ProcessGroup group)
void	setProxyHost(String proxyHost)
void	setProxyPassword(String proxyPassword)
void	setProxyPort(Integer proxyPort)
void	setProxyUser(String proxyUser)
void	setTargetId(String targetId)
void	setTargetUris(String targetUris)
void	setTransportProtocol(SiteToSiteTransportProtocol transportProtocol)
void	setVersionedComponentId(String versionedComponentId)
void	setYieldDuration(String yieldDuration)
void	shutdown()
void	startTransmitting()
void	startTransmitting(RemoteGroupPort port)
Future<?>	stopTransmitting()
void	stopTransmitting(RemoteGroupPort port)
String	toString()
Collection<ValidationResult>	validate()
void	verifyCanDelete()
void	verifyCanDelete(boolean ignoreConnections)
void	verifyCanStartTransmitting()
void	verifyCanStopTransmitting()
void	verifyCanUpdate()
private void	waitForPortShutdown()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.authorization.resource.Authorizable

authorize, authorize, checkAuthorization, checkAuthorization, getRequestedResource, isAuthorized

Field Details

logger

private static final org.slf4j.Logger logger

UNAUTHORIZED_STATUS_CODE

private static final int UNAUTHORIZED_STATUS_CODE

FORBIDDEN_STATUS_CODE

private static final int FORBIDDEN_STATUS_CODE

id

private final String id

targetUris

private volatile String targetUris

scheduler

private final ProcessScheduler scheduler

eventReporter

private final EventReporter eventReporter

stateManager

private final StateManager stateManager

remoteContentsCacheExpiration

private final long remoteContentsCacheExpiration

initialized

private volatile boolean initialized

name

private final AtomicReference<String> name

position

private final AtomicReference<Position> position

comments

private final AtomicReference<String> comments

processGroup

private final AtomicReference<ProcessGroup> processGroup

transmitting

private final AtomicBoolean transmitting

configuredToTransmit

private final AtomicBoolean configuredToTransmit

versionedComponentId

private final AtomicReference<String> versionedComponentId

sslContext

private final SSLContext sslContext

communicationsTimeout

private volatile String communicationsTimeout

targetId

private volatile String targetId

yieldDuration

private volatile String yieldDuration

transportProtocol

private volatile SiteToSiteTransportProtocol transportProtocol

proxyHost

private volatile String proxyHost

proxyPort

private volatile Integer proxyPort

proxyUser

private volatile String proxyUser

proxyPassword

private volatile String proxyPassword

networkInterfaceName

private String networkInterfaceName

localAddress

private InetAddress localAddress

nicValidationResult

private ValidationResult nicValidationResult

rwLock

private final ReadWriteLock rwLock

readLock

private final Lock readLock

writeLock

private final Lock writeLock

inputPorts

private final Map<String,StandardRemoteGroupPort> inputPorts

outputPorts

private final Map<String,StandardRemoteGroupPort> outputPorts

counts

private RemoteProcessGroupCounts counts

refreshContentsTimestamp

private Long refreshContentsTimestamp

destinationSecure

private Boolean destinationSecure

listeningPort

private Integer listeningPort

listeningHttpPort

private Integer listeningHttpPort

authorizationIssue

private volatile String authorizationIssue

backgroundThreadExecutor

private final ScheduledExecutorService backgroundThreadExecutor

Constructor Details

StandardRemoteProcessGroup

public StandardRemoteProcessGroup(String id,
 String targetUris,
 ProcessGroup processGroup,
 ProcessScheduler processScheduler,
 BulletinRepository bulletinRepository,
 SSLContext sslContext,
 StateManager stateManager,
 long remoteContentsCacheExpirationMillis)

Method Details

initialize

public void initialize()

Specified by:

initialize in interface RemoteProcessGroup

isConnectionTimeoutError

private boolean isConnectionTimeoutError(Exception e)

Returns true if the exception indicates the root cause is a connection timeout error.

Parameters:

e - the exception thrown connecting to the remote instance

Returns:

true if the error is due to a connection timeout

setTargetUris

public void setTargetUris(String targetUris)

Specified by:

setTargetUris in interface RemoteProcessGroup

reinitialize

public void reinitialize(boolean isClustered)

Specified by:

reinitialize in interface RemoteProcessGroup

onRemove

public void onRemove()

Specified by:

onRemove in interface RemoteProcessGroup

shutdown

public void shutdown()

Specified by:

shutdown in interface RemoteProcessGroup

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface ComponentAuthorizable

Specified by:

getIdentifier in interface RemoteProcessGroup

getProcessGroupIdentifier

public String getProcessGroupIdentifier()

Specified by:

getProcessGroupIdentifier in interface ComponentAuthorizable

getParentAuthorizable

public Authorizable getParentAuthorizable()

Specified by:

getParentAuthorizable in interface Authorizable

getResource

public Resource getResource()

Specified by:

getResource in interface Authorizable

getProcessGroup

public ProcessGroup getProcessGroup()

Specified by:

getProcessGroup in interface RemoteProcessGroup

setProcessGroup

public void setProcessGroup(ProcessGroup group)

Specified by:

setProcessGroup in interface RemoteProcessGroup

setTargetId

public void setTargetId(String targetId)

setTransportProtocol

public void setTransportProtocol(SiteToSiteTransportProtocol transportProtocol)

Specified by:

setTransportProtocol in interface RemoteProcessGroup

getTransportProtocol

public SiteToSiteTransportProtocol getTransportProtocol()

Specified by:

getTransportProtocol in interface RemoteProcessGroup

getProxyHost

public String getProxyHost()

Specified by:

getProxyHost in interface RemoteProcessGroup

setProxyHost

public void setProxyHost(String proxyHost)

Specified by:

setProxyHost in interface RemoteProcessGroup

getProxyPort

public Integer getProxyPort()

Specified by:

getProxyPort in interface RemoteProcessGroup

setProxyPort

public void setProxyPort(Integer proxyPort)

Specified by:

setProxyPort in interface RemoteProcessGroup

getProxyUser

public String getProxyUser()

Specified by:

getProxyUser in interface RemoteProcessGroup

setProxyUser

public void setProxyUser(String proxyUser)

Specified by:

setProxyUser in interface RemoteProcessGroup

getProxyPassword

public String getProxyPassword()

Specified by:

getProxyPassword in interface RemoteProcessGroup

setProxyPassword

public void setProxyPassword(String proxyPassword)

Specified by:

setProxyPassword in interface RemoteProcessGroup

getTargetId

public String getTargetId()

Returns:

the ID of the Root Group on the remote instance

getName

public String getName()

Specified by:

getName in interface RemoteProcessGroup

setName

public void setName(String name)

Specified by:

setName in interface RemoteProcessGroup

getCommunicationsTimeout

public String getCommunicationsTimeout()

Specified by:

getCommunicationsTimeout in interface RemoteProcessGroup

setCommunicationsTimeout

public void setCommunicationsTimeout(String timePeriod)
                              throws IllegalArgumentException

Specified by:

setCommunicationsTimeout in interface RemoteProcessGroup

Throws:

IllegalArgumentException

getCommunicationsTimeout

public int getCommunicationsTimeout(TimeUnit timeUnit)

Specified by:

getCommunicationsTimeout in interface RemoteProcessGroup

getComments

public String getComments()

Specified by:

getComments in interface RemoteProcessGroup

setComments

public void setComments(String comments)

Specified by:

setComments in interface RemoteProcessGroup

getPosition

public Position getPosition()

Specified by:

getPosition in interface Positionable

setPosition

public void setPosition(Position position)

Specified by:

setPosition in interface Positionable

getTargetUri

public String getTargetUri()

Specified by:

getTargetUri in interface RemoteProcessGroup

getTargetUris

public String getTargetUris()

Specified by:

getTargetUris in interface RemoteProcessGroup

getAuthorizationIssue

public String getAuthorizationIssue()

Specified by:

getAuthorizationIssue in interface RemoteProcessGroup

validate

public Collection<ValidationResult> validate()

Specified by:

validate in interface RemoteProcessGroup

getInputPortCount

public int getInputPortCount()

getOutputPortCount

public int getOutputPortCount()

containsInputPort

public boolean containsInputPort(String id)

setInputPorts

public void setInputPorts(Set<RemoteProcessGroupPortDescriptor> ports,
 boolean pruneUnusedPorts)

Changes the currently configured input ports to the ports described in the given set. If any port is currently configured that is not in the set given, that port will be shutdown and removed. If any port is currently not configured and is in the set given, that port will be instantiated and started.

Specified by:

setInputPorts in interface RemoteProcessGroup

Parameters:

ports - the new ports

pruneUnusedPorts - if true, any ports that are not included in the given set of ports and that do not have any incoming connections will be removed.

Throws:

NullPointerException - if the given argument is null

containsOutputPort

public boolean containsOutputPort(String id)

Returns a boolean indicating whether or not an Output Port exists with the given ID

Parameters:

id - identifier of port

Returns:

true if an Output Port exists with the given ID, false otherwise.

setOutputPorts

public void setOutputPorts(Set<RemoteProcessGroupPortDescriptor> ports,
 boolean pruneUnusedPorts)

Changes the currently configured output ports to the ports described in the given set. If any port is currently configured that is not in the set given, that port will be shutdown and removed. If any port is currently not configured and is in the set given, that port will be instantiated and started.

Specified by:

setOutputPorts in interface RemoteProcessGroup

Parameters:

ports - the new ports

pruneUnusedPorts - if true, will remove any ports that are not in the given list and that have no outgoing connections

Throws:

NullPointerException - if the given argument is null

removeNonExistentPort

public void removeNonExistentPort(RemoteGroupPort port)

Shuts down and removes the given port

Specified by:

removeNonExistentPort in interface RemoteProcessGroup

Throws:

NullPointerException - if the given output Port is null

IllegalStateException - if the port does not belong to this remote process group

addOutputPort

private StandardRemoteGroupPort addOutputPort(RemoteProcessGroupPortDescriptor descriptor)

Adds an Output Port to this Remote Process Group that is described by this DTO.

Parameters:

descriptor - the RPG port descriptor

Throws:

IllegalStateException - if an Output Port already exists with the ID given by dto.getId()

getInputPort

public RemoteGroupPort getInputPort(String portIdentifier)

Specified by:

getInputPort in interface RemoteProcessGroup

Parameters:

portIdentifier - the ID of the Port to send FlowFiles to

Returns:

RemoteGroupPort that can be used to send FlowFiles to the port whose ID is given on the remote instance

getInputPorts

public Set<RemoteGroupPort> getInputPorts()

Specified by:

getInputPorts in interface RemoteProcessGroup

Returns:

a set of Outgoing Ports used for transmitting FlowFiles to the remote instance

addInputPort

private StandardRemoteGroupPort addInputPort(RemoteProcessGroupPortDescriptor descriptor)

Adds an InputPort to this ProcessGroup that is described by the given DTO.

Parameters:

descriptor - port descriptor

Throws:

IllegalStateException - if an Input Port already exists with the ID given by the ID of the DTO.

generatePortId

private String generatePortId(String targetId)

getOutputPort

public RemoteGroupPort getOutputPort(String portIdentifier)

Specified by:

getOutputPort in interface RemoteProcessGroup

getOutputPorts

public Set<RemoteGroupPort> getOutputPorts()

Specified by:

getOutputPorts in interface RemoteProcessGroup

Returns:

a set of RemoteGroupPorts used for receiving FlowFiles from the remote instance

toString

public String toString()

Overrides:

toString in class Object

getCounts

public RemoteProcessGroupCounts getCounts()

Specified by:

getCounts in interface RemoteProcessGroup

setCounts

private void setCounts(RemoteProcessGroupCounts counts)

getLastRefreshTime

public Date getLastRefreshTime()

Specified by:

getLastRefreshTime in interface RemoteProcessGroup

refreshFlowContents

public void refreshFlowContents()
                         throws CommunicationsException

Specified by:

refreshFlowContents in interface RemoteProcessGroup

Throws:

CommunicationsException

getNetworkInterface

public String getNetworkInterface()

Specified by:

getNetworkInterface in interface RemoteProcessGroup

setNetworkInterface

public void setNetworkInterface(String interfaceName)

Specified by:

setNetworkInterface in interface RemoteProcessGroup

getLocalAddress

public InetAddress getLocalAddress()

Specified by:

getLocalAddress in interface RemoteProcessGroup

getSiteToSiteRestApiClient

private SiteToSiteRestApiClient getSiteToSiteRestApiClient()

convertRemotePort

private Set<RemoteProcessGroupPortDescriptor> convertRemotePort(Set<PortDTO> ports)

Converts a set of ports into a set of remote process group ports.

Parameters:

ports - to convert

Returns:

descriptors of ports

isTransmitting

public boolean isTransmitting()

Specified by:

isTransmitting in interface RemoteProcessGroup

isConfiguredToTransmit

public boolean isConfiguredToTransmit()

Specified by:

isConfiguredToTransmit in interface RemoteProcessGroup

startTransmitting

public void startTransmitting()

Specified by:

startTransmitting in interface RemoteProcessGroup

startTransmitting

public void startTransmitting(RemoteGroupPort port)

Specified by:

startTransmitting in interface RemoteProcessGroup

stopTransmitting

public Future<?> stopTransmitting()

Specified by:

stopTransmitting in interface RemoteProcessGroup

waitForPortShutdown

private void waitForPortShutdown()

stopTransmitting

public void stopTransmitting(RemoteGroupPort port)

Specified by:

stopTransmitting in interface RemoteProcessGroup

isSecure

public boolean isSecure()
                 throws CommunicationsException

Specified by:

isSecure in interface RemoteProcessGroup

Throws:

CommunicationsException

getSecureFlag

public Boolean getSecureFlag()

Specified by:

getSecureFlag in interface RemoteProcessGroup

isSiteToSiteEnabled

public boolean isSiteToSiteEnabled()

Specified by:

isSiteToSiteEnabled in interface RemoteProcessGroup

getEventReporter

public EventReporter getEventReporter()

Specified by:

getEventReporter in interface RemoteProcessGroup

setYieldDuration

public void setYieldDuration(String yieldDuration)

Specified by:

setYieldDuration in interface RemoteProcessGroup

getYieldDuration

public String getYieldDuration()

Specified by:

getYieldDuration in interface RemoteProcessGroup

verifyCanDelete

public void verifyCanDelete()

Specified by:

verifyCanDelete in interface RemoteProcessGroup

verifyCanDelete

public void verifyCanDelete(boolean ignoreConnections)

Specified by:

verifyCanDelete in interface RemoteProcessGroup

verifyCanStartTransmitting

public void verifyCanStartTransmitting()

Specified by:

verifyCanStartTransmitting in interface RemoteProcessGroup

verifyCanStopTransmitting

public void verifyCanStopTransmitting()

Specified by:

verifyCanStopTransmitting in interface RemoteProcessGroup

verifyCanUpdate

public void verifyCanUpdate()

Specified by:

verifyCanUpdate in interface RemoteProcessGroup

getVersionedComponentId

public Optional<String> getVersionedComponentId()

Specified by:

getVersionedComponentId in interface VersionedComponent

setVersionedComponentId

public void setVersionedComponentId(String versionedComponentId)

Specified by:

setVersionedComponentId in interface VersionedComponent

getStateManager

public StateManager getStateManager()

Specified by:

getStateManager in interface RemoteProcessGroup