com.manydesigns.portofino.oauth

Class OAuthHelper

java.lang.Object

com.manydesigns.portofino.oauth.OAuthHelper

public class OAuthHelper
extends Object

Utility class for generic OAuth authorization

Author:

Paolo Predonzani - paolo.predonzani@manydesigns.com, Angelo Lupo - angelo.lupo@manydesigns.com, Giampiero Granatella - giampiero.granatella@manydesigns.com, Alessio Stalla - alessio.stalla@manydesigns.com

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.api.client.auth.oauth2.Credential.AccessMethod	accessMethod
protected ActionBeanContext	actionBeanContext
protected String	authorizationServerUrl
protected String	authorizeMethod
protected String	clientId
protected String	clientSecret
static String	copyright
protected com.google.api.client.auth.oauth2.CredentialStore	credentialStore
protected String	error
protected com.google.api.client.http.HttpTransport	httpTransport
protected static com.google.api.client.json.JsonFactory	JSON_FACTORY
static org.slf4j.Logger	logger
protected Collection<String>	scopes
protected String	tokenServerUrl

Constructor Summary

Constructors

Constructor and Description
OAuthHelper(ActionBeanContext actionBeanContext, String tokenServerUrl, String authorizationServerUrl, Collection<String> scopes, String clientId, String clientSecret)
OAuthHelper(ActionBeanContext actionBeanContext, String tokenServerUrl, String authorizationServerUrl, String scope, String clientId, String clientSecret)

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.auth.oauth2.Credential	authorize() Handles the callback from the OAuth provider, returning a valid Credential if successful.
com.google.api.client.auth.oauth2.Credential	authorize(HttpServletRequest request, String userId) Handles the callback from the OAuth provider, returning a valid Credential if successful.
com.google.api.client.auth.oauth2.Credential	authorize(String code, String userId) Handles the callback from the OAuth provider, returning a valid Credential if successful.
String	computeAuthorizationUrl() Returns a URL where the user should be redirected in order to authorize access to the selected resources.
protected com.google.api.client.auth.oauth2.AuthorizationCodeFlow	createCodeFlow()
Resolution	doWithCredential(Callable<Resolution> action) Executes an action if the current logged in user's credential is known, otherwise redirects to the authorization page.
Resolution	doWithCredential(String userId, Callable<Resolution> action) Executes an action if the user's credential is known, otherwise redirects to the authorization page.
com.google.api.client.auth.oauth2.Credential.AccessMethod	getAccessMethod()
String	getAuthorizeMethod()
com.google.api.client.auth.oauth2.CredentialStore	getCredentialStore()
String	getError()
protected com.google.api.client.http.HttpExecuteInterceptor	getHttpExecuteInterceptor()
com.google.api.client.http.HttpTransport	getHttpTransport()
com.google.api.client.json.JsonFactory	getJsonFactory()
String	getRedirectUrl()
com.google.api.client.auth.oauth2.Credential	loadCredential(String userId)
void	setAccessMethod(com.google.api.client.auth.oauth2.Credential.AccessMethod accessMethod)
void	setAuthorizeMethod(String authorizeMethod)
void	setCredentialStore(com.google.api.client.auth.oauth2.CredentialStore credentialStore)
void	setHttpTransport(com.google.api.client.http.HttpTransport httpTransport)

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

logger

public static final org.slf4j.Logger logger

credentialStore

protected com.google.api.client.auth.oauth2.CredentialStore credentialStore

authorizeMethod

protected String authorizeMethod

httpTransport

protected com.google.api.client.http.HttpTransport httpTransport

accessMethod

protected com.google.api.client.auth.oauth2.Credential.AccessMethod accessMethod

JSON_FACTORY

protected static final com.google.api.client.json.JsonFactory JSON_FACTORY

actionBeanContext

protected final ActionBeanContext actionBeanContext

tokenServerUrl

protected final String tokenServerUrl

authorizationServerUrl

protected final String authorizationServerUrl

scopes

protected final Collection<String> scopes

clientId

protected final String clientId

clientSecret

protected final String clientSecret

error

protected String error

Constructor Detail

OAuthHelper

public OAuthHelper(ActionBeanContext actionBeanContext,
           String tokenServerUrl,
           String authorizationServerUrl,
           Collection<String> scopes,
           String clientId,
           String clientSecret)

OAuthHelper

public OAuthHelper(ActionBeanContext actionBeanContext,
           String tokenServerUrl,
           String authorizationServerUrl,
           String scope,
           String clientId,
           String clientSecret)

Method Detail

computeAuthorizationUrl

public String computeAuthorizationUrl()

Returns a URL where the user should be redirected in order to authorize access to the selected resources.

Returns:

the authorization URL.

getRedirectUrl

public String getRedirectUrl()

authorize

public com.google.api.client.auth.oauth2.Credential authorize(String code,
                                                     @Nullable
                                                     String userId)
                                                       throws IOException

Handles the callback from the OAuth provider, returning a valid Credential if successful.

Parameters:

code -

userId -

Returns:

Throws:

IOException

authorize

public com.google.api.client.auth.oauth2.Credential authorize(HttpServletRequest request,
                                                     String userId)
                                                       throws IOException

Handles the callback from the OAuth provider, returning a valid Credential if successful.

Parameters:

request -

userId -

Returns:

Throws:

IOException

authorize

public com.google.api.client.auth.oauth2.Credential authorize()
                                                       throws IOException

Handles the callback from the OAuth provider, returning a valid Credential if successful. Automatically uses the current request and the logged in user.

Returns:

Throws:

IOException

doWithCredential

public Resolution doWithCredential(String userId,
                          Callable<Resolution> action)

Executes an action if the user's credential is known, otherwise redirects to the authorization page.

Parameters:

userId -

action -

Returns:

doWithCredential

public Resolution doWithCredential(Callable<Resolution> action)

Executes an action if the current logged in user's credential is known, otherwise redirects to the authorization page.

Parameters:

action -

Returns:

createCodeFlow

protected com.google.api.client.auth.oauth2.AuthorizationCodeFlow createCodeFlow()

getHttpExecuteInterceptor

protected com.google.api.client.http.HttpExecuteInterceptor getHttpExecuteInterceptor()

loadCredential

public com.google.api.client.auth.oauth2.Credential loadCredential(String userId)

getCredentialStore

public com.google.api.client.auth.oauth2.CredentialStore getCredentialStore()

setCredentialStore

public void setCredentialStore(com.google.api.client.auth.oauth2.CredentialStore credentialStore)

getAuthorizeMethod

public String getAuthorizeMethod()

setAuthorizeMethod

public void setAuthorizeMethod(String authorizeMethod)

getHttpTransport

public com.google.api.client.http.HttpTransport getHttpTransport()

setHttpTransport

public void setHttpTransport(com.google.api.client.http.HttpTransport httpTransport)

getAccessMethod

public com.google.api.client.auth.oauth2.Credential.AccessMethod getAccessMethod()

setAccessMethod

public void setAccessMethod(com.google.api.client.auth.oauth2.Credential.AccessMethod accessMethod)

getError

public String getError()

getJsonFactory

public com.google.api.client.json.JsonFactory getJsonFactory()