Package org.apache.nifi.reporting

Class AbstractEventAccess

java.lang.Object

org.apache.nifi.reporting.AbstractEventAccess

All Implemented Interfaces:

EventAccess

public abstract class AbstractEventAccess
extends Object
implements EventAccess

Field Summary

Fields

Modifier and Type	Field	Description
private final FlowFileEventRepository	flowFileEventRepository
private final FlowManager	flowManager
private static final org.slf4j.Logger	logger
private final ProcessScheduler	processScheduler
private final StatusAnalyticsEngine	statusAnalyticsEngine

Constructor Summary

Constructors

Constructor	Description
AbstractEventAccess(ProcessScheduler processScheduler, StatusAnalyticsEngine analyticsEngine, FlowManager flowManager, FlowFileEventRepository flowFileEventRepository)

Method Summary

Modifier and Type	Method	Description
private RemoteProcessGroupStatus	createRemoteGroupStatus(RemoteProcessGroup remoteGroup, RepositoryStatusReport statusReport, Predicate<Authorizable> isAuthorized)
protected RepositoryStatusReport	generateRepositoryStatusReport()
ProcessGroupStatus	getControllerStatus()	Returns the status of all components in the controller.
ProcessGroupStatus	getGroupStatus(String groupId)	Returns the status of all components in the specified group.
ProcessGroupStatus	getGroupStatus(String groupId, RepositoryStatusReport statusReport)	Returns the status for the components in the specified group with the specified report.
(package private) ProcessGroupStatus	getGroupStatus(ProcessGroup group, RepositoryStatusReport statusReport, Predicate<Authorizable> isAuthorized, int recursiveStatusDepth, int currentDepth, boolean includeConnectionDetails)	Returns the status for the components in the specified group with the specified report.
protected ProcessorStatus	getProcessorStatus(FlowFileEvent flowFileEvent, ProcessorNode procNode, Predicate<Authorizable> isAuthorized)
private ProcessorStatus	getProcessorStatus(RepositoryStatusReport report, ProcessorNode procNode, Predicate<Authorizable> isAuthorized)
List<ProvenanceEventRecord>	getProvenanceEvents(long firstEventId, int maxRecords)
long	getTotalBytesRead()	Returns the total number of bytes read by this instance (at the root process group level, i.e.
long	getTotalBytesReceived()	Returns the total number of bytes received by this instance (at the root process group level) since the instance started
long	getTotalBytesSent()	Returns the total number of bytes sent by this instance (at the root process group level) since the instance started
long	getTotalBytesWritten()	Returns the total number of bytes written by this instance (at the root process group level, i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.nifi.reporting.EventAccess

getContentRepositoryStorageUsage, getFlowChanges, getFlowFileRepositoryStorageUsage, getProvenanceRepository, getProvenanceRepositoryStorageUsage

Field Details

logger

private static final org.slf4j.Logger logger

processScheduler

private final ProcessScheduler processScheduler

statusAnalyticsEngine

private final StatusAnalyticsEngine statusAnalyticsEngine

flowManager

private final FlowManager flowManager

flowFileEventRepository

private final FlowFileEventRepository flowFileEventRepository

Constructor Details

AbstractEventAccess

public AbstractEventAccess(ProcessScheduler processScheduler,
 StatusAnalyticsEngine analyticsEngine,
 FlowManager flowManager,
 FlowFileEventRepository flowFileEventRepository)

Method Details

getGroupStatus

public ProcessGroupStatus getGroupStatus(String groupId)

Returns the status of all components in the specified group. This request is not in the context of a user so the results will be unfiltered.

Specified by:

getGroupStatus in interface EventAccess

Parameters:

groupId - group id

Returns:

the component status

getGroupStatus

public ProcessGroupStatus getGroupStatus(String groupId,
 RepositoryStatusReport statusReport)

Returns the status for the components in the specified group with the specified report. This request is not in the context of a user so the results will be unfiltered.

Parameters:

groupId - group id

statusReport - report

Returns:

the component status

generateRepositoryStatusReport

protected RepositoryStatusReport generateRepositoryStatusReport()

getGroupStatus

ProcessGroupStatus getGroupStatus(ProcessGroup group,
 RepositoryStatusReport statusReport,
 Predicate<Authorizable> isAuthorized,
 int recursiveStatusDepth,
 int currentDepth,
 boolean includeConnectionDetails)

Returns the status for the components in the specified group with the specified report. The results will be filtered by executing the specified predicate.

Parameters:

group - group id

statusReport - report

isAuthorized - is authorized check

recursiveStatusDepth - the number of levels deep we should recurse and still include the the processors' statuses, the groups' statuses, etc. in the returned ProcessGroupStatus

currentDepth - the current number of levels deep that we have recursed

includeConnectionDetails - whether or not to include the details of the connections that may be expensive to calculate and/or require locks be obtained

Returns:

the component status

createRemoteGroupStatus

private RemoteProcessGroupStatus createRemoteGroupStatus(RemoteProcessGroup remoteGroup,
 RepositoryStatusReport statusReport,
 Predicate<Authorizable> isAuthorized)

getProcessorStatus

private ProcessorStatus getProcessorStatus(RepositoryStatusReport report,
 ProcessorNode procNode,
 Predicate<Authorizable> isAuthorized)

getProcessorStatus

protected ProcessorStatus getProcessorStatus(FlowFileEvent flowFileEvent,
 ProcessorNode procNode,
 Predicate<Authorizable> isAuthorized)

getControllerStatus

public ProcessGroupStatus getControllerStatus()

Returns the status of all components in the controller. This request is not in the context of a user so the results will be unfiltered.

Specified by:

getControllerStatus in interface EventAccess

Returns:

the component status

getProvenanceEvents

public List<ProvenanceEventRecord> getProvenanceEvents(long firstEventId,
 int maxRecords)
                                                throws IOException

Specified by:

getProvenanceEvents in interface EventAccess

Throws:

IOException

getTotalBytesRead

public long getTotalBytesRead()

Returns the total number of bytes read by this instance (at the root process group level, i.e. all events) since the instance started

Specified by:

getTotalBytesRead in interface EventAccess

Returns:

the total number of bytes read by this instance

getTotalBytesWritten

public long getTotalBytesWritten()

Returns the total number of bytes written by this instance (at the root process group level, i.e. all events) since the instance started

Specified by:

getTotalBytesWritten in interface EventAccess

Returns:

the total number of bytes written by this instance

getTotalBytesSent

public long getTotalBytesSent()

Returns the total number of bytes sent by this instance (at the root process group level) since the instance started

Specified by:

getTotalBytesSent in interface EventAccess

Returns:

the total number of bytes sent by this instance

getTotalBytesReceived

public long getTotalBytesReceived()

Returns the total number of bytes received by this instance (at the root process group level) since the instance started

Specified by:

getTotalBytesReceived in interface EventAccess

Returns:

the total number of bytes received by this instance