public class TerminalRouteResponse extends Acknowledgement
Constructor and Description |
---|
TerminalRouteResponse() |
Modifier and Type | Method and Description |
---|---|
String |
getError()
Gets a narrative description of the error, if any.
|
String |
getIpAddress()
Returns the current local IP address of the terminal on its local subnet.
|
String |
getPublicKey()
Gets the public key of the terminal.
|
RawPublicKey |
getRawKey()
Gets the raw public key of the terminal.
|
String |
getTerminalName()
Echoes back the terminal name for the route lookup.
|
Date |
getTimestamp()
Gets the timestamp associated with the route request.
|
APICredentials |
getTransientCredentials()
Gets transient credentials to be used with the terminal route.
|
boolean |
isCloudRelayEnabled()
Returns the cloud relay flag.
|
boolean |
isExists()
Gets the exists flag.
|
boolean |
isSuccess()
Gets the success flag.
|
void |
setCloudRelayEnabled(boolean cloudRelayEnabled)
Sets the cloud relay flag.
|
void |
setError(String error)
Sets a narrative description of the error, if any.
|
void |
setExists(boolean exists)
Sets the exists flag.
|
void |
setIpAddress(String ipAddress)
Sets the local IP address.
|
void |
setPublicKey(String publicKey)
Sets the compressed public key for the terminal.
|
void |
setRawKey(RawPublicKey rawKey)
Sets the raw public key of the terminal.
|
void |
setSuccess(boolean success)
Sets the success flag.
|
void |
setTerminalName(String terminalName)
Sets the terminal name.
|
void |
setTimestamp(Date timestamp)
Sets the timestamp associated with the route request.
|
void |
setTransientCredentials(APICredentials transientCredentials)
Sets transient credentials to be used with the terminal route.
|
getResponseDescription, setResponseDescription
public boolean isSuccess()
isSuccess
in interface IAbstractAcknowledgement
isSuccess
in class Acknowledgement
public void setSuccess(boolean success)
setSuccess
in class Acknowledgement
success
- true if the API call succeeded.public String getError()
getError
in interface IAbstractAcknowledgement
getError
in class Acknowledgement
public void setError(String error)
setError
in class Acknowledgement
error
- narrative description of any error.public String getTerminalName()
public void setTerminalName(String terminalName)
terminalName
- name of the terminal assigned at activation.public String getIpAddress()
public void setIpAddress(String ipAddress)
ipAddress
- standard IPv4 IP address.public String getPublicKey()
public void setPublicKey(String publicKey)
publicKey
- Base58 encoded compressed public key.public RawPublicKey getRawKey()
public void setRawKey(RawPublicKey rawKey)
rawKey
- Elliptic Curve Public Key.public boolean isExists()
public void setExists(boolean exists)
exists
- true if the terminal exists.public boolean isCloudRelayEnabled()
public void setCloudRelayEnabled(boolean cloudRelayEnabled)
cloudRelayEnabled
- true if cloud relay is enabled.public APICredentials getTransientCredentials()
APICredentials
public void setTransientCredentials(APICredentials transientCredentials)
transientCredentials
- APICredentials
public Date getTimestamp()
public void setTimestamp(Date timestamp)
timestamp
- date and time the route request was processed.Copyright © 2022 BlockChyp, Inc.. All rights reserved.