Package org.summerboot.jexpress.security.auth

Class BootAuthenticator<T>

java.lang.Object

org.summerboot.jexpress.security.auth.BootAuthenticator<T>

Type Parameters:

T - authenticate(T metaData)

All Implemented Interfaces:

Authenticator

Direct Known Subclasses:

AuthenticatorMockImpl

public abstract class BootAuthenticator<T>
extends Object
implements Authenticator

Author:

Changski Tie Zheng Zhang 张铁铮, 魏泽北, 杜旺财, 杜富贵

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthConfig	authCfg
protected AuthenticatorListener	listener

Constructor Summary

Constructors

Constructor	Description
BootAuthenticator()

Method Summary

Modifier and Type	Method	Description
protected abstract Caller	authenticate(String uid, String password, T metaData, AuthenticatorListener listener, ServiceContext context)
Caller	fromJwt(io.jsonwebtoken.Claims claims)	Convert Caller back from auth token, override this method to implement customized token format
String	getBearerToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders)	Retrieve token based on RFC 6750 - The OAuth 2.0 Authorization Framework override this method to get customized token
String	login(String uid, String pwd, Object metaData, int validForMinutes, ServiceContext context)	Success HTTP Status: 201 Created
void	logout(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders, AuthTokenCache cache, ServiceContext context)	Success HTTP Status: 204 No Content
void	logout(String authToken, AuthTokenCache cache, ServiceContext context)	Success HTTP Status: 204 No Content
protected Integer	overrideVerifyTokenErrorCode()
void	setListener(AuthenticatorListener listener)
io.jsonwebtoken.JwtBuilder	toJwt(Caller caller)	Convert Caller to auth token, override this method to implement customized token format
Caller	verifyBearerToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders, AuthTokenCache cache, Integer errorCode, ServiceContext context)	Success HTTP Status: 200 OK
Caller	verifyToken(String authToken, AuthTokenCache cache, Integer errorCode, ServiceContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.summerboot.jexpress.security.auth.Authenticator

preAccessCheck

Field Details

listener

protected AuthenticatorListener listener

authCfg

protected AuthConfig authCfg

Constructor Details

BootAuthenticator

public BootAuthenticator()

Method Details

setListener

public void setListener(AuthenticatorListener listener)

Specified by:

setListener in interface Authenticator

Parameters:

listener -

login

public String login(String uid,
 String pwd,
 Object metaData,
 int validForMinutes,
 ServiceContext context)
             throws NamingException

Description copied from interface: Authenticator

Success HTTP Status: 201 Created

Specified by:

login in interface Authenticator

Parameters:

uid -

pwd -

validForMinutes -

context -

Returns:

Throws:

NamingException

authenticate

protected abstract Caller authenticate(String uid,
 String password,
 T metaData,
 AuthenticatorListener listener,
 ServiceContext context)
                                throws NamingException

Parameters:

uid -

password -

metaData -

listener -

context -

Returns:

Throws:

NamingException

toJwt

public io.jsonwebtoken.JwtBuilder toJwt(Caller caller)

Convert Caller to auth token, override this method to implement customized token format

Specified by:

toJwt in interface Authenticator

Parameters:

caller -

Returns:

formatted auth token builder

fromJwt

public Caller fromJwt(io.jsonwebtoken.Claims claims)

Convert Caller back from auth token, override this method to implement customized token format

Specified by:

fromJwt in interface Authenticator

Parameters:

claims -

Returns:

Caller

getBearerToken

public String getBearerToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders)

Description copied from interface: Authenticator

Retrieve token based on RFC 6750 - The OAuth 2.0 Authorization Framework override this method to get customized token

Specified by:

getBearerToken in interface Authenticator

Parameters:

httpRequestHeaders -

Returns:

verifyBearerToken

public Caller verifyBearerToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders,
 AuthTokenCache cache,
 Integer errorCode,
 ServiceContext context)

Description copied from interface: Authenticator

Success HTTP Status: 200 OK

Specified by:

verifyBearerToken in interface Authenticator

Parameters:

httpRequestHeaders -

cache -

errorCode -

context -

Returns:

verifyToken

public Caller verifyToken(String authToken,
 AuthTokenCache cache,
 Integer errorCode,
 ServiceContext context)

Specified by:

verifyToken in interface Authenticator

Parameters:

authToken -

cache -

errorCode -

context -

Returns:

overrideVerifyTokenErrorCode

protected Integer overrideVerifyTokenErrorCode()

logout

public void logout(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders,
 AuthTokenCache cache,
 ServiceContext context)

Description copied from interface: Authenticator

Success HTTP Status: 204 No Content

Specified by:

logout in interface Authenticator

Parameters:

httpRequestHeaders -

cache -

context -

logout

public void logout(String authToken,
 AuthTokenCache cache,
 ServiceContext context)

Description copied from interface: Authenticator

Success HTTP Status: 204 No Content

Specified by:

logout in interface Authenticator

Parameters:

authToken -

cache -

context -