org.apache.nifi.web

Interface NiFiWebConfigurationContext

All Superinterfaces:

VariableRegistryProvider

public interface NiFiWebConfigurationContext
extends VariableRegistryProvider

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

Method Summary

Methods

Modifier and Type	Method and Description
ComponentDetails	getComponentDetails(NiFiWebRequestContext requestContext) Gets the details for the underlying component (including configuration, validation errors, and annotation data).
ControllerService	getControllerService(String serviceIdentifier)
String	getCurrentUserDn()
String	getCurrentUserName()
void	saveActions(NiFiWebRequestContext requestContext, Collection<ConfigurationAction> actions) Provides a mechanism for custom UIs to save actions to appear in NiFi configuration history.
ComponentDetails	setAnnotationData(NiFiWebConfigurationRequestContext configurationContext, String annotationData) Sets the annotation data for the underlying component.
ComponentDetails	setProperties(NiFiWebConfigurationRequestContext configurationContext, Map<String,String> properties) Sets the property values for the underlying component.

Methods inherited from interface org.apache.nifi.registry.VariableRegistryProvider

getVariableRegistry

Method Detail

getControllerService

ControllerService getControllerService(String serviceIdentifier)

Parameters:

serviceIdentifier - of the controller service

Returns:

the ControllerService for the specified identifier. If a corresponding service cannot be found, null is returned. If this NiFi is clustered, the only services available will be those those availability is NCM only

saveActions

void saveActions(NiFiWebRequestContext requestContext,
               Collection<ConfigurationAction> 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:

requestContext - context of the request

actions - to save

Throws:

IllegalArgumentException - When the requestContext isn't fully populated or isn't appropriate for the given request

getCurrentUserDn

String getCurrentUserDn()

Returns:

the current user identity. The value may be a DN, an email, a username, or any string that identities the user. Returns null if no user is found

getCurrentUserName

String getCurrentUserName()

Returns:

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

setAnnotationData

ComponentDetails setAnnotationData(NiFiWebConfigurationRequestContext configurationContext,
                                 String annotationData)
                                   throws ResourceNotFoundException,
                                          InvalidRevisionException,
                                          ClusterRequestException

Sets the annotation data for the underlying component.

Parameters:

configurationContext - config context

annotationData - the data

Returns:

the configuration for the underlying component

Throws:

ResourceNotFoundException - if the underlying component 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 underlying component. This exception will only be thrown when operating in a cluster.

IllegalArgumentException - When the requestContext isn't fully populated or isn't appropriate for the given request

setProperties

ComponentDetails setProperties(NiFiWebConfigurationRequestContext configurationContext,
                             Map<String,String> properties)
                               throws ResourceNotFoundException,
                                      InvalidRevisionException,
                                      ClusterRequestException

Sets the property values for the underlying component.

Parameters:

configurationContext - config context

properties - Map of property name with property value

Returns:

the configuration for the underlying component

Throws:

ResourceNotFoundException - if the underlying component 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 underlying component. This exception will only be thrown when operating in a cluster.

IllegalArgumentException - When the requestContext isn't fully populated or isn't appropriate for the given request

getComponentDetails

ComponentDetails getComponentDetails(NiFiWebRequestContext requestContext)
                                     throws ResourceNotFoundException,
                                            ClusterRequestException

Gets the details for the underlying component (including configuration, validation errors, and annotation data).

Parameters:

requestContext - context of request

Returns:

the configuration for the underlying component

Throws:

ResourceNotFoundException - if the underlying component does not exit

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

IllegalArgumentException - When the requestContext isn't fully populated or isn't appropriate for the given request