Package org.apache.nifi.toolkit.client

Interface ControllerClient

All Known Implementing Classes:

JerseyControllerClient

public interface ControllerClient

Client for interacting with NiFi's Controller Resource.

Method Summary

Modifier and Type	Method	Description
FlowAnalysisRuleEntity	activateFlowAnalysisRule(String id, FlowAnalysisRuleRunStatusEntity runStatusEntity)
NodeEntity	connectNode(String nodeId, NodeEntity nodeEntity)
ControllerServiceEntity	createControllerService(ControllerServiceEntity controllerService)
FlowAnalysisRuleEntity	createFlowAnalysisRule(FlowAnalysisRuleEntity reportingTask)
ParameterProviderEntity	createParamProvider(ParameterProviderEntity paramProvider)
FlowRegistryClientEntity	createRegistryClient(FlowRegistryClientEntity flowRegistryClientEntity)
ReportingTaskEntity	createReportingTask(ReportingTaskEntity reportingTask)
FlowAnalysisRuleEntity	deleteFlowAnalysisRule(FlowAnalysisRuleEntity flowAnalysisRule)
VerifyConfigRequestEntity	deleteFlowAnalysisRuleConfigVerificationRequest(String taskId, String verificationRequestId)
NarSummaryEntity	deleteNar(String identifier, boolean forceDelete)
NodeEntity	deleteNode(String nodeId)
NodeEntity	disconnectNode(String nodeId, NodeEntity nodeEntity)
File	downloadNar(String identifier, File outputDir)
ControllerConfigurationEntity	getControllerConfiguration()
FlowAnalysisRuleEntity	getFlowAnalysisRule(String id)
VerifyConfigRequestEntity	getFlowAnalysisRuleConfigVerificationRequest(String taskId, String verificationRequestId)
PropertyDescriptorEntity	getFlowAnalysisRulePropertyDescriptor(String componentId, String propertyName, Boolean sensitive)
FlowAnalysisRulesEntity	getFlowAnalysisRules()
NarDetailsEntity	getNarDetails(String identifier)
NarSummariesEntity	getNarSummaries()
NarSummaryEntity	getNarSummary(String identifier)
NodeEntity	getNode(String nodeId)
ClusterEntity	getNodes()
FlowRegistryClientEntity	getRegistryClient(String id)
FlowRegistryClientsEntity	getRegistryClients()
VersionedReportingTaskImportResponseEntity	importReportingTasks(VersionedReportingTaskImportRequestEntity importRequestEntity)
NodeEntity	offloadNode(String nodeId, NodeEntity nodeEntity)
VerifyConfigRequestEntity	submitFlowAnalysisRuleConfigVerificationRequest(VerifyConfigRequestEntity configRequestEntity)
ControllerConfigurationEntity	updateControllerConfiguration(ControllerConfigurationEntity controllerConfiguration)
FlowAnalysisRuleEntity	updateFlowAnalysisRule(FlowAnalysisRuleEntity flowAnalysisRuleEntity)
FlowRegistryClientEntity	updateRegistryClient(FlowRegistryClientEntity flowRegistryClientEntity)
NarSummaryEntity	uploadNar(String filename, InputStream narContentStream)

Method Details

getRegistryClients

FlowRegistryClientsEntity getRegistryClients()
                                      throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getRegistryClient

FlowRegistryClientEntity getRegistryClient(String id)
                                    throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

createRegistryClient

FlowRegistryClientEntity createRegistryClient(FlowRegistryClientEntity flowRegistryClientEntity)
                                       throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

updateRegistryClient

FlowRegistryClientEntity updateRegistryClient(FlowRegistryClientEntity flowRegistryClientEntity)
                                       throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

connectNode

NodeEntity connectNode(String nodeId,
 NodeEntity nodeEntity)
                throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

deleteNode

NodeEntity deleteNode(String nodeId)
               throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

disconnectNode

NodeEntity disconnectNode(String nodeId,
 NodeEntity nodeEntity)
                   throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getNode

NodeEntity getNode(String nodeId)
            throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getNodes

ClusterEntity getNodes()
                throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

offloadNode

NodeEntity offloadNode(String nodeId,
 NodeEntity nodeEntity)
                throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

createControllerService

ControllerServiceEntity createControllerService(ControllerServiceEntity controllerService)
                                         throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

createReportingTask

ReportingTaskEntity createReportingTask(ReportingTaskEntity reportingTask)
                                 throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

importReportingTasks

VersionedReportingTaskImportResponseEntity importReportingTasks(VersionedReportingTaskImportRequestEntity importRequestEntity)
                                                         throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getFlowAnalysisRules

FlowAnalysisRulesEntity getFlowAnalysisRules()
                                      throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getFlowAnalysisRule

FlowAnalysisRuleEntity getFlowAnalysisRule(String id)
                                    throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getFlowAnalysisRulePropertyDescriptor

PropertyDescriptorEntity getFlowAnalysisRulePropertyDescriptor(String componentId,
 String propertyName,
 Boolean sensitive)
                                                        throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

createFlowAnalysisRule

FlowAnalysisRuleEntity createFlowAnalysisRule(FlowAnalysisRuleEntity reportingTask)
                                       throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

updateFlowAnalysisRule

FlowAnalysisRuleEntity updateFlowAnalysisRule(FlowAnalysisRuleEntity flowAnalysisRuleEntity)
                                       throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

activateFlowAnalysisRule

FlowAnalysisRuleEntity activateFlowAnalysisRule(String id,
 FlowAnalysisRuleRunStatusEntity runStatusEntity)
                                         throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

deleteFlowAnalysisRule

FlowAnalysisRuleEntity deleteFlowAnalysisRule(FlowAnalysisRuleEntity flowAnalysisRule)
                                       throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

submitFlowAnalysisRuleConfigVerificationRequest

VerifyConfigRequestEntity submitFlowAnalysisRuleConfigVerificationRequest(VerifyConfigRequestEntity configRequestEntity)
                                                                   throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getFlowAnalysisRuleConfigVerificationRequest

VerifyConfigRequestEntity getFlowAnalysisRuleConfigVerificationRequest(String taskId,
 String verificationRequestId)
                                                                throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

deleteFlowAnalysisRuleConfigVerificationRequest

VerifyConfigRequestEntity deleteFlowAnalysisRuleConfigVerificationRequest(String taskId,
 String verificationRequestId)
                                                                   throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

createParamProvider

ParameterProviderEntity createParamProvider(ParameterProviderEntity paramProvider)
                                     throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getControllerConfiguration

ControllerConfigurationEntity getControllerConfiguration()
                                                  throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

updateControllerConfiguration

ControllerConfigurationEntity updateControllerConfiguration(ControllerConfigurationEntity controllerConfiguration)
                                                     throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

uploadNar

NarSummaryEntity uploadNar(String filename,
 InputStream narContentStream)
                    throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getNarSummaries

NarSummariesEntity getNarSummaries()
                            throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getNarSummary

NarSummaryEntity getNarSummary(String identifier)
                        throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

deleteNar

NarSummaryEntity deleteNar(String identifier,
 boolean forceDelete)
                    throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getNarDetails

NarDetailsEntity getNarDetails(String identifier)
                        throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

downloadNar

File downloadNar(String identifier,
 File outputDir)
          throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException