org.apache.nifi.documentation.init

Class DocumentationControllerServiceInitializationContext

java.lang.Object

org.apache.nifi.documentation.init.DocumentationControllerServiceInitializationContext

All Implemented Interfaces:

ControllerServiceInitializationContext, KerberosContext

public class DocumentationControllerServiceInitializationContext
extends Object
implements ControllerServiceInitializationContext

Field Summary

Fields

Modifier and Type	Field and Description
private ComponentLog	componentLog
private String	id
private ControllerServiceLookup	serviceLookup

Constructor Summary

Constructors

Constructor and Description
DocumentationControllerServiceInitializationContext()

Method Summary

Modifier and Type	Method and 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()
StateManager	getStateManager()

Methods inherited from class java.lang.Object

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

Field Detail

id

private final String id

serviceLookup

private final ControllerServiceLookup serviceLookup

componentLog

private final ComponentLog componentLog

Constructor Detail

DocumentationControllerServiceInitializationContext

public DocumentationControllerServiceInitializationContext()

Method Detail

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface ControllerServiceInitializationContext

Returns:

the identifier associated with the ControllerService with which this context is associated

getControllerServiceLookup

public ControllerServiceLookup getControllerServiceLookup()

Specified by:

getControllerServiceLookup in interface ControllerServiceInitializationContext

Returns:

the ControllerServiceLookup which can be used to obtain Controller Services

getLogger

public ComponentLog getLogger()

Specified by:

getLogger in interface ControllerServiceInitializationContext

Returns:

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

getStateManager

public StateManager getStateManager()

Specified by:

getStateManager in interface ControllerServiceInitializationContext

Returns:

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

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