Package alpine.auth

Class OidcAuthenticationService

java.lang.Object

alpine.auth.OidcAuthenticationService

All Implemented Interfaces:

AuthenticationService

public class OidcAuthenticationService
extends Object
implements AuthenticationService

Since:

1.8.0

Constructor Summary

Constructors

Constructor	Description
OidcAuthenticationService(String accessToken)

Method Summary

Modifier and Type	Method	Description
Principal	authenticate()	Defines an authentication method which returns a Principal if authentication is successful or an AuthorizationException if not.
boolean	isSpecified()	Defines a method which returns if the specified piece of data, required to perform authentication is present.

Methods inherited from class java.lang.Object

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

Constructor Detail

OidcAuthenticationService

public OidcAuthenticationService(String accessToken)

Method Detail

isSpecified

public boolean isSpecified()

Description copied from interface: AuthenticationService

Defines a method which returns if the specified piece of data, required to perform authentication is present.

Specified by:

isSpecified in interface AuthenticationService

Returns:

true if the authentication data was specified, false if not

authenticate

@Nullable
public Principal authenticate()
                       throws AlpineAuthenticationException

Description copied from interface: AuthenticationService

Defines an authentication method which returns a Principal if authentication is successful or an AuthorizationException if not.

Specified by:

authenticate in interface AuthenticationService

Returns:

a Principal of the authenticated user

Throws:

AlpineAuthenticationException