JWTBuilder (PicketLink Parent 2.7.1.Final API)

java.lang.Object
- org.picketlink.json.jwt.JWTBuilder<T,B>

Type Parameters:

T - the generic type

B - the generic type

Direct Known Subclasses:

AbstractJWSBuilder
```
public class JWTBuilder<T extends JWT,B extends JWTBuilder<?,?>>
extends Object
```
A JWTBuilder is used to construct JWT instances. It provides a fluent API with methods to populate the claims for a given JWT type.

JWT instances may also be built from a String representing the token in a JSON format.

The default implementation builds JWT instances.

Author:

Giriraj Sharma

Constructor Summary

Constructors
Constructor and Description

JWTBuilder()
Instantiates a new JWT builder.

JWTBuilder(Class<T> tokenType)
Instantiates a new JWT builder with the token value.

Constructors
Constructor and Description
`JWTBuilder()` Instantiates a new JWT builder.
`JWTBuilder(Class<T> tokenType)` Instantiates a new JWT builder with the token value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`B`	`audience(String... audience)` Sets the audience that the JWT is intended for.
`T`	`build()` Builds a `JWT` instance using the provided claims.
`protected T`	`build(javax.json.JsonObject headersObject, javax.json.JsonObject claimsObject)` Builds the `JsonObject` of headers and claims set.
`T`	`build(String json)` Builds a `JWT` instance from its JSON representation.
`B`	`claim(String name, int... value)` Updates the claims set with the specified claim int value(s).
`B`	`claim(String name, String... value)` Updates the claims set with the specified claim string value(s).
`B`	`contentType(String contentType)` Sets the Content type used by this specification to convey structural information about the JWT.
`B`	`expiration(int expirationTime)` Sets the expiration time on or after which the token MUST NOT be accepted for processing.
`protected javax.json.JsonObjectBuilder`	`getClaimsBuilder()` Subclasses can use this method to obtain a reference to the `JsonObjectBuilder` being used to manage the claims set.
`protected javax.json.JsonObjectBuilder`	`getHeadersBuilder()` Gets the JSON Web Token headers builder.
`protected Class<T>`	`getTokenType()` Gets the token type.
`B`	`header(String name, int... value)` Updates the headers set with the specified header int value(s).
`B`	`header(String name, javax.json.JsonArray value)` Updates the headers set with the specified header `JsonArray` value.
`B`	`header(String name, List<javax.json.JsonObject> value)` Populates the headers set with the specified header `JsonObject` collection.
`B`	`header(String name, String... value)` Updates the headers set with the specified header string value(s).
`B`	`id(String id)` Sets the unique identifier for a JWT.
`B`	`issuedAt(int issuedAt)` Sets the time at which the JWT was issued.
`B`	`issuer(String issuer)` Sets the principal that issued the JWT.
`B`	`notBefore(int notBefore)` Sets the time before which the token MUST NOT be accepted for processing
`B`	`subject(String subject)` Sets the principal that is the subject of the JWT.
`B`	`type(String type)` Sets the MIME Media Type [IANA.MediaTypes] of this complete JWT in contexts where this is useful to the application.

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

- Constructor Detail
  - JWTBuilder
```
public JWTBuilder()
```
    Instantiates a new JWT builder.
  - JWTBuilder
```
public JWTBuilder(Class<T> tokenType)
```
    Instantiates a new JWT builder with the token value.
    
    Parameters:
    
    tokenType - the token type
- Method Detail
  - getTokenType
```
protected Class<T> getTokenType()
```
    Gets the token type.
    
    Returns:
    
    the token type
  - getHeadersBuilder
```
protected javax.json.JsonObjectBuilder getHeadersBuilder()
```
    Gets the JSON Web Token headers builder.
    
    Returns:
    
    the headers builder
  - getClaimsBuilder
```
protected javax.json.JsonObjectBuilder getClaimsBuilder()
```
    Subclasses can use this method to obtain a reference to the JsonObjectBuilder being used to manage the claims set.
    
    Returns:
    
    the claims builder
  - type
```
public B type(String type)
```
    Sets the MIME Media Type [IANA.MediaTypes] of this complete JWT in contexts where this is useful to the application.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the JWT builder
  - contentType
```
public B contentType(String contentType)
```
    Sets the Content type used by this specification to convey structural information about the JWT.
    
    Parameters:
    
    contentType - the content type
    
    Returns:
    
    the JWT builder
  - id
```
public B id(String id)
```
    Sets the unique identifier for a JWT.
    
    Parameters:
    
    id - the id
    
    Returns:
    
    the JWT builder
  - issuer
```
public B issuer(String issuer)
```
    Sets the principal that issued the JWT.
    
    Parameters:
    
    issuer - the issuer
    
    Returns:
    
    the JWT builder
  - audience
```
public B audience(String... audience)
```
    Sets the audience that the JWT is intended for.
    
    Parameters:
    
    audience - the audience
    
    Returns:
    
    the JWT builder
  - subject
```
public B subject(String subject)
```
    Sets the principal that is the subject of the JWT.
    
    Parameters:
    
    subject - the subject
    
    Returns:
    
    the JWT builder
  - issuedAt
```
public B issuedAt(int issuedAt)
```
    Sets the time at which the JWT was issued.
    
    Parameters:
    
    issuedAt - the issued at
    
    Returns:
    
    the JWT builder
  - expiration
```
public B expiration(int expirationTime)
```
    Sets the expiration time on or after which the token MUST NOT be accepted for processing.
    
    Parameters:
    
    expirationTime - the expiration time
    
    Returns:
    
    the JWT builder
  - notBefore
```
public B notBefore(int notBefore)
```
    Sets the time before which the token MUST NOT be accepted for processing
    
    Parameters:
    
    notBefore - the not before
    
    Returns:
    
    the JWT builder
  - claim
```
public B claim(String name,
               String... value)
```
    Updates the claims set with the specified claim string value(s).
    
    Parameters:
    
    name - the name of the claim
    
    value - the value(s) of the claim
    
    Returns:
    
    the JWT builder
  - claim
```
public B claim(String name,
               int... value)
```
    Updates the claims set with the specified claim int value(s).
    
    Parameters:
    
    name - the name of the claim
    
    value - the value(s) of the claim
    
    Returns:
    
    the JWT builder
  - header
```
public B header(String name,
                String... value)
```
    Updates the headers set with the specified header string value(s).
    
    Parameters:
    
    name - the name of the header
    
    value - the value(s) of the header
    
    Returns:
    
    the JWT builder
  - header
```
public B header(String name,
                int... value)
```
    Updates the headers set with the specified header int value(s).
    
    Parameters:
    
    name - the name of the header
    
    value - the value(s) of the header
    
    Returns:
    
    the JWT builder
  - header
```
public B header(String name,
                List<javax.json.JsonObject> value)
```
    Populates the headers set with the specified header JsonObject collection.
    
    Parameters:
    
    name - the name of the header
    
    value - the value(s) of the header
    
    Returns:
    
    the JWT builder
  - header
```
public B header(String name,
                javax.json.JsonArray value)
```
    Updates the headers set with the specified header JsonArray value.
    
    Parameters:
    
    name - the name of the header
    
    value - the value(s) of the header
    
    Returns:
    
    the JWT builder
  - build
```
public T build()
```
    Builds a JWT instance using the provided claims.
    
    Returns:
    
    the t
  - build
```
public T build(String json)
```
    Builds a JWT instance from its JSON representation.
    
    Parameters:
    
    json - the jwt encoded json string
    
    Returns:
    
    the t
  - build
```
protected T build(javax.json.JsonObject headersObject,
                  javax.json.JsonObject claimsObject)
```
    Builds the JsonObject of headers and claims set.
    
    Parameters:
    
    headersObject - the headers object
    
    claimsObject - the claims object
    
    Returns:

Class JWTBuilder<T extends JWT,B extends JWTBuilder<?,?>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JWTBuilder

JWTBuilder

Method Detail

getTokenType

getHeadersBuilder

getClaimsBuilder

type

contentType

id

issuer

audience

subject

issuedAt

expiration

notBefore

claim

claim

header

header

header

header

build

build

build