Package com.inrupt.client.uma

Class UmaAuthenticationProvider

java.lang.Object

com.inrupt.client.uma.UmaAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public class UmaAuthenticationProvider
extends Object
implements AuthenticationProvider

An authentication mechanism that makes use of User Managed Access (UMA) authorization servers.

UMA defines an OAuth 2.0 profile by which applications can negotiate for an access token through an iterative claims gathering process.

See Also:

• User Managed Access (UMA) 2.0 Grant for OAuth 2.0 Authorization

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UmaAuthenticationProvider.UmaAuthenticator	A mechanism capable of retrieving an access token from an UMA authorization server.

Field Summary

Fields

Modifier and Type	Field	Description
static final URI	ID_TOKEN
static final URI	VERIFIABLE_CREDENTIAL

Constructor Summary

Constructors

Constructor	Description
UmaAuthenticationProvider()
UmaAuthenticationProvider(int priority)	Create a UmaAuthenticationProvider with a defined priority.
UmaAuthenticationProvider(int priority, UmaClient umaClient)	Create a UmaAuthenticationProvider with a defined priority.

Method Summary

Modifier and Type	Method	Description
Authenticator	getAuthenticator(Challenge challenge)	Return an authenticator for the supplied challenge.
Set<String>	getSchemes()	Return the set of supported authorization schemes, such as Bearer or DPoP.

Methods inherited from class java.lang.Object

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

Field Details

ID_TOKEN

public static final URI ID_TOKEN

VERIFIABLE_CREDENTIAL

public static final URI VERIFIABLE_CREDENTIAL

Constructor Details

UmaAuthenticationProvider

public UmaAuthenticationProvider()

UmaAuthenticationProvider

public UmaAuthenticationProvider(int priority)

Create a UmaAuthenticationProvider with a defined priority.

Parameters:

priority - the priority of this authentication mechanism

UmaAuthenticationProvider

public UmaAuthenticationProvider(int priority,
 UmaClient umaClient)

Create a UmaAuthenticationProvider with a defined priority.

Parameters:

priority - the priority of this authentication mechanism

umaClient - an UMA HTTP client

Method Details

getSchemes

public Set<String> getSchemes()

Description copied from interface: AuthenticationProvider

Return the set of supported authorization schemes, such as Bearer or DPoP.

Specified by:

getSchemes in interface AuthenticationProvider

Returns:

the authorization schemes

getAuthenticator

public Authenticator getAuthenticator(Challenge challenge)

Description copied from interface: AuthenticationProvider

Return an authenticator for the supplied challenge.

Specified by:

getAuthenticator in interface AuthenticationProvider

Parameters:

challenge - the HTTP challenge value

Returns:

an authenticator