com.intuit.oauth2.client

Class OAuth2PlatformClient

java.lang.Object

com.intuit.oauth2.client.OAuth2PlatformClient

public class OAuth2PlatformClient
extends Object

Client class for OAuth2 API's with methods to retrieve bearer token, refresh token and get UserInfo

Author:

dderose

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OAuth2PlatformClient() Hiding the default constructor as OAuth2PlatformClient is always required to function properly
	OAuth2PlatformClient(OAuth2Config oauth2Config)

Method Summary

Modifier and Type	Method and Description
UserInfoResponse	getUserInfo(String accessToken) Method to retrieve UserInfo data associated with the accessToken generated The response depends on the Scope supplied during openId
BearerTokenResponse	refreshToken(String refreshToken) Method to renew OAuth2 tokens by passing the refreshToken
BearerTokenResponse	retrieveBearerTokens(String authCode, String redirectURI) Method to retrieve OAuth2 access token by passing the redirectURI and authCode
PlatformResponse	revokeToken(String token) Method to revoke OAuth2 tokens
boolean	validateIDToken(String idToken) Method to validate IDToken

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2PlatformClient

public OAuth2PlatformClient(OAuth2Config oauth2Config)

OAuth2PlatformClient

protected OAuth2PlatformClient()

Hiding the default constructor as OAuth2PlatformClient is always required to function properly

Method Detail

retrieveBearerTokens

public BearerTokenResponse retrieveBearerTokens(String authCode,
                                                String redirectURI)
                                         throws OAuthException

Method to retrieve OAuth2 access token by passing the redirectURI and authCode

Parameters:

auth_code -

redirectUri -

Returns:

Throws:

OAuthException

refreshToken

public BearerTokenResponse refreshToken(String refreshToken)
                                 throws OAuthException

Method to renew OAuth2 tokens by passing the refreshToken

Parameters:

refreshToken -

Returns:

Throws:

OAuthException

revokeToken

public PlatformResponse revokeToken(String token)
                             throws ConnectionException

Method to revoke OAuth2 tokens

Parameters:

token -

Returns:

Throws:

ConnectionException

getUserInfo

public UserInfoResponse getUserInfo(String accessToken)
                             throws OpenIdException

Method to retrieve UserInfo data associated with the accessToken generated The response depends on the Scope supplied during openId

Parameters:

accessToken -

Returns:

Throws:

OpenIdException

validateIDToken

public boolean validateIDToken(String idToken)
                        throws OpenIdException

Method to validate IDToken

Parameters:

idToken -

clientId -

Returns:

Throws:

OpenIdException