Package org.springframework.security.oauth2.jwt

Class JwtEncoderParameters

java.lang.Object

org.springframework.security.oauth2.jwt.JwtEncoderParameters

public final class JwtEncoderParameters
extends Object

A holder of parameters containing the JWS headers and JWT Claims Set.

Since:

5.6

See Also:

• JwsHeader
• JwtClaimsSet
• JwtEncoder

Method Summary

Modifier and Type	Method	Description
static JwtEncoderParameters	from(JwsHeader jwsHeader, JwtClaimsSet claims)	Returns a new JwtEncoderParameters, initialized with the provided JwsHeader and JwtClaimsSet.
static JwtEncoderParameters	from(JwtClaimsSet claims)	Returns a new JwtEncoderParameters, initialized with the provided JwtClaimsSet.
JwtClaimsSet	getClaims()	Returns the claims.
JwsHeader	getJwsHeader()	Returns the JWS headers.

Methods inherited from class java.lang.Object

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

Method Details

from

public static JwtEncoderParameters from(JwtClaimsSet claims)

Returns a new JwtEncoderParameters, initialized with the provided JwtClaimsSet.

Parameters:

claims - the JwtClaimsSet

Returns:

the JwtEncoderParameters

from

public static JwtEncoderParameters from(JwsHeader jwsHeader,
 JwtClaimsSet claims)

Returns a new JwtEncoderParameters, initialized with the provided JwsHeader and JwtClaimsSet.

Parameters:

jwsHeader - the JwsHeader

claims - the JwtClaimsSet

Returns:

the JwtEncoderParameters

getJwsHeader

@Nullable
public JwsHeader getJwsHeader()

Returns the JWS headers.

Returns:

the JwsHeader, or null if not specified

getClaims

public JwtClaimsSet getClaims()

Returns the claims.

Returns:

the JwtClaimsSet