org.picketlink.json.jwt

Class JWTBuilder<T extends JWT,B extends JWTBuilder>

java.lang.Object

org.picketlink.json.jwt.JWTBuilder<T,B>

Type Parameters:

T -

B -

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
	JWTBuilder()
protected	JWTBuilder(Class<T> tokenType)

Method Summary

Methods

Modifier and Type	Method and Description
B	audience(String... audience)
T	build() Builds a JWT instance using the provided claims.
protected T	build(javax.json.JsonObject headersObject, javax.json.JsonObject claimsObject)
T	build(String json) Builds a JWT instance from its JSON representation.
B	claim(String name, int... value)
B	claim(String name, String... value)
B	contentType(String contentType)
B	expiration(int expirationTime)
protected javax.json.JsonObjectBuilder	getClaimsBuilder() Subclasses can use this method to obatain a reference to the JsonObjectBuilder being used to manage the claims set.
protected javax.json.JsonObjectBuilder	getHeadersBuilder()
protected Class<T>	getTokenType()
B	header(String name, int... value)
B	header(String name, String... value)
B	id(String id)
B	issuedAt(int issuedAt)
B	issuer(String issuer)
B	notBefore(int notBefore)
B	subject(String subject)
B	type(String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

JWTBuilder

public JWTBuilder()

JWTBuilder

protected JWTBuilder(Class<T> tokenType)

Method Detail

type

public B type(String type)

contentType

public B contentType(String contentType)

id

public B id(String id)

issuer

public B issuer(String issuer)

audience

public B audience(String... audience)

subject

public B subject(String subject)

issuedAt

public B issuedAt(int issuedAt)

expiration

public B expiration(int expirationTime)

notBefore

public B notBefore(int notBefore)

claim

public B claim(String name,
      String... value)

claim

public B claim(String name,
      int... value)

header

public B header(String name,
       String... value)

header

public B header(String name,
       int... value)

build

public T build()

Builds a JWT instance using the provided claims.

Returns:

build

public T build(String json)

Builds a JWT instance from its JSON representation.

Returns:

getClaimsBuilder

protected javax.json.JsonObjectBuilder getClaimsBuilder()

Subclasses can use this method to obatain a reference to the JsonObjectBuilder being used to manage the claims set.

Returns:

getHeadersBuilder

protected javax.json.JsonObjectBuilder getHeadersBuilder()

getTokenType

protected Class<T> getTokenType()

build

protected T build(javax.json.JsonObject headersObject,
      javax.json.JsonObject claimsObject)