org.apache.nifi.connectable

Class StandardConnection

java.lang.Object

org.apache.nifi.connectable.StandardConnection

All Implemented Interfaces:

Authorizable, VersionedComponent, Connection, ConnectionEventListener

public final class StandardConnection
extends Object
implements Connection, ConnectionEventListener

Models a connection between connectable components. A connection may contain one or more relationships that map the source component to the destination component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardConnection.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicReference<List<Position>>	bendPoints
private AtomicReference<Connectable>	destination
private FlowFileQueue	flowFileQueue
private int	hashCode
private String	id
private AtomicInteger	labelIndex
private AtomicReference<String>	name
private AtomicReference<ProcessGroup>	processGroup
private AtomicReference<Collection<Relationship>>	relationships
private ProcessScheduler	scheduler
private Connectable	source
private AtomicReference<String>	versionedComponentId
private AtomicLong	zIndex

Fields inherited from interface org.apache.nifi.controller.queue.ConnectionEventListener

NOP_EVENT_LISTENER

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StandardConnection(StandardConnection.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	authorize(Authorizer authorizer, RequestAction action, NiFiUser user, Map<String,String> resourceContext)
AuthorizationResult	checkAuthorization(Authorizer authorizer, RequestAction action, NiFiUser user, Map<String,String> resourceContext)
void	enqueue(Collection<FlowFileRecord> flowFiles)
void	enqueue(FlowFileRecord flowFile) Gives this Connection ownership of the given FlowFile and allows the Connection to hold on to the FlowFile but NOT provide the FlowFile to consumers.
boolean	equals(Object other)
List<Position>	getBendPoints()
Connectable	getDestination()
Authorizable	getDestinationAuthorizable()
FlowFileQueue	getFlowFileQueue()
String	getIdentifier()
int	getLabelIndex()
String	getName()
Authorizable	getParentAuthorizable()
ProcessGroup	getProcessGroup()
Collection<Relationship>	getRelationships()
Resource	getResource()
Connectable	getSource()
Authorizable	getSourceAuthorizable()
Optional<String>	getVersionedComponentId()
long	getZIndex()
int	hashCode()
void	lock()
List<FlowFileRecord>	poll(FlowFileFilter filter, Set<FlowFileRecord> expiredRecords)
FlowFileRecord	poll(Set<FlowFileRecord> expiredRecords)
void	setBendPoints(List<Position> position)
void	setDestination(Connectable newDestination)
void	setLabelIndex(int labelIndex)
void	setName(String name)
void	setProcessGroup(ProcessGroup newGroup)
void	setRelationships(Collection<Relationship> newRelationships)
void	setVersionedComponentId(String versionedComponentId)
void	setZIndex(long zIndex)
String	toString()
void	triggerDestinationEvent()
void	triggerSourceEvent()
void	unlock()
void	verifyCanDelete()
void	verifyCanUpdate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

authorize, checkAuthorization, getRequestedResource, isAuthorized

Field Detail

id

private final String id

processGroup

private final AtomicReference<ProcessGroup> processGroup

name

private final AtomicReference<String> name

bendPoints

private final AtomicReference<List<Position>> bendPoints

source

private final Connectable source

destination

private final AtomicReference<Connectable> destination

relationships

private final AtomicReference<Collection<Relationship>> relationships

labelIndex

private final AtomicInteger labelIndex

zIndex

private final AtomicLong zIndex

versionedComponentId

private final AtomicReference<String> versionedComponentId

scheduler

private final ProcessScheduler scheduler

hashCode

private final int hashCode

flowFileQueue

private volatile FlowFileQueue flowFileQueue

Constructor Detail

StandardConnection

private StandardConnection(StandardConnection.Builder builder)

Method Detail

getProcessGroup

public ProcessGroup getProcessGroup()

Specified by:

getProcessGroup in interface Connection

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface Connection

getName

public String getName()

Specified by:

getName in interface Connection

setName

public void setName(String name)

Specified by:

setName in interface Connection

getParentAuthorizable

public Authorizable getParentAuthorizable()

Specified by:

getParentAuthorizable in interface Authorizable

getResource

public Resource getResource()

Specified by:

getResource in interface Authorizable

triggerDestinationEvent

public void triggerDestinationEvent()

Specified by:

triggerDestinationEvent in interface ConnectionEventListener

triggerSourceEvent

public void triggerSourceEvent()

Specified by:

triggerSourceEvent in interface ConnectionEventListener

getSourceAuthorizable

public Authorizable getSourceAuthorizable()

Specified by:

getSourceAuthorizable in interface Connection

getDestinationAuthorizable

public Authorizable getDestinationAuthorizable()

Specified by:

getDestinationAuthorizable in interface Connection

checkAuthorization

public AuthorizationResult checkAuthorization(Authorizer authorizer,
                                              RequestAction action,
                                              NiFiUser user,
                                              Map<String,String> resourceContext)

Specified by:

checkAuthorization in interface Authorizable

authorize

public void authorize(Authorizer authorizer,
                      RequestAction action,
                      NiFiUser user,
                      Map<String,String> resourceContext)
               throws AccessDeniedException

Specified by:

authorize in interface Authorizable

Throws:

AccessDeniedException

getBendPoints

public List<Position> getBendPoints()

Specified by:

getBendPoints in interface Connection

setBendPoints

public void setBendPoints(List<Position> position)

Specified by:

setBendPoints in interface Connection

getLabelIndex

public int getLabelIndex()

Specified by:

getLabelIndex in interface Connection

setLabelIndex

public void setLabelIndex(int labelIndex)

Specified by:

setLabelIndex in interface Connection

getZIndex

public long getZIndex()

Specified by:

getZIndex in interface Connection

setZIndex

public void setZIndex(long zIndex)

Specified by:

setZIndex in interface Connection

getSource

public Connectable getSource()

Specified by:

getSource in interface Connection

getDestination

public Connectable getDestination()

Specified by:

getDestination in interface Connection

getRelationships

public Collection<Relationship> getRelationships()

Specified by:

getRelationships in interface Connection

getFlowFileQueue

public FlowFileQueue getFlowFileQueue()

Specified by:

getFlowFileQueue in interface Connection

setProcessGroup

public void setProcessGroup(ProcessGroup newGroup)

Specified by:

setProcessGroup in interface Connection

setRelationships

public void setRelationships(Collection<Relationship> newRelationships)

Specified by:

setRelationships in interface Connection

setDestination

public void setDestination(Connectable newDestination)

Specified by:

setDestination in interface Connection

lock

public void lock()

Specified by:

lock in interface Connection

unlock

public void unlock()

Specified by:

unlock in interface Connection

poll

public List<FlowFileRecord> poll(FlowFileFilter filter,
                                 Set<FlowFileRecord> expiredRecords)

Specified by:

poll in interface Connection

poll

public FlowFileRecord poll(Set<FlowFileRecord> expiredRecords)

Specified by:

poll in interface Connection

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

enqueue

public void enqueue(FlowFileRecord flowFile)

Gives this Connection ownership of the given FlowFile and allows the Connection to hold on to the FlowFile but NOT provide the FlowFile to consumers. This allows us to ensure that the Connection is not deleted during the middle of a Session commit.

Specified by:

enqueue in interface Connection

Parameters:

flowFile - to add

enqueue

public void enqueue(Collection<FlowFileRecord> flowFiles)

Specified by:

enqueue in interface Connection

verifyCanUpdate

public void verifyCanUpdate()

Specified by:

verifyCanUpdate in interface Connection

verifyCanDelete

public void verifyCanDelete()

Specified by:

verifyCanDelete in interface Connection

getVersionedComponentId

public Optional<String> getVersionedComponentId()

Specified by:

getVersionedComponentId in interface VersionedComponent

setVersionedComponentId

public void setVersionedComponentId(String versionedComponentId)

Specified by:

setVersionedComponentId in interface VersionedComponent