org.apache.nifi.registry.client.impl

Class JerseyFlowSnapshotClient

java.lang.Object

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

org.apache.nifi.registry.client.impl.JerseyFlowSnapshotClient

All Implemented Interfaces:

FlowSnapshotClient

public class JerseyFlowSnapshotClient
extends AbstractJerseyClient
implements FlowSnapshotClient

Jersey implementation of FlowSnapshotClient.

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
(package private) javax.ws.rs.client.WebTarget	bucketFlowSnapshotTarget
(package private) javax.ws.rs.client.WebTarget	flowsFlowSnapshotTarget

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
VersionedFlowSnapshot	create(VersionedFlowSnapshot snapshot) Creates a new snapshot/version for the given flow.
VersionedFlowSnapshot	get(String flowId, int version) Gets the snapshot for the given flow and version.
VersionedFlowSnapshot	get(String bucketId, String flowId, int version) Gets the snapshot for the given bucket, flow, and version.
VersionedFlowSnapshot	getLatest(String flowId) Gets the latest snapshot for the given flow.
VersionedFlowSnapshot	getLatest(String bucketId, String flowId) Gets the latest snapshot for the given flow.
VersionedFlowSnapshotMetadata	getLatestMetadata(String flowId) Gets the latest snapshot metadata for the given flow.
VersionedFlowSnapshotMetadata	getLatestMetadata(String bucketId, String flowId) Gets the latest snapshot metadata for the given flow.
List<VersionedFlowSnapshotMetadata>	getSnapshotMetadata(String flowId) Gets a list of the metadata for all snapshots of a given flow.
List<VersionedFlowSnapshotMetadata>	getSnapshotMetadata(String bucketId, String flowId) Gets a list of the metadata for all snapshots of a given flow.

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

bucketFlowSnapshotTarget

final javax.ws.rs.client.WebTarget bucketFlowSnapshotTarget

flowsFlowSnapshotTarget

final javax.ws.rs.client.WebTarget flowsFlowSnapshotTarget

Constructor Detail

JerseyFlowSnapshotClient

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

JerseyFlowSnapshotClient

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

Method Detail

create

public VersionedFlowSnapshot create(VersionedFlowSnapshot snapshot)
                             throws NiFiRegistryException,
                                    IOException

Description copied from interface: FlowSnapshotClient

Creates a new snapshot/version for the given flow. The snapshot object must have the version populated, and will receive an error if the submitted version is not the next one-up version.

Specified by:

create in interface FlowSnapshotClient

Parameters:

snapshot - the new snapshot

Returns:

the created snapshot

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

get

public VersionedFlowSnapshot get(String bucketId,
                                 String flowId,
                                 int version)
                          throws NiFiRegistryException,
                                 IOException

Description copied from interface: FlowSnapshotClient

Gets the snapshot for the given bucket, flow, and version.

Specified by:

get in interface FlowSnapshotClient

Parameters:

bucketId - the bucket id

flowId - the flow id

version - the version

Returns:

the snapshot with the given version of the given flow in the given bucket

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

get

public VersionedFlowSnapshot get(String flowId,
                                 int version)
                          throws NiFiRegistryException,
                                 IOException

Description copied from interface: FlowSnapshotClient

Gets the snapshot for the given flow and version.

Specified by:

get in interface FlowSnapshotClient

Parameters:

flowId - the flow id

version - the version

Returns:

the snapshot with the given version of the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getLatest

public VersionedFlowSnapshot getLatest(String bucketId,
                                       String flowId)
                                throws NiFiRegistryException,
                                       IOException

Description copied from interface: FlowSnapshotClient

Gets the latest snapshot for the given flow.

Specified by:

getLatest in interface FlowSnapshotClient

Parameters:

bucketId - the bucket id

flowId - the flow id

Returns:

the snapshot with the latest version for the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getLatest

public VersionedFlowSnapshot getLatest(String flowId)
                                throws NiFiRegistryException,
                                       IOException

Description copied from interface: FlowSnapshotClient

Gets the latest snapshot for the given flow.

Specified by:

getLatest in interface FlowSnapshotClient

Parameters:

flowId - the flow id

Returns:

the snapshot with the latest version for the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getLatestMetadata

public VersionedFlowSnapshotMetadata getLatestMetadata(String bucketId,
                                                       String flowId)
                                                throws NiFiRegistryException,
                                                       IOException

Description copied from interface: FlowSnapshotClient

Gets the latest snapshot metadata for the given flow.

Specified by:

getLatestMetadata in interface FlowSnapshotClient

Parameters:

bucketId - the bucket id

flowId - the flow id

Returns:

the snapshot metadata for the latest version of the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getLatestMetadata

public VersionedFlowSnapshotMetadata getLatestMetadata(String flowId)
                                                throws NiFiRegistryException,
                                                       IOException

Description copied from interface: FlowSnapshotClient

Gets the latest snapshot metadata for the given flow.

Specified by:

getLatestMetadata in interface FlowSnapshotClient

Parameters:

flowId - the flow id

Returns:

the snapshot metadata for the latest version of the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getSnapshotMetadata

public List<VersionedFlowSnapshotMetadata> getSnapshotMetadata(String bucketId,
                                                               String flowId)
                                                        throws NiFiRegistryException,
                                                               IOException

Description copied from interface: FlowSnapshotClient

Gets a list of the metadata for all snapshots of a given flow. The contents of each snapshot are not part of the response.

Specified by:

getSnapshotMetadata in interface FlowSnapshotClient

Parameters:

bucketId - the bucket id

flowId - the flow id

Returns:

the list of snapshot metadata

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getSnapshotMetadata

public List<VersionedFlowSnapshotMetadata> getSnapshotMetadata(String flowId)
                                                        throws NiFiRegistryException,
                                                               IOException

Description copied from interface: FlowSnapshotClient

Gets a list of the metadata for all snapshots of a given flow. The contents of each snapshot are not part of the response.

Specified by:

getSnapshotMetadata in interface FlowSnapshotClient

Parameters:

flowId - the flow id

Returns:

the list of snapshot metadata

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered