org.apache.nifi.reporting

Interface ReportingContext

public interface ReportingContext

This interface provides a bridge between the NiFi Framework and a ReportingTask. This context allows a ReportingTask to access statistics, metrics, and monitoring information, as well as configuration supplied by the user.

Method Summary

Modifier and Type	Method and Description
Bulletin	createBulletin(String category, Severity severity, String message) Creates a system-level Bulletin with the given category, severity level, and message, so that the Bulletin can be added to the BulletinRepository.
Bulletin	createBulletin(String componentId, String category, Severity severity, String message) Creates a Bulletin for the component with the specified identifier
BulletinRepository	getBulletinRepository()
ControllerServiceLookup	getControllerServiceLookup()
EventAccess	getEventAccess()
Map<PropertyDescriptor,String>	getProperties()
PropertyValue	getProperty(PropertyDescriptor propertyName)
StateManager	getStateManager()

Method Detail

getProperties

Map<PropertyDescriptor,String> getProperties()

Returns:

a Map of all known PropertyDescriptors to their configured properties. This Map will contain a null for any Property that has not been configured by the user, even if the PropertyDescriptor has a default value

getProperty

PropertyValue getProperty(PropertyDescriptor propertyName)

Parameters:

propertyName - descriptor of property to lookup the value of

Returns:

PropertyValue that represents the user-configured value for the given PropertyDescriptor

getEventAccess

EventAccess getEventAccess()

Returns:

the EventAccess object that can be used to obtain information about specific events and reports that have happened

getBulletinRepository

BulletinRepository getBulletinRepository()

Returns:

the BulletinRepository that can be used to analyze Bulletins that have been emitted and register new Bulletins

createBulletin

Bulletin createBulletin(String category,
                        Severity severity,
                        String message)

Creates a system-level Bulletin with the given category, severity level, and message, so that the Bulletin can be added to the BulletinRepository.

Parameters:

category - of bulletin

severity - of bulletin

message - of bulletin

Returns:

new bulletin

createBulletin

Bulletin createBulletin(String componentId,
                        String category,
                        Severity severity,
                        String message)

Creates a Bulletin for the component with the specified identifier

Parameters:

componentId - the ID of the component

category - the name of the bulletin's category

severity - the severity level of the bulletin

message - the bulletin's message

Returns:

new bulletin

getControllerServiceLookup

ControllerServiceLookup getControllerServiceLookup()

Returns:

the ControllerServiceLookup which can be used to obtain Controller Services

getStateManager

StateManager getStateManager()

Returns:

the StateManager that can be used to store and retrieve state for this component