org.jboss.aerogear.android.authentication

Interface AuthenticationModule

All Superinterfaces:

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

All Known Implementing Classes:

AbstractAuthenticationModule, HttpBasicAuthenticationModule, HttpDigestAuthenticationModule

public interface AuthenticationModule
extends org.jboss.aerogear.android.pipe.module.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.core.Callback<org.jboss.aerogear.android.pipe.http.HeaderAndBody> callback) Will try to register a user with a service using userData.
URL	getBaseURL()
String	getEnrollEndpoint()
String	getLoginEndpoint()
String	getLogoutEndpoint()
boolean	isLoggedIn()
void	login(Map<String,String> loginData, org.jboss.aerogear.android.core.Callback<org.jboss.aerogear.android.pipe.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.core.Callback<org.jboss.aerogear.android.pipe.http.HeaderAndBody> callback) Will try to log in a user using username and password.
void	logout(org.jboss.aerogear.android.core.Callback<Void> callback) Performs a logout of the current user.

Methods inherited from interface org.jboss.aerogear.android.pipe.module.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.core.Callback<org.jboss.aerogear.android.pipe.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.core.Callback<org.jboss.aerogear.android.pipe.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.core.Callback<org.jboss.aerogear.android.pipe.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.core.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