org.apache.nifi.reporting

Class SiteToSiteStatusReportingTask

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.reporting.AbstractReportingTask

org.apache.nifi.reporting.AbstractSiteToSiteReportingTask

org.apache.nifi.reporting.SiteToSiteStatusReportingTask

All Implemented Interfaces:

ConfigurableComponent, ReportingTask, VerifiableReportingTask

@Tags(value={"status","metrics","history","site","site to site"})
 @CapabilityDescription(value="Publishes Status events using the Site To Site protocol.  The component type and name filter regexes form a union: only components matching both regexes will be reported.  However, all process groups are recursively searched for matching components, regardless of whether the process group matches the component filters.")
public class SiteToSiteStatusReportingTask
extends AbstractSiteToSiteReportingTask

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	COMPONENT_NAME_FILTER_REGEX
(package private) static PropertyDescriptor	COMPONENT_TYPE_FILTER_REGEX
private Pattern	componentNameFilter
private Pattern	componentTypeFilter
(package private) static PropertyDescriptor	PLATFORM
private Map<String,String>	processGroupIDToPath

Fields inherited from class org.apache.nifi.reporting.AbstractSiteToSiteReportingTask

ALLOW_NULL_VALUES, DESTINATION_URL_PATH, LAST_EVENT_ID_KEY, RECORD_WRITER, recordSchema, siteToSiteClient, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
SiteToSiteStatusReportingTask()

Method Summary

Modifier and Type	Method and Description
private void	addCommonFields(javax.json.JsonObjectBuilder builder, DateFormat df, String hostname, String applicationName, String platform, ProcessGroupStatus parent, Date currentDate, String componentType, String componentName, Boolean allowNullValues)
private static void	addField(javax.json.JsonObjectBuilder builder, javax.json.JsonBuilderFactory factory, String key, Map<String,Long> values, Boolean allowNullValues)
private boolean	componentMatchesFilters(String componentType, String componentName) Returns true only if the component type matches the component type filter and the component name matches the component name filter.
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ReportingContext context)
private void	serializeConnectionStatus(javax.json.JsonArrayBuilder arrayBuilder, javax.json.JsonBuilderFactory factory, ConnectionStatus status, DateFormat df, String hostname, String applicationName, String platform, ProcessGroupStatus parent, Date currentDate, Boolean allowNullValues)
private void	serializePortStatus(String componentType, javax.json.JsonArrayBuilder arrayBuilder, javax.json.JsonBuilderFactory factory, PortStatus status, DateFormat df, String hostname, String applicationName, String platform, ProcessGroupStatus parent, Date currentDate, Boolean allowNullValues)
private void	serializeProcessGroupStatus(javax.json.JsonArrayBuilder arrayBuilder, javax.json.JsonBuilderFactory factory, ProcessGroupStatus status, DateFormat df, String hostname, String applicationName, String platform, ProcessGroupStatus parent, Date currentDate, Boolean allowNullValues) Serialize the ProcessGroupStatus and add it to the JsonArrayBuilder.
private void	serializeProcessorStatus(javax.json.JsonArrayBuilder arrayBuilder, javax.json.JsonBuilderFactory factory, ProcessorStatus status, DateFormat df, String hostname, String applicationName, String platform, ProcessGroupStatus parent, Date currentDate, Boolean allowNullValues)
private void	serializeRemoteProcessGroupStatus(javax.json.JsonArrayBuilder arrayBuilder, javax.json.JsonBuilderFactory factory, RemoteProcessGroupStatus status, DateFormat df, String hostname, String applicationName, String platform, ProcessGroupStatus parent, Date currentDate, Boolean allowNullValues)

Methods inherited from class org.apache.nifi.reporting.AbstractSiteToSiteReportingTask

addField, addField, addField, addField, getClient, getData, sendData, setup, shutdown, verify

Methods inherited from class org.apache.nifi.reporting.AbstractReportingTask

getControllerServiceLookup, getIdentifier, getLogger, getName, getNodeTypeProvider, getSchedulingPeriod, init, initialize, setComponentInfo

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

PLATFORM

static final PropertyDescriptor PLATFORM

COMPONENT_TYPE_FILTER_REGEX

static final PropertyDescriptor COMPONENT_TYPE_FILTER_REGEX

COMPONENT_NAME_FILTER_REGEX

static final PropertyDescriptor COMPONENT_NAME_FILTER_REGEX

componentTypeFilter

private volatile Pattern componentTypeFilter

componentNameFilter

private volatile Pattern componentNameFilter

processGroupIDToPath

private volatile Map<String,String> processGroupIDToPath

Constructor Detail

SiteToSiteStatusReportingTask

public SiteToSiteStatusReportingTask()
                              throws IOException

Throws:

IOException

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractSiteToSiteReportingTask

onTrigger

public void onTrigger(ReportingContext context)

componentMatchesFilters

private boolean componentMatchesFilters(String componentType,
                                        String componentName)

Returns true only if the component type matches the component type filter and the component name matches the component name filter.

Parameters:

componentType - The component type

componentName - The component name

Returns:

Whether the component matches both filters

serializeProcessGroupStatus

private void serializeProcessGroupStatus(javax.json.JsonArrayBuilder arrayBuilder,
                                         javax.json.JsonBuilderFactory factory,
                                         ProcessGroupStatus status,
                                         DateFormat df,
                                         String hostname,
                                         String applicationName,
                                         String platform,
                                         ProcessGroupStatus parent,
                                         Date currentDate,
                                         Boolean allowNullValues)

Serialize the ProcessGroupStatus and add it to the JsonArrayBuilder.

Parameters:

arrayBuilder - The JSON Array builder

factory - The JSON Builder Factory

status - The ProcessGroupStatus

df - A date format

hostname - The current hostname

applicationName - The root process group name

platform - The configured platform

parent - The parent's process group status object

currentDate - The current date

allowNullValues - Allow null values

serializeRemoteProcessGroupStatus

private void serializeRemoteProcessGroupStatus(javax.json.JsonArrayBuilder arrayBuilder,
                                               javax.json.JsonBuilderFactory factory,
                                               RemoteProcessGroupStatus status,
                                               DateFormat df,
                                               String hostname,
                                               String applicationName,
                                               String platform,
                                               ProcessGroupStatus parent,
                                               Date currentDate,
                                               Boolean allowNullValues)

serializePortStatus

private void serializePortStatus(String componentType,
                                 javax.json.JsonArrayBuilder arrayBuilder,
                                 javax.json.JsonBuilderFactory factory,
                                 PortStatus status,
                                 DateFormat df,
                                 String hostname,
                                 String applicationName,
                                 String platform,
                                 ProcessGroupStatus parent,
                                 Date currentDate,
                                 Boolean allowNullValues)

serializeConnectionStatus

private void serializeConnectionStatus(javax.json.JsonArrayBuilder arrayBuilder,
                                       javax.json.JsonBuilderFactory factory,
                                       ConnectionStatus status,
                                       DateFormat df,
                                       String hostname,
                                       String applicationName,
                                       String platform,
                                       ProcessGroupStatus parent,
                                       Date currentDate,
                                       Boolean allowNullValues)

serializeProcessorStatus

private void serializeProcessorStatus(javax.json.JsonArrayBuilder arrayBuilder,
                                      javax.json.JsonBuilderFactory factory,
                                      ProcessorStatus status,
                                      DateFormat df,
                                      String hostname,
                                      String applicationName,
                                      String platform,
                                      ProcessGroupStatus parent,
                                      Date currentDate,
                                      Boolean allowNullValues)

addCommonFields

private void addCommonFields(javax.json.JsonObjectBuilder builder,
                             DateFormat df,
                             String hostname,
                             String applicationName,
                             String platform,
                             ProcessGroupStatus parent,
                             Date currentDate,
                             String componentType,
                             String componentName,
                             Boolean allowNullValues)

addField

private static void addField(javax.json.JsonObjectBuilder builder,
                             javax.json.JsonBuilderFactory factory,
                             String key,
                             Map<String,Long> values,
                             Boolean allowNullValues)