Package org.apache.nifi.connectable

Class LocalPort

java.lang.Object

org.apache.nifi.controller.AbstractPort

org.apache.nifi.connectable.LocalPort

All Implemented Interfaces:

Authorizable, ComponentAuthorizable, VersionedComponent, Connectable, Port, Positionable, Triggerable, GroupedComponent

public class LocalPort
extends AbstractPort

Provides a mechanism by which FlowFiles can be transferred into and out of a ProcessGroup to and/or from another ProcessGroup within the same instance of NiFi.

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	logger
private final int	maxIterations
private final Lock	readLock
private final ReadWriteLock	rwLock
private final Lock	writeLock

Fields inherited from class org.apache.nifi.controller.AbstractPort

PORT_RELATIONSHIP

Fields inherited from interface org.apache.nifi.controller.Triggerable

MINIMUM_SCHEDULING_NANOS

Constructor Summary

Constructors

Constructor	Description
LocalPort(String id, String name, ConnectableType type, ProcessScheduler scheduler, int maxConcurrentTasks, int maxBatchSize, String boredYieldDuration)

Method Summary

Modifier and Type	Method	Description
void	addConnection(Connection connection)
String	getComponentType()
Set<Connection>	getConnections()
Set<Connection>	getConnections(Relationship relationship)
List<Connection>	getIncomingConnections()
SchedulingStrategy	getSchedulingStrategy()
Collection<ValidationResult>	getValidationErrors()
boolean	hasIncomingConnection()
private boolean	hasOutboundConnection()
private boolean	isOutboundConnectionRequired()	An Outbound Connection is required for a Local Port unless all of the following conditions are met:
boolean	isSideEffectFree()
private boolean	isTransferDataOut()
boolean	isTriggerWhenEmpty()
boolean	isValid()
void	onTrigger(ProcessContext context, ProcessSession session)
void	removeConnection(Connection connection)
String	toString()
private void	transferInputBatch(ProcessSession session)
private void	transferSingleFlowFile(ProcessSession session)
protected void	transferUnboundedConcurrency(ProcessContext context, ProcessSession session)
private void	triggerInputPort(ProcessContext context, ProcessSession session)
private void	triggerOutputPort(ProcessContext context, ProcessSession session)
void	updateConnection(Connection connection)

Methods inherited from class org.apache.nifi.controller.AbstractPort

disable, enable, evaluateParameters, getBackoffMechanism, getComments, getConnectableType, getIdentifier, getMaxBackoffPeriod, getMaxConcurrentTasks, getName, getParentAuthorizable, getPenalizationPeriod, getPenalizationPeriod, getPortFunction, getPosition, getProcessGroup, getProcessGroupIdentifier, getRelationship, getRelationships, getResource, getRetriedRelationships, getRetryCount, getScheduledState, getSchedulingPeriod, getSchedulingPeriod, getVersionedComponentId, getYieldExpiration, getYieldPeriod, getYieldPeriod, isAutoTerminated, isLossTolerant, isRelationshipRetried, isRunning, onSchedulingStart, onTrigger, setBackoffMechanism, setComments, setLossTolerant, setMaxBackoffPeriod, setMaxConcurrentTasks, setName, setPenalizationPeriod, setPortFunction, setPosition, setProcessGroup, setRetriedRelationships, setRetryCount, setSchedulingPeriod, setVersionedComponentId, setYieldPeriod, shutdown, verifyCanClearState, verifyCanDelete, verifyCanDelete, verifyCanDisable, verifyCanEnable, verifyCanStart, verifyCanStop, verifyCanUpdate, yield, yield

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

Methods inherited from interface org.apache.nifi.connectable.Connectable

getRunDuration, getRunnableComponent, isIsolated, isSessionBatchingSupported, isTriggerWhenAnyDestinationAvailable

Field Details

logger

private static final org.slf4j.Logger logger

rwLock

private final ReadWriteLock rwLock

readLock

private final Lock readLock

writeLock

private final Lock writeLock

maxIterations

private final int maxIterations

Constructor Details

LocalPort

public LocalPort(String id,
 String name,
 ConnectableType type,
 ProcessScheduler scheduler,
 int maxConcurrentTasks,
 int maxBatchSize,
 String boredYieldDuration)

Method Details

isValid

public boolean isValid()

Specified by:

isValid in interface Port

Specified by:

isValid in class AbstractPort

hasOutboundConnection

private boolean hasOutboundConnection()

isOutboundConnectionRequired

private boolean isOutboundConnectionRequired()

An Outbound Connection is required for a Local Port unless all of the following conditions are met:

• Group is using the Stateless Execution Engine
• There is no Input Port to the Group
• The Port is a failure port

Under these conditions, it is not necessary to have an outbound connection because anything that gets routed to the Port will end up being rolled back anyway, and since there is no Input Port, there is no input FlowFile to route to failure.

Returns:

true if an Outbound Connection is required in order for the Port to be valid, false otherwise

getValidationErrors

public Collection<ValidationResult> getValidationErrors()

onTrigger

public void onTrigger(ProcessContext context,
 ProcessSession session)

Specified by:

onTrigger in class AbstractPort

triggerOutputPort

private void triggerOutputPort(ProcessContext context,
 ProcessSession session)

triggerInputPort

private void triggerInputPort(ProcessContext context,
 ProcessSession session)

isTransferDataOut

private boolean isTransferDataOut()

transferInputBatch

private void transferInputBatch(ProcessSession session)

transferSingleFlowFile

private void transferSingleFlowFile(ProcessSession session)

transferUnboundedConcurrency

protected void transferUnboundedConcurrency(ProcessContext context,
 ProcessSession session)

updateConnection

public void updateConnection(Connection connection)
                      throws IllegalStateException

Specified by:

updateConnection in interface Connectable

Overrides:

updateConnection in class AbstractPort

Throws:

IllegalStateException

addConnection

public void addConnection(Connection connection)
                   throws IllegalArgumentException

Specified by:

addConnection in interface Connectable

Overrides:

addConnection in class AbstractPort

Throws:

IllegalArgumentException

removeConnection

public void removeConnection(Connection connection)
                      throws IllegalArgumentException,
IllegalStateException

Specified by:

removeConnection in interface Connectable

Overrides:

removeConnection in class AbstractPort

Throws:

IllegalArgumentException

IllegalStateException

getConnections

public Set<Connection> getConnections()

Specified by:

getConnections in interface Connectable

Overrides:

getConnections in class AbstractPort

getConnections

public Set<Connection> getConnections(Relationship relationship)

Specified by:

getConnections in interface Connectable

Overrides:

getConnections in class AbstractPort

getIncomingConnections

public List<Connection> getIncomingConnections()

Specified by:

getIncomingConnections in interface Connectable

Overrides:

getIncomingConnections in class AbstractPort

hasIncomingConnection

public boolean hasIncomingConnection()

Specified by:

hasIncomingConnection in interface Connectable

Overrides:

hasIncomingConnection in class AbstractPort

isTriggerWhenEmpty

public boolean isTriggerWhenEmpty()

getSchedulingStrategy

public SchedulingStrategy getSchedulingStrategy()

isSideEffectFree

public boolean isSideEffectFree()

getComponentType

public String getComponentType()

toString

public String toString()

Overrides:

toString in class AbstractPort