Package org.apache.nifi.toolkit.client

Interface FlowClient

All Known Implementing Classes:

JerseyFlowClient

public interface FlowClient

Client for FlowResource.

Method Summary

Modifier and Type	Method	Description
ActivateControllerServicesEntity	activateControllerServices(ActivateControllerServicesEntity activateControllerServicesEntity)	Enable or disable controller services in the given process group.
ClusterSummaryEntity	getClusterSummary()
ConnectionStatusEntity	getConnectionStatus(String connectionId, boolean nodewise)	Retrieves the status for the connection with the given ID
ControllerServicesEntity	getControllerServices()	Retrieves the controller services for the reporting tasks.
ControllerServicesEntity	getControllerServices(String groupId)	Retrieves the controller services for the given group.
ControllerServiceTypesEntity	getControllerServiceTypes()	Retrieves the available controller service types.
CurrentUserEntity	getCurrentUser()
FlowRegistryBranchesEntity	getFlowRegistryBranches(String registryClientId)	Returns the list of branches for the specified registry client ID
FlowRegistryBucketsEntity	getFlowRegistryBuckets(String registryClientId, String branch)	Returns the list of buckets in a given branch for the specified registry client ID
VersionedFlowsEntity	getFlowRegistryFlows(String registryClientId, String branch, String bucket)	Returns the list of flows in a given branch and bucket for the specified registry client ID
ParameterProvidersEntity	getParamProviders()	Retrieves the parameter providers.
ProcessGroupFlowEntity	getProcessGroup(String id)	Retrieves the process group with the given id.
ProcessGroupStatusEntity	getProcessGroupStatus(String groupId, boolean recursive)	Retrieves the status for the process group with the given ID
ProcessorTypesEntity	getProcessorTypes()	Retrieves the available processor types.
ReportingTasksEntity	getReportingTasks()	Retrieves the reporting tasks.
org.apache.nifi.flow.VersionedReportingTaskSnapshot	getReportingTaskSnapshot()	Retrieves the snapshot of all reporting tasks and their respective controller services.
org.apache.nifi.flow.VersionedReportingTaskSnapshot	getReportingTaskSnapshot(String reportingTaskId)	Retrieves the snapshot of the given reporting task and it's respective controller services.
ReportingTaskTypesEntity	getReportingTaskTypes()	Retrieves the available reporting task types.
String	getRootGroupId()
ProcessGroupBox	getSuggestedProcessGroupCoordinates(String parentId)	Suggest a location for the new process group on a canvas, within a given process group.
VersionedFlowSnapshotMetadataSetEntity	getVersions(String registryId, String bucketId, String flowId)	Gets the possible versions for the given flow in the given bucket in the given registry.
VersionedFlowSnapshotMetadataSetEntity	getVersions(String registryId, String bucketId, String flowId, String branch)	Gets the possible versions for the given flow in the given bucket/branch in the given registry.
ScheduleComponentsEntity	scheduleProcessGroupComponents(String processGroupId, ScheduleComponentsEntity scheduleComponentsEntity)	Schedules the components of a process group.

Method Details

getCurrentUser

CurrentUserEntity getCurrentUser()
                          throws NiFiClientException,
IOException

Returns:

the entity representing the current user accessing the NiFi instance

Throws:

NiFiClientException

IOException

getRootGroupId

String getRootGroupId()
               throws NiFiClientException,
IOException

Returns:

the id of the root process group

Throws:

NiFiClientException

IOException

getProcessGroup

ProcessGroupFlowEntity getProcessGroup(String id)
                                throws NiFiClientException,
IOException

Retrieves the process group with the given id. Passing in "root" as the id will retrieve the root group.

Parameters:

id - the id of the process group to retrieve

Returns:

the process group entity

Throws:

NiFiClientException

IOException

getSuggestedProcessGroupCoordinates

ProcessGroupBox getSuggestedProcessGroupCoordinates(String parentId)
                                             throws NiFiClientException,
IOException

Suggest a location for the new process group on a canvas, within a given process group. Will locate to the right and then bottom and offset for the size of the PG box.

Parameters:

parentId - the id of the parent process group where the new process group will be located

Returns:

the process group box where a new process group can be placed

Throws:

NiFiClientException

IOException

scheduleProcessGroupComponents

ScheduleComponentsEntity scheduleProcessGroupComponents(String processGroupId,
 ScheduleComponentsEntity scheduleComponentsEntity)
                                                 throws NiFiClientException,
IOException

Schedules the components of a process group.

Parameters:

processGroupId - the id of a process group

scheduleComponentsEntity - the scheduled state to update to

Returns:

the entity representing the scheduled state

Throws:

NiFiClientException

IOException

getVersions

VersionedFlowSnapshotMetadataSetEntity getVersions(String registryId,
 String bucketId,
 String flowId)
                                            throws NiFiClientException,
IOException

Gets the possible versions for the given flow in the given bucket in the given registry.

Parameters:

registryId - the id of the registry client

bucketId - the bucket id

flowId - the flow id

Returns:

the set of snapshot metadata entities

Throws:

NiFiClientException

IOException

getVersions

VersionedFlowSnapshotMetadataSetEntity getVersions(String registryId,
 String bucketId,
 String flowId,
 String branch)
                                            throws NiFiClientException,
IOException

Gets the possible versions for the given flow in the given bucket/branch in the given registry.

Parameters:

registryId - the id of the registry client

bucketId - the bucket id

flowId - the flow id

branch - the branch name

Returns:

the set of snapshot metadata entities

Throws:

NiFiClientException

IOException

getControllerServices

ControllerServicesEntity getControllerServices(String groupId)
                                        throws NiFiClientException,
IOException

Retrieves the controller services for the given group.

Parameters:

groupId - the process group id

Returns:

the controller services entity

Throws:

NiFiClientException

IOException

activateControllerServices

ActivateControllerServicesEntity activateControllerServices(ActivateControllerServicesEntity activateControllerServicesEntity)
                                                     throws NiFiClientException,
IOException

Enable or disable controller services in the given process group.

Parameters:

activateControllerServicesEntity - the entity indicating the process group to enable/disable services for

Returns:

the activate response

Throws:

NiFiClientException

IOException

getClusterSummary

ClusterSummaryEntity getClusterSummary()
                                throws NiFiClientException,
IOException

Returns:

cluster summary response

Throws:

NiFiClientException

IOException

getControllerServices

ControllerServicesEntity getControllerServices()
                                        throws NiFiClientException,
IOException

Retrieves the controller services for the reporting tasks.

Returns:

the controller services entity

Throws:

NiFiClientException

IOException

getReportingTasks

ReportingTasksEntity getReportingTasks()
                                throws NiFiClientException,
IOException

Retrieves the reporting tasks.

Returns:

the reporting tasks entity

Throws:

NiFiClientException

IOException

getReportingTaskSnapshot

org.apache.nifi.flow.VersionedReportingTaskSnapshot getReportingTaskSnapshot()
                                                                      throws NiFiClientException,
IOException

Retrieves the snapshot of all reporting tasks and their respective controller services.

Returns:

the snapshot

Throws:

NiFiClientException

IOException

getReportingTaskSnapshot

org.apache.nifi.flow.VersionedReportingTaskSnapshot getReportingTaskSnapshot(String reportingTaskId)
                                                                      throws NiFiClientException,
IOException

Retrieves the snapshot of the given reporting task and it's respective controller services.

Returns:

the snapshot

Throws:

NiFiClientException

IOException

getParamProviders

ParameterProvidersEntity getParamProviders()
                                    throws NiFiClientException,
IOException

Retrieves the parameter providers.

Returns:

the parameter providers entity

Throws:

NiFiClientException

IOException

getConnectionStatus

ConnectionStatusEntity getConnectionStatus(String connectionId,
 boolean nodewise)
                                    throws NiFiClientException,
IOException

Retrieves the status for the connection with the given ID

Parameters:

connectionId - the id of the connection

nodewise - whether or not node-wise information should be returned

Returns:

the status for the connection

Throws:

NiFiClientException

IOException

getProcessGroupStatus

ProcessGroupStatusEntity getProcessGroupStatus(String groupId,
 boolean recursive)
                                        throws NiFiClientException,
IOException

Retrieves the status for the process group with the given ID

Parameters:

groupId - the id of the process group

recursive - whether or not to recurse into sub groups

Returns:

the status for the process group

Throws:

NiFiClientException

IOException

getProcessorTypes

ProcessorTypesEntity getProcessorTypes()
                                throws NiFiClientException,
IOException

Retrieves the available processor types.

Returns:

the processor types

Throws:

NiFiClientException

IOException

getControllerServiceTypes

ControllerServiceTypesEntity getControllerServiceTypes()
                                                throws NiFiClientException,
IOException

Retrieves the available controller service types.

Returns:

the controller service types

Throws:

NiFiClientException

IOException

getReportingTaskTypes

ReportingTaskTypesEntity getReportingTaskTypes()
                                        throws NiFiClientException,
IOException

Retrieves the available reporting task types.

Returns:

the reporting task types

Throws:

NiFiClientException

IOException

getFlowRegistryBranches

FlowRegistryBranchesEntity getFlowRegistryBranches(String registryClientId)
                                            throws NiFiClientException,
IOException

Returns the list of branches for the specified registry client ID

Parameters:

registryClientId - Registry Client ID

Returns:

list of branches

Throws:

NiFiClientException

IOException

getFlowRegistryBuckets

FlowRegistryBucketsEntity getFlowRegistryBuckets(String registryClientId,
 String branch)
                                          throws NiFiClientException,
IOException

Returns the list of buckets in a given branch for the specified registry client ID

Parameters:

registryClientId - Registry Client ID

branch - Name of the branch

Returns:

list of buckets

Throws:

NiFiClientException

IOException

getFlowRegistryFlows

VersionedFlowsEntity getFlowRegistryFlows(String registryClientId,
 String branch,
 String bucket)
                                   throws NiFiClientException,
IOException

Returns the list of flows in a given branch and bucket for the specified registry client ID

Parameters:

registryClientId - Registry Client ID

branch - Name of the branch

bucket - ID of the bucket

Returns:

list of flows

Throws:

NiFiClientException

IOException