org.wildfly.security.credential.source

Class OAuth2CredentialSource

java.lang.Object

org.wildfly.security.credential.source.OAuth2CredentialSource

All Implemented Interfaces:

CredentialSource

public class OAuth2CredentialSource
extends Object
implements CredentialSource

A CredentialSource capable of authenticating against a OAuth2 compliant authorization server and obtaining access tokens in form of a BearerTokenCredential.

Author:

Pedro Igor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth2CredentialSource.Builder

Field Summary

Fields inherited from interface org.wildfly.security.credential.source.CredentialSource

NONE

Method Summary

Modifier and Type	Method and Description
static OAuth2CredentialSource.Builder	builder(URL tokenEndpointUrl) Creates a new OAuth2CredentialSource.Builder instance in order to configure and build a OAuth2CredentialSource.
<C extends Credential> C	getCredential(Class<C> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec) Acquire a credential of the given type.
SupportLevel	getCredentialAcquireSupport(Class<? extends Credential> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec) Determine whether a given credential is definitely obtainable, possibly obtainable, or definitely not obtainable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.security.credential.source.CredentialSource

applyToCredential, applyToCredential, applyToCredential, fromSecurityFactory, getCredential, getCredential, getCredentialAcquireSupport, getCredentialAcquireSupport, with, without, without, without

Method Detail

builder

public static OAuth2CredentialSource.Builder builder(URL tokenEndpointUrl)

Creates a new OAuth2CredentialSource.Builder instance in order to configure and build a OAuth2CredentialSource.

Parameters:

tokenEndpointUrl - the token endpoint that will be used to obtain OAuth2 access tokens

Returns:

a new builder instance

getCredentialAcquireSupport

public SupportLevel getCredentialAcquireSupport(Class<? extends Credential> credentialType,
                                                String algorithmName,
                                                AlgorithmParameterSpec parameterSpec)
                                         throws IOException

Description copied from interface: CredentialSource

Determine whether a given credential is definitely obtainable, possibly obtainable, or definitely not obtainable.

Specified by:

getCredentialAcquireSupport in interface CredentialSource

Parameters:

credentialType - the credential type class (must not be null)

algorithmName - the algorithm name, or null if any algorithm is acceptable or the credential type does not support algorithm names

parameterSpec - the algorithm parameters to match, or null if any parameters are acceptable or the credential type does not support algorithm parameters

Returns:

the level of support for this credential type (not null)

Throws:

IOException - if the credential source failed to determine the support level

getCredential

public <C extends Credential> C getCredential(Class<C> credentialType,
                                              String algorithmName,
                                              AlgorithmParameterSpec parameterSpec)
                                       throws IOException

Description copied from interface: CredentialSource

Acquire a credential of the given type. The credential type is defined by its Class and an optional algorithmName. If the algorithm name is not given, then the query is performed for any algorithm of the given type.

Specified by:

getCredential in interface CredentialSource

Type Parameters:

C - the credential type

Parameters:

credentialType - the credential type class (must not be null)

algorithmName - the algorithm name, or null if any algorithm is acceptable or the credential type does not support algorithm names

parameterSpec - the algorithm parameters to match, or null if any parameters are acceptable or the credential type does not support algorithm parameters

Returns:

the credential, or null if the principal has no credential of that type

Throws:

IOException - if the realm is not able to handle requests for any reason