@ThreadSafe public class JWSObjectJSON extends JOSEObjectJSON
This class is thread-safe.
Modifier and Type | Class and Description |
---|---|
static class |
JWSObjectJSON.Signature
Individual signature in a JWS secured object serialisable to JSON.
|
static class |
JWSObjectJSON.State
Enumeration of the states of a JSON Web Signature (JWS) secured
object serialisable to JSON.
|
MIME_TYPE_JOSE_JSON
Constructor and Description |
---|
JWSObjectJSON(Payload payload)
Creates a new to-be-signed JSON Web Signature (JWS) secured object
with the specified payload.
|
Modifier and Type | Method and Description |
---|---|
List<JWSObjectJSON.Signature> |
getSignatures()
Returns the individual signatures.
|
JWSObjectJSON.State |
getState()
Returns the current signatures state.
|
static JWSObjectJSON |
parse(Map<String,Object> jsonObject)
Parses a JWS secured object from the specified JSON object
representation.
|
static JWSObjectJSON |
parse(String json)
Parses a JWS secured object from the specified JSON object string.
|
String |
serializeFlattened()
Serialises this JOSE object to a flattened JSON object string.
|
String |
serializeGeneral()
Serialises this JOSE object to a general JOSE object string.
|
void |
sign(JWSHeader jwsHeader,
JWSSigner signer)
Signs this JWS secured object with the specified JWS signer and
adds the resulting signature to it.
|
void |
sign(JWSHeader jwsHeader,
UnprotectedHeader unprotectedHeader,
JWSSigner signer)
Signs this JWS secured object with the specified JWS signer and
adds the resulting signature to it.
|
Map<String,Object> |
toFlattenedJSONObject()
Returns a flattened JSON object representation of this JOSE secured
object.
|
Map<String,Object> |
toGeneralJSONObject()
Returns a general JSON object representation of this JOSE secured
object.
|
getPayload, setPayload
public JWSObjectJSON(Payload payload)
payload
- The payload. Must not be null
.public List<JWSObjectJSON.Signature> getSignatures()
public void sign(JWSHeader jwsHeader, JWSSigner signer) throws JOSEException
signatures
call this method successively.jwsHeader
- The JWS protected header. The algorithm specified
by the header must be supported by the JWS signer.
Must not be null
.signer
- The JWS signer. Must not be null
.JOSEException
- If the JWS object couldn't be signed.public void sign(JWSHeader jwsHeader, UnprotectedHeader unprotectedHeader, JWSSigner signer) throws JOSEException
signatures
call this method successively.jwsHeader
- The JWS protected header. The
algorithm specified by the header must
be supported by the JWS signer. Must
not be null
.unprotectedHeader
- The unprotected header to include,
null
if none.signer
- The JWS signer. Must not be
null
.JOSEException
- If the JWS object couldn't be signed.public JWSObjectJSON.State getState()
public Map<String,Object> toGeneralJSONObject()
JOSEObjectJSON
public Map<String,Object> toFlattenedJSONObject()
JOSEObjectJSON
See JWS flattened serialisation or JWE flattened serialisation.
public String serializeGeneral()
JOSEObjectJSON
serializeGeneral
in class JOSEObjectJSON
public String serializeFlattened()
JOSEObjectJSON
See JWS flattened serialisation or JWE flattened serialisation.
serializeFlattened
in class JOSEObjectJSON
public static JWSObjectJSON parse(Map<String,Object> jsonObject) throws ParseException
jsonObject
- The JSON object to parse. Must not be
null
.ParseException
- If the JSON object couldn't be parsed to a
JWS secured object.public static JWSObjectJSON parse(String json) throws ParseException
json
- The JSON object string to parse. Must not be
null
.ParseException
- If the string couldn't be parsed to a JWS
secured object.Copyright © 2021 Connect2id Ltd.. All rights reserved.