org.apache.nifi.web

Interface NiFiServiceFacade

All Known Implementing Classes:

StandardNiFiServiceFacade

public interface NiFiServiceFacade

Defines the NiFiServiceFacade interface.

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurationSnapshot<FlowSnippetDTO>	copySnippet(Revision revision, String groupId, String snippetId, Double originX, Double originY) Creates a new snippet based off the existing snippet.
ConfigurationSnapshot<Void>	createArchive(Revision revision) Creates a new archive of the flow configuration.
ConfigurationSnapshot<ConnectionDTO>	createConnection(Revision revision, String groupId, ConnectionDTO connectionDTO) Creates a new Relationship target.
ConfigurationSnapshot<FunnelDTO>	createFunnel(Revision revision, String groupId, FunnelDTO funnelDTO) Creates a funnel.
ConfigurationSnapshot<PortDTO>	createInputPort(Revision revision, String groupId, PortDTO inputPortDTO) Creates a new input port.
ConfigurationSnapshot<LabelDTO>	createLabel(Revision revision, String groupId, LabelDTO labelDTO) Creates a label.
ConfigurationSnapshot<PortDTO>	createOutputPort(Revision revision, String groupId, PortDTO outputPortDTO) Creates a new output port.
ConfigurationSnapshot<ProcessGroupDTO>	createProcessGroup(String parentGroupId, Revision revision, ProcessGroupDTO processGroupDTO) Creates a new process group.
ConfigurationSnapshot<ProcessorDTO>	createProcessor(Revision revision, String groupId, ProcessorDTO processorDTO) Creates a new Processor.
ConfigurationSnapshot<RemoteProcessGroupDTO>	createRemoteProcessGroup(Revision revision, String groupId, RemoteProcessGroupDTO remoteProcessGroupDTO) Creates a new remote process group.
ConfigurationSnapshot<SnippetDTO>	createSnippet(Revision revision, SnippetDTO snippet) Creates a new snippet.
TemplateDTO	createTemplate(String name, String description, String snippetId) Creates a new Template based off the specified snippet.
ConfigurationSnapshot<FlowSnippetDTO>	createTemplateInstance(Revision revision, String groupId, Double originX, Double originY, String templateId) Instantiate the corresponding template.
void	deleteActions(Date endDate) Purges all actions up to the specified end date.
ConfigurationSnapshot<Void>	deleteConnection(Revision revision, String groupId, String connectionId) Deletes the specified relationship target.
ConfigurationSnapshot<Void>	deleteFunnel(Revision revision, String groupId, String funnelId) Deletes the specified label.
ConfigurationSnapshot<Void>	deleteInputPort(Revision revision, String groupId, String inputPortId) Deletes the specified input port.
ConfigurationSnapshot<Void>	deleteLabel(Revision revision, String groupId, String labelId) Deletes the specified label.
void	deleteLineage(String lineageId) Deletes the lineage with the specified id.
void	deleteNode(String nodeId) Deletes the node.
ConfigurationSnapshot<Void>	deleteOutputPort(Revision revision, String groupId, String outputPortId) Determines if the output port could be deleted.
ConfigurationSnapshot<Void>	deleteProcessGroup(Revision revision, String groupId) Deletes the specified process group.
ConfigurationSnapshot<Void>	deleteProcessor(Revision revision, String groupId, String processorId) Deletes the specified processor.
void	deleteProvenance(String queryId) Deletes provenance.
ConfigurationSnapshot<Void>	deleteRemoteProcessGroup(Revision revision, String groupId, String remoteProcessGroupId) Deletes the specified remote process group.
ConfigurationSnapshot<Void>	deleteSnippet(Revision revision, String snippetId) Removes the specified snippet.
void	deleteTemplate(String id) Deletes the specified template.
void	deleteUser(String userId) Deletes the specified user.
TemplateDTO	exportTemplate(String id) Gets the template, includes contents, with the specified id.
ActionDTO	getAction(Integer actionId) Returns the details for the specified action id.
HistoryDTO	getActions(HistoryQueryDTO historyQuery) Returns actions that meet the specified criteria.
BulletinBoardDTO	getBulletinBoard(BulletinQueryDTO query) Returns the bulletin board for this NiFi.
ClusterDTO	getCluster() Returns the contents of cluster.
ClusterConnectionStatusDTO	getClusterConnectionStatus(String connectionId) Returns a connection's status for each node connected to the cluster.
ClusterStatusHistoryDTO	getClusterConnectionStatusHistory(String connectionId) Returns the connection status history for each node connected to the cluster.
ClusterPortStatusDTO	getClusterInputPortStatus(String inputPortId) Returns an input port's status for each node connected to the cluster.
ClusterPortStatusDTO	getClusterOutputPortStatus(String outputPortId) Returns an output port's status for each node connected to the cluster.
ClusterStatusHistoryDTO	getClusterProcessGroupStatusHistory(String processGroupId) Returns the process group status history for each node connected to the cluster.
ClusterProcessorStatusDTO	getClusterProcessorStatus(String processorId) Returns a processor's status for each node connected to the cluster.
ClusterStatusHistoryDTO	getClusterProcessorStatusHistory(String processorId) Returns the processor status history for each node connected to the cluster.
ClusterRemoteProcessGroupStatusDTO	getClusterRemoteProcessGroupStatus(String remoteProcessGroupId) Returns a remote process group's status for each node connected to the cluster.
ClusterStatusHistoryDTO	getClusterRemoteProcessGroupStatusHistory(String remoteProcessGroupId) Returns the remote process group status history for each node connected to the cluster.
ClusterStatusDTO	getClusterStatus() Returns the cluster's status.
ConnectionDTO	getConnection(String groupId, String connectionId) Gets the specified Connection transfer object.
Set<ConnectionDTO>	getConnections(String groupId) Gets the Connection transfer objects for the specified source processor.
StatusHistoryDTO	getConnectionStatusHistory(String groupId, String connectionId) Gets the status history of the specified connection.
DownloadableContent	getContent(Long eventId, String uri, ContentDirection contentDirection) Gets the content for the specified claim.
ControllerDTO	getController()
ControllerConfigurationDTO	getControllerConfiguration() Gets the configuration for this controller.
ControllerStatusDTO	getControllerStatus() Returns the controller status.
CountersDTO	getCounters() Returns the counters.
FunnelDTO	getFunnel(String groupId, String funnelId) Gets the specified funnel.
Set<FunnelDTO>	getFunnels(String groupId) Gets all of the funnels.
PortDTO	getInputPort(String groupId, String inputPortId) Gets an input port.
Set<PortDTO>	getInputPorts(String groupId) Gets all input ports in a given group.
String	getInstanceId() The instance id of this NiFi.
LabelDTO	getLabel(String groupId, String labelId) Gets the specified label.
Set<LabelDTO>	getLabels(String groupId) Gets all of the labels.
LineageDTO	getLineage(String lineageId) Gets the lineage with the specified id.
NodeDTO	getNode(String nodeId) Returns the contents of the node.
String	getNodeId() Gets the id of this node, if clustered.
NodeStatusDTO	getNodeStatus(String nodeId) Returns the status the specified node id.
NodeSystemDiagnosticsDTO	getNodeSystemDiagnostics(String nodeId) Returns the system diagnostics for the specified node id.
PortDTO	getOutputPort(String groupId, String outputPortId) Gets an output port.
Set<PortDTO>	getOutputPorts(String groupId) Gets all output ports in a given group.
ConfigurationSnapshot<ProcessGroupDTO>	getProcessGroup(String groupId, boolean recurse) Returns the process group.
Set<ProcessGroupDTO>	getProcessGroups(String parentGroupId) Gets all process groups in the specified parent group.
ProcessGroupStatusDTO	getProcessGroupStatus(String groupId) Returns the process group status.
StatusHistoryDTO	getProcessGroupStatusHistory(String groupId) Gets the process group status history.
ProcessorDTO	getProcessor(String id) Gets the Processor transfer object for the specified id.
ProcessorDTO	getProcessor(String groupId, String id) Gets the Processor transfer object for the specified id.
ProcessorHistoryDTO	getProcessorHistory(String processorId) Gets the history for the specified property for the specified processor.
Set<ProcessorDTO>	getProcessors(String groupId) Gets all the Processor transfer objects for this controller.
StatusHistoryDTO	getProcessorStatusHistory(String groupId, String id) Gets the processor status history.
Set<DocumentedTypeDTO>	getProcessorTypes() Returns the list of processor types.
ProvenanceDTO	getProvenance(String queryId) Retrieves provenance.
ProvenanceEventDTO	getProvenanceEvent(Long id) Gets the provenance event with the specified id.
ProvenanceOptionsDTO	getProvenanceSearchOptions() Returns the available options for searching provenance.
RemoteProcessGroupDTO	getRemoteProcessGroup(String groupId, String remoteProcessGroupId) Gets a remote process group.
Set<RemoteProcessGroupDTO>	getRemoteProcessGroups(String groupId) Gets all remote process groups in the a given parent group.
StatusHistoryDTO	getRemoteProcessGroupStatusHistory(String groupId, String id) Gets the remote process group status history.
RevisionDTO	getRevision() Returns the current revision.
SnippetDTO	getSnippet(String snippetId) Gets the specified snippet.
SystemDiagnosticsDTO	getSystemDiagnostics() Returns the system diagnostics.
TemplateDTO	getTemplate(String id) Gets the template with the specified id.
Set<TemplateDTO>	getTemplates() Gets all templates.
UserDTO	getUser(String userId) Gets the user with the specified id.
Collection<UserDTO>	getUsers(Boolean grouped) Gets all of the users registered with this controller.
Set<DocumentedTypeDTO>	getWorkQueuePrioritizerTypes() Returns the list of prioritizer types.
TemplateDTO	importTemplate(TemplateDTO templateDTO) Imports the specified Template.
void	invalidateUser(String userId) Invalidates the specified user.
void	invalidateUserGroup(String userGroup, Set<String> userIds) Invalidates the specified user accounts and all accounts associated with this group.
boolean	isClustered()
void	removeUserFromGroup(String userId) Ungroups the specified user.
void	removeUserGroup(String userGroup) Deletes the specified user group.
SearchResultsDTO	searchController(String query) Searches the controller for the specified query string.
ConfigurationSnapshot<ProcessorDTO>	setProcessorAnnotationData(Revision revision, String processorId, String annotationData) Sets the annotation data for a processor.
LineageDTO	submitLineage(LineageDTO lineage) Submits a lineage request.
ProvenanceDTO	submitProvenance(ProvenanceDTO query) Submits a provenance request.
ProvenanceEventDTO	submitReplay(Long eventId) Submits a new replay request.
ConfigurationSnapshot<ConnectionDTO>	updateConnection(Revision revision, String groupId, ConnectionDTO connectionDTO) Updates the specified Relationship target.
ConfigurationSnapshot<ControllerConfigurationDTO>	updateControllerConfiguration(Revision revision, ControllerConfigurationDTO controllerConfigurationDTO) Updates the configuration for this controller.
CounterDTO	updateCounter(String counterId) Updates the specified counter by setting its value to 0.
ConfigurationSnapshot<FunnelDTO>	updateFunnel(Revision revision, String groupId, FunnelDTO funnelDTO) Updates the specified label.
ConfigurationSnapshot<PortDTO>	updateInputPort(Revision revision, String groupId, PortDTO inputPortDTO) Updates the specified input port.
ConfigurationSnapshot<LabelDTO>	updateLabel(Revision revision, String groupId, LabelDTO labelDTO) Updates the specified label.
NodeDTO	updateNode(NodeDTO nodeDTO) Updates the contents of the node.
ConfigurationSnapshot<PortDTO>	updateOutputPort(Revision revision, String groupId, PortDTO outputPortDTO) Updates the specified output port.
ConfigurationSnapshot<ProcessGroupDTO>	updateProcessGroup(Revision revision, String parentGroupId, ProcessGroupDTO processGroupDTO) Updates the specified process group.
ConfigurationSnapshot<ProcessorDTO>	updateProcessor(Revision revision, String groupId, ProcessorDTO processorDTO) Updates the specified Processor.
ConfigurationSnapshot<RemoteProcessGroupDTO>	updateRemoteProcessGroup(Revision revision, String groupId, RemoteProcessGroupDTO remoteProcessGroupDTO) Updates the specified remote process group.
ConfigurationSnapshot<RemoteProcessGroupPortDTO>	updateRemoteProcessGroupInputPort(Revision revision, String groupId, String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPortDTO) Updates the specified remote process groups input port.
ConfigurationSnapshot<RemoteProcessGroupPortDTO>	updateRemoteProcessGroupOutputPort(Revision revision, String groupId, String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPortDTO) Updates the specified remote process groups output port.
ConfigurationSnapshot<SnippetDTO>	updateSnippet(Revision revision, SnippetDTO snippetDto) If group id is specified, moves the specified snippet to the specified group.
UserDTO	updateUser(UserDTO user) Updates the specified user accordingly.
UserGroupDTO	updateUserGroup(UserGroupDTO userGroup) Updates a user group with the specified group and comprised of the specified users.
void	verifyCreateConnection(String groupId, ConnectionDTO connectionDTO) Determines if this connection can be created.
void	verifyDeleteConnection(String groupId, String connectionId) Determines if this connection can be removed.
void	verifyDeleteFunnel(String groupId, String funnelId) Verifies the specified funnel can be deleted.
void	verifyDeleteInputPort(String groupId, String inputPortId) Determines if the input port could be deleted.
void	verifyDeleteOutputPort(String groupId, String outputPortId) Determines if the output port could be deleted.
void	verifyDeleteProcessGroup(String groupId) Verifies the specified process group can be removed.
void	verifyDeleteProcessor(String groupId, String processorId) Verifies the specified processor can be removed.
void	verifyDeleteRemoteProcessGroup(String groupId, String remoteProcessGroupId) Verifies the remote process group can be deleted.
void	verifyDeleteSnippet(String id) Determines if this snippet can be removed.
void	verifyUpdateConnection(String groupId, ConnectionDTO connectionDTO) Determines if this connection can be updated.
void	verifyUpdateInputPort(String groupId, PortDTO inputPortDTO) Determines if the input port could be updated.
void	verifyUpdateOutputPort(String groupId, PortDTO outputPortDTO) Determines if the output port could be updated.
void	verifyUpdateProcessGroup(ProcessGroupDTO processGroupDTO) Verifies the specified process group can be updated.
void	verifyUpdateProcessor(ProcessorDTO processorDTO) Verifies the specified processor can be updated.
void	verifyUpdateProcessor(String groupId, ProcessorDTO processorDTO) Verifies the specified processor can be updated.
void	verifyUpdateRemoteProcessGroup(String groupId, RemoteProcessGroupDTO remoteProcessGroupDTO) Verifies the specified remote process group can be updated.
void	verifyUpdateRemoteProcessGroupInputPort(String groupId, String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPortDTO) Verifies the specified remote process group can update the specified remote input port.
void	verifyUpdateRemoteProcessGroupOutputPort(String groupId, String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPortDTO) Verifies the specified remote process group can update the specified remote output port.
void	verifyUpdateSnippet(SnippetDTO snippetDto) Determines if this snippet can be updated.

Method Detail

getController

ControllerDTO getController()

searchController

SearchResultsDTO searchController(String query)

Searches the controller for the specified query string.

Parameters:

query -

Returns:

submitProvenance

ProvenanceDTO submitProvenance(ProvenanceDTO query)

Submits a provenance request.

Parameters:

query -

Returns:

submitReplay

ProvenanceEventDTO submitReplay(Long eventId)

Submits a new replay request.

Parameters:

eventId -

Returns:

getContent

DownloadableContent getContent(Long eventId,
                             String uri,
                             ContentDirection contentDirection)

Gets the content for the specified claim.

Parameters:

eventId -

uri -

contentDirection -

Returns:

getProvenance

ProvenanceDTO getProvenance(String queryId)

Retrieves provenance.

Parameters:

queryId -

Returns:

deleteProvenance

void deleteProvenance(String queryId)

Deletes provenance.

Parameters:

queryId -

getProvenanceSearchOptions

ProvenanceOptionsDTO getProvenanceSearchOptions()

Returns the available options for searching provenance.

Returns:

submitLineage

LineageDTO submitLineage(LineageDTO lineage)

Submits a lineage request.

Parameters:

lineage -

Returns:

getLineage

LineageDTO getLineage(String lineageId)

Gets the lineage with the specified id.

Parameters:

lineageId -

Returns:

deleteLineage

void deleteLineage(String lineageId)

Deletes the lineage with the specified id.

Parameters:

lineageId -

getProvenanceEvent

ProvenanceEventDTO getProvenanceEvent(Long id)

Gets the provenance event with the specified id.

Parameters:

id -

Returns:

getControllerConfiguration

ControllerConfigurationDTO getControllerConfiguration()

Gets the configuration for this controller.

Returns:

Controller configuration transfer object

updateControllerConfiguration

ConfigurationSnapshot<ControllerConfigurationDTO> updateControllerConfiguration(Revision revision,
                                                                              ControllerConfigurationDTO controllerConfigurationDTO)

Updates the configuration for this controller.

Parameters:

revision - Revision to compare with current base revision

controllerConfigurationDTO - Controller configuration DTO

Returns:

Controller configuration DTO

createArchive

ConfigurationSnapshot<Void> createArchive(Revision revision)

Creates a new archive of the flow configuration.

Parameters:

revision - Revision to compare with current base revision

Returns:

setProcessorAnnotationData

ConfigurationSnapshot<ProcessorDTO> setProcessorAnnotationData(Revision revision,
                                                             String processorId,
                                                             String annotationData)

Sets the annotation data for a processor.

Parameters:

revision - the revision to compare with current base revision

processorId - the id of the processor to update

annotationData - the annotation data

Returns:

getProcessGroupStatus

ProcessGroupStatusDTO getProcessGroupStatus(String groupId)

Returns the process group status.

Parameters:

groupId -

Returns:

The process group status

getProcessGroupStatusHistory

StatusHistoryDTO getProcessGroupStatusHistory(String groupId)

Gets the process group status history.

Parameters:

groupId -

Returns:

getControllerStatus

ControllerStatusDTO getControllerStatus()

Returns the controller status.

Returns:

updateCounter

CounterDTO updateCounter(String counterId)

Updates the specified counter by setting its value to 0.

Parameters:

counterId -

Returns:

getCounters

CountersDTO getCounters()

Returns the counters.

Returns:

The counters

getProcessorTypes

Set<DocumentedTypeDTO> getProcessorTypes()

Returns the list of processor types.

Returns:

The list of available processor types

getWorkQueuePrioritizerTypes

Set<DocumentedTypeDTO> getWorkQueuePrioritizerTypes()

Returns the list of prioritizer types.

Returns:

The list of available prioritizer types

getRevision

RevisionDTO getRevision()

Returns the current revision.

Returns:

createTemplate

TemplateDTO createTemplate(String name,
                         String description,
                         String snippetId)

Creates a new Template based off the specified snippet.

Parameters:

name -

description -

snippetId -

Returns:

importTemplate

TemplateDTO importTemplate(TemplateDTO templateDTO)

Imports the specified Template.

Parameters:

templateDTO - The template dto

Returns:

The new template dto

createTemplateInstance

ConfigurationSnapshot<FlowSnippetDTO> createTemplateInstance(Revision revision,
                                                           String groupId,
                                                           Double originX,
                                                           Double originY,
                                                           String templateId)

Instantiate the corresponding template.

Parameters:

revision -

groupId -

templateId -

originX -

originY -

Returns:

getTemplate

TemplateDTO getTemplate(String id)

Gets the template with the specified id.

Parameters:

id -

Returns:

exportTemplate

TemplateDTO exportTemplate(String id)

Gets the template, includes contents, with the specified id.

Parameters:

id -

Returns:

getTemplates

Set<TemplateDTO> getTemplates()

Gets all templates.

Returns:

deleteTemplate

void deleteTemplate(String id)

Deletes the specified template.

Parameters:

id - The id of the template

createProcessor

ConfigurationSnapshot<ProcessorDTO> createProcessor(Revision revision,
                                                  String groupId,
                                                  ProcessorDTO processorDTO)

Creates a new Processor.

Parameters:

revision - Revision to compare with current base revision

groupId - Group id

processorDTO - The processor DTO

Returns:

The new processor DTO

getProcessor

ProcessorDTO getProcessor(String groupId,
                        String id)

Gets the Processor transfer object for the specified id.

Parameters:

groupId - Id of the processor group containing the processor

id - Id of the processor to return

Returns:

The Processor transfer object

getProcessor

ProcessorDTO getProcessor(String id)

Gets the Processor transfer object for the specified id.

Parameters:

id - Id of the processor to return

Returns:

The Processor transfer object

getProcessorStatusHistory

StatusHistoryDTO getProcessorStatusHistory(String groupId,
                                         String id)

Gets the processor status history.

Parameters:

groupId -

id -

Returns:

getProcessors

Set<ProcessorDTO> getProcessors(String groupId)

Gets all the Processor transfer objects for this controller.

Parameters:

groupId -

Returns:

List of all the Processor transfer object

verifyUpdateProcessor

void verifyUpdateProcessor(ProcessorDTO processorDTO)

Verifies the specified processor can be updated.

Parameters:

processorDTO -

verifyUpdateProcessor

void verifyUpdateProcessor(String groupId,
                         ProcessorDTO processorDTO)

Verifies the specified processor can be updated.

Parameters:

groupId -

processorDTO -

updateProcessor

ConfigurationSnapshot<ProcessorDTO> updateProcessor(Revision revision,
                                                  String groupId,
                                                  ProcessorDTO processorDTO)

Updates the specified Processor.

Parameters:

revision - Revision to compare with current base revision

groupId -

processorDTO - The processorDTO

Returns:

The updated processor

verifyDeleteProcessor

void verifyDeleteProcessor(String groupId,
                         String processorId)

Verifies the specified processor can be removed.

Parameters:

groupId -

processorId -

deleteProcessor

ConfigurationSnapshot<Void> deleteProcessor(Revision revision,
                                          String groupId,
                                          String processorId)

Deletes the specified processor.

Parameters:

revision - Revision to compare with current base revision

groupId -

processorId - The processor id to delete

Returns:

getConnections

Set<ConnectionDTO> getConnections(String groupId)

Gets the Connection transfer objects for the specified source processor.

Parameters:

groupId -

Returns:

The Connection transfer objects

getConnection

ConnectionDTO getConnection(String groupId,
                          String connectionId)

Gets the specified Connection transfer object.

Parameters:

groupId -

connectionId - The ID of the connection

Returns:

The Connection transfer object

getConnectionStatusHistory

StatusHistoryDTO getConnectionStatusHistory(String groupId,
                                          String connectionId)

Gets the status history of the specified connection.

Parameters:

groupId -

connectionId -

Returns:

createConnection

ConfigurationSnapshot<ConnectionDTO> createConnection(Revision revision,
                                                    String groupId,
                                                    ConnectionDTO connectionDTO)

Creates a new Relationship target.

Parameters:

revision - Revision to compare with current base revision

groupId -

connectionDTO - The Connection DTO

Returns:

The Connection DTO

verifyCreateConnection

void verifyCreateConnection(String groupId,
                          ConnectionDTO connectionDTO)

Determines if this connection can be created.

Parameters:

groupId -

connectionDTO -

verifyUpdateConnection

void verifyUpdateConnection(String groupId,
                          ConnectionDTO connectionDTO)

Determines if this connection can be updated.

Parameters:

groupId -

connectionDTO -

updateConnection

ConfigurationSnapshot<ConnectionDTO> updateConnection(Revision revision,
                                                    String groupId,
                                                    ConnectionDTO connectionDTO)

Updates the specified Relationship target.

Parameters:

revision - Revision to compare with current base revision

groupId -

connectionDTO - The Connection DTO

Returns:

The Connection DTO

verifyDeleteConnection

void verifyDeleteConnection(String groupId,
                          String connectionId)

Determines if this connection can be removed.

Parameters:

groupId -

connectionId -

deleteConnection

ConfigurationSnapshot<Void> deleteConnection(Revision revision,
                                           String groupId,
                                           String connectionId)

Deletes the specified relationship target.

Parameters:

revision - Revision to compare with current base revision

groupId -

connectionId - The ID of the connection

Returns:

createInputPort

ConfigurationSnapshot<PortDTO> createInputPort(Revision revision,
                                             String groupId,
                                             PortDTO inputPortDTO)

Creates a new input port.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the group this port should be create in

inputPortDTO - The input PortDTO

Returns:

getInputPort

PortDTO getInputPort(String groupId,
                   String inputPortId)

Gets an input port.

Parameters:

groupId - The id of the group this port is in

inputPortId - The input port id

Returns:

getInputPorts

Set<PortDTO> getInputPorts(String groupId)

Gets all input ports in a given group.

Parameters:

groupId - The id of the group

Returns:

verifyUpdateInputPort

void verifyUpdateInputPort(String groupId,
                         PortDTO inputPortDTO)

Determines if the input port could be updated.

Parameters:

groupId - The id of the group

inputPortDTO - The id of the input port

updateInputPort

ConfigurationSnapshot<PortDTO> updateInputPort(Revision revision,
                                             String groupId,
                                             PortDTO inputPortDTO)

Updates the specified input port.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the group

inputPortDTO - The input PortDTO

Returns:

verifyDeleteInputPort

void verifyDeleteInputPort(String groupId,
                         String inputPortId)

Determines if the input port could be deleted.

Parameters:

groupId - The id of the group

inputPortId - The id of the input port

deleteInputPort

ConfigurationSnapshot<Void> deleteInputPort(Revision revision,
                                          String groupId,
                                          String inputPortId)

Deletes the specified input port.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the group

inputPortId - The id of the input port

Returns:

createOutputPort

ConfigurationSnapshot<PortDTO> createOutputPort(Revision revision,
                                              String groupId,
                                              PortDTO outputPortDTO)

Creates a new output port.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the group this port should be create in

outputPortDTO - The output PortDTO

Returns:

getOutputPort

PortDTO getOutputPort(String groupId,
                    String outputPortId)

Gets an output port.

Parameters:

groupId - The id of the group this port is in

outputPortId - The output port id

Returns:

getOutputPorts

Set<PortDTO> getOutputPorts(String groupId)

Gets all output ports in a given group.

Parameters:

groupId - The id of the group

Returns:

verifyUpdateOutputPort

void verifyUpdateOutputPort(String groupId,
                          PortDTO outputPortDTO)

Determines if the output port could be updated.

Parameters:

groupId - The id of the group

outputPortDTO - The id of the output port

updateOutputPort

ConfigurationSnapshot<PortDTO> updateOutputPort(Revision revision,
                                              String groupId,
                                              PortDTO outputPortDTO)

Updates the specified output port.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the group

outputPortDTO - The output PortDTO

Returns:

verifyDeleteOutputPort

void verifyDeleteOutputPort(String groupId,
                          String outputPortId)

Determines if the output port could be deleted.

Parameters:

groupId - The id of the group

outputPortId - The id of the output port

deleteOutputPort

ConfigurationSnapshot<Void> deleteOutputPort(Revision revision,
                                           String groupId,
                                           String outputPortId)

Determines if the output port could be deleted.

Parameters:

revision -

groupId - The id of the group

outputPortId - The id of the output port

Returns:

createProcessGroup

ConfigurationSnapshot<ProcessGroupDTO> createProcessGroup(String parentGroupId,
                                                        Revision revision,
                                                        ProcessGroupDTO processGroupDTO)

Creates a new process group.

Parameters:

parentGroupId - The id of the parent group

revision - Revision to compare with current base revision

processGroupDTO - The ProcessGroupDTO

Returns:

getProcessGroup

ConfigurationSnapshot<ProcessGroupDTO> getProcessGroup(String groupId,
                                                     boolean recurse)

Returns the process group.

Parameters:

groupId -

recurse -

Returns:

ProcessGroup transfer object

getProcessGroups

Set<ProcessGroupDTO> getProcessGroups(String parentGroupId)

Gets all process groups in the specified parent group.

Parameters:

parentGroupId - The id of the parent group

Returns:

verifyUpdateProcessGroup

void verifyUpdateProcessGroup(ProcessGroupDTO processGroupDTO)

Verifies the specified process group can be updated.

Parameters:

processGroupDTO - The ProcessGroupDTO

updateProcessGroup

ConfigurationSnapshot<ProcessGroupDTO> updateProcessGroup(Revision revision,
                                                        String parentGroupId,
                                                        ProcessGroupDTO processGroupDTO)

Updates the specified process group.

Parameters:

revision - Revision to compare with current base revision

parentGroupId - The id of the parent group

processGroupDTO - The ProcessGroupDTO

Returns:

verifyDeleteProcessGroup

void verifyDeleteProcessGroup(String groupId)

Verifies the specified process group can be removed.

Parameters:

groupId - The id of the process group

deleteProcessGroup

ConfigurationSnapshot<Void> deleteProcessGroup(Revision revision,
                                             String groupId)

Deletes the specified process group.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the process group

Returns:

getInstanceId

String getInstanceId()

The instance id of this NiFi.

Returns:

createRemoteProcessGroup

ConfigurationSnapshot<RemoteProcessGroupDTO> createRemoteProcessGroup(Revision revision,
                                                                    String groupId,
                                                                    RemoteProcessGroupDTO remoteProcessGroupDTO)

Creates a new remote process group.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the parent group

remoteProcessGroupDTO - The RemoteProcessGroupDTO

Returns:

getRemoteProcessGroup

RemoteProcessGroupDTO getRemoteProcessGroup(String groupId,
                                          String remoteProcessGroupId)

Gets a remote process group.

Parameters:

groupId - The id of the parent group

remoteProcessGroupId - The id of the remote process group

Returns:

getRemoteProcessGroups

Set<RemoteProcessGroupDTO> getRemoteProcessGroups(String groupId)

Gets all remote process groups in the a given parent group.

Parameters:

groupId - The id of the parent group

Returns:

getRemoteProcessGroupStatusHistory

StatusHistoryDTO getRemoteProcessGroupStatusHistory(String groupId,
                                                  String id)

Gets the remote process group status history.

Parameters:

groupId - The id of the parent group

id - The id of the remote process group

Returns:

verifyUpdateRemoteProcessGroup

void verifyUpdateRemoteProcessGroup(String groupId,
                                  RemoteProcessGroupDTO remoteProcessGroupDTO)

Verifies the specified remote process group can be updated.

Parameters:

groupId - The id of the parent group

remoteProcessGroupDTO - The RemoteProcessGroupDTO

verifyUpdateRemoteProcessGroupInputPort

void verifyUpdateRemoteProcessGroupInputPort(String groupId,
                                           String remoteProcessGroupId,
                                           RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)

Verifies the specified remote process group can update the specified remote input port.

Parameters:

groupId - The id of the parent group

remoteProcessGroupId - The id of the remote process group

remoteProcessGroupPortDTO - The RemoteProcessGroupPortDTO

verifyUpdateRemoteProcessGroupOutputPort

void verifyUpdateRemoteProcessGroupOutputPort(String groupId,
                                            String remoteProcessGroupId,
                                            RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)

Verifies the specified remote process group can update the specified remote output port.

Parameters:

groupId - The id of the parent group

remoteProcessGroupId - The id of the remote process group

remoteProcessGroupPortDTO - The RemoteProcessGroupPortDTO

updateRemoteProcessGroup

ConfigurationSnapshot<RemoteProcessGroupDTO> updateRemoteProcessGroup(Revision revision,
                                                                    String groupId,
                                                                    RemoteProcessGroupDTO remoteProcessGroupDTO)

Updates the specified remote process group.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the parent group

remoteProcessGroupDTO - The RemoteProcessGroupDTO

Returns:

updateRemoteProcessGroupInputPort

ConfigurationSnapshot<RemoteProcessGroupPortDTO> updateRemoteProcessGroupInputPort(Revision revision,
                                                                                 String groupId,
                                                                                 String remoteProcessGroupId,
                                                                                 RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)

Updates the specified remote process groups input port.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the parent group

remoteProcessGroupId - The id of the remote process group

remoteProcessGroupPortDTO - The RemoteProcessGroupPortDTO

Returns:

updateRemoteProcessGroupOutputPort

ConfigurationSnapshot<RemoteProcessGroupPortDTO> updateRemoteProcessGroupOutputPort(Revision revision,
                                                                                  String groupId,
                                                                                  String remoteProcessGroupId,
                                                                                  RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)

Updates the specified remote process groups output port.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the parent group

remoteProcessGroupId - The id of the remote process group

remoteProcessGroupPortDTO - The RemoteProcessGroupPortDTO

Returns:

verifyDeleteRemoteProcessGroup

void verifyDeleteRemoteProcessGroup(String groupId,
                                  String remoteProcessGroupId)

Verifies the remote process group can be deleted.

Parameters:

groupId - The id of the parent group

remoteProcessGroupId - The id of the remote process group

deleteRemoteProcessGroup

ConfigurationSnapshot<Void> deleteRemoteProcessGroup(Revision revision,
                                                   String groupId,
                                                   String remoteProcessGroupId)

Deletes the specified remote process group.

Parameters:

revision - Revision to compare with current base revision

groupId - The id of the parent group

remoteProcessGroupId - The id of the remote process group

Returns:

createFunnel

ConfigurationSnapshot<FunnelDTO> createFunnel(Revision revision,
                                            String groupId,
                                            FunnelDTO funnelDTO)

Creates a funnel.

Parameters:

revision - Revision to compare with current base revision

groupId -

funnelDTO -

Returns:

The funnel DTO

getFunnel

FunnelDTO getFunnel(String groupId,
                  String funnelId)

Gets the specified funnel.

Parameters:

groupId -

funnelId - The funnel id

Returns:

The funnel transfer object

getFunnels

Set<FunnelDTO> getFunnels(String groupId)

Gets all of the funnels.

Parameters:

groupId -

Returns:

The funnel transfer objects

updateFunnel

ConfigurationSnapshot<FunnelDTO> updateFunnel(Revision revision,
                                            String groupId,
                                            FunnelDTO funnelDTO)

Updates the specified label.

Parameters:

revision - Revision to compare with current base revision

groupId -

funnelDTO - The funnel DTO

Returns:

The funnel DTO

verifyDeleteFunnel

void verifyDeleteFunnel(String groupId,
                      String funnelId)

Verifies the specified funnel can be deleted.

Parameters:

groupId -

funnelId -

deleteFunnel

ConfigurationSnapshot<Void> deleteFunnel(Revision revision,
                                       String groupId,
                                       String funnelId)

Deletes the specified label.

Parameters:

revision - Revision to compare with current base revision

groupId -

funnelId - The funnel id

Returns:

createLabel

ConfigurationSnapshot<LabelDTO> createLabel(Revision revision,
                                          String groupId,
                                          LabelDTO labelDTO)

Creates a label.

Parameters:

revision - Revision to compare with current base revision

groupId -

labelDTO - The label DTO

Returns:

The label DTO

getLabel

LabelDTO getLabel(String groupId,
                String labelId)

Gets the specified label.

Parameters:

groupId -

labelId - The label id

Returns:

The label transfer object

getLabels

Set<LabelDTO> getLabels(String groupId)

Gets all of the labels.

Parameters:

groupId -

Returns:

The label transfer objects

updateLabel

ConfigurationSnapshot<LabelDTO> updateLabel(Revision revision,
                                          String groupId,
                                          LabelDTO labelDTO)

Updates the specified label.

Parameters:

revision - Revision to compare with current base revision

groupId -

labelDTO - The label DTO

Returns:

The label DTO

deleteLabel

ConfigurationSnapshot<Void> deleteLabel(Revision revision,
                                      String groupId,
                                      String labelId)

Deletes the specified label.

Parameters:

revision - Revision to compare with current base revision

groupId -

labelId - The label id

Returns:

getActions

HistoryDTO getActions(HistoryQueryDTO historyQuery)

Returns actions that meet the specified criteria.

Parameters:

historyQuery -

Returns:

getAction

ActionDTO getAction(Integer actionId)

Returns the details for the specified action id.

Parameters:

actionId -

Returns:

deleteActions

void deleteActions(Date endDate)

Purges all actions up to the specified end date.

Parameters:

endDate - The end date

getProcessorHistory

ProcessorHistoryDTO getProcessorHistory(String processorId)

Gets the history for the specified property for the specified processor.

Parameters:

processorId -

Returns:

copySnippet

ConfigurationSnapshot<FlowSnippetDTO> copySnippet(Revision revision,
                                                String groupId,
                                                String snippetId,
                                                Double originX,
                                                Double originY)

Creates a new snippet based off the existing snippet.

Parameters:

revision -

groupId -

snippetId -

originX -

originY -

Returns:

createSnippet

ConfigurationSnapshot<SnippetDTO> createSnippet(Revision revision,
                                              SnippetDTO snippet)

Creates a new snippet.

Parameters:

revision -

snippet -

Returns:

getSnippet

SnippetDTO getSnippet(String snippetId)

Gets the specified snippet.

Parameters:

snippetId -

Returns:

verifyUpdateSnippet

void verifyUpdateSnippet(SnippetDTO snippetDto)

Determines if this snippet can be updated.

Parameters:

snippetDto -

updateSnippet

ConfigurationSnapshot<SnippetDTO> updateSnippet(Revision revision,
                                              SnippetDTO snippetDto)

If group id is specified, moves the specified snippet to the specified group.

Parameters:

revision -

snippetDto -

Returns:

verifyDeleteSnippet

void verifyDeleteSnippet(String id)

Determines if this snippet can be removed.

Parameters:

id -

deleteSnippet

ConfigurationSnapshot<Void> deleteSnippet(Revision revision,
                                        String snippetId)

Removes the specified snippet.

Parameters:

revision -

snippetId -

Returns:

getUser

UserDTO getUser(String userId)

Gets the user with the specified id.

Parameters:

userId - The user id

Returns:

getUsers

Collection<UserDTO> getUsers(Boolean grouped)

Gets all of the users registered with this controller.

Parameters:

grouped -

Returns:

updateUser

UserDTO updateUser(UserDTO user)

Updates the specified user accordingly.

Parameters:

user - The user to update

Returns:

invalidateUser

void invalidateUser(String userId)

Invalidates the specified user.

Parameters:

userId -

invalidateUserGroup

void invalidateUserGroup(String userGroup,
                       Set<String> userIds)

Invalidates the specified user accounts and all accounts associated with this group.

Parameters:

userGroup -

userIds -

deleteUser

void deleteUser(String userId)

Deletes the specified user.

Parameters:

userId -

updateUserGroup

UserGroupDTO updateUserGroup(UserGroupDTO userGroup)

Updates a user group with the specified group and comprised of the specified users.

Parameters:

userGroup -

Returns:

removeUserFromGroup

void removeUserFromGroup(String userId)

Ungroups the specified user.

Parameters:

userId -

removeUserGroup

void removeUserGroup(String userGroup)

Deletes the specified user group.

Parameters:

userGroup -

isClustered

boolean isClustered()

Returns:

true if controller is connected or trying to connect to the cluster

getNodeId

String getNodeId()

Gets the id of this node, if clustered. If not clustered, returns null.

Returns:

getCluster

ClusterDTO getCluster()

Returns the contents of cluster.

Returns:

the contents of cluster

getNode

NodeDTO getNode(String nodeId)

Returns the contents of the node.

Parameters:

nodeId - a node identifier

Returns:

the contents of the node

updateNode

NodeDTO updateNode(NodeDTO nodeDTO)

Updates the contents of the node.

Parameters:

nodeDTO - a node transfer object

Returns:

deleteNode

void deleteNode(String nodeId)

Deletes the node.

Parameters:

nodeId - a node identifier

getNodeStatus

NodeStatusDTO getNodeStatus(String nodeId)

Returns the status the specified node id.

Parameters:

nodeId - The id of the desired node

Returns:

The node status

getNodeSystemDiagnostics

NodeSystemDiagnosticsDTO getNodeSystemDiagnostics(String nodeId)

Returns the system diagnostics for the specified node id.

Parameters:

nodeId - The id of the desired node

Returns:

The node status

getClusterStatus

ClusterStatusDTO getClusterStatus()

Returns the cluster's status.

Returns:

The cluster status

getClusterProcessorStatus

ClusterProcessorStatusDTO getClusterProcessorStatus(String processorId)

Returns a processor's status for each node connected to the cluster.

Parameters:

processorId - a processor identifier

Returns:

The cluster processor status transfer object.

getClusterProcessorStatusHistory

ClusterStatusHistoryDTO getClusterProcessorStatusHistory(String processorId)

Returns the processor status history for each node connected to the cluster.

Parameters:

processorId -

Returns:

getClusterConnectionStatus

ClusterConnectionStatusDTO getClusterConnectionStatus(String connectionId)

Returns a connection's status for each node connected to the cluster.

Parameters:

connectionId - a connection identifier

Returns:

The cluster connection status transfer object.

getClusterConnectionStatusHistory

ClusterStatusHistoryDTO getClusterConnectionStatusHistory(String connectionId)

Returns the connection status history for each node connected to the cluster.

Parameters:

connectionId -

Returns:

getClusterProcessGroupStatusHistory

ClusterStatusHistoryDTO getClusterProcessGroupStatusHistory(String processGroupId)

Returns the process group status history for each node connected to the cluster.

Parameters:

processGroupId -

Returns:

getClusterRemoteProcessGroupStatusHistory

ClusterStatusHistoryDTO getClusterRemoteProcessGroupStatusHistory(String remoteProcessGroupId)

Returns the remote process group status history for each node connected to the cluster.

Parameters:

remoteProcessGroupId -

Returns:

getClusterRemoteProcessGroupStatus

ClusterRemoteProcessGroupStatusDTO getClusterRemoteProcessGroupStatus(String remoteProcessGroupId)

Returns a remote process group's status for each node connected to the cluster.

Parameters:

remoteProcessGroupId - a remote process group identifier

Returns:

The cluster remote process group status transfer object.

getClusterInputPortStatus

ClusterPortStatusDTO getClusterInputPortStatus(String inputPortId)

Returns an input port's status for each node connected to the cluster.

Parameters:

inputPortId - a port identifier

Returns:

The cluster port status transfer object.

getClusterOutputPortStatus

ClusterPortStatusDTO getClusterOutputPortStatus(String outputPortId)

Returns an output port's status for each node connected to the cluster.

Parameters:

outputPortId - a port identifier

Returns:

The cluster port status transfer object.

getBulletinBoard

BulletinBoardDTO getBulletinBoard(BulletinQueryDTO query)

Returns the bulletin board for this NiFi.

Parameters:

query -

Returns:

getSystemDiagnostics

SystemDiagnosticsDTO getSystemDiagnostics()

Returns the system diagnostics.

Returns: