Package com.io7m.sunburst.inventory.api

Interface SBTransactionReadableType

All Superinterfaces:

AutoCloseable, SBTransactionCloseableType

All Known Subinterfaces:

SBTransactionType

public interface SBTransactionReadableType
extends SBTransactionCloseableType

The type of transactions that can be read.

Method Summary

Modifier and Type	Method	Description
Path	blobFile(SBPackageIdentifier identifier, SBPath path)	Obtain the file associated with the blob in the given package.
Optional<SBBlob>	blobGet(SBHash hash)	Retrieve a blob.
Map<SBHash,SBBlob>	blobList()	List all available blobs.
Map<SBHash,SBBlob>	blobsUnreferenced()	List all blobs that are not referenced by any packages.
Optional<SBPackage>	packageGet(SBPackageIdentifier identifier)
Set<SBPackageIdentifier>	packages()
Set<SBPackageIdentifier>	packagesUpdatedSince(OffsetDateTime time)

Methods inherited from interface com.io7m.sunburst.inventory.api.SBTransactionCloseableType

close

Method Details

blobFile

Path blobFile(SBPackageIdentifier identifier,
 SBPath path)
       throws SBInventoryException

Obtain the file associated with the blob in the given package.

Parameters:

identifier - The package identifier

path - The file path

Returns:

A file path

Throws:

SBInventoryException - On errors

packagesUpdatedSince

Set<SBPackageIdentifier> packagesUpdatedSince(OffsetDateTime time)
                                       throws SBInventoryException

Parameters:

time - The comparison time

Returns:

The installed set of packages that have been updated since the given time

Throws:

SBInventoryException - On errors

packages

Set<SBPackageIdentifier> packages()
                           throws SBInventoryException

Returns:

The installed set of packages

Throws:

SBInventoryException - On errors

packageGet

Optional<SBPackage> packageGet(SBPackageIdentifier identifier)
                        throws SBInventoryException

Parameters:

identifier - The package identifier

Returns:

The package with the given identifier, if one is installed

Throws:

SBInventoryException - On errors

blobGet

Optional<SBBlob> blobGet(SBHash hash)
                  throws SBInventoryException

Retrieve a blob.

Parameters:

hash - The hash value

Returns:

A blob, if one exists

Throws:

SBInventoryException - On errors

blobList

Map<SBHash,SBBlob> blobList()
                     throws SBInventoryException

List all available blobs.

Returns:

The available blobs

Throws:

SBInventoryException - On errors

blobsUnreferenced

Map<SBHash,SBBlob> blobsUnreferenced()
                              throws SBInventoryException

List all blobs that are not referenced by any packages.

Returns:

The unreferenced blobs

Throws:

SBInventoryException - On errors