Interface AuthenticationScheme

All Known Implementing Classes:

EmbeddedAuthenicationScheme, NoAuthenicationScheme, OidcAuthenticationScheme

public interface AuthenticationScheme

Interface through which authentication is verified. Nimbus performs OIDC cryptographic verification, and input properties. Letting endpoints to focus on evaluating roles.

Method Summary

Modifier and Type	Method	Description
AuthPrincipal	authenticate(Object input)	Verify authenticity of input
AuthenticationSchemeType	getSchemeType()	Provide AuthenticationSchemeType of implementing class
AuthPrincipal	mapToAuthPrincipal(Object input)	Map JWTClaimsSet to AuthPrincipal
boolean	validate(Object input)	Validate JWT input properties
boolean	verifiyIssuer(Object input)	Verify issuer of HWT
boolean	verifyAudience(Object input)	Verify audience of JWT
boolean	verifyExpiration(Object input)	Verify expiration of JWT

Method Details

getSchemeType

AuthenticationSchemeType getSchemeType()

Provide AuthenticationSchemeType of implementing class

Returns:

AuthenticationSchemeType

authenticate

AuthPrincipal authenticate(Object input)
                    throws AuthenticationException

Verify authenticity of input

Parameters:

input -

Returns:

AuthPrincipal

Throws:

AuthenticationException

mapToAuthPrincipal

AuthPrincipal mapToAuthPrincipal(Object input)

Map JWTClaimsSet to AuthPrincipal

Parameters:

input -

Returns:

AuthPrincipal

validate

boolean validate(Object input)

Validate JWT input properties

Parameters:

input -

Returns:

boolean

verifiyIssuer

boolean verifiyIssuer(Object input)

Verify issuer of HWT

Parameters:

input -

Returns:

boolean

verifyAudience

boolean verifyAudience(Object input)

Verify audience of JWT

Parameters:

input -

Returns:

boolean

verifyExpiration

boolean verifyExpiration(Object input)

Verify expiration of JWT

Parameters:

input -

Returns:

boolean