org.jboss.aerogear.android.authorization.oauth2

Class OAuth2AuthzModule

java.lang.Object

org.jboss.aerogear.android.authorization.oauth2.OAuth2AuthzModule

All Implemented Interfaces:

AuthzModule, org.jboss.aerogear.android.pipe.module.PipeModule

Direct Known Subclasses:

OAuth2IntentAuthzModule, OAuth2WebViewAuthzModule

public abstract class OAuth2AuthzModule
extends Object
implements AuthzModule

An Authorization module which works with the OAuth2 protocol. Authorization is performed in a WebView and returned to the calling activity.

Field Summary

Fields

Modifier and Type	Field and Description
protected OAuth2AuthzSession	account
protected String	accountId
protected String	clientId
protected OAuth2Properties	config
protected OAuth2AuthzService	service
String	TAG

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthzModule(OAuth2Properties config)

Method Summary

Modifier and Type	Method and Description
void	deleteAccount() This will remove all information about the account with the Module's AccountId
org.jboss.aerogear.android.pipe.module.AuthorizationFields	getAuthorizationFields(URI requestUri, String method, byte[] requestBody) This method is called be Pipe implementations when they need security applied to their HttpProvider.
boolean	handleError(org.jboss.aerogear.android.pipe.http.HttpException exception)
protected boolean	hasAccount()
boolean	hasCredentials() This function checks if a module has all of the necessary information to make a authorized request.
boolean	isAuthorized() If a module is Authorized that means that it can be used to provide authorization meta-data to calling code.
protected boolean	isNullOrEmpty(String testString)
org.jboss.aerogear.android.pipe.module.ModuleFields	loadModule(URI relativeURI, String httpMethod, byte[] requestBody)
boolean	refreshAccess() Refreshing access will synchronously check the current of the tokens and refresh them if necessary.
protected void	removeAccount() Removes the account used in the module.
abstract void	requestAccess(android.app.Activity activity, org.jboss.aerogear.android.core.Callback<String> callback) Begin requesting access for the application.
protected void	setAccount(OAuth2AuthzSession account) Sets the account used in the module.

Methods inherited from class java.lang.Object

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

Field Detail

accountId

protected final String accountId

clientId

protected final String clientId

config

protected final OAuth2Properties config

account

protected OAuth2AuthzSession account

service

protected OAuth2AuthzService service

TAG

public final String TAG

Constructor Detail

OAuth2AuthzModule

public OAuth2AuthzModule(OAuth2Properties config)

Method Detail

isAuthorized

public final boolean isAuthorized()

Description copied from interface: AuthzModule

If a module is Authorized that means that it can be used to provide authorization meta-data to calling code.

Specified by:

isAuthorized in interface AuthzModule

Returns:

if the module is in a state that allows it to be used.

hasCredentials

public final boolean hasCredentials()

Description copied from interface: AuthzModule

This function checks if a module has all of the necessary information to make a authorized request. This method does not check the state of those tokens. For that you should use AuthzModule.isAuthorized()

Specified by:

hasCredentials in interface AuthzModule

Returns:

if the module has completed Authorization.

requestAccess

public abstract void requestAccess(android.app.Activity activity,
                                   org.jboss.aerogear.android.core.Callback<String> callback)

Description copied from interface: AuthzModule

Begin requesting access for the application. This method MUST be asynchronous. An implementation MAY start a new activity, but the calling Activity MUST handle the response itself.

Specified by:

requestAccess in interface AuthzModule

Parameters:

activity - the calling activity.

callback - a callback to be called upon completion of the authorization action.

getAuthorizationFields

public final org.jboss.aerogear.android.pipe.module.AuthorizationFields getAuthorizationFields(URI requestUri,
                                                                                               String method,
                                                                                               byte[] requestBody)

Description copied from interface: AuthzModule

This method is called be Pipe implementations when they need security applied to their HttpProvider. The headers/data/query parameters returned should be applied to the Url and HttpProvider directly before a call.

Specified by:

getAuthorizationFields in interface AuthzModule

Parameters:

requestUri - the Request-Line URI.

method - the HTTP method being used

requestBody - the body of the request. This method promises to not modify the body.

Returns:

the current AuthorizationFields for security

refreshAccess

public final boolean refreshAccess()

Description copied from interface: AuthzModule

Refreshing access will synchronously check the current of the tokens and refresh them if necessary. This is used by AeroGear if tokens expired while a reference to the module is still held by a pipe.

Specified by:

refreshAccess in interface AuthzModule

Returns:

true if access to the system is in a good state.

hasAccount

protected boolean hasAccount()

Returns:

true if accountId has a value AND that value is stored in the OAuth2AuthzService

loadModule

public final org.jboss.aerogear.android.pipe.module.ModuleFields loadModule(URI relativeURI,
                                                                            String httpMethod,
                                                                            byte[] requestBody)

Specified by:

loadModule in interface org.jboss.aerogear.android.pipe.module.PipeModule

handleError

public final boolean handleError(org.jboss.aerogear.android.pipe.http.HttpException exception)

Specified by:

handleError in interface org.jboss.aerogear.android.pipe.module.PipeModule

deleteAccount

public final void deleteAccount()

Description copied from interface: AuthzModule

This will remove all information about the account with the Module's AccountId

Specified by:

deleteAccount in interface AuthzModule

isNullOrEmpty

protected boolean isNullOrEmpty(String testString)

setAccount

protected void setAccount(OAuth2AuthzSession account)

Sets the account used in the module.

Parameters:

account - a new account to use

removeAccount

protected void removeAccount()

Removes the account used in the module.