org.lightningj.paywall.vo

Class Invoice

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.tokengenerator.JWTClaim

org.lightningj.paywall.vo.MinimalInvoice

org.lightningj.paywall.vo.Invoice

All Implemented Interfaces:

Payment

public class Invoice
extends MinimalInvoice
implements Payment

Invoice data is generated by LightningHandler and contains information about one Lightning Invoice. Created by Philip Vendil on 2018-11-11.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	bolt11Invoice
static java.lang.String	CLAIM_NAME
protected java.lang.String	description
protected java.time.Instant	expireDate
protected CryptoAmount	invoiceAmount
protected java.time.Instant	invoiceDate
protected NodeInfo	nodeInfo
protected boolean	settled
protected CryptoAmount	settledAmount
protected java.time.Instant	settlementDate
protected java.lang.String	sourceNode

Fields inherited from class org.lightningj.paywall.vo.MinimalInvoice

preImageHash

Constructor Summary

Constructors

Constructor and Description
Invoice() Empty Constructor
Invoice(byte[] preImageHash, java.lang.String bolt11Invoice, java.lang.String description, CryptoAmount invoiceAmount, NodeInfo nodeInfo, java.time.Instant expireDate, java.time.Instant invoiceDate) Default constructor, for unsettled invoice.
Invoice(byte[] preImageHash, java.lang.String bolt11Invoice, java.lang.String description, CryptoAmount invoiceAmount, NodeInfo nodeInfo, java.time.Instant expireDate, java.time.Instant invoiceDate, boolean settled, CryptoAmount settledAmount, java.time.Instant settlementDate) Default constructor, for settled invoice.
Invoice(javax.json.JsonObject jsonObject) JSON Parseable constructor
Invoice(org.jose4j.jwt.JwtClaims jwtClaims) Parse from JWTClaims 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	getBolt11Invoice()
java.lang.String	getClaimName()
java.lang.String	getDescription()
java.time.Instant	getExpireDate()
CryptoAmount	getInvoiceAmount()
java.time.Instant	getInvoiceDate()
NodeInfo	getNodeInfo()
CryptoAmount	getSettledAmount()
java.time.Instant	getSettlementDate()
java.lang.String	getSourceNode()
boolean	isSettled()
void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
void	setBolt11Invoice(java.lang.String bolt11Invoice)
void	setDescription(java.lang.String description)
void	setExpireDate(java.time.Instant expireDate)
void	setInvoiceAmount(CryptoAmount invoiceAmount)
void	setInvoiceDate(java.time.Instant invoiceDate)
void	setNodeInfo(NodeInfo nodeInfo)
void	setSettled(boolean settled)
void	setSettledAmount(CryptoAmount settledAmount)
void	setSettlementDate(java.time.Instant settlementDate)
void	setSourceNode(java.lang.String sourceNode)

Methods inherited from class org.lightningj.paywall.vo.MinimalInvoice

getPreImageHash, setPreImageHash

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

Methods inherited from interface org.lightningj.paywall.paymenthandler.Payment

getPreImageHash

Field Detail

CLAIM_NAME

public static final java.lang.String CLAIM_NAME

See Also:

Constant Field Values

bolt11Invoice

protected java.lang.String bolt11Invoice

description

protected java.lang.String description

invoiceAmount

protected CryptoAmount invoiceAmount

nodeInfo

protected NodeInfo nodeInfo

expireDate

protected java.time.Instant expireDate

invoiceDate

protected java.time.Instant invoiceDate

settled

protected boolean settled

settledAmount

protected CryptoAmount settledAmount

settlementDate

protected java.time.Instant settlementDate

sourceNode

protected java.lang.String sourceNode

Constructor Detail

Invoice

public Invoice()

Empty Constructor

Invoice

public Invoice(byte[] preImageHash,
               java.lang.String bolt11Invoice,
               java.lang.String description,
               CryptoAmount invoiceAmount,
               NodeInfo nodeInfo,
               java.time.Instant expireDate,
               java.time.Instant invoiceDate)

Default constructor, for unsettled invoice.

Parameters:

preImageHash - the generated preImageHash from PreImageData which acts as an unique id for the payment.

bolt11Invoice - the bolt11 invoice to display for the requester.

description - description to display in the invoice. (Optional).

invoiceAmount - the amount in the invoice. (Optional)

nodeInfo - information about the lightning handlers lightning node. (Optional)

expireDate - the time the invoice will expire.

invoiceDate - the time this invoice was created.

Invoice

public Invoice(byte[] preImageHash,
               java.lang.String bolt11Invoice,
               java.lang.String description,
               CryptoAmount invoiceAmount,
               NodeInfo nodeInfo,
               java.time.Instant expireDate,
               java.time.Instant invoiceDate,
               boolean settled,
               CryptoAmount settledAmount,
               java.time.Instant settlementDate)

Default constructor, for settled invoice.

Parameters:

preImageHash - the generated preImageHash from PreImageData which acts as an unique id for the payment.

bolt11Invoice - the bolt11 invoice to display for the requester.

description - description to display in the invoice. (Optional).

invoiceAmount - the amount in the invoice. (Optional)

nodeInfo - information about the lightning handlers lightning node. (Optional)

expireDate - the time the invoice will expire.

invoiceDate - the time this invoice was created.

settled - if the payment was done successfully.

settledAmount - the amount that was settled. (Optional)

settlementDate - the time the payment was settled with the LightningHandler. (Optional)

Invoice

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

JSON Parseable constructor

Parameters:

jsonObject - the json object to parse

Throws:

javax.json.JsonException

Invoice

public Invoice(org.jose4j.jwt.JwtClaims jwtClaims)

Parse from JWTClaims constructor

Parameters:

jwtClaims - the JWT Tokens Claim set to extract data from.

Method Detail

getBolt11Invoice

public java.lang.String getBolt11Invoice()

Returns:

the bolt11 invoice to display for the requester.

setBolt11Invoice

public void setBolt11Invoice(java.lang.String bolt11Invoice)

Parameters:

bolt11Invoice - the bolt11 invoice to display for the requester.

getDescription

public java.lang.String getDescription()

Returns:

description to display in the invoice. (Optional).

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - to display in the invoice. (Optional).

getInvoiceAmount

public CryptoAmount getInvoiceAmount()

Returns:

the amount in the invoice. (Optional)

setInvoiceAmount

public void setInvoiceAmount(CryptoAmount invoiceAmount)

Parameters:

invoiceAmount - the amount in the invoice. (Optional)

getNodeInfo

public NodeInfo getNodeInfo()

Returns:

information about the lightning handlers lightning node. (Optional)

setNodeInfo

public void setNodeInfo(NodeInfo nodeInfo)

Parameters:

nodeInfo - information about the lightning handlers lightning node. (Optional)

getExpireDate

public java.time.Instant getExpireDate()

Returns:

the time the invoice will expire.

setExpireDate

public void setExpireDate(java.time.Instant expireDate)

Parameters:

expireDate - the time the invoice will expire.

getInvoiceDate

public java.time.Instant getInvoiceDate()

Returns:

the time this invoice was created.

setInvoiceDate

public void setInvoiceDate(java.time.Instant invoiceDate)

Parameters:

invoiceDate - the time this invoice was created.

isSettled

public boolean isSettled()

Returns:

if the payment was done successfully.

setSettled

public void setSettled(boolean settled)

Parameters:

settled - if the payment was done successfully.

getSettledAmount

public CryptoAmount getSettledAmount()

Returns:

the amount that was settled. (Optional)

setSettledAmount

public void setSettledAmount(CryptoAmount settledAmount)

Parameters:

settledAmount - the amount that was settled.

getSettlementDate

public java.time.Instant getSettlementDate()

Returns:

the time the payment was settled with the LightningHandler. (Optional)

setSettlementDate

public void setSettlementDate(java.time.Instant settlementDate)

Parameters:

settlementDate - the time the payment was settled with the LightningHandler.

getSourceNode

public java.lang.String getSourceNode()

Returns:

the source node of the node creating the order, used in a distributed environment where the paywalled service and lightning handler is in different systems.

setSourceNode

public void setSourceNode(java.lang.String sourceNode)

Parameters:

sourceNode - the source node of the node creating the order, used in a distributed environment where the paywalled service and lightning handler is in different systems.

convertToJson

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

Method that should set the objects property to Json representation.

Overrides:

convertToJson in class MinimalInvoice

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.

Overrides:

parseJson in class MinimalInvoice

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.

getClaimName

public java.lang.String getClaimName()

Overrides:

getClaimName in class MinimalInvoice

Returns:

the claim name to set for implementing data in generated JWT token