Package org.apache.nifi.documentation.init

Class DocumentationReportingInitializationContext

java.lang.Object

org.apache.nifi.documentation.init.DocumentationReportingInitializationContext

All Implemented Interfaces:

KerberosContext, ReportingInitializationContext

public class DocumentationReportingInitializationContext
extends Object
implements ReportingInitializationContext

Field Summary

Fields

Modifier and Type	Field	Description
private final ComponentLog	componentLog
private final String	id
private final String	name
private final NodeTypeProvider	nodeTypeProvider

Constructor Summary

Constructors

Constructor	Description
DocumentationReportingInitializationContext()

Method Summary

Modifier and Type	Method	Description
ControllerServiceLookup	getControllerServiceLookup()
String	getIdentifier()
File	getKerberosConfigurationFile()	The Kerberos configuration file (typically krb5.conf) that will be used by this JVM during all Kerberos operations.
File	getKerberosServiceKeytab()	The File instance for the Kerberos service keytab.
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()
String	getName()
NodeTypeProvider	getNodeTypeProvider()
String	getSchedulingPeriod()
long	getSchedulingPeriod(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()

Methods inherited from class java.lang.Object

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

Field Details

id

private final String id

componentLog

private final ComponentLog componentLog

nodeTypeProvider

private final NodeTypeProvider nodeTypeProvider

name

private final String name

See Also:

• Constant Field Values

Constructor Details

DocumentationReportingInitializationContext

public DocumentationReportingInitializationContext()

Method Details

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface ReportingInitializationContext

Returns:

the identifier for this ReportingTask

getName

public String getName()

Specified by:

getName in interface ReportingInitializationContext

Returns:

the configured name for this ReportingTask

getSchedulingPeriod

public long getSchedulingPeriod(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

getControllerServiceLookup

public ControllerServiceLookup getControllerServiceLookup()

Specified by:

getControllerServiceLookup in interface ReportingInitializationContext

Returns:

the ControllerServiceLookup which can be used to obtain Controller Services

getSchedulingPeriod

public 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

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

getNodeTypeProvider

public NodeTypeProvider getNodeTypeProvider()

Specified by:

getNodeTypeProvider in interface ReportingInitializationContext

Returns:

the NodeTypeProvider which can be used to detect the node type of this NiFi instance.

getKerberosServicePrincipal

public 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 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 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