com.pega.pegarules.pub.services.oauth2

Interface OAuth2AccessTokenService

public interface OAuth2AccessTokenService

Service for issuing access tokens to external clients which use Pega OAuth2.0 service

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
OAuth2AccessToken	handleTokenRequest(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters) Authenticates the client (if required) and generates an access token.
OAuth2TokenRevocation	handleTokenRevocation(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters) Authenticates the client (if required) and revoke an access token.
boolean	isAccessTokenAvailable(PublicAPI aTools, java.lang.String clientID) Checks if access token exists pertaining to the given clientID
boolean	revokeAccessTokenByClientID(PublicAPI aTools, java.lang.String clientID, java.lang.String operatorID, java.lang.String grantType) Removes all the access token pertaining to the given clientID

Field Detail

VERSION

static final java.lang.String VERSION

Method Detail

handleTokenRequest

OAuth2AccessToken handleTokenRequest(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)

Authenticates the client (if required) and generates an access token. The input parameters should contain a Map of (HTTP) parameters and their values. For client credentials : CLIENT-ID - ID of the client requesting the token CLIENT_SECRET - Secret of the Client requesting the token On successful authentication, an access token is generated and returned. If the authentication fails, an appropriate error code is returned.

Parameters:

parameters - a Map of (HTTP) parameters and their values *

Returns:

An OAuth2AccessToken object containing the token info

revokeAccessTokenByClientID

boolean revokeAccessTokenByClientID(PublicAPI aTools,
                                    java.lang.String clientID,
                                    java.lang.String operatorID,
                                    java.lang.String grantType)

Removes all the access token pertaining to the given clientID

Parameters:

aTools -

clientID -

operatorID -

grantType -

Returns:

gives the status of the revoke operation. true if all the delete operation is success ; false if the delete operation fails

handleTokenRevocation

OAuth2TokenRevocation handleTokenRevocation(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)

Authenticates the client (if required) and revoke an access token. The input parameters should contain a Map of (HTTP) parameters and their values. For client credentials : CLIENT-ID - ID of the client for the token CLIENT_SECRET - Secret of the Client for the token On successful authentication, an access token is revoked. If the authentication fails, an appropriate error code is returned.

Parameters:

parameters - a Map of (HTTP) parameters and their values

Returns:

An OAuth2AccessToken object containing the token info

isAccessTokenAvailable

boolean isAccessTokenAvailable(PublicAPI aTools,
                               java.lang.String clientID)

Checks if access token exists pertaining to the given clientID

Parameters:

aTools -

clientID -

Returns:

gives the status of the access token availability. true if access token is present ; false if the access token doesn't exist