com.auth0.jwt

Class JWTSigner

java.lang.Object

com.auth0.jwt.JWTSigner

public class JWTSigner
extends Object

Handles JWT Sign Operation Default algorithm when none provided is HMAC SHA-256 ("HS256") See associated library test cases for clear examples on usage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JWTSigner.Options An option object for JWT signing operation.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Algorithm	DEFAULT_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
JWTSigner(byte[] secret)
JWTSigner(PrivateKey privateKey)
JWTSigner(String secret)

Method Summary

Methods

Modifier and Type	Method and Description
String	sign(Map<String,Object> claims) Generate a JSON Web Token using the default algorithm HMAC SHA-256 ("HS256") and no claims automatically set.
String	sign(Map<String,Object> claims, JWTSigner.Options options) Generate a JSON Web Token.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ALGORITHM

protected static final Algorithm DEFAULT_ALGORITHM

Constructor Detail

JWTSigner

public JWTSigner(String secret)

JWTSigner

public JWTSigner(byte[] secret)

JWTSigner

public JWTSigner(PrivateKey privateKey)

Method Detail

sign

public String sign(Map<String,Object> claims,
          JWTSigner.Options options)

Generate a JSON Web Token.

Parameters:

claims - A map of the JWT claims that form the payload. Registered claims must be of appropriate Java datatype as following:

• iss, sub: String
• exp, nbf, iat, jti: numeric, eg. Long
• aud: String, or Collection<String>

All claims with a null value are left out the JWT. Any claims set automatically as specified in the "options" parameter override claims in this map.

options - Allow choosing the signing algorithm, and automatic setting of some registered claims.

sign

public String sign(Map<String,Object> claims)

Generate a JSON Web Token using the default algorithm HMAC SHA-256 ("HS256") and no claims automatically set.