Package org.summerboot.jexpress.security.auth

Interface Authenticator

All Superinterfaces:

HealthInspector

All Known Implementing Classes:

AuthenticatorMockImpl, BootAuthenticator

public interface Authenticator
extends HealthInspector

Author:

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

Field Summary

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

healthInspectorCounter

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)
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
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)
<T extends Caller> T	verifyBearerToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders, AuthTokenCache cache, Integer errorCode, ServiceContext context)	Success HTTP Status: 200 OK
<T extends Caller> T	verifyToken(String authToken, AuthTokenCache cache, Integer errorCode, ServiceContext context)

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

ping

Method Details

setListener

void setListener(AuthenticatorListener listener)

Parameters:

listener -

authenticate

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

Success HTTP Status: 201 Created

Parameters:

uid -

pwd -

validForMinutes -

context -

Returns:

JWT

Throws:

IOException

NamingException

toJwt

io.jsonwebtoken.JwtBuilder toJwt(Caller caller)

fromJwt

Caller fromJwt(io.jsonwebtoken.Claims claims)

getBearerToken

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

Parameters:

httpRequestHeaders -

Returns:

verifyBearerToken

<T extends Caller> T verifyBearerToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders,
 AuthTokenCache cache,
 Integer errorCode,
 ServiceContext context)

Success HTTP Status: 200 OK

Type Parameters:

T -

Parameters:

httpRequestHeaders - contains Authorization = Bearer + JWT

cache -

errorCode -

context -

Returns:

Caller

verifyToken

<T extends Caller> T verifyToken(String authToken,
 AuthTokenCache cache,
 Integer errorCode,
 ServiceContext context)

Type Parameters:

T -

Parameters:

authToken -

cache -

errorCode -

context -

Returns:

Caller

logout

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

Success HTTP Status: 204 No Content

Parameters:

httpRequestHeaders - contains Authorization = Bearer + JWT

cache -

context -

logout

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

Success HTTP Status: 204 No Content

Parameters:

authToken -

cache -

context -