Package com.inrupt.client.uma

Class UmaAuthenticationProvider.UmaAuthenticator

java.lang.Object

com.inrupt.client.uma.UmaAuthenticationProvider.UmaAuthenticator

All Implemented Interfaces:

Authenticator

Enclosing class:

UmaAuthenticationProvider

public class UmaAuthenticationProvider.UmaAuthenticator
extends Object
implements Authenticator

A mechanism capable of retrieving an access token from an UMA authorization server.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UmaAuthenticator(UmaClient umaClient, com.inrupt.client.uma.UmaAuthenticationProvider.NeedInfoHandler claimHandler, Challenge challenge, int priority)	The UmaAuthenticator with a defined challenge and priority.

Method Summary

Modifier and Type	Method	Description
void	addHandler(ClaimGatheringHandler handler)	Add a claim gathering handler.
CompletionStage<Credential>	authenticate(Session session, Request request, Set<String> algorithms)	Perform an ansynchronous authentication process, resulting in an access token.
String	getName()	Gets the authenticator name (e.g.
int	getPriority()	Gets the priority of the authenticator.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

UmaAuthenticator

protected UmaAuthenticator(UmaClient umaClient,
 com.inrupt.client.uma.UmaAuthenticationProvider.NeedInfoHandler claimHandler,
 Challenge challenge,
 int priority)

The UmaAuthenticator with a defined challenge and priority.

Parameters:

umaClient - the UMA client

challenge - the resource server challenge

priority - the priority of this authentication mechanism

Method Details

addHandler

public void addHandler(ClaimGatheringHandler handler)

Add a claim gathering handler.

Parameters:

handler - the claim gathering handler

getName

public String getName()

Description copied from interface: Authenticator

Gets the authenticator name (e.g. UMA, OpenID).

Specified by:

getName in interface Authenticator

Returns:

the name

getPriority

public int getPriority()

Description copied from interface: Authenticator

Gets the priority of the authenticator.

Specified by:

getPriority in interface Authenticator

Returns:

the priority

authenticate

public CompletionStage<Credential> authenticate(Session session,
 Request request,
 Set<String> algorithms)

Description copied from interface: Authenticator

Perform an ansynchronous authentication process, resulting in an access token.

Specified by:

authenticate in interface Authenticator

Parameters:

session - the client session

request - the HTTP request

algorithms - the supported DPoP algorithms

Returns:

the next stage of completion, containing the access token

toString

public String toString()

Overrides:

toString in class Object