org.jboss.aerogear.android.impl.authz.oauth2

Class OAuth2AuthzModule

java.lang.Object

org.jboss.aerogear.android.impl.authz.oauth2.OAuth2AuthzModule

All Implemented Interfaces:

AuthzModule

public 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.

Author:

summers

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthzModule(AuthzConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationFields	getAuthorizationFields(URI requestUri, String method, byte[] requestBody) This method is called be Pipe implementations when they need security applied to their HttpProvider.
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.
boolean	refreshAccess() Refreshing access will synchronously check the current of the tokens and refresh them if necessary.
void	requestAccess(android.app.Activity activity, Callback<String> callback) Begin requesting access for the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2AuthzModule

public OAuth2AuthzModule(AuthzConfig config)

Method Detail

isAuthorized

public 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 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 void requestAccess(android.app.Activity activity,
                 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 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 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.