com.nimbusds.jose

Class JOSEObject

java.lang.Object

com.nimbusds.jose.JOSEObject

Direct Known Subclasses:

JWEObject, JWSObject, PlainObject

public abstract class JOSEObject
extends java.lang.Object

The base abstract class for plaintext, JSON Web Signature (JWS) and JSON Web Encryption (JWE) objects.

Version:

$version$ (2014-07-08)

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MIME_TYPE_COMPACT The MIME type of JOSE objects serialised to a compact form: application/jose; charset=UTF-8
static java.lang.String	MIME_TYPE_JS The MIME type of JOSE objects serialised to a JSON object form: application/jose+json; charset=UTF-8

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JOSEObject() Creates a new JOSE object.
protected	JOSEObject(Payload payload) Creates a new JOSE object with the specified payload.

Method Summary

Methods

Modifier and Type	Method and Description
abstract Header	getHeader() Returns the header of this JOSE object.
Base64URL[]	getParsedParts() Returns the original parsed Base64URL parts used to create this JOSE object.
java.lang.String	getParsedString() Returns the original parsed string used to create this JOSE object.
Payload	getPayload() Returns the payload of this JOSE object.
static JOSEObject	parse(java.lang.String s) Parses a JOSE object from the specified string in compact format.
abstract java.lang.String	serialize() Serialises this JOSE object to its compact format consisting of Base64URL-encoded parts delimited by period ('.') characters.
protected void	setParsedParts(Base64URL... parts) Sets the original parsed Base64URL parts used to create this JOSE object.
protected void	setPayload(Payload payload) Sets the payload of this JOSE object.
static Base64URL[]	split(java.lang.String s) Splits a serialised JOSE object into its Base64URL-encoded parts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIME_TYPE_COMPACT

public static final java.lang.String MIME_TYPE_COMPACT

The MIME type of JOSE objects serialised to a compact form: application/jose; charset=UTF-8

See Also:

Constant Field Values

MIME_TYPE_JS

public static final java.lang.String MIME_TYPE_JS

The MIME type of JOSE objects serialised to a JSON object form: application/jose+json; charset=UTF-8

See Also:

Constant Field Values

Constructor Detail

JOSEObject

protected JOSEObject()

Creates a new JOSE object. The payload and the original parsed Base64URL parts are not defined.

JOSEObject

protected JOSEObject(Payload payload)

Creates a new JOSE object with the specified payload.

Parameters:

payload - The payload, null if not available (e.g for an encrypted JWE object).

Method Detail

getHeader

public abstract Header getHeader()

Returns the header of this JOSE object.

Returns:

The header.

setPayload

protected void setPayload(Payload payload)

Sets the payload of this JOSE object.

Parameters:

payload - The payload, null if not available (e.g. for an encrypted JWE object).

getPayload

public Payload getPayload()

Returns the payload of this JOSE object.

Returns:

The payload, null if not available (for an encrypted JWE object that hasn't been decrypted).

setParsedParts

protected void setParsedParts(Base64URL... parts)

Sets the original parsed Base64URL parts used to create this JOSE object.

Parameters:

parts - The original Base64URL parts used to creates this JOSE object, null if the object was created from scratch. The individual parts may be empty or null to indicate a missing part.

getParsedParts

public Base64URL[] getParsedParts()

Returns the original parsed Base64URL parts used to create this JOSE object.

Returns:

The original Base64URL parts used to creates this JOSE object, null if the object was created from scratch. The individual parts may be empty or null to indicate a missing part.

getParsedString

public java.lang.String getParsedString()

Returns the original parsed string used to create this JOSE object.

Returns:

The parsed string used to create this JOSE object, null if the object was creates from scratch.

See Also:

getParsedParts()

serialize

public abstract java.lang.String serialize()

Serialises this JOSE object to its compact format consisting of Base64URL-encoded parts delimited by period ('.') characters.

Returns:

The serialised JOSE object.

Throws:

java.lang.IllegalStateException - If the JOSE object is not in a state that permits serialisation.

split

public static Base64URL[] split(java.lang.String s)
                         throws java.text.ParseException

Splits a serialised JOSE object into its Base64URL-encoded parts.

Parameters:

s - The serialised JOSE object to split. Must not be null.

Returns:

The JOSE Base64URL-encoded parts (three for plaintext and JWS objects, five for JWE objects).

Throws:

java.text.ParseException - If the specified string couldn't be split into three or five Base64URL-encoded parts.

parse

public static JOSEObject parse(java.lang.String s)
                        throws java.text.ParseException

Parses a JOSE object from the specified string in compact format.

Parameters:

s - The string to parse. Must not be null.

Returns:

The corresponding PlainObject, JWSObject or JWEObject instance.

Throws:

java.text.ParseException - If the string couldn't be parsed to a valid plaintext, JWS or JWE object.