cz.srayayay.tierion.hashapi

Class V1TierionHashApiClient

java.lang.Object

cz.srayayay.tierion.hashapi.V1TierionHashApiClient

All Implemented Interfaces:

TierionHashApiClient, AutoCloseable

public class V1TierionHashApiClient
extends Object
implements TierionHashApiClient

Constructor Summary

Constructors

Constructor and Description
V1TierionHashApiClient()
V1TierionHashApiClient(int connectionPoolSize)
V1TierionHashApiClient(String username, String password)
V1TierionHashApiClient(String username, String password, int connectionPoolSize)

Method Summary

Modifier and Type	Method and Description
void	close()
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

V1TierionHashApiClient

public V1TierionHashApiClient(String username,
                              String password,
                              int connectionPoolSize)

V1TierionHashApiClient

public V1TierionHashApiClient(String username,
                              String password)

V1TierionHashApiClient

public V1TierionHashApiClient(int connectionPoolSize)

V1TierionHashApiClient

public V1TierionHashApiClient()

Method Detail

submitHash

public HashResponse submitHash(String hash)

Description copied from interface: TierionHashApiClient

Submits a hash to the blockchain.

Specified by:

submitHash in interface TierionHashApiClient

Parameters:

hash - A hex-encoded SHA-256 hash.

submitContent

public HashResponse submitContent(byte[] text)

Description copied from interface: TierionHashApiClient

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.

Specified by:

submitContent in interface TierionHashApiClient

Parameters:

text - Content to be hashed.

submitFile

public HashResponse submitFile(Path file)
                        throws IOException

Description copied from interface: TierionHashApiClient

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

Specified by:

submitFile in interface TierionHashApiClient

Parameters:

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

Throws:

IOException

getReceipt

public BlockchainReceipt getReceipt(String receiptId)

Description copied from interface: TierionHashApiClient

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

Specified by:

getReceipt in interface TierionHashApiClient

Parameters:

receiptId - ID of the receipt to be retrieved.

Returns:

Representation of the requested blockchain receipt.

getAllBlockSubscriptions

public List<BlockSubscription> getAllBlockSubscriptions()

Description copied from interface: TierionHashApiClient

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

Specified by:

getAllBlockSubscriptions in interface TierionHashApiClient

Returns:

A list of all block subscriptions.

getBlockSubscription

public BlockSubscription getBlockSubscription(String id)

Description copied from interface: TierionHashApiClient

Retrieves data about a block subscription specified by id.

Specified by:

getBlockSubscription in interface TierionHashApiClient

Parameters:

id - The block subscription ID.

Returns:

Representation of the requested block subscription.

createBlockSubscription

public String createBlockSubscription(String callbackUrl,
                                      String label)

Description copied from interface: TierionHashApiClient

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

Specified by:

createBlockSubscription in interface TierionHashApiClient

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

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

Description copied from interface: TierionHashApiClient

Updates an existing block subscription.

Specified by:

updateBlockSubscription in interface TierionHashApiClient

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.

deleteBlockSubscription

public void deleteBlockSubscription(String id)

Description copied from interface: TierionHashApiClient

Deletes an existing block subscription with the specified id.

Specified by:

deleteBlockSubscription in interface TierionHashApiClient

Parameters:

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

close

public void close()

Specified by:

close in interface AutoCloseable