cz.srayayay.tierion.hashapi

Interface TierionHashApiClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

V1TierionHashApiClient

public interface TierionHashApiClient
extends AutoCloseable

Method Summary

Modifier and Type	Method and Description
String	createBlockSubscription(String callbackUrl, String label) Creates a new block subscription using the specified callbackUrl and label.
void	deleteBlockSubscription(String id) Deletes an existing block subscription with the specified id.
List<BlockSubscription>	getAllBlockSubscriptions() Retrieves a list of all block subscriptions bound to the user's account.
BlockSubscription	getBlockSubscription(String id) Retrieves data about a block subscription specified by id.
BlockchainReceipt	getReceipt(String receiptId) Retrieves a receipt of a hash item.
HashResponse	submitContent(byte[] text) Submits an item for hashing, as a byte array.
HashResponse	submitFile(Path file) Submits a File from the filesystem for hashing.
HashResponse	submitHash(String hash) Submits a hash to the blockchain.
BlockSubscription	updateBlockSubscription(String id, String callbackUrl, String label) Updates an existing block subscription.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

submitHash

HashResponse submitHash(String hash)

Submits a hash to the blockchain.

Parameters:

hash - A hex-encoded SHA-256 hash.

submitContent

HashResponse submitContent(byte[] text)

Submits an item for hashing, as a byte array. The SHA-256 will be computed automatically from the byte array and will be submitted to the blockchain.

Parameters:

text - Content to be hashed.

submitFile

HashResponse submitFile(Path file)
                 throws IOException

Submits a File from the filesystem for hashing. The SHA-256 hash will be computed automatically and will be submitted to the blockchain.

Parameters:

file - Path to the file which should be hashed and the hash submitted.

Throws:

IOException

getReceipt

BlockchainReceipt getReceipt(String receiptId)

Retrieves a receipt of a hash item. This will only work for hash items which are already processed and placed on the blockchain.

Parameters:

receiptId - ID of the receipt to be retrieved.

Returns:

Representation of the requested blockchain receipt.

Throws:

TierionException - If no receipt with the specified ID exists.

getAllBlockSubscriptions

List<BlockSubscription> getAllBlockSubscriptions()

Retrieves a list of all block subscriptions bound to the user's account.

Returns:

A list of all block subscriptions.

getBlockSubscription

BlockSubscription getBlockSubscription(String id)

Retrieves data about a block subscription specified by id.

Parameters:

id - The block subscription ID.

Returns:

Representation of the requested block subscription.

Throws:

TierionException - If no subscription with the requested ID is found.

createBlockSubscription

String createBlockSubscription(String callbackUrl,
                               String label)

Creates a new block subscription using the specified callbackUrl and label.

Parameters:

callbackUrl - The callback URL for this block subscription.

label - The label of this block subscription.

Returns:

The id of the newly created block subscription. TODO: a tool for computing the HMAC-SHA256 signature (https://tierion.com/docs/hashapi#api-blocksubscriptions)

updateBlockSubscription

BlockSubscription updateBlockSubscription(String id,
                                          String callbackUrl,
                                          String label)

Updates an existing block subscription.

Parameters:

id - The ID of the block subscription to be updated.

callbackUrl - The new callback URL. If null, then the current callback URL will remain unchanged.

label - The new label. If null, then the current label will remain unchanged.

Throws:

TierionException - If no subscription with the requested ID is found.

deleteBlockSubscription

void deleteBlockSubscription(String id)

Deletes an existing block subscription with the specified id.

Parameters:

id - The ID of the block subscription to be deleted.

Throws:

TierionException - If no subscription with the requested ID is found.