org.lightningj.paywall.vo

Class Order

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.tokengenerator.JWTClaim

org.lightningj.paywall.vo.Order

All Implemented Interfaces:

Payment

Direct Known Subclasses:

ConvertedOrder, PreImageOrder

public class Order
extends JWTClaim
implements Payment

Value object containing information needed to create lightning invoice, generated by the PaymentHandler. Created by Philip Vendil on 2018-10-29.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLAIM_NAME
protected java.lang.String	description
protected java.time.Instant	expireDate
protected Amount	orderAmount
protected byte[]	preImageHash

Constructor Summary

Constructors

Constructor and Description
Order() Empty Constructor
Order(byte[] preImageHash, java.lang.String description, Amount orderAmount, java.time.Instant expireDate) Default Constructor.
Order(javax.json.JsonObject jsonObject) JSON Parseable constructor
Order(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	getClaimName()
java.lang.String	getDescription()
java.time.Instant	getExpireDate()
Amount	getOrderAmount()
byte[]	getPreImageHash()
void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
void	setDescription(java.lang.String description)
void	setExpireDate(java.time.Instant expireDate)
void	setOrderAmount(Amount orderAmount)
void	setPreImageHash(byte[] preImageHash)

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

CLAIM_NAME

public static final java.lang.String CLAIM_NAME

See Also:

Constant Field Values

preImageHash

protected byte[] preImageHash

description

protected java.lang.String description

orderAmount

protected Amount orderAmount

expireDate

protected java.time.Instant expireDate

Constructor Detail

Order

public Order()

Empty Constructor

Order

public Order(byte[] preImageHash,
             java.lang.String description,
             Amount orderAmount,
             java.time.Instant expireDate)

Default Constructor.

Parameters:

preImageHash - the generated preImageHash from PreImageData.

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

orderAmount - the amount to create invoice for before eventual currency convertion. (Required)

expireDate - the time when the payment should be considered expired and not accepted. (Required)

Order

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

JSON Parseable constructor

Parameters:

jsonObject - the json object to parse

Throws:

javax.json.JsonException

Order

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

Parse from JWTClaims constructor

Parameters:

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

Method Detail

getPreImageHash

public byte[] getPreImageHash()

Specified by:

getPreImageHash in interface Payment

Returns:

the generated preImageHash from PreImageData.

setPreImageHash

public void setPreImageHash(byte[] preImageHash)

Parameters:

preImageHash - the generated preImageHash from PreImageData.

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).

getOrderAmount

public Amount getOrderAmount()

Returns:

the amount to create invoice for before eventual currency convertion. (Required)

setOrderAmount

public void setOrderAmount(Amount orderAmount)

Parameters:

orderAmount - the amount to create invoice for before eventual currency convertion. (Required)

getExpireDate

public java.time.Instant getExpireDate()

Returns:

the time when the payment should be considered expired and not accepted. (Required)

setExpireDate

public void setExpireDate(java.time.Instant expireDate)

Parameters:

expireDate - the time when the payment should be considered expired and not accepted. (Required)

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.

getClaimName

public java.lang.String getClaimName()

Specified by:

getClaimName in class JWTClaim

Returns:

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