Package org.summerboot.jexpress.security.auth

Class BootAuthenticator

java.lang.Object

org.summerboot.jexpress.security.auth.BootAuthenticator

All Implemented Interfaces:

HealthInspector, Authenticator

Direct Known Subclasses:

AuthenticatorMockImpl

public abstract class BootAuthenticator
extends Object
implements Authenticator

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthConfig	authCfg
protected AuthenticatorListener	listener

Fields inherited from interface org.summerboot.jexpress.boot.instrumentation.HealthInspector

healthInspectorCounter

Constructor Summary

Constructors

Constructor	Description
BootAuthenticator()

Method Summary

Modifier and Type	Method	Description
String	authenticate(String uid, String pwd, int validForMinutes, ServiceContext context)	Success HTTP Status: 201 Created
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
protected abstract Caller	login(String uid, String password, AuthenticatorListener listener)
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
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.boot.instrumentation.HealthInspector

ping

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 -

authenticate

public String authenticate(String uid,
 String pwd,
 int validForMinutes,
 ServiceContext context)
                    throws IOException,
NamingException

Description copied from interface: Authenticator

Success HTTP Status: 201 Created

Specified by:

authenticate in interface Authenticator

Parameters:

uid -

pwd -

validForMinutes -

context -

Returns:

Throws:

IOException

NamingException

login

protected abstract Caller login(String uid,
 String password,
 AuthenticatorListener listener)
                         throws IOException,
NamingException

Parameters:

uid -

password -

listener -

Returns:

Throws:

IOException

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:

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 -