JWE (PicketLink Parent 2.7.1.Final API)

java.lang.Object
- org.picketlink.json.jose.JWE

```
public class JWE
extends Object
```
JSON Web Encryption (JWE) header.
Supports all Principal Registered Parameter Names of the JWE specification:
- alg
- typ
- cty
- enc
- zip
- keys
- jku
- x5u
- x5c
- x5t
- x5t#S256
Example header:
```
 {
   "alg":"RSA1_5",
   "kid":"2011-04-29",
   "enc":"A128CBC-HS256",
   "jku":"https://server.example.com/keys.jwks"
 }
 
```
Author:

Giriraj Sharma

Constructor Summary

Constructors
Modifier Constructor and Description

protected JWE(javax.json.JsonObject headers)
Instantiates a new JWE.

Constructors
Modifier	Constructor and Description
`protected`	`JWE(javax.json.JsonObject headers)` Instantiates a new JWE.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`encode()` Encodes the JSON representation of headers of a JWE according to the specification.
`String`	`getAlgorithm()` Gets the algorithm used to encrypt or determine the value of the Content Encryption Key (CEK).
`String`	`getCEKBitLength()` Gets the Content Encryption Key bit length.
`String`	`getCompressionAlgorithm()` Gets the compression algorithm.
`String`	`getContentType()` Gets the content type of JOSE Header.
`List<String>`	`getCriticalHeader()` Gets the critical header.
`String`	`getEncryptionAlgorithm()` Gets the encryption algorithm used to encrypt the Plaintext to produce the Ciphertext.
`String`	`getHeader(String name)` Gets the string representation of headers.
`javax.json.JsonObject`	`getHeaders()` Gets the `JsonObject` headers.
`List<String>`	`getHeaderValues(String name)` Gets the header values for the specified name.
`javax.json.JsonObject`	`getJsonObject()` Gets the `JsonObject`.
`String`	`getJWK()` Gets the JWK.
`String`	`getJWKSet()` Gets the JWK Set.
`String`	`getKeyIdentifier()` Gets the key identifier used to determine the private key needed to decrypt the JWE.
`String`	`getType()` Gets the type of JOSE Header.
`List<String>`	`getX509CertificateChain()` Gets the x509 certificate chain.
`String`	`getX509SHA1CertificateThumbprint()` Gets the x509 SHA1 certificate thumbprint.
`String`	`getX509SHA256CertificateThumbprint()` Gets the x509 SHA256 certificate thumbprint.
`String`	`getX509Url()` Gets the x509 URL.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JWE
```
protected JWE(javax.json.JsonObject headers)
```
    Instantiates a new JWE.
    
    Parameters:
    
    headers - the headers
- Method Detail
  - encode
```
public String encode()
```
    Encodes the JSON representation of headers of a JWE according to the specification.
    
    In order to decode, refer to the corresponding JWEBuilder of this class.
    
    Returns:
    
    the string
  - getType
```
public String getType()
```
    Gets the type of JOSE Header.
    
    Returns:
    
    the string
  - getContentType
```
public String getContentType()
```
    Gets the content type of JOSE Header.
    
    Returns:
    
    the content type
  - getAlgorithm
```
public String getAlgorithm()
```
    Gets the algorithm used to encrypt or determine the value of the Content Encryption Key (CEK).
    - #RSA1_5
    - RSA-OAEP
    - RSA-OAEP-256
    Returns:
    
    the algorithm
  - getEncryptionAlgorithm
```
public String getEncryptionAlgorithm()
```
    Gets the encryption algorithm used to encrypt the Plaintext to produce the Ciphertext.
    - A128CBC-HS256
    - A192CBC-HS384
    - A256CBC-HS512
    - #A128GCM
    - #A192GCM
    - #A256GCM
    Returns:
    
    the encryption algorithm
  - getCEKBitLength
```
public String getCEKBitLength()
```
    Gets the Content Encryption Key bit length.
    
    Returns:
    
    the Content Encryption Key bit length
  - getKeyIdentifier
```
public String getKeyIdentifier()
```
    Gets the key identifier used to determine the private key needed to decrypt the JWE.
    
    Returns:
    
    the key identifier
  - getCompressionAlgorithm
```
public String getCompressionAlgorithm()
```
    Gets the compression algorithm. The zip (compression algorithm) applied to the Plaintext before encryption, if any. The zip value defined by this specification is:
    Returns:
    
    the compression algorithm
  - getJWKSet
```
public String getJWKSet()
```
    Gets the JWK Set.
    The JWK Set resource contains the public key to which the JWE was encrypted; this can be used to determine the private key needed to decrypt the JWE.
    
    Returns:
    
    the JWK Set
  - getJWK
```
public String getJWK()
```
    Gets the JWK.
    JWK key is the public key to which the JWE was encrypted; this can be used to determine the private key needed to decrypt the JWE.
    
    Returns:
    
    the JWK
  - getX509Url
```
public String getX509Url()
```
    Gets the x509 URL.
    X.509 public key certificate or certificate chain [RFC5280] contains the public key to which the JWE was encrypted; this can be used to determine the private key needed to decrypt the JWE.
    
    Returns:
    
    the x509 URL
  - getX509CertificateChain
```
public List<String> getX509CertificateChain()
```
    Gets the x509 certificate chain.
    The X.509 public key certificate or certificate chain [RFC5280] contains the public key to which the JWE was encrypted; this can be used to determine the private key needed to decrypt the JWE.
    
    Returns:
    
    the x509 certificate chain
  - getX509SHA1CertificateThumbprint
```
public String getX509SHA1CertificateThumbprint()
```
    Gets the x509 SHA1 certificate thumbprint.
    The certificate referenced by the thumbprint contains the public key to which the JWE was encrypted; this can be used to determine the private key needed to decrypt the JWE.
    
    Returns:
    
    the x509 SHA1 certificate thumbprint
  - getX509SHA256CertificateThumbprint
```
public String getX509SHA256CertificateThumbprint()
```
    Gets the x509 SHA256 certificate thumbprint.
    The certificate referenced by the thumbprint contains the public key to which the JWE was encrypted; this can be used to determine the private key needed to decrypt the JWE.
    
    Returns:
    
    the x509 SHA256 certificate thumbprint
  - getCriticalHeader
```
public List<String> getCriticalHeader()
```
    Gets the critical header.
    The "crit" (critical) Header Parameter indicates that extensions to the initial RFC versions of [[ this specification ]] and [JWA] are being used that MUST be understood and processed. Its value is an array listing the Header Parameter names present in the JOSE Header that use those extensions.
    
    Returns:
    
    the critical header
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - getHeaders
```
public javax.json.JsonObject getHeaders()
```
    Gets the JsonObject headers.
    
    Returns:
    
    the headers
  - getHeader
```
public String getHeader(String name)
```
    Gets the string representation of headers.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the header
  - getHeaderValues
```
public List<String> getHeaderValues(String name)
```
    Gets the header values for the specified name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the header values
  - getJsonObject
```
public javax.json.JsonObject getJsonObject()
```
    Gets the JsonObject.
    
    Returns:
    
    the JSON object

Class JWE

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JWE

Method Detail

encode

getType

getContentType

getAlgorithm

getEncryptionAlgorithm

getCEKBitLength

getKeyIdentifier

getCompressionAlgorithm

getJWKSet

getJWK

getX509Url

getX509CertificateChain

getX509SHA1CertificateThumbprint

getX509SHA256CertificateThumbprint

getCriticalHeader

toString

getHeaders

getHeader

getHeaderValues

getJsonObject