org.apache.nifi.connectable

Interface Connectable

All Superinterfaces:

Authorizable, ComponentAuthorizable, Positionable, Triggerable

All Known Subinterfaces:

Funnel, Port, RootGroupPort

All Known Implementing Classes:

AbstractPort, LocalPort, ProcessorNode, RemoteGroupPort, StandardFunnel, StandardProcessorNode, StandardRemoteGroupPort, StandardRootGroupPort

public interface Connectable
extends Triggerable, ComponentAuthorizable, Positionable

Represents a connectable component to which or from which data can flow.

Field Summary

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

MINIMUM_SCHEDULING_NANOS

Method Summary

Modifier and Type	Method and Description
void	addConnection(Connection connection) Adds the given connection to this Connectable.
java.lang.String	getComments()
java.lang.String	getComponentType()
ConnectableType	getConnectableType()
java.util.Set<Connection>	getConnections()
java.util.Set<Connection>	getConnections(Relationship relationship)
java.lang.String	getIdentifier() The identifier of the underlying component.
java.util.List<Connection>	getIncomingConnections()
java.lang.String	getName()
java.lang.String	getPenalizationPeriod()
long	getPenalizationPeriod(java.util.concurrent.TimeUnit timeUnit)
ProcessGroup	getProcessGroup()
Relationship	getRelationship(java.lang.String relationshipName) Returns the ProcessorRelationship whose name is given
java.util.Collection<Relationship>	getRelationships()
SchedulingStrategy	getSchedulingStrategy()
java.util.Collection<ValidationResult>	getValidationErrors()
long	getYieldExpiration()
java.lang.String	getYieldPeriod()
long	getYieldPeriod(java.util.concurrent.TimeUnit timeUnit)
boolean	hasIncomingConnection()
boolean	isAutoTerminated(Relationship relationship)
boolean	isLossTolerant()
boolean	isSideEffectFree()
boolean	isTriggerWhenEmpty()
void	removeConnection(Connection connection)
void	setComments(java.lang.String comments) Sets the comments of this Connectable.
void	setLossTolerant(boolean lossTolerant)
void	setName(java.lang.String name) Sets the name of this Connectable so that its name will be visible on the UI
void	setPenalizationPeriod(java.lang.String penalizationPeriod) Updates the amount of time that this Connectable will penalize FlowFiles when ProcessSession.penalize(org.apache.nifi.flowfile.FlowFile) is called
void	setProcessGroup(ProcessGroup group) Sets the new ProcessGroup to which this Connectable belongs
void	setYieldPeriod(java.lang.String yieldPeriod) Updates the amount of time that this Connectable should avoid being scheduled when the processor calls ProcessContext.yield()
void	updateConnection(Connection newConnection) Updates any internal state that depends on the given connection.
void	verifyCanClearState()
void	verifyCanDelete()
void	verifyCanDelete(boolean ignoreConnections)
void	verifyCanDisable()
void	verifyCanEnable()
void	verifyCanStart()
void	verifyCanStop()
void	verifyCanUpdate()
void	yield() Causes the processor not to be scheduled for some period of time.

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

getMaxConcurrentTasks, getScheduledState, getSchedulingPeriod, getSchedulingPeriod, isRunning, onTrigger, setMaxConcurrentTasks, setScheduldingPeriod

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

getProcessGroupIdentifier

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

authorize, authorize, checkAuthorization, checkAuthorization, getParentAuthorizable, getRequestedResource, getResource, isAuthorized

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

getPosition, setPosition

Method Detail

getIdentifier

java.lang.String getIdentifier()

Description copied from interface: ComponentAuthorizable

The identifier of the underlying component.

Specified by:

getIdentifier in interface ComponentAuthorizable

Returns:

the unique identifier for this Connectable

getRelationships

java.util.Collection<Relationship> getRelationships()

Returns:

a Collection of all relationships for this Connectable

getRelationship

Relationship getRelationship(java.lang.String relationshipName)

Returns the ProcessorRelationship whose name is given

Parameters:

relationshipName - name

Returns:

a ProcessorRelationship whose name is given, or null if none exists

addConnection

void addConnection(Connection connection)
            throws java.lang.IllegalArgumentException

Adds the given connection to this Connectable.

Parameters:

connection - the connection to add

Throws:

java.lang.NullPointerException - if the argument is null

java.lang.IllegalArgumentException - if the given Connection is not valid

hasIncomingConnection

boolean hasIncomingConnection()

Returns:

true if the Connectable is the destination of any other Connectable, false otherwise.

removeConnection

void removeConnection(Connection connection)
               throws java.lang.IllegalStateException

Parameters:

connection - to remove

Throws:

java.lang.IllegalStateException - if the given Connection is not registered to this.

updateConnection

void updateConnection(Connection newConnection)
               throws java.lang.IllegalStateException

Updates any internal state that depends on the given connection. The given connection will share the same ID as the old connection.

Parameters:

newConnection - new connection

Throws:

java.lang.IllegalStateException - ise

getIncomingConnections

java.util.List<Connection> getIncomingConnections()

Returns:

a Set of all Connections for which this Connectable is the destination

getConnections

java.util.Set<Connection> getConnections()

Returns:

a Set of all Connections for which this Connectable is the source; if no connections exist, will return an empty Collection. Guaranteed not null.

getConnections

java.util.Set<Connection> getConnections(Relationship relationship)

Parameters:

relationship - to get connections for

Returns:

a Set of all Connections that contain the given relationship for which this Connectable is the source

getName

java.lang.String getName()

Returns:

the name of this Connectable

setName

void setName(java.lang.String name)

Sets the name of this Connectable so that its name will be visible on the UI

Parameters:

name - new name

getComments

java.lang.String getComments()

Returns:

the comments of this Connectable

setComments

void setComments(java.lang.String comments)

Sets the comments of this Connectable.

Parameters:

comments - of this Connectable

isTriggerWhenEmpty

boolean isTriggerWhenEmpty()

Returns:

If true, Triggerable.onTrigger(org.apache.nifi.processor.ProcessContext, org.apache.nifi.processor.ProcessSessionFactory) should be called even when this Connectable has no FlowFiles queued for processing

getProcessGroup

ProcessGroup getProcessGroup()

Returns:

the ProcessGroup to which this Connectable belongs

setProcessGroup

void setProcessGroup(ProcessGroup group)

Sets the new ProcessGroup to which this Connectable belongs

Parameters:

group - new group

isAutoTerminated

boolean isAutoTerminated(Relationship relationship)

Parameters:

relationship - the relationship

Returns:

true indicates flow files transferred to the given relationship should be terminated if the relationship is not connected to another FlowFileConsumer; false indicates they will not be terminated and the processor will not be valid until specified

isLossTolerant

boolean isLossTolerant()

Returns:

Indicates whether flow file content made by this connectable must be persisted

setLossTolerant

void setLossTolerant(boolean lossTolerant)

Parameters:

lossTolerant - true if it is

getConnectableType

ConnectableType getConnectableType()

Returns:

the type of the Connectable

getValidationErrors

java.util.Collection<ValidationResult> getValidationErrors()

Returns:

any validation errors for this connectable

getPenalizationPeriod

long getPenalizationPeriod(java.util.concurrent.TimeUnit timeUnit)

Parameters:

timeUnit - unit over which to interpret the duration

Returns:

the amount of time for which a FlowFile should be penalized when ProcessSession.penalize(org.apache.nifi.flowfile.FlowFile) is called

getPenalizationPeriod

java.lang.String getPenalizationPeriod()

Returns:

a string representation for which a FlowFile should be penalized when ProcessSession.penalize(org.apache.nifi.flowfile.FlowFile) is called

getYieldPeriod

long getYieldPeriod(java.util.concurrent.TimeUnit timeUnit)

Parameters:

timeUnit - determines the unit of time to represent the yield period.

Returns:

yield period

getYieldPeriod

java.lang.String getYieldPeriod()

Returns:

the string representation for this Connectable's configured yield period

setYieldPeriod

void setYieldPeriod(java.lang.String yieldPeriod)

Updates the amount of time that this Connectable should avoid being scheduled when the processor calls ProcessContext.yield()

Parameters:

yieldPeriod - new yield period

setPenalizationPeriod

void setPenalizationPeriod(java.lang.String penalizationPeriod)

Updates the amount of time that this Connectable will penalize FlowFiles when ProcessSession.penalize(org.apache.nifi.flowfile.FlowFile) is called

Parameters:

penalizationPeriod - new period

yield

void yield()

Causes the processor not to be scheduled for some period of time. This duration can be obtained and set via the getYieldPeriod(TimeUnit) and setYieldPeriod(String yieldPeriod) methods.

getYieldExpiration

long getYieldExpiration()

Returns:

the time in milliseconds since Epoch at which this Connectable should no longer yield its threads

isSideEffectFree

boolean isSideEffectFree()

Returns:

Specifies whether or not this component is considered side-effect free, with respect to external systems

verifyCanDelete

void verifyCanDelete()
              throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

verifyCanDelete

void verifyCanDelete(boolean ignoreConnections)
              throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

verifyCanStart

void verifyCanStart()
             throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

verifyCanStop

void verifyCanStop()
            throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

verifyCanUpdate

void verifyCanUpdate()
              throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

verifyCanEnable

void verifyCanEnable()
              throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

verifyCanDisable

void verifyCanDisable()
               throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

verifyCanClearState

void verifyCanClearState()
                  throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

getSchedulingStrategy

SchedulingStrategy getSchedulingStrategy()

getComponentType

java.lang.String getComponentType()

Returns:

the type of the component. I.e., the class name of the implementation