org.lightningj.paywall.vo

Class OrderRequest

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.tokengenerator.JWTClaim

org.lightningj.paywall.vo.OrderRequest

public class OrderRequest
extends JWTClaim

OrderRequest contains values generated from related PaymentRequired annotation and is used as a basis for creating a payment flow in PaymentHandler. Created by Philip Vendil on 2018-12-07.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
OrderRequest() Empty Constructor
OrderRequest(javax.json.JsonObject jsonObject) JSON Parseable constructor
OrderRequest(org.jose4j.jwt.JwtClaims jwtClaims) Parse from JWTClaims constructor
OrderRequest(java.lang.String articleId, int calculatedUnits, java.util.List<PaymentOption> paymentOptions, boolean payPerRequest) 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	getArticleId()
java.lang.String	getClaimName()
java.util.List<PaymentOption>	getPaymentOptions()
int	getUnits()
boolean	isPayPerRequest()
void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
void	setArticleId(java.lang.String articleId)
void	setPaymentOptions(java.util.List<PaymentOption> paymentOptions)
void	setPayPerRequest(boolean payPerRequest)
void	setUnits(int units)

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

Constructor Detail

OrderRequest

public OrderRequest()

Empty Constructor

OrderRequest

public OrderRequest(java.lang.String articleId,
                    int calculatedUnits,
                    java.util.List<PaymentOption> paymentOptions,
                    boolean payPerRequest)

Default constructor.

Parameters:

articleId - the article id derived from PaymentRequired notation and OrderRequestGenerator.

calculatedUnits - the calculated units for paymentRequiredAnnotation unit calculator.

paymentOptions - optional payment options which can be custom values defined between PaymentRequired annotation and used PaymentHandler.

payPerRequest - true if payment only should be valid for one payment, set by annotation, but PaymentHandler might override this setting. Important: If used must PaymentData implementation implement PerRequestPaymentData.

OrderRequest

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

JSON Parseable constructor

Parameters:

jsonObject - the json object to parse

Throws:

javax.json.JsonException

OrderRequest

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

Parse from JWTClaims constructor

Parameters:

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

Method Detail

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

getArticleId

public java.lang.String getArticleId()

Returns:

the article id derived from PaymentRequired notation and OrderRequestGenerator.

setArticleId

public void setArticleId(java.lang.String articleId)

Parameters:

articleId - the article id derived from PaymentRequired notation and OrderRequestGenerator.

getUnits

public int getUnits()

Returns:

the number of units ordered.

setUnits

public void setUnits(int units)

Parameters:

units - the number of units ordered.

getPaymentOptions

public java.util.List<PaymentOption> getPaymentOptions()

Returns:

optional payment options which can be custom values defined between PaymentRequired annotation and used PaymentHandler.

setPaymentOptions

public void setPaymentOptions(java.util.List<PaymentOption> paymentOptions)

Parameters:

paymentOptions - optional payment options which can be custom values defined between PaymentRequired annotation and used PaymentHandler.

isPayPerRequest

public boolean isPayPerRequest()

Returns:

true if payment only should be valid for one payment, set by annotation, but PaymentHandler might override this setting. Important: If used must PaymentData implementation implement PerRequestPaymentData.

setPayPerRequest

public void setPayPerRequest(boolean payPerRequest)

Parameters:

payPerRequest - true if payment only should be valid for one payment, set by annotation, but PaymentHandler might override this setting. Important: If used must PaymentData implementation implement PerRequestPaymentData.

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.