org.jboss.aerogear.android.authentication

Interface AuthenticationModule

All Superinterfaces:

org.jboss.aerogear.android.code.PipeModule

All Known Subinterfaces:

LoaderAuthenticationModule

All Known Implementing Classes:

AbstractAuthenticationModule, AuthenticationModuleAdapter, HttpBasicAuthenticationModule, HttpDigestAuthenticationModule, SupportAuthenticationModuleAdapter

public interface AuthenticationModule
extends org.jboss.aerogear.android.code.PipeModule

A module which can authenticate a user. It also provides the necessary tools to log a user in, out, and modify requests from a Pipe so they are seen as authenticated.

Method Summary

Modifier and Type	Method and Description
void	enroll(Map<String,String> userData, org.jboss.aerogear.android.Callback<org.jboss.aerogear.android.http.HeaderAndBody> callback) Will try to register a user with a service using userData.
org.jboss.aerogear.android.authentication.AuthorizationFields	getAuthorizationFields(URI requestUri, String method, byte[] requestBody) Deprecated. replaced by PipeModule.loadModule(java.net.URI, java.lang.String, byte[])
URL	getBaseURL()
String	getEnrollEndpoint()
String	getLoginEndpoint()
String	getLogoutEndpoint()
boolean	isLoggedIn()
void	login(Map<String,String> loginData, org.jboss.aerogear.android.Callback<org.jboss.aerogear.android.http.HeaderAndBody> callback) Will try to log in a user It will call the callbacks onSuccess with a parameter of a Map of the values returned by the enroll service or onFailure if there is an error
void	login(String username, String password, org.jboss.aerogear.android.Callback<org.jboss.aerogear.android.http.HeaderAndBody> callback) Will try to log in a user using username and password.
void	logout(org.jboss.aerogear.android.Callback<Void> callback) Performs a logout of the current user.
boolean	retryLogin() Deprecated. replaced by PipeModule.handleError(org.jboss.aerogear.android.http.HttpException)

Methods inherited from interface org.jboss.aerogear.android.code.PipeModule

handleError, loadModule

Method Detail

getBaseURL

URL getBaseURL()

getLoginEndpoint

String getLoginEndpoint()

getLogoutEndpoint

String getLogoutEndpoint()

getEnrollEndpoint

String getEnrollEndpoint()

enroll

void enroll(Map<String,String> userData,
            org.jboss.aerogear.android.Callback<org.jboss.aerogear.android.http.HeaderAndBody> callback)

Will try to register a user with a service using userData. It will call the callbacks onSuccess with a parameter of a Map of the values returned by the enroll service or onFailure if there is an error

Parameters:

userData - a collection of data to be passed to the server.

callback - a callback which will handle the server response.

login

void login(String username,
           String password,
           org.jboss.aerogear.android.Callback<org.jboss.aerogear.android.http.HeaderAndBody> callback)

Will try to log in a user using username and password. It will call the callbacks onSuccess with a parameter of a Map of the values returned by the enroll service or onFailure if there is an error

Parameters:

username - the users userName

password - the users Password

callback - a callback which will handle the server response.

login

void login(Map<String,String> loginData,
           org.jboss.aerogear.android.Callback<org.jboss.aerogear.android.http.HeaderAndBody> callback)

Will try to log in a user It will call the callbacks onSuccess with a parameter of a Map of the values returned by the enroll service or onFailure if there is an error

Parameters:

loginData - a map of data which will be passed to the server

callback - a callback which will handle the server response.

logout

void logout(org.jboss.aerogear.android.Callback<Void> callback)

Performs a logout of the current user. It will call callback.onSuccess with no value on success and callback.onFailure if there is an error.

Parameters:

callback - a callback which will handle the server response.

isLoggedIn

boolean isLoggedIn()

Returns:

true if the module has been logged in successfully

getAuthorizationFields

@Deprecated
org.jboss.aerogear.android.authentication.AuthorizationFields getAuthorizationFields(URI requestUri,
                                                                                                 String method,
                                                                                                 byte[] requestBody)

Deprecated. replaced by PipeModule.loadModule(java.net.URI, java.lang.String, byte[])

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

retryLogin

@Deprecated
boolean retryLogin()
                        throws org.jboss.aerogear.android.http.HttpException

Deprecated. replaced by PipeModule.handleError(org.jboss.aerogear.android.http.HttpException)

Some authorization schemes (HTTP Digest, OAUTH) have a mechanism for retrying a login to fetch fresh credentials after the credentials expire. In the event of a 401 error, this method should retry the login. If the system does not support retrying or if the retry fails then it will return false. Otherwise it returns true and refreshes the various credentials. This method is blocking and it should NOT be called by the user directly.

Returns:

whether or not retrying the login succeeded.

Throws:

org.jboss.aerogear.android.http.HttpException