org.apache.nifi.registry.client.impl

Class JerseyFlowClient

java.lang.Object

org.apache.nifi.registry.client.impl.AbstractJerseyClient

org.apache.nifi.registry.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.registry.client.impl.AbstractJerseyClient

AbstractJerseyClient.NiFiRegistryAction<T>

Field Summary

Fields

Modifier and Type	Field and Description
private javax.ws.rs.client.WebTarget	bucketFlowsTarget
private javax.ws.rs.client.WebTarget	flowsTarget

Constructor Summary

Constructors

Constructor and Description
JerseyFlowClient(javax.ws.rs.client.WebTarget baseTarget)
JerseyFlowClient(javax.ws.rs.client.WebTarget baseTarget, Map<String,String> headers)

Method Summary

Modifier and Type	Method and Description
VersionedFlow	create(VersionedFlow flow) Create the given flow in the given bucket.
VersionedFlow	delete(String bucketId, String flowId) Deletes the flow with the given id in the given bucket.
VersionedFlowDifference	diff(String bucketId, String flowId, Integer versionA, Integer versionB)
VersionedFlow	get(String flowId) Gets the flow with the given id.
VersionedFlow	get(String bucketId, String flowId) Gets the flow with the given id in the given bucket.
List<VersionedFlow>	getByBucket(String bucketId) Gets the flows for a given bucket.
Fields	getFields() Gets the field info for flows.
VersionedFlow	update(String bucketId, VersionedFlow flow) Updates the given flow with in the given bucket.

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

executeAction, getHeaders, getIOExceptionCause, getRequestBuilder

Methods inherited from class java.lang.Object

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

Field Detail

flowsTarget

private final javax.ws.rs.client.WebTarget flowsTarget

bucketFlowsTarget

private final javax.ws.rs.client.WebTarget bucketFlowsTarget

Constructor Detail

JerseyFlowClient

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

JerseyFlowClient

public JerseyFlowClient(javax.ws.rs.client.WebTarget baseTarget,
                        Map<String,String> headers)

Method Detail

create

public VersionedFlow create(VersionedFlow flow)
                     throws NiFiRegistryException,
                            IOException

Description copied from interface: FlowClient

Create the given flow in the given bucket.

Specified by:

create in interface FlowClient

Parameters:

flow - the flow to create

Returns:

the created flow with the identifier populated

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

get

public VersionedFlow get(String bucketId,
                         String flowId)
                  throws NiFiRegistryException,
                         IOException

Description copied from interface: FlowClient

Gets the flow with the given id in the given bucket. The list of snapshot metadata will NOT be populated.

Specified by:

get in interface FlowClient

Parameters:

bucketId - a bucket id

flowId - a flow id

Returns:

the flow with the given id in the given bucket

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

get

public VersionedFlow get(String flowId)
                  throws NiFiRegistryException,
                         IOException

Description copied from interface: FlowClient

Gets the flow with the given id.

Specified by:

get in interface FlowClient

Parameters:

flowId - a flow id

Returns:

the flow with the given id

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

update

public VersionedFlow update(String bucketId,
                            VersionedFlow flow)
                     throws NiFiRegistryException,
                            IOException

Description copied from interface: FlowClient

Updates the given flow with in the given bucket. The identifier of the flow must be populated in the flow object, and only the name and description can be updated.

Specified by:

update in interface FlowClient

Parameters:

bucketId - a bucket id

flow - the flow with updates

Returns:

the updated flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

delete

public VersionedFlow delete(String bucketId,
                            String flowId)
                     throws NiFiRegistryException,
                            IOException

Description copied from interface: FlowClient

Deletes the flow with the given id in the given bucket.

Specified by:

delete in interface FlowClient

Parameters:

bucketId - a bucket id

flowId - the id of the flow to delete

Returns:

the deleted flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getFields

public Fields getFields()
                 throws NiFiRegistryException,
                        IOException

Description copied from interface: FlowClient

Gets the field info for flows.

Specified by:

getFields in interface FlowClient

Returns:

field info for flows

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getByBucket

public List<VersionedFlow> getByBucket(String bucketId)
                                throws NiFiRegistryException,
                                       IOException

Description copied from interface: FlowClient

Gets the flows for a given bucket.

Specified by:

getByBucket in interface FlowClient

Parameters:

bucketId - a bucket id

Returns:

the flows in the given bucket

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

diff

public VersionedFlowDifference diff(String bucketId,
                                    String flowId,
                                    Integer versionA,
                                    Integer versionB)
                             throws NiFiRegistryException,
                                    IOException

Specified by:

diff in interface FlowClient

Parameters:

bucketId - a bucket id

flowId - the flow that is under inspection

versionA - the first version to use in the comparison

versionB - the second flow to use in the comparison

Returns:

the list of differences between the 2 flow versions grouped by component

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered