org.apache.nifi.controller.status.history

Class VolatileComponentStatusRepository

java.lang.Object

org.apache.nifi.controller.status.history.VolatileComponentStatusRepository

All Implemented Interfaces:

ComponentStatusRepository

public class VolatileComponentStatusRepository
extends java.lang.Object
implements ComponentStatusRepository

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NUM_DATA_POINTS
static java.lang.String	NUM_DATA_POINTS_PROPERTY

Fields inherited from interface org.apache.nifi.controller.status.history.ComponentStatusRepository

COMPONENT_DETAIL_DESTINATION_NAME, COMPONENT_DETAIL_GROUP_ID, COMPONENT_DETAIL_ID, COMPONENT_DETAIL_NAME, COMPONENT_DETAIL_SOURCE_NAME, COMPONENT_DETAIL_TYPE, COMPONENT_DETAIL_URI

Constructor Summary

Constructors

Constructor and Description
VolatileComponentStatusRepository() Default no args constructor for service loading only
VolatileComponentStatusRepository(NiFiProperties nifiProperties)

Method Summary

Modifier and Type	Method and Description
void	capture(ProcessGroupStatus rootGroupStatus) Captures the status information provided in the given report
void	capture(ProcessGroupStatus rootGroupStatus, java.util.Date timestamp) Captures the status information provided in the given report, providing a timestamp that indicates the time at which the status report was generated.
StatusHistory	getConnectionStatusHistory(java.lang.String connectionId, java.util.Date start, java.util.Date end, int preferredDataPoints)
java.util.Date	getLastCaptureDate()
StatusHistory	getProcessGroupStatusHistory(java.lang.String processGroupId, java.util.Date start, java.util.Date end, int preferredDataPoints)
StatusHistory	getProcessorStatusHistory(java.lang.String processorId, java.util.Date start, java.util.Date end, int preferredDataPoints, boolean includeCounters)
StatusHistory	getRemoteProcessGroupStatusHistory(java.lang.String remoteGroupId, java.util.Date start, java.util.Date end, int preferredDataPoints)

Methods inherited from class java.lang.Object

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

Field Detail

NUM_DATA_POINTS_PROPERTY

public static final java.lang.String NUM_DATA_POINTS_PROPERTY

See Also:

Constant Field Values

DEFAULT_NUM_DATA_POINTS

public static final int DEFAULT_NUM_DATA_POINTS

See Also:

Constant Field Values

Constructor Detail

VolatileComponentStatusRepository

public VolatileComponentStatusRepository()

Default no args constructor for service loading only

VolatileComponentStatusRepository

public VolatileComponentStatusRepository(NiFiProperties nifiProperties)

Method Detail

capture

public void capture(ProcessGroupStatus rootGroupStatus)

Description copied from interface: ComponentStatusRepository

Captures the status information provided in the given report

Specified by:

capture in interface ComponentStatusRepository

Parameters:

rootGroupStatus - status of root group

capture

public void capture(ProcessGroupStatus rootGroupStatus,
                    java.util.Date timestamp)

Description copied from interface: ComponentStatusRepository

Captures the status information provided in the given report, providing a timestamp that indicates the time at which the status report was generated. This can be used to replay historical values.

Specified by:

capture in interface ComponentStatusRepository

Parameters:

rootGroupStatus - status

timestamp - timestamp of capture

getLastCaptureDate

public java.util.Date getLastCaptureDate()

Specified by:

getLastCaptureDate in interface ComponentStatusRepository

Returns:

the Date at which the latest capture was performed

getProcessorStatusHistory

public StatusHistory getProcessorStatusHistory(java.lang.String processorId,
                                               java.util.Date start,
                                               java.util.Date end,
                                               int preferredDataPoints,
                                               boolean includeCounters)

Specified by:

getProcessorStatusHistory in interface ComponentStatusRepository

Parameters:

processorId - to get status of

start - the earliest date for which status information should be returned; if null, the start date should be assumed to be the beginning of time

end - the latest date for which status information should be returned; if null, the end date should be assumed to be the current time

preferredDataPoints - the preferred number of data points to return. If the date range is large, the total number of data points could be far too many to process. Therefore, this parameter allows the requestor to indicate how many samples to return.

includeCounters - specifies whether or not metrics from Processor counters should be included in the StatusHistory.

Returns:

a StatusHistory that provides the status information about the Processor with the given ID during the given time period

getConnectionStatusHistory

public StatusHistory getConnectionStatusHistory(java.lang.String connectionId,
                                                java.util.Date start,
                                                java.util.Date end,
                                                int preferredDataPoints)

Specified by:

getConnectionStatusHistory in interface ComponentStatusRepository

Parameters:

connectionId - the ID of the Connection for which the Status is desired

start - the earliest date for which status information should be returned; if null, the start date should be assumed to be the beginning of time

end - the latest date for which status information should be returned; if null, the end date should be assumed to be the current time

preferredDataPoints - the preferred number of data points to return. If the date range is large, the total number of data points could be far too many to process. Therefore, this parameter allows the requestor to indicate how many samples to return.

Returns:

a StatusHistory that provides the status information about the Connection with the given ID during the given time period

getProcessGroupStatusHistory

public StatusHistory getProcessGroupStatusHistory(java.lang.String processGroupId,
                                                  java.util.Date start,
                                                  java.util.Date end,
                                                  int preferredDataPoints)

Specified by:

getProcessGroupStatusHistory in interface ComponentStatusRepository

Parameters:

processGroupId - of group to get status of

start - the earliest date for which status information should be returned; if null, the start date should be assumed to be the beginning of time

end - the latest date for which status information should be returned; if null, the end date should be assumed to be the current time

preferredDataPoints - the preferred number of data points to return. If the date range is large, the total number of data points could be far too many to process. Therefore, this parameter allows the requestor to indicate how many samples to return.

Returns:

a StatusHistory that provides the status information about the Process Group with the given ID during the given time period

getRemoteProcessGroupStatusHistory

public StatusHistory getRemoteProcessGroupStatusHistory(java.lang.String remoteGroupId,
                                                        java.util.Date start,
                                                        java.util.Date end,
                                                        int preferredDataPoints)

Specified by:

getRemoteProcessGroupStatusHistory in interface ComponentStatusRepository

Parameters:

remoteGroupId - to get history of

start - the earliest date for which status information should be returned; if null, the start date should be assumed to be the beginning of time

end - the latest date for which status information should be returned; if null, the end date should be assumed to be the current time

preferredDataPoints - the preferred number of data points to return. If the date range is large, the total number of data points could be far too many to process. Therefore, this parameter allows the requestor to indicate how many samples to return.

Returns:

a StatusHistory that provides the status information about the Remote Process Group with the given ID during the given time period