org.apache.nifi.controller.reporting

Class StandardReportingInitializationContext

java.lang.Object

org.apache.nifi.controller.reporting.StandardReportingInitializationContext

All Implemented Interfaces:

ControllerServiceLookup, KerberosContext, ReportingInitializationContext

public class StandardReportingInitializationContext
extends java.lang.Object
implements ReportingInitializationContext, ControllerServiceLookup

Constructor Summary

Constructors

Constructor and Description
StandardReportingInitializationContext(java.lang.String id, java.lang.String name, SchedulingStrategy schedulingStrategy, java.lang.String schedulingPeriod, ComponentLog logger, ControllerServiceProvider serviceProvider, NiFiProperties nifiProperties)

Method Summary

Modifier and Type	Method and Description
ControllerService	getControllerService(java.lang.String identifier)
java.util.Set<java.lang.String>	getControllerServiceIdentifiers(java.lang.Class<? extends ControllerService> serviceType)
ControllerServiceLookup	getControllerServiceLookup()
java.lang.String	getControllerServiceName(java.lang.String serviceIdentifier)
java.lang.String	getIdentifier()
java.io.File	getKerberosConfigurationFile() The Kerberos configuration file (typically krb5.conf) that will be used by this JVM during all Kerberos operations.
java.io.File	getKerberosServiceKeytab() The File instance for the Kerberos service keytab.
java.lang.String	getKerberosServicePrincipal() The Kerberos service principal used by NiFi to communicate with the KDC in order to obtain tickets on behalf of NiFi.
ComponentLog	getLogger()
java.lang.String	getName()
java.lang.String	getSchedulingPeriod()
long	getSchedulingPeriod(java.util.concurrent.TimeUnit timeUnit) Returns the amount of time, in the given TimeUnit that will elapsed between the return of one execution of the ReportingTask's onTrigger method and the time at which the method is invoked again.
SchedulingStrategy	getSchedulingStrategy()
boolean	isControllerServiceEnabled(ControllerService service)
boolean	isControllerServiceEnabled(java.lang.String serviceIdentifier)
boolean	isControllerServiceEnabling(java.lang.String serviceIdentifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardReportingInitializationContext

public StandardReportingInitializationContext(java.lang.String id,
                                              java.lang.String name,
                                              SchedulingStrategy schedulingStrategy,
                                              java.lang.String schedulingPeriod,
                                              ComponentLog logger,
                                              ControllerServiceProvider serviceProvider,
                                              NiFiProperties nifiProperties)

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Specified by:

getIdentifier in interface ReportingInitializationContext

Returns:

the identifier for this ReportingTask

getName

public java.lang.String getName()

Specified by:

getName in interface ReportingInitializationContext

Returns:

the configured name for this ReportingTask

getSchedulingPeriod

public long getSchedulingPeriod(java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: ReportingInitializationContext

Returns the amount of time, in the given TimeUnit that will elapsed between the return of one execution of the ReportingTask's onTrigger method and the time at which the method is invoked again. This method will return -1L if the Scheduling Strategy is not set to SchedulingStrategy.TIMER_DRIVEN

Specified by:

getSchedulingPeriod in interface ReportingInitializationContext

Parameters:

timeUnit - unit of time for scheduling

Returns:

period of time

getSchedulingPeriod

public java.lang.String getSchedulingPeriod()

Specified by:

getSchedulingPeriod in interface ReportingInitializationContext

Returns:

a String representation of the scheduling period

getSchedulingStrategy

public SchedulingStrategy getSchedulingStrategy()

Specified by:

getSchedulingStrategy in interface ReportingInitializationContext

Returns:

the SchedulingStrategy that is used to trigger the task to run

getControllerServiceIdentifiers

public java.util.Set<java.lang.String> getControllerServiceIdentifiers(java.lang.Class<? extends ControllerService> serviceType)

Specified by:

getControllerServiceIdentifiers in interface ControllerServiceLookup

Parameters:

serviceType - type of service to get identifiers for

Returns:

the set of all Controller Service Identifiers whose Controller Service is of the given type.

getControllerService

public ControllerService getControllerService(java.lang.String identifier)

Specified by:

getControllerService in interface ControllerServiceLookup

Parameters:

identifier - of controller service

Returns:

the ControllerService that is registered with the given identifier

isControllerServiceEnabled

public boolean isControllerServiceEnabled(ControllerService service)

Specified by:

isControllerServiceEnabled in interface ControllerServiceLookup

Parameters:

service - service to check

Returns:

true if the given Controller Service is enabled, false otherwise. If the given Controller Service is not known by this ControllerServiceLookup, returns false

isControllerServiceEnabled

public boolean isControllerServiceEnabled(java.lang.String serviceIdentifier)

Specified by:

isControllerServiceEnabled in interface ControllerServiceLookup

Parameters:

serviceIdentifier - identifier of service to check

Returns:

true if the Controller Service with the given identifier is enabled, false otherwise. If the given identifier is not known by this ControllerServiceLookup, returns false

isControllerServiceEnabling

public boolean isControllerServiceEnabling(java.lang.String serviceIdentifier)

Specified by:

isControllerServiceEnabling in interface ControllerServiceLookup

Parameters:

serviceIdentifier - identifier of service to check

Returns:

true if the Controller Service with the given identifier has been enabled but is still in the transitioning state, otherwise returns false. If the given identifier is not known by this ControllerServiceLookup, returns false

getControllerServiceLookup

public ControllerServiceLookup getControllerServiceLookup()

Specified by:

getControllerServiceLookup in interface ReportingInitializationContext

Returns:

the ControllerServiceLookup which can be used to obtain Controller Services

getControllerServiceName

public java.lang.String getControllerServiceName(java.lang.String serviceIdentifier)

Specified by:

getControllerServiceName in interface ControllerServiceLookup

Parameters:

serviceIdentifier - identifier to look up

Returns:

the name of the Controller service with the given identifier. If no service can be found with this identifier, returns null

getLogger

public ComponentLog getLogger()

Specified by:

getLogger in interface ReportingInitializationContext

Returns:

a logger that can be used to log important events in a standard way and generate bulletins when appropriate

getKerberosServicePrincipal

public java.lang.String getKerberosServicePrincipal()

Description copied from interface: KerberosContext

The Kerberos service principal used by NiFi to communicate with the KDC in order to obtain tickets on behalf of NiFi. Typically of the form NIFI/fully.qualified.domain@REALM.

Specified by:

getKerberosServicePrincipal in interface KerberosContext

Returns:

the principal, or null if this NiFi instance is not configured with a NiFi Kerberos service principal

getKerberosServiceKeytab

public java.io.File getKerberosServiceKeytab()

Description copied from interface: KerberosContext

The File instance for the Kerberos service keytab. The service principal and service keytab will be used to communicate with the KDC to obtain tickets on behalf of NiFi.

Specified by:

getKerberosServiceKeytab in interface KerberosContext

Returns:

the File instance of the service keytab, or null if this NiFi instance is not configured with a NiFi Kerberos service keytab

getKerberosConfigurationFile

public java.io.File getKerberosConfigurationFile()

Description copied from interface: KerberosContext

The Kerberos configuration file (typically krb5.conf) that will be used by this JVM during all Kerberos operations.

Specified by:

getKerberosConfigurationFile in interface KerberosContext

Returns:

the File instance for the Kerberos configuration file, or null if this NiFi instance is not configured with a Kerberos configuration file