com.nimbusds.jose

Interface ReadOnlyJWEHeader

All Superinterfaces:

ReadOnlyCommonSEHeader, ReadOnlyHeader

All Known Implementing Classes:

JWEHeader

public interface ReadOnlyJWEHeader
extends ReadOnlyCommonSEHeader

Read-only view of a JWE header.

Version:

$version$ (2012-10-16)

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.
Base64URL	getEncryptionPartyUInfo() Gets the encryption PartyUInfo (epu) parameter.
Base64URL	getEncryptionPartyVInfo() Gets the encryption PartyVInfo (epv) parameter.
ECKey	getEphemeralPublicKey() Gets the Ephemeral Public Key (epk) parameter.

Methods inherited from interface com.nimbusds.jose.ReadOnlyCommonSEHeader

getJWK, getJWKURL, getKeyID, getX509CertChain, getX509CertThumbprint, getX509CertURL

Methods inherited from interface com.nimbusds.jose.ReadOnlyHeader

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

Method Detail

getAlgorithm

JWEAlgorithm getAlgorithm()

Gets the algorithm (alg) parameter.

Specified by:

getAlgorithm in interface ReadOnlyHeader

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.

getEncryptionPartyUInfo

Base64URL getEncryptionPartyUInfo()

Gets the encryption PartyUInfo (epu) parameter.

Returns:

The encryption PartyUInfo parameter, null if not specified.

getEncryptionPartyVInfo

Base64URL getEncryptionPartyVInfo()

Gets the encryption PartyVInfo (epv) parameter.

Returns:

The encryption PartyVInfo parameter, null if not specified.