org.apache.nifi.registry.client

Interface ItemsClient

All Known Implementing Classes:

JerseyItemsClient

public interface ItemsClient

Client for interacting with bucket items. Bucket items contain the common fields across anything stored in the registry. Each item contains a type field and a link to the URI of the specific item. i.e. The link field of a flow item would contain the URI to the specific flow.

Method Summary

Modifier and Type	Method and Description
List<BucketItem>	getAll() Gets all bucket items in the registry.
List<BucketItem>	getByBucket(String bucketId) Gets all bucket items for the given bucket.
Fields	getFields() Gets the field info for bucket items.

Method Detail

getAll

List<BucketItem> getAll()
                 throws NiFiRegistryException,
                        IOException

Gets all bucket items in the registry.

Returns:

the list of all bucket items

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getByBucket

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

Gets all bucket items for the given bucket.

Parameters:

bucketId - the bucket id

Returns:

the list of items in the given bucket

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getFields

Fields getFields()
          throws NiFiRegistryException,
                 IOException

Gets the field info for bucket items.

Returns:

the list of field info

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered