@Immutable public final class Payload extends Object implements Serializable
UTF-8 is the character set for all conversions between strings and byte arrays.
Conversion relations:
JSONObject <=> String <=> Base64URL <=> byte[] <=> JWSObject <=> SignedJWT
Modifier and Type | Class and Description |
---|---|
static class |
Payload.Origin
Enumeration of the original data types used to create a
Payload . |
Constructor and Description |
---|
Payload(Base64URL base64URL)
Creates a new payload from the specified Base64URL-encoded object.
|
Payload(byte[] bytes)
Creates a new payload from the specified byte array.
|
Payload(net.minidev.json.JSONObject jsonObject)
Creates a new payload from the specified JSON object.
|
Payload(JWSObject jwsObject)
Creates a new payload from the specified JWS object.
|
Payload(SignedJWT signedJWT)
Creates a new payload from the specified signed JSON Web Token
(JWT).
|
Payload(String string)
Creates a new payload from the specified string.
|
Modifier and Type | Method and Description |
---|---|
Payload.Origin |
getOrigin()
Gets the original data type used to create this payload.
|
Base64URL |
toBase64URL()
Returns a Base64URL representation of this payload.
|
byte[] |
toBytes()
Returns a byte array representation of this payload.
|
net.minidev.json.JSONObject |
toJSONObject()
Returns a JSON object representation of this payload.
|
JWSObject |
toJWSObject()
Returns a JWS object representation of this payload.
|
SignedJWT |
toSignedJWT()
Returns a signed JSON Web Token (JWT) representation of this
payload.
|
String |
toString()
Returns a string representation of this payload.
|
<T> T |
toType(PayloadTransformer<T> transformer)
Returns a transformation of this payload.
|
public Payload(net.minidev.json.JSONObject jsonObject)
jsonObject
- The JSON object representing the payload. Must not
be null
.public Payload(String string)
string
- The string representing the payload. Must not be
null
.public Payload(byte[] bytes)
bytes
- The byte array representing the payload. Must not be
null
.public Payload(Base64URL base64URL)
base64URL
- The Base64URL-encoded object representing the
payload. Must not be null
.public Payload(JWSObject jwsObject)
jwsObject
- The JWS object representing the payload. Must be in
a signed state and not null
.public Payload.Origin getOrigin()
public net.minidev.json.JSONObject toJSONObject()
null
if the payload
couldn't be converted to a JSON object.public byte[] toBytes()
public Base64URL toBase64URL()
public JWSObject toJWSObject()
null
if the payload
couldn't be converted to a JWS object.public SignedJWT toSignedJWT()
null
if the payload
couldn't be converted to a signed JWT.public <T> T toType(PayloadTransformer<T> transformer)
T
- Type of the result.transformer
- The payload transformer. Must not be
null
.Copyright © 2017 Connect2id Ltd.. All rights reserved.