Package com.pingidentity.sdk.oauth20

Interface BearerAccessTokenManagementPlugin

All Superinterfaces:

ConfigurablePlugin, DescribablePlugin, Plugin

public interface BearerAccessTokenManagementPlugin
extends Plugin

This interface defines the methods that the PingFederate calls to issue and validate access tokens.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TOKEN_TYPE	The token type this plugin represents.

Method Summary

Modifier and Type	Method	Description
default IssuedAccessToken	issueAccessToken(Map<String,AttributeValue> attributes, Scope scope, String clientId, String accessGrantGuid)	Issues an IssuedAccessToken based on the specified parameters.
default IssuedAccessToken	issueAccessToken(Map<String,AttributeValue> attributes, Scope scope, String clientId, String accessGrantGuid, int tokenManagerSequenceNumber)	Issues an IssuedAccessToken based on the specified parameters.
default IssuedAccessToken	issueAccessToken(Map<String,AttributeValue> attributes, Scope scope, String clientId, String accessGrantGuid, int tokenManagerSequenceNumber, AuthorizationDetails authorizationDetails)	Issues an IssuedAccessToken based on the specified parameters.
default boolean	issuedToken(String accessTokenValue, int tokenManagerSequenceNumber)	Indicate if this plugin could have issued the token using the supplied token manager sequence number.
AccessToken	validateAccessToken(String accessTokenValue)	Validates the AccessToken and updates the expiration of the token if it hasn't yet expired.

Methods inherited from interface com.pingidentity.sdk.ConfigurablePlugin

configure

Methods inherited from interface com.pingidentity.sdk.DescribablePlugin

getPluginDescriptor

Field Detail

TOKEN_TYPE

static final String TOKEN_TYPE

The token type this plugin represents.

See Also:

Constant Field Values

Method Detail

validateAccessToken

AccessToken validateAccessToken(String accessTokenValue)

Validates the AccessToken and updates the expiration of the token if it hasn't yet expired.

Parameters:

accessTokenValue - The String representation of the access token.

Returns:

The AccessToken that was validated.

issueAccessToken

default IssuedAccessToken issueAccessToken(Map<String,AttributeValue> attributes,
                                           Scope scope,
                                           String clientId,
                                           String accessGrantGuid)

Issues an IssuedAccessToken based on the specified parameters.

Parameters:

attributes - The attributes associated with the access token.

scope - The scope of the access token.

clientId - The client ID of the access token.

accessGrantGuid - The access grant GUID of the access token.

Returns:

The issued access token.

issueAccessToken

default IssuedAccessToken issueAccessToken(Map<String,AttributeValue> attributes,
                                           Scope scope,
                                           String clientId,
                                           String accessGrantGuid,
                                           int tokenManagerSequenceNumber)

Issues an IssuedAccessToken based on the specified parameters.

Parameters:

attributes - The attributes associated with the access token.

scope - The scope of the access token.

clientId - The client ID of the access token.

accessGrantGuid - The access grant GUID of the access token.

tokenManagerSequenceNumber - The sequence number of this plugin.

Returns:

The issued access token.

Since:

9.3

issueAccessToken

default IssuedAccessToken issueAccessToken(Map<String,AttributeValue> attributes,
                                           Scope scope,
                                           String clientId,
                                           String accessGrantGuid,
                                           int tokenManagerSequenceNumber,
                                           AuthorizationDetails authorizationDetails)

Issues an IssuedAccessToken based on the specified parameters.

Parameters:

attributes - The attributes associated with the access token.

scope - The scope of the access token.

clientId - The client ID of the access token.

accessGrantGuid - The access grant GUID of the access token.

tokenManagerSequenceNumber - The sequence number of this plugin.

authorizationDetails - The authorization details of the access token.

Returns:

The issued access token.

Since:

11.2

issuedToken

default boolean issuedToken(String accessTokenValue,
                            int tokenManagerSequenceNumber)

Indicate if this plugin could have issued the token using the supplied token manager sequence number.

Parameters:

accessTokenValue - The String representation of the access token.

tokenManagerSequenceNumber - The sequence number of this plugin.

Returns:

True if this token manager could have generated the token. Default implementation is to return true.

Since:

9.3