org.apache.nifi.remote

Class StandardRootGroupPort

java.lang.Object

org.apache.nifi.controller.AbstractPort

org.apache.nifi.remote.StandardRootGroupPort

All Implemented Interfaces:

Authorizable, ComponentAuthorizable, Connectable, Port, Positionable, Triggerable, RootGroupPort

public class StandardRootGroupPort
extends AbstractPort
implements RootGroupPort

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardRootGroupPort.StandardPortAuthorizationResult

Field Summary

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

DEFAULT_TIME_UNIT, DEFAULT_YIELD_PERIOD, DEFAULT_YIELD_TIME_UNIT, MINIMUM_PENALIZATION_MILLIS, MINIMUM_YIELD_MILLIS, PORT_RELATIONSHIP

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

MINIMUM_SCHEDULING_NANOS

Constructor Summary

Constructors

Constructor and Description
StandardRootGroupPort(java.lang.String id, java.lang.String name, ProcessGroup processGroup, TransferDirection direction, ConnectableType type, Authorizer authorizer, BulletinRepository bulletinRepository, ProcessScheduler scheduler, boolean secure, NiFiProperties nifiProperties)

Method Summary

Modifier and Type	Method and Description
PortAuthorizationResult	checkUserAuthorization(NiFiUser user) Verifies that the specified user is authorized to interact with this port and returns a PortAuthorizationResult indicating why the user is unauthorized if this assumption fails
PortAuthorizationResult	checkUserAuthorization(java.lang.String dn) Verifies that the specified user is authorized to interact with this port and returns a PortAuthorizationResult indicating why the user is unauthorized if this assumption fails RootGroupPort.checkUserAuthorization(NiFiUser) should be used if applicable because NiFiUser has additional context such as chained user.
java.lang.String	getComponentType()
java.util.Set<java.lang.String>	getGroupAccessControl()
java.util.Collection<Relationship>	getRelationships()
SchedulingStrategy	getSchedulingStrategy()
java.util.Set<java.lang.String>	getUserAccessControl()
java.util.Collection<ValidationResult>	getValidationErrors()
boolean	isSideEffectFree()
boolean	isTransmitting()
boolean	isTriggerWhenEmpty()
boolean	isValid()
void	onSchedulingStart() This method is called just before a Port is scheduled to run, giving the Port a chance to initialize any resources needed.
void	onTrigger(ProcessContext context, ProcessSession session)
void	onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory) The method called when this processor is triggered to operate by the controller.
int	receiveFlowFiles(Peer peer, ServerProtocol serverProtocol) Receives data from the given stream
void	setGroupAccessControl(java.util.Set<java.lang.String> groups)
void	setUserAccessControl(java.util.Set<java.lang.String> users)
void	shutdown()
int	transferFlowFiles(Peer peer, ServerProtocol serverProtocol) Transfers data to the given stream

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

addConnection, disable, enable, getComments, getConnectableType, getConnections, getConnections, getIdentifier, getIncomingConnections, getMaxConcurrentTasks, getName, getParentAuthorizable, getPenalizationPeriod, getPenalizationPeriod, getPosition, getProcessGroup, getProcessGroupIdentifier, getRelationship, getResource, getScheduledState, getSchedulingPeriod, getSchedulingPeriod, getYieldExpiration, getYieldPeriod, getYieldPeriod, hasIncomingConnection, isAutoTerminated, isLossTolerant, isRunning, removeConnection, setComments, setLossTolerant, setMaxConcurrentTasks, setName, setPenalizationPeriod, setPosition, setProcessGroup, setScheduldingPeriod, setYieldPeriod, toString, updateConnection, verifyCanClearState, verifyCanDelete, verifyCanDelete, verifyCanDisable, verifyCanEnable, verifyCanStart, verifyCanStop, verifyCanUpdate, 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.Connectable

addConnection, getComments, getConnectableType, getConnections, getConnections, getIdentifier, getIncomingConnections, getName, getPenalizationPeriod, getPenalizationPeriod, getProcessGroup, getRelationship, getYieldExpiration, getYieldPeriod, getYieldPeriod, hasIncomingConnection, isAutoTerminated, isLossTolerant, removeConnection, setComments, setLossTolerant, setName, setPenalizationPeriod, setProcessGroup, setYieldPeriod, updateConnection, verifyCanClearState, verifyCanDelete, verifyCanDelete, verifyCanDisable, verifyCanEnable, verifyCanStart, verifyCanStop, verifyCanUpdate, yield

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

getMaxConcurrentTasks, getScheduledState, getSchedulingPeriod, getSchedulingPeriod, isRunning, 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

Constructor Detail

StandardRootGroupPort

public StandardRootGroupPort(java.lang.String id,
                             java.lang.String name,
                             ProcessGroup processGroup,
                             TransferDirection direction,
                             ConnectableType type,
                             Authorizer authorizer,
                             BulletinRepository bulletinRepository,
                             ProcessScheduler scheduler,
                             boolean secure,
                             NiFiProperties nifiProperties)

Method Detail

getRelationships

public java.util.Collection<Relationship> getRelationships()

Specified by:

getRelationships in interface Connectable

Overrides:

getRelationships in class AbstractPort

Returns:

a Collection of all relationships for this Connectable

isTriggerWhenEmpty

public boolean isTriggerWhenEmpty()

Specified by:

isTriggerWhenEmpty in interface Connectable

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

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSessionFactory sessionFactory)

Description copied from interface: Triggerable

The method called when this processor is triggered to operate by the controller. This method may be called concurrently from different threads. When this method is called depends on how this processor is configured within a controller to be triggered (timing or event based).

The processor may commit, roll back, or allow the framework to automatically manage the session. If the sessions are to be managed by the framework (recommended) then what it will do depends on several factors. If the method call returns due to an exception then the session will be rolled back. If the method returns normally then the session will be committed or the framework may use the session again for another processor down stream

Specified by:

onTrigger in interface Triggerable

Overrides:

onTrigger in class AbstractPort

Parameters:

context - in which the component is triggered

sessionFactory - used to generate ProcessSessions to use for operating on flow files within the repository

onTrigger

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

Specified by:

onTrigger in class AbstractPort

Throws:

ProcessException

isValid

public boolean isValid()

Specified by:

isValid in interface Port

Specified by:

isValid in class AbstractPort

getValidationErrors

public java.util.Collection<ValidationResult> getValidationErrors()

Specified by:

getValidationErrors in interface Connectable

Returns:

any validation errors for this connectable

isTransmitting

public boolean isTransmitting()

Specified by:

isTransmitting in interface RootGroupPort

setGroupAccessControl

public void setGroupAccessControl(java.util.Set<java.lang.String> groups)

Specified by:

setGroupAccessControl in interface RootGroupPort

getGroupAccessControl

public java.util.Set<java.lang.String> getGroupAccessControl()

Specified by:

getGroupAccessControl in interface RootGroupPort

setUserAccessControl

public void setUserAccessControl(java.util.Set<java.lang.String> users)

Specified by:

setUserAccessControl in interface RootGroupPort

getUserAccessControl

public java.util.Set<java.lang.String> getUserAccessControl()

Specified by:

getUserAccessControl in interface RootGroupPort

shutdown

public void shutdown()

Specified by:

shutdown in interface Port

Overrides:

shutdown in class AbstractPort

onSchedulingStart

public void onSchedulingStart()

Description copied from interface: Port

This method is called just before a Port is scheduled to run, giving the Port a chance to initialize any resources needed.

Specified by:

onSchedulingStart in interface Port

Overrides:

onSchedulingStart in class AbstractPort

checkUserAuthorization

public PortAuthorizationResult checkUserAuthorization(java.lang.String dn)

Description copied from interface: RootGroupPort

Verifies that the specified user is authorized to interact with this port and returns a PortAuthorizationResult indicating why the user is unauthorized if this assumption fails RootGroupPort.checkUserAuthorization(NiFiUser) should be used if applicable because NiFiUser has additional context such as chained user.

Specified by:

checkUserAuthorization in interface RootGroupPort

Parameters:

dn - dn of user

Returns:

result

checkUserAuthorization

public PortAuthorizationResult checkUserAuthorization(NiFiUser user)

Description copied from interface: RootGroupPort

Verifies that the specified user is authorized to interact with this port and returns a PortAuthorizationResult indicating why the user is unauthorized if this assumption fails

Specified by:

checkUserAuthorization in interface RootGroupPort

Parameters:

user - to authorize

Returns:

result

receiveFlowFiles

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

Description copied from interface: RootGroupPort

Receives data from the given stream

Specified by:

receiveFlowFiles in interface RootGroupPort

Parameters:

peer - peer

serverProtocol - protocol

Returns:

the number of FlowFiles received

Throws:

NotAuthorizedException - nae

BadRequestException - bre

RequestExpiredException - ree

transferFlowFiles

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

Description copied from interface: RootGroupPort

Transfers data to the given stream

Specified by:

transferFlowFiles in interface RootGroupPort

Parameters:

peer - peer

serverProtocol - protocol

Returns:

the number of FlowFiles transferred

Throws:

NotAuthorizedException - nae

BadRequestException - bre

RequestExpiredException - ree

getSchedulingStrategy

public SchedulingStrategy getSchedulingStrategy()

Specified by:

getSchedulingStrategy in interface Connectable

isSideEffectFree

public boolean isSideEffectFree()

Specified by:

isSideEffectFree in interface Connectable

Returns:

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

getComponentType

public java.lang.String getComponentType()

Specified by:

getComponentType in interface Connectable

Returns:

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