com.nimbusds.jose

Interface ReadOnlyJWEHeader

All Known Implementing Classes:

JWEHeader

public interface ReadOnlyJWEHeader

Read-only view of a JWE header.

Version:

$version$ (2013-08-20)

Author:

Vladimir Dzhuvinov

Method Summary

Methods

Modifier and Type	Method and Description
Base64URL	getAgreementPartyUInfo() Gets the agreement PartyUInfo (apu) parameter.
Base64URL	getAgreementPartyVInfo() Gets the agreement PartyVInfo (apv) parameter.
JWEAlgorithm	getAlgorithm() Gets the algorithm (alg) parameter.
CompressionAlgorithm	getCompressionAlgorithm() Gets the compression algorithm (zip) parameter.
EncryptionMethod	getEncryptionMethod() Gets the encryption method (enc) parameter.
ECKey	getEphemeralPublicKey() Gets the Ephemeral Public Key (epk) parameter.
JWK	getJWK() Gets the JSON Web Key (JWK) (jwk) parameter.
URL	getJWKURL() Gets the JSON Web Key (JWK) Set URL (jku) parameter.
String	getKeyID() Gets the key ID (kid) parameter.
int	getPBES2Count() Gets the PBES2 count (p2c) parameter.
Base64URL	getPBES2Salt() Gets the PBES2 salt (p2s) parameter.
List<Base64>	getX509CertChain() Gets the X.509 certificate chain (x5c) parameter corresponding to the key used to sign or encrypt the JWS / JWE object.
Base64URL	getX509CertThumbprint() Gets the X.509 certificate thumbprint (x5t) parameter.
URL	getX509CertURL() Gets the X.509 certificate URL (x5u) parameter.

Methods inherited from interface com.nimbusds.jose.ReadOnlyHeader

getContentType, getCriticalHeaders, getCustomParameter, getCustomParameters, getIncludedParameters, getType, toBase64URL, toJSONObject, toString

Method Detail

getAlgorithm

JWEAlgorithm getAlgorithm()

Gets the algorithm (alg) parameter.

Returns:

The algorithm parameter.

getEncryptionMethod

EncryptionMethod getEncryptionMethod()

Gets the encryption method (enc) parameter.

Returns:

The encryption method parameter.

getEphemeralPublicKey

ECKey getEphemeralPublicKey()

Gets the Ephemeral Public Key (epk) parameter.

Returns:

The Ephemeral Public Key parameter, null if not specified.

getCompressionAlgorithm

CompressionAlgorithm getCompressionAlgorithm()

Gets the compression algorithm (zip) parameter.

Returns:

The compression algorithm parameter, null if not specified.

getAgreementPartyUInfo

Base64URL getAgreementPartyUInfo()

Gets the agreement PartyUInfo (apu) parameter.

Returns:

The agreement PartyUInfo parameter, null if not specified.

getAgreementPartyVInfo

Base64URL getAgreementPartyVInfo()

Gets the agreement PartyVInfo (apv) parameter.

Returns:

The agreement PartyVInfo parameter, null if not specified.

getPBES2Salt

Base64URL getPBES2Salt()

Gets the PBES2 salt (p2s) parameter.

Returns:

The PBES2 salt parameter, null if not specified.

getPBES2Count

int getPBES2Count()

Gets the PBES2 count (p2c) parameter.

Returns:

The PBES2 count parameter, zero if not specified.

getJWKURL

URL getJWKURL()

Gets the JSON Web Key (JWK) Set URL (jku) parameter.

Returns:

The JSON Web Key (JWK) Set URL parameter, null if not specified.

getJWK

JWK getJWK()

Gets the JSON Web Key (JWK) (jwk) parameter.

Returns:

The JSON Web Key (JWK) parameter, null if not specified.

getX509CertURL

URL getX509CertURL()

Gets the X.509 certificate URL (x5u) parameter.

Returns:

The X.509 certificate URL parameter, null if not specified.

getX509CertThumbprint

Base64URL getX509CertThumbprint()

Gets the X.509 certificate thumbprint (x5t) parameter.

Returns:

The X.509 certificate thumbprint parameter, null if not specified.

getX509CertChain

List<Base64> getX509CertChain()

Gets the X.509 certificate chain (x5c) parameter corresponding to the key used to sign or encrypt the JWS / JWE object.

Returns:

The X.509 certificate chain parameter as a unmodifiable list, null if not specified.

getKeyID

String getKeyID()

Gets the key ID (kid) parameter.

Returns:

The key ID parameter, null if not specified.