Package io.bdeploy.bhive.remote.jersey

Interface BHiveResource

All Known Implementing Classes:

BHiveResourceImpl

@Path("/hive")
@Produces("application/json")
@Consumes("application/json")
public interface BHiveResource

Resource allowing access to a single BHive.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BHiveResource.FetchSpec
static class	BHiveResource.ObjectListSpec

Method Summary

Modifier and Type	Method	Description
Path	fetch(BHiveResource.FetchSpec spec)	Fetch manifests from the remote as ZIPed BHive.
InputStream	fetchAsStream(BHiveResource.FetchSpec spec)	Streams manifests and objects from the remove hive.
SortedMap<Manifest.Key,ObjectId>	getManifestInventory(String... names)	Retrieve all Manifest.Keys along with the root tree ObjectId available to the remote repository.
Set<ObjectId>	getMissingObjects(Set<ObjectId> all)	From the given set, filter all remotely known ObjectIds and return only ObjectId which are not yet present on the remote.
Set<ObjectId>	getRequiredObjects(BHiveResource.ObjectListSpec spec)	Retrieve the ObjectId required to satisfy a given tree.
Set<ObjectId>	getRequiredTrees(ObjectId tree)	Retrieve the ObjectIds of all required Tree objects recursively in the given tree.
void	prune()	Perform a prune operation on the remote BHive, removing any unreferenced objects.
void	push(Path zipedHive)	Transfer the ZIPed BHive to the remote and apply all top-level Manifests referenced within.
TransferStatistics	pushAsStream(InputStream in)	Streams manifests and objects into the remove hive.
void	removeManifest(Manifest.Key key)

Method Details

getManifestInventory

@POST
@Path("/manifests")
SortedMap<Manifest.Key,ObjectId> getManifestInventory(String... names)

Retrieve all Manifest.Keys along with the root tree ObjectId available to the remote repository.

Parameters:

names -

removeManifest

@POST
@Path("/manifest_remove")
@RequiredPermission(permission=WRITE)
void removeManifest(Manifest.Key key)

Parameters:

key - the manifest to delete.

prune

@POST
@Path("/prune")
void prune()

Perform a prune operation on the remote BHive, removing any unreferenced objects.

getMissingObjects

@POST
@Path("/obj_missing")
Set<ObjectId> getMissingObjects(Set<ObjectId> all)

From the given set, filter all remotely known ObjectIds and return only ObjectId which are not yet present on the remote.

getRequiredObjects

@POST
@Path("/tree_objects")
Set<ObjectId> getRequiredObjects(BHiveResource.ObjectListSpec spec)

Retrieve the ObjectId required to satisfy a given tree.

getRequiredTrees

@POST
@Path("/tree_trees")
Set<ObjectId> getRequiredTrees(ObjectId tree)

Retrieve the ObjectIds of all required Tree objects recursively in the given tree.

push

@PUT
@Path("/push")
@Consumes("application/octet-stream")
@RequiredPermission(permission=WRITE)
void push(Path zipedHive)

Transfer the ZIPed BHive to the remote and apply all top-level Manifests referenced within.

pushAsStream

@PUT
@Path("/pushAsStream")
@Produces("application/json")
@Consumes("application/octet-stream")
@RequiredPermission(permission=WRITE)
TransferStatistics pushAsStream(InputStream in)

Streams manifests and objects into the remove hive.

fetch

@POST
@Path("/fetch")
@Produces("application/octet-stream")
Path fetch(BHiveResource.FetchSpec spec)

Fetch manifests from the remote as ZIPed BHive.

The caller is responsible for cleaning up the file pointed at by the returned Path.

fetchAsStream

@POST
@Path("/fetchAsStream")
@Produces("application/octet-stream")
InputStream fetchAsStream(BHiveResource.FetchSpec spec)

Streams manifests and objects from the remove hive.