org.apache.nifi.web

Interface NiFiWebContext

public interface NiFiWebContext

NiFi web context providing limited access to dataflow configuration for processor custom UIs.

Method Summary

Methods

Modifier and Type	Method and Description
ControllerService	getControllerService(String serviceIdentifier) Gets the ControllerService for the specified identifier.
String	getCurrentUserDn() Gets the current user dn.
String	getCurrentUserName() Gets the current user name.
ProcessorInfo	getProcessor(NiFiWebContextConfig config) Gets the Processor configuration.
void	saveActions(Collection<ProcessorConfigurationAction> actions) Provides a mechanism for custom UIs to save actions to appear in NiFi configuration history.
void	setProcessorAnnotationData(NiFiWebContextConfig config, String annotationData) Sets the Processor annotation data.

Method Detail

getControllerService

ControllerService getControllerService(String serviceIdentifier)

Gets the ControllerService for the specified identifier. If a corresponding service cannot be found, null is returned. If this NiFi is clustered, the ControllerService is loaded from the NCM.

Parameters:

serviceIdentifier -

Returns:

saveActions

void saveActions(Collection<ProcessorConfigurationAction> actions)

Provides a mechanism for custom UIs to save actions to appear in NiFi configuration history. Note all fields within each Action must be populated. Null values will result in a failure to insert the audit record. Since the saving to these actions is separate from the actual configuration change, a failure to insert here will just generate a warning log message. The recording of these actions typically happens after a configuration change is applied. Since those changes have already been applied to the flow, we cannot revert them because of a failure to insert an audit record.

Parameters:

actions -

getCurrentUserDn

String getCurrentUserDn()

Gets the current user dn. Returns null if no user is found.

Returns:

getCurrentUserName

String getCurrentUserName()

Gets the current user name. Returns null if no user is found.

Returns:

getProcessor

ProcessorInfo getProcessor(NiFiWebContextConfig config)
                           throws ResourceNotFoundException,
                                  ClusterRequestException

Gets the Processor configuration. The given configuration is expected to contain the following configuration:

• revision -- the client identifier and optionally the version number
• processorId -- the id of the processor to retrieve information for
• X509Certificate -- the certificate if this is a secure request

When operating in a clustered environment, if the configuration contains a X509Certificate, then the certificate information will be forwarded to the nodes.

Parameters:

config - the configuration

Returns:

the processor info object

Throws:

ResourceNotFoundException - if the processor does not exit

ClusterRequestException - if the processor was unable to be retrieved from the cluster. This exception will only be thrown when operating in a cluster.

setProcessorAnnotationData

void setProcessorAnnotationData(NiFiWebContextConfig config,
                              String annotationData)
                                throws ResourceNotFoundException,
                                       InvalidRevisionException,
                                       ClusterRequestException

Sets the Processor annotation data. The given configuration is expected to contain the following configuration:

• revision -- the client identifier and optionally the version number
• processorId -- the id of the processor to retrieve information for
• X509Certificate -- the certificate if this is a secure request

When operating in a clustered environment, if the configuration contains a X509Certificate, then the certificate information will be forwarded to the nodes.

Parameters:

config - the configuration

annotationData - the annotation data

Throws:

ResourceNotFoundException - if the processor does not exit

InvalidRevisionException - if a revision other than the current revision is given

ClusterRequestException - if the annotation data was unable to be set for the processor. This exception will only be thrown when operating in a cluster.