Package org.apache.nifi.toolkit.client.impl

Class JerseyFlowClient

java.lang.Object

org.apache.nifi.toolkit.client.impl.AbstractJerseyClient

org.apache.nifi.toolkit.client.impl.JerseyFlowClient

All Implemented Interfaces:

FlowClient

public class JerseyFlowClient
extends AbstractJerseyClient
implements FlowClient

Jersey implementation of FlowClient.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.nifi.toolkit.client.impl.AbstractJerseyClient

AbstractJerseyClient.NiFiAction<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final jakarta.ws.rs.client.WebTarget	flowTarget
(package private) static final String	ROOT

Constructor Summary

Constructors

Constructor	Description
JerseyFlowClient(jakarta.ws.rs.client.WebTarget baseTarget)
JerseyFlowClient(jakarta.ws.rs.client.WebTarget baseTarget, RequestConfig requestConfig)

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.

Methods inherited from class org.apache.nifi.toolkit.client.impl.AbstractJerseyClient

executeAction, getContentDispositionFilename, getIOExceptionCause, getRequestBuilder, getRequestConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROOT

static final String ROOT

See Also:

• Constant Field Values

flowTarget

private final jakarta.ws.rs.client.WebTarget flowTarget

Constructor Details

JerseyFlowClient

public JerseyFlowClient(jakarta.ws.rs.client.WebTarget baseTarget)

JerseyFlowClient

public JerseyFlowClient(jakarta.ws.rs.client.WebTarget baseTarget,
 RequestConfig requestConfig)

Method Details

getCurrentUser

public CurrentUserEntity getCurrentUser()
                                 throws NiFiClientException,
IOException

Specified by:

getCurrentUser in interface FlowClient

Returns:

the entity representing the current user accessing the NiFi instance

Throws:

NiFiClientException

IOException

getRootGroupId

public String getRootGroupId()
                      throws NiFiClientException,
IOException

Specified by:

getRootGroupId in interface FlowClient

Returns:

the id of the root process group

Throws:

NiFiClientException

IOException

getProcessGroup

public ProcessGroupFlowEntity getProcessGroup(String id)
                                       throws NiFiClientException,
IOException

Description copied from interface: FlowClient

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

Specified by:

getProcessGroup in interface FlowClient

Parameters:

id - the id of the process group to retrieve

Returns:

the process group entity

Throws:

NiFiClientException

IOException

getSuggestedProcessGroupCoordinates

public ProcessGroupBox getSuggestedProcessGroupCoordinates(String parentId)
                                                    throws NiFiClientException,
IOException

Description copied from interface: FlowClient

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.

Specified by:

getSuggestedProcessGroupCoordinates in interface FlowClient

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

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

Description copied from interface: FlowClient

Schedules the components of a process group.

Specified by:

scheduleProcessGroupComponents in interface FlowClient

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

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

Description copied from interface: FlowClient

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

Specified by:

getVersions in interface FlowClient

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

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

Description copied from interface: FlowClient

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

Specified by:

getVersions in interface FlowClient

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

public ControllerServicesEntity getControllerServices(String groupId)
                                               throws NiFiClientException,
IOException

Description copied from interface: FlowClient

Retrieves the controller services for the given group.

Specified by:

getControllerServices in interface FlowClient

Parameters:

groupId - the process group id

Returns:

the controller services entity

Throws:

NiFiClientException

IOException

activateControllerServices

public ActivateControllerServicesEntity activateControllerServices(ActivateControllerServicesEntity activateControllerServicesEntity)
                                                            throws NiFiClientException,
IOException

Description copied from interface: FlowClient

Enable or disable controller services in the given process group.

Specified by:

activateControllerServices in interface FlowClient

Parameters:

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

Returns:

the activate response

Throws:

NiFiClientException

IOException

getClusterSummary

public ClusterSummaryEntity getClusterSummary()
                                       throws NiFiClientException,
IOException

Specified by:

getClusterSummary in interface FlowClient

Returns:

cluster summary response

Throws:

NiFiClientException

IOException

getControllerServices

public ControllerServicesEntity getControllerServices()
                                               throws NiFiClientException,
IOException

Description copied from interface: FlowClient

Retrieves the controller services for the reporting tasks.

Specified by:

getControllerServices in interface FlowClient

Returns:

the controller services entity

Throws:

NiFiClientException

IOException

getReportingTasks

public ReportingTasksEntity getReportingTasks()
                                       throws NiFiClientException,
IOException

Description copied from interface: FlowClient

Retrieves the reporting tasks.

Specified by:

getReportingTasks in interface FlowClient

Returns:

the reporting tasks entity

Throws:

NiFiClientException

IOException

getReportingTaskSnapshot

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

Description copied from interface: FlowClient

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

Specified by:

getReportingTaskSnapshot in interface FlowClient

Returns:

the snapshot

Throws:

NiFiClientException

IOException

getReportingTaskSnapshot

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

Description copied from interface: FlowClient

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

Specified by:

getReportingTaskSnapshot in interface FlowClient

Returns:

the snapshot

Throws:

NiFiClientException

IOException

getParamProviders

public ParameterProvidersEntity getParamProviders()
                                           throws NiFiClientException,
IOException

Description copied from interface: FlowClient

Retrieves the parameter providers.

Specified by:

getParamProviders in interface FlowClient

Returns:

the parameter providers entity

Throws:

NiFiClientException

IOException

getConnectionStatus

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

Description copied from interface: FlowClient

Retrieves the status for the connection with the given ID

Specified by:

getConnectionStatus in interface FlowClient

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

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

Description copied from interface: FlowClient

Retrieves the status for the process group with the given ID

Specified by:

getProcessGroupStatus in interface FlowClient

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

public ProcessorTypesEntity getProcessorTypes()
                                       throws NiFiClientException,
IOException

Description copied from interface: FlowClient

Retrieves the available processor types.

Specified by:

getProcessorTypes in interface FlowClient

Returns:

the processor types

Throws:

NiFiClientException

IOException

getControllerServiceTypes

public ControllerServiceTypesEntity getControllerServiceTypes()
                                                       throws NiFiClientException,
IOException

Description copied from interface: FlowClient

Retrieves the available controller service types.

Specified by:

getControllerServiceTypes in interface FlowClient

Returns:

the controller service types

Throws:

NiFiClientException

IOException

getReportingTaskTypes

public ReportingTaskTypesEntity getReportingTaskTypes()
                                               throws NiFiClientException,
IOException

Description copied from interface: FlowClient

Retrieves the available reporting task types.

Specified by:

getReportingTaskTypes in interface FlowClient

Returns:

the reporting task types

Throws:

NiFiClientException

IOException

getFlowRegistryBranches

public FlowRegistryBranchesEntity getFlowRegistryBranches(String registryClientId)
                                                   throws NiFiClientException,
IOException

Description copied from interface: FlowClient

Returns the list of branches for the specified registry client ID

Specified by:

getFlowRegistryBranches in interface FlowClient

Parameters:

registryClientId - Registry Client ID

Returns:

list of branches

Throws:

NiFiClientException

IOException

getFlowRegistryBuckets

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

Description copied from interface: FlowClient

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

Specified by:

getFlowRegistryBuckets in interface FlowClient

Parameters:

registryClientId - Registry Client ID

branch - Name of the branch

Returns:

list of buckets

Throws:

NiFiClientException

IOException

getFlowRegistryFlows

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

Description copied from interface: FlowClient

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

Specified by:

getFlowRegistryFlows in interface FlowClient

Parameters:

registryClientId - Registry Client ID

branch - Name of the branch

bucket - ID of the bucket

Returns:

list of flows

Throws:

NiFiClientException

IOException