java.lang.Object
- com.github.katenachain.api.Handler

```
public class Handler
extends Object
```
Handler provides helper methods to send and retrieve tx without directly interacting with the HTTP Client.

Constructor Summary

Constructors
Constructor Description

Handler(String apiUrl, Serializer serializer)
Handler constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`byte[]`	`getTxDataState(String chainId, Instant nonceTime, TxData txData)`	returns the sorted and marshaled json representation of a TxData ready to be signed.
`TxData`	`retrieveCertificate(String fqId)`	fetches the API and returns a certificate from the state.
`TxResults`	`retrieveCertificateTxs(String fqId, int page, int txPerPage)`	fetches the API to return all txs related to a certificate fqid.
`KeyV1[]`	`retrieveCompanyKeys(String companyBcId, int page, int txPerPage)`	fetches the API and returns a list of keys for a company from the state.
`KeyV1`	`retrieveKey(String fqId)`	fetches the API and returns a key from the state.
`TxResults`	`retrieveKeyTxs(String fqId, int page, int txPerPage)`	fetches the API to return all txs related to a key fqid.
`TxResult`	`retrieveLastCertificateTx(String fqId)`	fetches the API to return the last tx related to a certificate fqid.
`TxResult`	`retrieveLastKeyTx(String fqId)`	fetches the API to return the last tx related to a key fqid.
`TxResult`	`retrieveLastSecretTx(String fqId)`	fetches the API to return the last tx related to a secret fqid.
`TxData`	`retrieveSecret(String fqId)`	fetches the API and returns a secret from the state.
`TxResults`	`retrieveSecretTxs(String fqId, int page, int txPerPage)`	fetches the API to return all txs related to a secret fqid.
`TxResult`	`retrieveTx(String hash)`	fetches the API to return any tx by its hash.
`SendTxResult`	`sendTx(Tx tx)`	accepts an encoded tx and sends it to the Api to return its status and its hash.
`Tx`	`signTx(TxSigner txSigner, String chainId, Instant nonceTime, TxData txData)`	signs a tx data and returns a new tx ready to be sent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Handler

public Handler(String apiUrl,
               Serializer serializer)

Handler constructor.

Parameters:: apiUrl -; serializer -

Method Detail

retrieveLastCertificateTx

public TxResult retrieveLastCertificateTx(String fqId)
                                   throws IOException,
                                          ApiException

fetches the API to return the last tx related to a certificate fqid.

Parameters:: fqId -
Returns:
Throws:: IOException; ApiException

retrieveCertificateTxs

public TxResults retrieveCertificateTxs(String fqId,
                                        int page,
                                        int txPerPage)
                                 throws IOException,
                                        ApiException

fetches the API to return all txs related to a certificate fqid.

Parameters:: fqId -; page -; txPerPage -
Returns:
Throws:: IOException; ApiException

retrieveLastSecretTx

public TxResult retrieveLastSecretTx(String fqId)
                              throws IOException,
                                     ApiException

fetches the API to return the last tx related to a secret fqid.

Parameters:: fqId -
Returns:
Throws:: IOException; ApiException

retrieveSecretTxs

public TxResults retrieveSecretTxs(String fqId,
                                   int page,
                                   int txPerPage)
                            throws IOException,
                                   ApiException

fetches the API to return all txs related to a secret fqid.

Parameters:: txPerPage -; page -; fqId -
Returns:
Throws:: IOException; ApiException

retrieveLastKeyTx

public TxResult retrieveLastKeyTx(String fqId)
                           throws IOException,
                                  ApiException

fetches the API to return the last tx related to a key fqid.

Parameters:: fqId -
Returns:
Throws:: IOException; ApiException

retrieveKeyTxs

public TxResults retrieveKeyTxs(String fqId,
                                int page,
                                int txPerPage)
                         throws IOException,
                                ApiException

fetches the API to return all txs related to a key fqid.

Parameters:: txPerPage -; page -; fqId -
Returns:
Throws:: IOException; ApiException

retrieveTx

public TxResult retrieveTx(String hash)
                    throws IOException,
                           ApiException

fetches the API to return any tx by its hash.

Parameters:: hash -
Returns:
Throws:: IOException; ApiException

retrieveCertificate

public TxData retrieveCertificate(String fqId)
                           throws IOException,
                                  ApiException

fetches the API and returns a certificate from the state.

Parameters:: fqId -
Returns:
Throws:: IOException; ApiException

retrieveSecret

public TxData retrieveSecret(String fqId)
                      throws IOException,
                             ApiException

fetches the API and returns a secret from the state.

Parameters:: fqId -
Returns:
Throws:: IOException; ApiException

retrieveKey

public KeyV1 retrieveKey(String fqId)
                  throws IOException,
                         ApiException

fetches the API and returns a key from the state.

Parameters:: fqId -
Returns:
Throws:: IOException; ApiException

retrieveCompanyKeys

public KeyV1[] retrieveCompanyKeys(String companyBcId,
                                   int page,
                                   int txPerPage)
                            throws IOException,
                                   ApiException

fetches the API and returns a list of keys for a company from the state.

Parameters:: txPerPage -; page -; companyBcId -
Returns:
Throws:: IOException; ApiException

sendTx

public SendTxResult sendTx(Tx tx)
                    throws IOException,
                           ApiException

accepts an encoded tx and sends it to the Api to return its status and its hash.

Parameters:: tx -
Returns:
Throws:: IOException; ApiException

signTx

public Tx signTx(TxSigner txSigner,
                 String chainId,
                 Instant nonceTime,
                 TxData txData)
          throws NoSuchAlgorithmException,
                 InvalidKeyException,
                 SignatureException

signs a tx data and returns a new tx ready to be sent.

Parameters:: chainId -; nonceTime -; txSigner -; txData -
Returns:
Throws:: NoSuchAlgorithmException; InvalidKeyException; SignatureException

getTxDataState

public byte[] getTxDataState(String chainId,
                             Instant nonceTime,
                             TxData txData)

returns the sorted and marshaled json representation of a TxData ready to be signed.

Parameters:: txData -; nonceTime -; chainId -
Returns:

Class Handler

Constructor Summary