org.jboss.aerogear.android.authorization

Interface AuthzModule

All Superinterfaces:

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

All Known Implementing Classes:

OAuth2AuthzModule, OAuth2IntentAuthzModule, OAuth2WebViewAuthzModule

public interface AuthzModule
extends org.jboss.aerogear.android.pipe.module.PipeModule

The AuthzModule wraps access to Authorization providers and exposes authorization state and tokens to Android applications.

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	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, org.jboss.aerogear.android.core.Callback<String> callback) Begin requesting access for the application.

Methods inherited from interface org.jboss.aerogear.android.pipe.module.PipeModule

handleError, loadModule

Method Detail

isAuthorized

boolean isAuthorized()

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

Returns:

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

hasCredentials

boolean hasCredentials()

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 isAuthorized()

Returns:

if the module has completed Authorization.

requestAccess

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

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.

Parameters:

activity - the calling activity.

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

refreshAccess

boolean refreshAccess()

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.

Returns:

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

deleteAccount

void deleteAccount()

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

getAuthorizationFields

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. The headers/data/query parameters returned should be applied to the Url and HttpProvider directly before a call.

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