org.lightningj.paywall.vo

Class RequestData

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.tokengenerator.JWTClaim

org.lightningj.paywall.vo.RequestData

public class RequestData
extends JWTClaim

Value object class containing information about a request that might require payment. Contains significant request data, which is a hash of the parts of a request that makes it uniquely identifiable. Created by Philip Vendil on 2018-11-23.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLAIM_NAME
protected java.time.Clock	clock
protected java.time.Instant	requestDate
protected byte[]	significantData

Constructor Summary

Constructors

Constructor and Description
RequestData() Empty Constructor
RequestData(byte[] significantData) Constructor setting request data to current instant.
RequestData(byte[] significantData, java.time.Instant requestDate) Default Constructor
RequestData(javax.json.JsonObject jsonObject) JSON Parseable constructor
RequestData(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.
boolean	equals(java.lang.Object o) Equals checks significantData only.
java.lang.String	getClaimName()
java.time.Instant	getRequestDate()
byte[]	getSignificantData()
int	hashCode()
void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
void	setRequestDate(java.time.Instant requestDate)
void	setSignificantData(byte[] significantData)

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

clock

protected java.time.Clock clock

CLAIM_NAME

public static final java.lang.String CLAIM_NAME

See Also:

Constant Field Values

significantData

protected byte[] significantData

requestDate

protected java.time.Instant requestDate

Constructor Detail

RequestData

public RequestData()

Empty Constructor

RequestData

public RequestData(byte[] significantData,
                   java.time.Instant requestDate)

Default Constructor

Parameters:

significantData - significant request data, which is a hash of the parts of a request that makes it uniquely identifiable.

requestDate - the date the request was generated.

RequestData

public RequestData(byte[] significantData)

Constructor setting request data to current instant.

Parameters:

significantData - significant request data, which is a hash of the parts of a request that makes it uniquely identifiable.

RequestData

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

JSON Parseable constructor

Parameters:

jsonObject - the json object to parse

Throws:

javax.json.JsonException

RequestData

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

Parse from JWTClaims constructor

Parameters:

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

Method Detail

getSignificantData

public byte[] getSignificantData()

Returns:

significant request data, which is a hash of the parts of a request that makes it uniquely

setSignificantData

public void setSignificantData(byte[] significantData)

Parameters:

significantData - significant request data, which is a hash of the parts of a request that makes it uniquely

getRequestDate

public java.time.Instant getRequestDate()

Returns:

the date the request was generated.

setRequestDate

public void setRequestDate(java.time.Instant requestDate)

Parameters:

requestDate - the date the request was generated.

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

equals

public boolean equals(java.lang.Object o)

Equals checks significantData only.

Overrides:

equals in class java.lang.Object

Parameters:

o - other object

Returns:

true if significantData is equal

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

hashcode of significantData only.