com.pega.pegarules.pub.connect.oauth2

Interface OAuth2Client

public interface OAuth2Client

This interface defines contract for OAuth 2.0 consumer implementation APIs

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessToken() Gets an access token for an instance of OAuth2 client It retrieves a valid existing token, if available or obtains one using the token endpoint details provided in authProfilePage
java.lang.String	getAccessToken(java.lang.String aAuthCode) Gets an access token using the given authorization code
ClipboardPage	getAccessTokenFromEndpoint() Deprecated.
java.lang.String	getAuthorizeURL(java.lang.String aGadgetID) Generate authorization URL to initiate Authorization Code flow.
java.lang.String	getFreshAccessToken() Purges the access token and invokes access token endpoint
java.lang.Object	getHttpRequestUpdatedWithAccessToken(java.util.Map<java.lang.String,java.lang.Object> map) Deprecated.
boolean	hasTokenExpired(ClipboardPage tokenPage) verifies if the token is expired
java.lang.String	invokeUserInfoEndpoint(java.lang.String userInfoEndpoint, java.lang.String oauth2Token)
boolean	isAccessTokenPresent() Will retrieve access token, possibly performing refresh operation and update cache.
boolean	isAccessTokenPresentForAnyUser() Check if access token is present for given client id, scope and grant type.
ClipboardPage	retrieveAccessToken() Gets an access token for an instance of OAuth2 client It retrieves a valid existing token, if available or obtains one using the token endpoint details provided in authProfilePage
java.util.Map<java.lang.String,java.lang.String>	revokeToken() revoke the access token for a given client id , client secret and scope Tries to delete the access token from the provider and then from pega
java.util.Map<java.lang.String,java.lang.String>	revokeTokensForAllUsers() revoke the access tokens for a given client id , client secret and scope Tries to delete all the access tokens for all users from the provider and then from pega.
boolean	updateHttpRequestWithAccessToken(java.lang.Object aHttpRequest, boolean aGetFresh) Updates HTTPRequest object with the access token.
boolean	updateHttpRequestWithAccessToken(java.lang.Object aHttpReqObj, boolean aGetFresh, java.lang.String aAccessToken)

Field Detail

VERSION

static final java.lang.String VERSION

Method Detail

getAccessToken

java.lang.String getAccessToken()

Gets an access token for an instance of OAuth2 client It retrieves a valid existing token, if available or obtains one using the token endpoint details provided in authProfilePage

Returns:

A string representing access token or null if unable to get an access token for the given input parameters

Throws:

PRRuntimeException - if encounters any problem while getting the token

getAccessToken

java.lang.String getAccessToken(java.lang.String aAuthCode)

Gets an access token using the given authorization code

Parameters:

aAuthCode -

Returns:

A string representing access token or null if unable to get an access token for the given input parameters

Throws:

PRRuntimeException - if encounters any problem while getting the token

retrieveAccessToken

ClipboardPage retrieveAccessToken()
                           throws java.lang.Exception

Gets an access token for an instance of OAuth2 client It retrieves a valid existing token, if available or obtains one using the token endpoint details provided in authProfilePage

Returns:

A ClipboardPage representing access token or null if unable to get an access token for the given input parameters

Throws:

java.lang.Exception

getAccessTokenFromEndpoint

@Deprecated
ClipboardPage getAccessTokenFromEndpoint()
                                              throws java.lang.Exception

Deprecated.

Gets an access token for an instance of OAuth2 client It retrieves a valid existing token, if available or obtains one using the token endpoint details provided in authProfilePage Rules should use getAccessToken(), getAccessToken(String) or retrieveAccessToken().

Returns:

A string representing access token or null if unable to get an access token for the given input parameters

Throws:

java.lang.Exception - if encounters any problem while getting the token

revokeToken

java.util.Map<java.lang.String,java.lang.String> revokeToken()

revoke the access token for a given client id , client secret and scope Tries to delete the access token from the provider and then from pega

Returns:

response map containing detail whether revocation is successful or not

revokeTokensForAllUsers

java.util.Map<java.lang.String,java.lang.String> revokeTokensForAllUsers()

revoke the access tokens for a given client id , client secret and scope Tries to delete all the access tokens for all users from the provider and then from pega.

Returns:

response map containing detail whether revocation is successful or not

hasTokenExpired

boolean hasTokenExpired(ClipboardPage tokenPage)

verifies if the token is expired

Parameters:

tokenPage -

Returns:

returns true if the token is expired otherwise false

getFreshAccessToken

java.lang.String getFreshAccessToken()

Purges the access token and invokes access token endpoint

Returns:

String new accesstoken

getHttpRequestUpdatedWithAccessToken

@Deprecated
java.lang.Object getHttpRequestUpdatedWithAccessToken(java.util.Map<java.lang.String,java.lang.Object> map)

Deprecated.

Updates HTTPRequest object with the new access token. Works only with com.pega.apache.http.client.methods.HttpUriRequest.

Parameters:

map - map comprising HttpUriRequest, URI and accesstoken

Returns:

Object HttpUriRequest object passed in, updated with the input access token.

updateHttpRequestWithAccessToken

boolean updateHttpRequestWithAccessToken(java.lang.Object aHttpRequest,
                                         boolean aGetFresh)

Updates HTTPRequest object with the access token. If access token is expired, it will fetch a fresh one, according to grant type.

Parameters:

aHttpRequest - PegaRESTClient implementation to set access token

aGetFresh - Attempt to retrieve a fresh access token

Returns:

if request updated, true or false

isAccessTokenPresent

boolean isAccessTokenPresent()

Will retrieve access token, possibly performing refresh operation and update cache.

Returns:

true if any access tokens are present for operator, false otherwise

isAccessTokenPresentForAnyUser

boolean isAccessTokenPresentForAnyUser()

Check if access token is present for given client id, scope and grant type. I.e. if any token is present for any user for the auth profile. Will not perform refresh operations or alter cache state.

Returns:

status: true if any access tokens are present for any user, false otherwise

getAuthorizeURL

java.lang.String getAuthorizeURL(java.lang.String aGadgetID)

Generate authorization URL to initiate Authorization Code flow.

Parameters:

aGadgetID - Used to restart UI flow from where it left off when access token is received.

Returns:

URL to open in new window.

updateHttpRequestWithAccessToken

boolean updateHttpRequestWithAccessToken(java.lang.Object aHttpReqObj,
                                         boolean aGetFresh,
                                         java.lang.String aAccessToken)

invokeUserInfoEndpoint

java.lang.String invokeUserInfoEndpoint(java.lang.String userInfoEndpoint,
                                        java.lang.String oauth2Token)
                                 throws java.lang.Exception

Throws:

java.lang.Exception