org.alfresco.mobile.android.api.session.authentication.impl

Class OAuthHelper

java.lang.Object

org.alfresco.mobile.android.api.session.authentication.impl.OAuthHelper

All Implemented Interfaces:

OAuthConstant

public final class OAuthHelper
extends Object
implements OAuthConstant

Utility class to manage the OAuth Flow for Alfresco Cloud.
An Alfresco application uses the OAuth 2.0 authorization code flow to authenticate itself with Alfresco Cloud and to allow users to authorize the application to access data on their behalf.
To use the Alfresco API, your application must first be registered with the Alfresco Developer Portal This class requires OAuth information like Api Key, Api Secret, callback URI...
If you need more informations on how Alfresco used OAuth and how it's implemented : Public API Presentation

Author:

Jean Marie Pascal

Field Summary

Fields inherited from interface org.alfresco.mobile.android.api.constants.OAuthConstant

PUBLIC_API_HOSTNAME, PUBLIC_API_OAUTH_AUTHORIZE_PATH, PUBLIC_API_OAUTH_AUTHORIZE_URL, PUBLIC_API_OAUTH_DEFAULT_CALLBACK, PUBLIC_API_OAUTH_TOKEN_PATH, PUBLIC_API_OAUTH_TOKEN_URL

Constructor Summary

Constructors

Constructor and Description
OAuthHelper()
OAuthHelper(String baseOAuthUrl) Override mechanism to set another base url.

Method Summary

Methods

Modifier and Type	Method and Description
OAuthData	getAccessToken(String apiKey, String apiSecret, String callback, String code) Retrieve the access token. Once the application has an authorization code, it can exchange this for an access token.
String	getAuthorizationUrl(String apiKey, String callback, String scope) Returns default authorization URL for the public API. Use this method in combination with a Webview to display the Server authentication form. All this information are available on Alfresco Developer Portal
OAuthData	refreshToken(OAuthData data) Request a new accestoken & refreshtoken based on OAuthData information.
static String	retrieveCode(String url) Retrieve the authorization code from the url callback uri.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthHelper

public OAuthHelper()

OAuthHelper

public OAuthHelper(String baseOAuthUrl)

Override mechanism to set another base url.
Used internally for test server.

Parameters:

baseOAuthUrl - : new base url like "https://myoauthtestserver.sample.com"

Method Detail

getAuthorizationUrl

public String getAuthorizationUrl(String apiKey,
                         String callback,
                         String scope)

Returns default authorization URL for the public API.
Use this method in combination with a Webview to display the Server authentication form.
All this information are available on Alfresco Developer Portal

Parameters:

apiKey - : API key associated to your application.

callback - : Callback URI associated to your application.

scope - : Scope associated to your application. You should always use the value public_api for scope.

Returns:

well formatted url to display the authentication form.

retrieveCode

public static String retrieveCode(String url)

Retrieve the authorization code from the url callback uri.
If user has access, Alfresco grant access and invoke the callback URI with the authorization code.

Parameters:

url - : Callback uri that contains authorization code.

Returns:

authorization code.

getAccessToken

public OAuthData getAccessToken(String apiKey,
                       String apiSecret,
                       String callback,
                       String code)

Retrieve the access token.
Once the application has an authorization code, it can exchange this for an access token. The access token is valid for one hour.

Parameters:

apiKey - : API key associated to your application.

apiSecret - : API secret key associated to your application.

callback - : Callback URI associated to your application.

code - : Authorization code

Returns:

OAuthData object that can be used to make authenticated calls using the Alfresco API.

Throws:

AlfrescoSessionException - SESSION_API_KEYS_INVALID : API key or secret were not recognized.

AlfrescoSessionException - SESSION_AUTH_CODE_INVALID : Authorization code is invalid or expired.

refreshToken

public OAuthData refreshToken(OAuthData data)

Request a new accestoken & refreshtoken based on OAuthData information.
Note that you can refresh the access token at any time before the timeout expires. The old access token becomes invalid when the new one is granted. The new refresh token supplied in the response body can be used in the same way.

Parameters:

data - : OAuthData object available from your cloud session object : CloudSession.getOAuthData()

Returns:

OAuthData object that can be used to make authenticated calls using the Alfresco API.

Throws:

AlfrescoSessionException - SESSION_API_KEYS_INVALID : API key or secret were not recognized.

AlfrescoSessionException - SESSION_AUTH_CODE_INVALID : Refresh token is invalid or expired.