software.sandc.springframework.security.jwt.authority

Interface JWTAuthority

All Superinterfaces:

JWTConsumer

All Known Implementing Classes:

DefaultJWTAuthority

public interface JWTAuthority
extends JWTConsumer

JWTAuthority is the core component of spring security JWT extension. It is responsible for create, validate, renew tokens and handle authentication requests.

Author:

selimok

Method Summary

Modifier and Type	Method and Description
JWTContext	authenticateLoginRequest(Credentials credentials, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Authenticate login request if the provided credentials are valid. The created JWTAuthentication object (which is also the part of JWTContext) is implicitly attached into SecurityContextHolder to inform spring security about the authenticated user.
JWTContext	create(String principal, Parameters parameters) Create a fully fledged JWTContext for given principal.
JWTContext	createAndAttach(String principal, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Parameters parameters) Create a fully fledged JWTContext for given principal and attach it into given HTTP Response.
JWTContext	renew(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Authenticate HTTP request if the request contains JWT and renew it if renewable.
JWTContext	renew(TokenContainer tokenContainer, Parameters parameters) Renew tokens given in the TokenContainer object.

Methods inherited from interface software.sandc.springframework.security.jwt.consumer.JWTConsumer

authenticateJWTRequest, validate

Method Detail

authenticateLoginRequest

JWTContext authenticateLoginRequest(Credentials credentials,
                                    javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)

Authenticate login request if the provided credentials are valid.

The created JWTAuthentication object (which is also the part of JWTContext) is implicitly attached into SecurityContextHolder to inform spring security about the authenticated user.

Parameters:

credentials - Credentials instance which contains principal (unique user identifier like user name, user id, email address etc.) and password.

request - HTTP request

response - HTTP response

Returns:

A fully fledged JWTContext object.

createAndAttach

JWTContext createAndAttach(String principal,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           Parameters parameters)

Create a fully fledged JWTContext for given principal and attach it into given HTTP Response.

The created JWTAuthentication object (which is also the part of JWTContext) is implicitly attached into SecurityContextHolder to inform spring security about the authenticated user.

Parameters:

principal - Unique user identifier. This can be the user name or user id according to underlying implementation.

request - HTTP request (may be used to read clients preferences for token handling)

response - HTTP response

parameters - Additional parameters to customize processing of the request. Possible parameters and their effects may differ depending on specific implementation. The parameters may be empty or null.

Returns:

A fully fledged JWTContext object.

create

JWTContext create(String principal,
                  Parameters parameters)

Create a fully fledged JWTContext for given principal.

Parameters:

principal - Unique user identifier. This can be the user name or user id according to underlying implementation.

parameters - Additional parameters to customize processing of the request. Possible parameters and their effects may differ depending on specific implementation. The parameters may be empty or null.

Returns:

A fully fledged JWTContext object.

renew

JWTContext renew(TokenContainer tokenContainer,
                 Parameters parameters)

Renew tokens given in the TokenContainer object.

Parameters:

tokenContainer - TokenContainer instance which contains JWT and XSRF tokens.

parameters - Additional parameters to customize processing of the request. Possible parameters and their effects may differ depending on specific implementation. The parameters may be empty or null.

Returns:

A fully fledged JWTContext object.

renew

JWTContext renew(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)

Authenticate HTTP request if the request contains JWT and renew it if renewable.

The created JWTAuthentication object (which is also the part of JWTContext) is implicitly attached into SecurityContextHolder to inform spring security about the authenticated user.

Renewed token will be attached automatically into the response object.

Parameters:

request - HTTP request (may be used to read clients preferences for token handling)

response - HTTP response

Returns:

A fully fledged JWTContext object.