org.apache.nifi.remote

Class StandardPublicPort

java.lang.Object

org.apache.nifi.controller.AbstractPort

org.apache.nifi.remote.StandardPublicPort

All Implemented Interfaces:

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

public class StandardPublicPort
extends AbstractPort
implements PublicPort

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	StandardPublicPort.FlowFileRequest
private static class	StandardPublicPort.ProcessingResult
static class	StandardPublicPort.StandardPortAuthorizationResult

Field Summary

Fields

Modifier and Type	Field and Description
private Set<StandardPublicPort.FlowFileRequest>	activeRequests
private Authorizer	authorizer
private BulletinRepository	bulletinRepository
private static String	CATEGORY
private TransferDirection	direction
private EventReporter	eventReporter
private AtomicReference<Set<String>>	groupAccessControl
private List<org.apache.nifi.authorization.util.IdentityMapping>	identityMappings
private static org.slf4j.Logger	logger
private Set<Relationship>	relationships
private Lock	requestLock
private BlockingQueue<StandardPublicPort.FlowFileRequest>	requestQueue
private ProcessScheduler	scheduler
private boolean	secure
private boolean	shutdown
private AtomicReference<Set<String>>	userAccessControl

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 and Description
StandardPublicPort(String id, String name, TransferDirection direction, ConnectableType type, Authorizer authorizer, BulletinRepository bulletinRepository, ProcessScheduler scheduler, boolean secure, String yieldPeriod, List<org.apache.nifi.authorization.util.IdentityMapping> identityMappings)

Method Summary

Modifier and Type	Method and Description
PortAuthorizationResult	checkUserAuthorization(NiFiUser user)
PortAuthorizationResult	checkUserAuthorization(String dn)
String	getComponentType()
TransferDirection	getDirection()
Set<String>	getGroupAccessControl()
Collection<Relationship>	getRelationships()
SchedulingStrategy	getSchedulingStrategy()
Set<String>	getUserAccessControl()
Collection<ValidationResult>	getValidationErrors()
boolean	isSideEffectFree()
boolean	isTransmitting()
boolean	isTriggerWhenEmpty()
boolean	isValid() Returns true if the port is not a local input port (remote input ports are handled by StandardRemoteGroupPort), or if the local input port has at least one available connection.
void	onSchedulingStart()
void	onTrigger(ProcessContext context, ProcessSession session)
void	onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory)
private void	onTrigger(ProcessContext context, ProcessSession session, StandardPublicPort.FlowFileRequest flowFileRequest)
int	receiveFlowFiles(Peer peer, ServerProtocol serverProtocol)
private int	receiveFlowFiles(ProcessContext context, ProcessSession session, org.apache.nifi.remote.codec.FlowFileCodec codec, StandardPublicPort.FlowFileRequest receiveRequest)
void	setGroupAccessControl(Set<String> groups)
void	setUserAccessControl(Set<String> users)
void	shutdown()
String	toString()
int	transferFlowFiles(Peer peer, ServerProtocol serverProtocol)
private int	transferFlowFiles(ProcessContext context, ProcessSession session, org.apache.nifi.remote.codec.FlowFileCodec codec, StandardPublicPort.FlowFileRequest request)

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

addConnection, disable, enable, evaluateParameters, getBackoffMechanism, getComments, getConnectableType, getConnections, getConnections, getIdentifier, getIncomingConnections, getMaxBackoffPeriod, getMaxConcurrentTasks, getName, getParentAuthorizable, getPenalizationPeriod, getPenalizationPeriod, getPosition, getProcessGroup, getProcessGroupIdentifier, getRelationship, getResource, getRetriedRelationships, getRetryCount, getScheduledState, getSchedulingPeriod, getSchedulingPeriod, getVersionedComponentId, getYieldExpiration, getYieldPeriod, getYieldPeriod, hasIncomingConnection, isAutoTerminated, isLossTolerant, isRelationshipRetried, isRunning, removeConnection, setBackoffMechanism, setComments, setLossTolerant, setMaxBackoffPeriod, setMaxConcurrentTasks, setName, setPenalizationPeriod, setPosition, setProcessGroup, setRetriedRelationships, setRetryCount, setSchedulingPeriod, setVersionedComponentId, setYieldPeriod, updateConnection, 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.connectable.Port

disable

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

addConnection, evaluateParameters, getBackoffMechanism, getComments, getConnectableType, getConnections, getConnections, getIdentifier, getIncomingConnections, getMaxBackoffPeriod, getName, getPenalizationPeriod, getPenalizationPeriod, getProcessGroup, getRelationship, getRetriedRelationships, getRetryCount, getRunDuration, getRunnableComponent, getYieldExpiration, getYieldPeriod, getYieldPeriod, hasIncomingConnection, isAutoTerminated, isIsolated, isLossTolerant, isRelationshipRetried, isSessionBatchingSupported, isTriggerWhenAnyDestinationAvailable, removeConnection, setBackoffMechanism, setComments, setLossTolerant, setMaxBackoffPeriod, setName, setPenalizationPeriod, setProcessGroup, setRetriedRelationships, setRetryCount, setYieldPeriod, updateConnection, verifyCanClearState, verifyCanDelete, verifyCanDelete, verifyCanDisable, verifyCanEnable, verifyCanStart, verifyCanStop, verifyCanUpdate, yield, yield

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

getMaxConcurrentTasks, getScheduledState, getSchedulingPeriod, getSchedulingPeriod, isRunning, setMaxConcurrentTasks, setSchedulingPeriod

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

Methods inherited from interface org.apache.nifi.components.VersionedComponent

getVersionedComponentId, setVersionedComponentId

Field Detail

CATEGORY

private static final String CATEGORY

See Also:

Constant Field Values

logger

private static final org.slf4j.Logger logger

groupAccessControl

private final AtomicReference<Set<String>> groupAccessControl

userAccessControl

private final AtomicReference<Set<String>> userAccessControl

secure

private final boolean secure

authorizer

private final Authorizer authorizer

identityMappings

private final List<org.apache.nifi.authorization.util.IdentityMapping> identityMappings

direction

private TransferDirection direction

bulletinRepository

private final BulletinRepository bulletinRepository

eventReporter

private final EventReporter eventReporter

scheduler

private final ProcessScheduler scheduler

relationships

private final Set<Relationship> relationships

requestQueue

private final BlockingQueue<StandardPublicPort.FlowFileRequest> requestQueue

activeRequests

private final Set<StandardPublicPort.FlowFileRequest> activeRequests

requestLock

private final Lock requestLock

shutdown

private boolean shutdown

Constructor Detail

StandardPublicPort

public StandardPublicPort(String id,
                          String name,
                          TransferDirection direction,
                          ConnectableType type,
                          Authorizer authorizer,
                          BulletinRepository bulletinRepository,
                          ProcessScheduler scheduler,
                          boolean secure,
                          String yieldPeriod,
                          List<org.apache.nifi.authorization.util.IdentityMapping> identityMappings)

Method Detail

getRelationships

public Collection<Relationship> getRelationships()

Specified by:

getRelationships in interface Connectable

Overrides:

getRelationships in class AbstractPort

isTriggerWhenEmpty

public boolean isTriggerWhenEmpty()

Specified by:

isTriggerWhenEmpty in interface Connectable

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSessionFactory sessionFactory)

Specified by:

onTrigger in interface Triggerable

Overrides:

onTrigger in class AbstractPort

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractPort

Throws:

ProcessException

onTrigger

private void onTrigger(ProcessContext context,
                       ProcessSession session,
                       StandardPublicPort.FlowFileRequest flowFileRequest)

transferFlowFiles

private int transferFlowFiles(ProcessContext context,
                              ProcessSession session,
                              org.apache.nifi.remote.codec.FlowFileCodec codec,
                              StandardPublicPort.FlowFileRequest request)
                       throws IOException

Throws:

IOException

receiveFlowFiles

private int receiveFlowFiles(ProcessContext context,
                             ProcessSession session,
                             org.apache.nifi.remote.codec.FlowFileCodec codec,
                             StandardPublicPort.FlowFileRequest receiveRequest)
                      throws IOException

Throws:

IOException

isValid

public boolean isValid()

Returns true if the port is not a local input port (remote input ports are handled by StandardRemoteGroupPort), or if the local input port has at least one available connection.

Specified by:

isValid in interface Port

Specified by:

isValid in class AbstractPort

Returns:

true if this port is valid

getValidationErrors

public Collection<ValidationResult> getValidationErrors()

Specified by:

getValidationErrors in interface Connectable

isTransmitting

public boolean isTransmitting()

Specified by:

isTransmitting in interface PublicPort

setGroupAccessControl

public void setGroupAccessControl(Set<String> groups)

Specified by:

setGroupAccessControl in interface PublicPort

getGroupAccessControl

public Set<String> getGroupAccessControl()

Specified by:

getGroupAccessControl in interface PublicPort

setUserAccessControl

public void setUserAccessControl(Set<String> users)

Specified by:

setUserAccessControl in interface PublicPort

getUserAccessControl

public Set<String> getUserAccessControl()

Specified by:

getUserAccessControl in interface PublicPort

shutdown

public void shutdown()

Specified by:

shutdown in interface Port

Overrides:

shutdown in class AbstractPort

onSchedulingStart

public void onSchedulingStart()

Specified by:

onSchedulingStart in interface Port

Overrides:

onSchedulingStart in class AbstractPort

checkUserAuthorization

public PortAuthorizationResult checkUserAuthorization(String dn)

Specified by:

checkUserAuthorization in interface PublicPort

checkUserAuthorization

public PortAuthorizationResult checkUserAuthorization(NiFiUser user)

Specified by:

checkUserAuthorization in interface PublicPort

receiveFlowFiles

public int receiveFlowFiles(Peer peer,
                            ServerProtocol serverProtocol)
                     throws NotAuthorizedException,
                            BadRequestException,
                            RequestExpiredException

Specified by:

receiveFlowFiles in interface PublicPort

Throws:

NotAuthorizedException

BadRequestException

RequestExpiredException

transferFlowFiles

public int transferFlowFiles(Peer peer,
                             ServerProtocol serverProtocol)
                      throws NotAuthorizedException,
                             BadRequestException,
                             RequestExpiredException

Specified by:

transferFlowFiles in interface PublicPort

Throws:

NotAuthorizedException

BadRequestException

RequestExpiredException

getSchedulingStrategy

public SchedulingStrategy getSchedulingStrategy()

Specified by:

getSchedulingStrategy in interface Connectable

isSideEffectFree

public boolean isSideEffectFree()

Specified by:

isSideEffectFree in interface Connectable

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface Connectable

getDirection

public TransferDirection getDirection()

Specified by:

getDirection in interface PublicPort

toString

public String toString()

Overrides:

toString in class AbstractPort