org.lightningj.paywall.vo

Class NodeInfo

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.vo.NodeInfo

public class NodeInfo
extends JSONParsable

Value object containing connection information to a Lightning Handlers Lightning node. Created by Philip Vendil on 2018-11-11.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeInfo.NodeNetwork Enumeration of available Node networks the LND node can be connected to.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	nodeAddress
protected NodeInfo.NodeNetwork	nodeNetwork
protected java.lang.Integer	nodePort
protected java.lang.String	publicKeyInfo

Constructor Summary

Constructors

Constructor and Description
NodeInfo() Empty Constructor
NodeInfo(javax.json.JsonObject jsonObject) JSON Parseable constructor
NodeInfo(java.lang.String connectString) Constructor populating data from connect string
NodeInfo(java.lang.String publicKeyInfo, java.lang.String nodeAddress, java.lang.Integer nodePort) Default Constructor
NodeInfo(java.lang.String publicKeyInfo, java.lang.String nodeAddress, java.lang.Integer nodePort, NodeInfo.NodeNetwork nodeNetwork) Default Constructor

Method Summary

Modifier and Type	Method and Description
void	convertToJson(javax.json.JsonObjectBuilder jsonObjectBuilder) Method that should set the objects property to Json representation.
java.lang.String	getConnectString()
java.lang.String	getNodeAddress()
NodeInfo.NodeNetwork	getNodeNetwork()
java.lang.Integer	getNodePort()
java.lang.String	getPublicKeyInfo()
void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
void	setConnectString(java.lang.String connectString) Setter using connect string.
void	setNodeAddress(java.lang.String nodeAddress)
void	setNodeNetwork(NodeInfo.NodeNetwork nodeNetwork)
void	setNodePort(java.lang.Integer nodePort)
void	setPublicKeyInfo(java.lang.String publicKeyInfo)

Methods inherited from class org.lightningj.paywall.JSONParsable

add, addB58, addNotRequired, addNotRequiredB58, getBoolean, getBooleanIfSet, getByteArrayFromB58, getByteArrayFromB58IfSet, getByteArrayFromB64, getByteArrayFromB64IfSet, getByteArrayFromHex, getByteArrayFromHexIfSet, getDate, getDateIfSet, getDouble, getDoubleIfSet, getInt, getIntIfSet, getJsonArray, getJsonArrayIfSet, getJsonObject, getJsonObjectIfSet, getLong, getLongIfSet, getString, getStringIfSet, toJson, toJsonAsString, toString

Methods inherited from class java.lang.Object

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

Field Detail

publicKeyInfo

protected java.lang.String publicKeyInfo

nodeAddress

protected java.lang.String nodeAddress

nodePort

protected java.lang.Integer nodePort

nodeNetwork

protected NodeInfo.NodeNetwork nodeNetwork

Constructor Detail

NodeInfo

public NodeInfo()

Empty Constructor

NodeInfo

public NodeInfo(java.lang.String publicKeyInfo,
                java.lang.String nodeAddress,
                java.lang.Integer nodePort)

Default Constructor

Parameters:

publicKeyInfo - the public key info of the lightning handlers node. (Optional)

nodeAddress - address information to the lightning handlers node. (Optional)

nodePort - port the node is listening on for channel connections. (Optional)

NodeInfo

public NodeInfo(java.lang.String publicKeyInfo,
                java.lang.String nodeAddress,
                java.lang.Integer nodePort,
                NodeInfo.NodeNetwork nodeNetwork)

Default Constructor

Parameters:

publicKeyInfo - the public key info of the lightning handlers node. (Optional)

nodeAddress - address information to the lightning handlers node. (Optional)

nodePort - port the node is listening on for channel connections. (Optional)

nodeNetwork - indicator which the network the LND node is connected to (UNKNOWN is default). (Optional)

NodeInfo

public NodeInfo(java.lang.String connectString)
         throws InternalErrorException

Constructor populating data from connect string

Parameters:

connectString - the full connect string with publicKeyInfo@nodeaddress:port, where port is optional.

Throws:

InternalErrorException - if given connect string was invalid.

NodeInfo

public NodeInfo(javax.json.JsonObject jsonObject)
         throws javax.json.JsonException

JSON Parseable constructor

Parameters:

jsonObject - the json object to parse

Throws:

javax.json.JsonException

Method Detail

getPublicKeyInfo

public java.lang.String getPublicKeyInfo()

Returns:

the public key info of the lightning handlers node. (Optional)

setPublicKeyInfo

public void setPublicKeyInfo(java.lang.String publicKeyInfo)

Parameters:

publicKeyInfo - the public key info of the lightning handlers node. (Optional)

getNodeAddress

public java.lang.String getNodeAddress()

Returns:

address information to the lightning handlers node. (Optional)

setNodeAddress

public void setNodeAddress(java.lang.String nodeAddress)

Parameters:

nodeAddress - address information to the lightning handlers node. (Optional)

getNodePort

public java.lang.Integer getNodePort()

Returns:

port the node is listening on for channel connections. (Optional)

setNodePort

public void setNodePort(java.lang.Integer nodePort)

Parameters:

nodePort - port the node is listening on for channel connections. (Optional)

getNodeNetwork

public NodeInfo.NodeNetwork getNodeNetwork()

Returns:

indicator which the network the LND node is connected to (UNKNOWN is default).

setNodeNetwork

public void setNodeNetwork(NodeInfo.NodeNetwork nodeNetwork)

Parameters:

nodeNetwork - indicator which the network the LND node is connected to (UNKNOWN is default).

getConnectString

public java.lang.String getConnectString()

Returns:

the full connect string of configured publicKeyInfo@nodeaddress:port, where port is omitted if not set.

setConnectString

public void setConnectString(java.lang.String connectString)
                      throws InternalErrorException

Setter using connect string. This method will parse the string and populate publikKeyInfo, nodeAddress and nodePort.

Parameters:

connectString - the full connect string with publicKeyInfo@nodeaddress:port, where port is optional.

Throws:

InternalErrorException - if given connect string was invalid.

convertToJson

public void convertToJson(javax.json.JsonObjectBuilder jsonObjectBuilder)
                   throws javax.json.JsonException

Method that should set the objects property to Json representation.

Specified by:

convertToJson in class JSONParsable

Parameters:

jsonObjectBuilder - the json object build to use to set key/values in json

Throws:

javax.json.JsonException - if problems occurred converting object to JSON.

parseJson

public void parseJson(javax.json.JsonObject jsonObject)
               throws javax.json.JsonException

Method to read all properties from a JsonObject into this value object.

Specified by:

parseJson in class JSONParsable

Parameters:

jsonObject - the json object to read key and values from and set object properties.

Throws:

javax.json.JsonException - if problems occurred converting object from JSON.