com.vordel.oauth.client.providers

Class BaseOAuth2Provider

java.lang.Object

com.vordel.oauth.client.providers.BaseOAuth2Provider

All Implemented Interfaces:

com.vordel.oauth.client.providers.OAuth2ProviderInterface

public class BaseOAuth2Provider
extends java.lang.Object
implements com.vordel.oauth.client.providers.OAuth2ProviderInterface

Provides a base implementation for OAuth Providers. Providers may have custom formats for tokens and token requests. This object implements a basic Provider and may be extended to accommodate Provider specifics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseOAuth2Provider.BodyType

Field Summary

Fields

Modifier and Type	Field and Description
protected static javax.xml.bind.JAXBContext	jc
protected static com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Constructor and Description
BaseOAuth2Provider()

Method Summary

Modifier and Type	Method and Description
com.vordel.oauth.client.store.OAuth2ClientAccessToken	extractToken(java.lang.Object body, java.lang.String authenticationID, java.lang.String clientID) Extracts the access token from from the Object body.
protected com.vordel.oauth.client.store.OAuth2ClientAccessToken	initializeToken(java.lang.String authenticationID, java.lang.String clientID, com.vordel.oauth.client.ClientAccessToken obj)
boolean	isTokenInvalid(java.lang.Integer rspStatus, java.lang.String authenticateHeader)
com.vordel.oauth.client.OAuthTokenRequest	modifyRequest(com.vordel.oauth.client.OAuthTokenRequest tokenRequest) Modifies an OAuthTokenRequest object with provider specific information
com.vordel.circuit.net.OAuthConnectionHandler.OAuthState	modifyState(com.vordel.circuit.net.OAuthConnectionHandler.OAuthState state, com.vordel.oauth.client.store.OAuth2ClientAccessToken token)
protected com.vordel.oauth.client.ClientAccessToken	parseTokenString(java.lang.String theString)
protected com.vordel.oauth.client.store.OAuth2ClientAccessToken	retrieveTokenFromJSON(com.fasterxml.jackson.databind.JsonNode body, java.lang.String clientID, java.lang.String authenticationID)
protected com.vordel.oauth.client.store.OAuth2ClientAccessToken	retrieveTokenFromRawBody(java.lang.Object body, java.lang.String clientID, java.lang.String authenticationID)
protected com.vordel.oauth.client.store.OAuth2ClientAccessToken	retrieveTokenFromXML(org.w3c.dom.Document body, java.lang.String clientID, java.lang.String authenticationID)

Methods inherited from class java.lang.Object

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

Field Detail

mapper

protected static com.fasterxml.jackson.databind.ObjectMapper mapper

jc

protected static javax.xml.bind.JAXBContext jc

Constructor Detail

BaseOAuth2Provider

public BaseOAuth2Provider()

Method Detail

extractToken

public com.vordel.oauth.client.store.OAuth2ClientAccessToken extractToken(java.lang.Object body,
                                                                          java.lang.String authenticationID,
                                                                          java.lang.String clientID)
                                                                   throws java.lang.Exception

Extracts the access token from from the Object body. The body may be a Json object JsonNode or and XML Document

Specified by:

extractToken in interface com.vordel.oauth.client.providers.OAuth2ProviderInterface

Parameters:

authenticationID - The authentication id of the user (Resource Owner)

clientID - the id of the Client Application

Returns:

OAuth2ClientAccessToken

Throws:

java.lang.Exception

retrieveTokenFromRawBody

protected com.vordel.oauth.client.store.OAuth2ClientAccessToken retrieveTokenFromRawBody(java.lang.Object body,
                                                                                         java.lang.String clientID,
                                                                                         java.lang.String authenticationID)
                                                                                  throws java.io.IOException

Throws:

java.io.IOException

parseTokenString

protected com.vordel.oauth.client.ClientAccessToken parseTokenString(java.lang.String theString)

retrieveTokenFromXML

protected com.vordel.oauth.client.store.OAuth2ClientAccessToken retrieveTokenFromXML(org.w3c.dom.Document body,
                                                                                     java.lang.String clientID,
                                                                                     java.lang.String authenticationID)
                                                                              throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException

retrieveTokenFromJSON

protected com.vordel.oauth.client.store.OAuth2ClientAccessToken retrieveTokenFromJSON(com.fasterxml.jackson.databind.JsonNode body,
                                                                                      java.lang.String clientID,
                                                                                      java.lang.String authenticationID)
                                                                               throws java.io.IOException

Throws:

java.io.IOException

initializeToken

protected com.vordel.oauth.client.store.OAuth2ClientAccessToken initializeToken(java.lang.String authenticationID,
                                                                                java.lang.String clientID,
                                                                                com.vordel.oauth.client.ClientAccessToken obj)

modifyRequest

public com.vordel.oauth.client.OAuthTokenRequest modifyRequest(com.vordel.oauth.client.OAuthTokenRequest tokenRequest)

Modifies an OAuthTokenRequest object with provider specific information

Provider classes that extend the BasOAuth2Provider class can customise the the token request

Specified by:

modifyRequest in interface com.vordel.oauth.client.providers.OAuth2ProviderInterface

Parameters:

tokenRequest - Token request to be modified

Returns:

the modified OAuthTokenRequest

isTokenInvalid

public boolean isTokenInvalid(java.lang.Integer rspStatus,
                              java.lang.String authenticateHeader)

Specified by:

isTokenInvalid in interface com.vordel.oauth.client.providers.OAuth2ProviderInterface

modifyState

public com.vordel.circuit.net.OAuthConnectionHandler.OAuthState modifyState(com.vordel.circuit.net.OAuthConnectionHandler.OAuthState state,
                                                                            com.vordel.oauth.client.store.OAuth2ClientAccessToken token)

Specified by:

modifyState in interface com.vordel.oauth.client.providers.OAuth2ProviderInterface