Package com.blockchyp.client.dto
Class HeartbeatResponse
java.lang.Object
com.blockchyp.client.dto.HeartbeatResponse
- All Implemented Interfaces:
IAbstractAcknowledgement
The response to a basic API health check. If the security context permits it, the
response may also include the public key of the current merchant.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the public key of the clockchain.getError()Gets the error, if an error occurred.Gets the hash of the last tick block.Gets the public key for the merchant's blockchain.Gets a narrative description of the transaction result.Gets the timestamp of the heartbeat.booleanGets whether or not the request succeeded.voidsetClockchain(String value) Sets the public key of the clockchain.voidSets the error, if an error occurred.voidsetLatestTick(String value) Sets the hash of the last tick block.voidsetMerchantPublicKey(String value) Sets the public key for the merchant's blockchain.voidsetResponseDescription(String value) Sets a narrative description of the transaction result.voidsetSuccess(boolean value) Sets whether or not the request succeeded.voidsetTimestamp(Date value) Sets the timestamp of the heartbeat.
-
Constructor Details
-
HeartbeatResponse
public HeartbeatResponse()
-
-
Method Details
-
setSuccess
public void setSuccess(boolean value) Sets whether or not the request succeeded.- Parameters:
value- whether or not the request succeeded.
-
isSuccess
public boolean isSuccess()Gets whether or not the request succeeded.- Specified by:
isSuccessin interfaceIAbstractAcknowledgement- Returns:
- whether or not the request succeeded.
-
setError
Sets the error, if an error occurred.- Parameters:
value- the error, if an error occurred.
-
getError
Gets the error, if an error occurred.- Specified by:
getErrorin interfaceIAbstractAcknowledgement- Returns:
- the error, if an error occurred.
-
setResponseDescription
Sets a narrative description of the transaction result.- Parameters:
value- a narrative description of the transaction result.
-
getResponseDescription
Gets a narrative description of the transaction result.- Specified by:
getResponseDescriptionin interfaceIAbstractAcknowledgement- Returns:
- a narrative description of the transaction result.
-
setTimestamp
Sets the timestamp of the heartbeat.- Parameters:
value- the timestamp of the heartbeat.
-
getTimestamp
Gets the timestamp of the heartbeat.- Returns:
- the timestamp of the heartbeat.
-
setClockchain
Sets the public key of the clockchain.- Parameters:
value- the public key of the clockchain. This is blockchain stuff that you don't really need to worry about. It is a base 58 encoded and compressed eliptic curve public key. For the production clockchain, this will always be: '3cuhsckVUd9HzMjbdUSW17aY5kCcm1d6YAphJMUwmtXRj7WLyU'.
-
getClockchain
Gets the public key of the clockchain.- Returns:
- the public key of the clockchain. This is blockchain stuff that you don't really need to worry about. It is a base 58 encoded and compressed eliptic curve public key. For the production clockchain, this will always be: '3cuhsckVUd9HzMjbdUSW17aY5kCcm1d6YAphJMUwmtXRj7WLyU'.
-
setLatestTick
Sets the hash of the last tick block.- Parameters:
value- the hash of the last tick block.
-
getLatestTick
Gets the hash of the last tick block.- Returns:
- the hash of the last tick block.
-
setMerchantPublicKey
Sets the public key for the merchant's blockchain.- Parameters:
value- the public key for the merchant's blockchain.
-
getMerchantPublicKey
Gets the public key for the merchant's blockchain.- Returns:
- the public key for the merchant's blockchain.
-