org.lightningj.paywall.spring.response

Class InvoiceResponse

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.spring.response.Response

org.lightningj.paywall.spring.response.InvoiceResponse

public class InvoiceResponse
extends Response

Value object used to return the value of a generated invoice generated by the PaywallInterceptor.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Fields inherited from class org.lightningj.paywall.spring.response.Response

STATUS_OK

Constructor Summary

Constructors

Constructor and Description
InvoiceResponse() Empty constructor.
InvoiceResponse(InvoiceResult invoiceResult, boolean isPayPerRequest, RequestPolicyType requestPolicyType, boolean includeNodeInfo, java.lang.String checkSettlementLink, java.lang.String qrLink, java.lang.String checkSettlementWebSocketEndpoint, java.lang.String baseCheckSettlementWebSocketQueue) Default constructor used by PaywallInterceptor.

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	getCheckSettlementLink()
java.lang.String	getCheckSettlementWebSocketEndpoint()
java.lang.String	getCheckSettlementWebSocketQueue()
java.lang.String	getDescription()
CryptoAmount	getInvoiceAmount()
java.util.Date	getInvoiceDate()
java.util.Date	getInvoiceExpireDate()
NodeInfo	getNodeInfo()
java.lang.Boolean	getPayPerRequest()
java.lang.String	getPreImageHash()
java.lang.String	getQrLink()
java.lang.String	getRequestPolicyType()
java.lang.String	getToken()
java.lang.String	getType()
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	setCheckSettlementLink(java.lang.String checkSettlementLink)
void	setCheckSettlementWebSocketEndpoint(java.lang.String checkSettlementWebSocketEndpoint)
void	setCheckSettlementWebSocketQueue(java.lang.String checkSettlementWebSocketQueue)
void	setDescription(java.lang.String description)
void	setInvoiceAmount(CryptoAmount invoiceAmount)
void	setInvoiceDate(java.util.Date invoiceDate)
void	setInvoiceExpireDate(java.util.Date invoiceExpireDate)
void	setNodeInfo(NodeInfo nodeInfo)
void	setPayPerRequest(java.lang.Boolean payPerRequest)
void	setPreImageHash(java.lang.String preImageHash)
void	setQrLink(java.lang.String qrLink)
void	setRequestPolicyType(java.lang.String requestPolicyType)
void	setToken(java.lang.String token)
void	setType(java.lang.String type)
java.lang.String	toString() Converts data content to pretty printed Json string.

Methods inherited from class org.lightningj.paywall.spring.response.Response

getStatus, setStatus

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

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

InvoiceResponse

public InvoiceResponse()

Empty constructor.

InvoiceResponse

public InvoiceResponse(InvoiceResult invoiceResult,
                       boolean isPayPerRequest,
                       RequestPolicyType requestPolicyType,
                       boolean includeNodeInfo,
                       java.lang.String checkSettlementLink,
                       java.lang.String qrLink,
                       java.lang.String checkSettlementWebSocketEndpoint,
                       java.lang.String baseCheckSettlementWebSocketQueue)
                throws InternalErrorException

Default constructor used by PaywallInterceptor.

Parameters:

invoiceResult - The related invoice result

isPayPerRequest - if invoice is required per request or if settlement with be valid for multiple requests during a period of time.

requestPolicyType - the related request policy type.

includeNodeInfo - if lightning connection information info should be included in the response.

checkSettlementLink - link to check settlement controller.

qrLink - link to generate QR Code controller.

checkSettlementWebSocketEndpoint - the URL to the check settlement web socket end point.

baseCheckSettlementWebSocketQueue - the check settlement web socket queue name without preImageHash. (Should end with a /)

Throws:

InternalErrorException - if internal error occurred creating the object.

Method Detail

getType

public java.lang.String getType()

Returns:

the type 'invoice', used in JSON conversions only.

setType

public void setType(java.lang.String type)

Parameters:

type - the type 'invoice', used in JSON conversions only.

getPreImageHash

public java.lang.String getPreImageHash()

Returns:

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

setPreImageHash

public void setPreImageHash(java.lang.String preImageHash)

Parameters:

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

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 - 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 related lightning node. (Optional)

setNodeInfo

public void setNodeInfo(NodeInfo nodeInfo)

Parameters:

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

getToken

public java.lang.String getToken()

Returns:

the generated JWT invoice token used to track the payment when checking settlement.

setToken

public void setToken(java.lang.String token)

Parameters:

token - the generated JWT invoice token used to track the payment when checking settlement.

getInvoiceDate

public java.util.Date getInvoiceDate()

Returns:

the time this invoice was created.

setInvoiceDate

public void setInvoiceDate(java.util.Date invoiceDate)

Parameters:

invoiceDate - the time this invoice was created.

getInvoiceExpireDate

public java.util.Date getInvoiceExpireDate()

Returns:

the time the invoice will expire.

setInvoiceExpireDate

public void setInvoiceExpireDate(java.util.Date invoiceExpireDate)

Parameters:

invoiceExpireDate - the time the invoice will expire.

getPayPerRequest

public java.lang.Boolean getPayPerRequest()

Returns:

if payment is for this api is for one time only or usage is for a given period of time.

setPayPerRequest

public void setPayPerRequest(java.lang.Boolean payPerRequest)

Parameters:

payPerRequest - if payment is for this api is for one time only or usage is for a given period of time.

getRequestPolicyType

public java.lang.String getRequestPolicyType()

Returns:

specifying type of policy used for aggregating significant request data.

setRequestPolicyType

public void setRequestPolicyType(java.lang.String requestPolicyType)

Parameters:

requestPolicyType - specifying type of policy used for aggregating significant request data.

getCheckSettlementLink

public java.lang.String getCheckSettlementLink()

Returns:

link to settlement controller for checking payment state.

setCheckSettlementLink

public void setCheckSettlementLink(java.lang.String checkSettlementLink)

Parameters:

checkSettlementLink - link to settlement controller for checking payment state.

getQrLink

public java.lang.String getQrLink()

Returns:

link to QR Code generator controller.

setQrLink

public void setQrLink(java.lang.String qrLink)

Parameters:

qrLink - link to QR Code generator controller.

getCheckSettlementWebSocketEndpoint

public java.lang.String getCheckSettlementWebSocketEndpoint()

Returns:

URL to the WebSocket CheckSettlement EndPoint.

setCheckSettlementWebSocketEndpoint

public void setCheckSettlementWebSocketEndpoint(java.lang.String checkSettlementWebSocketEndpoint)

Parameters:

checkSettlementWebSocketEndpoint - URL to the WebSocket CheckSettlement EndPoint.

getCheckSettlementWebSocketQueue

public java.lang.String getCheckSettlementWebSocketQueue()

Returns:

the preImageHash unique web socket queue to subscribe to.

setCheckSettlementWebSocketQueue

public void setCheckSettlementWebSocketQueue(java.lang.String checkSettlementWebSocketQueue)

Parameters:

checkSettlementWebSocketQueue - the preImageHash unique web socket queue to subscribe to.

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 Response

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 Response

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.

toString

public java.lang.String toString()

Description copied from class: JSONParsable

Converts data content to pretty printed Json string.

Overrides:

toString in class JSONParsable

Returns:

string representation of json object.