com.box.androidsdk.content.auth

Class BoxAuthentication

java.lang.Object

com.box.androidsdk.content.auth.BoxAuthentication

public class BoxAuthentication
extends java.lang.Object

Handles authentication and stores authentication information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BoxAuthentication.AuthenticationRefreshProvider An interface that should be implemented if using a custom authentication scheme and not the default oauth 2 based token refresh logic.
static interface	BoxAuthentication.AuthListener Interface of a listener to listen to authentication events.
static class	BoxAuthentication.AuthStorage Storage class to store auth info.
static class	BoxAuthentication.BoxAuthenticationInfo Object holding authentication info.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.concurrent.ThreadPoolExecutor	AUTH_EXECUTOR

Method Summary

Modifier and Type	Method and Description
void	addListener(BoxAuthentication.AuthListener listener) Add listener to listen to the authentication process for this BoxSession.
java.util.concurrent.FutureTask<BoxAuthentication.BoxAuthenticationInfo>	create(BoxSession session, java.lang.String code) Create Oauth for the first time.
BoxAuthentication.BoxAuthenticationInfo	getAuthInfo(java.lang.String userId, android.content.Context context) Get the BoxAuthenticationInfo for a given user.
BoxAuthentication.AuthStorage	getAuthStorage()
static BoxAuthentication	getInstance() Get singleton instance of the BoxAuthentication object.
java.lang.String	getLastAuthenticatedUserId(android.content.Context context) Get the user id that was last authenticated.
java.util.Set<BoxAuthentication.AuthListener>	getListeners()
BoxAuthentication.AuthenticationRefreshProvider	getRefreshProvider() Get the refresh provider if singleton was created with one, or one was set.
java.util.Map<java.lang.String,BoxAuthentication.BoxAuthenticationInfo>	getStoredAuthInfo(android.content.Context context) Get a map of all stored auth information.
static boolean	isBoxAuthAppAvailable(android.content.Context context) A check to see if an official box application supporting third party authentication is available.
void	logout(BoxSession session) Log out current BoxSession.
void	logoutAllUsers(android.content.Context context) Log out all users.
void	onAuthenticated(BoxAuthentication.BoxAuthenticationInfo info, android.content.Context context) Callback method to be called when authentication process finishes.
void	onAuthenticationFailure(BoxAuthentication.BoxAuthenticationInfo info, java.lang.Exception ex) Callback method to be called if authentication process fails.
void	onLoggedOut(BoxAuthentication.BoxAuthenticationInfo info, java.lang.Exception ex) Callback method to be called on logout.
java.util.concurrent.FutureTask<BoxAuthentication.BoxAuthenticationInfo>	refresh(BoxSession session) Refresh the OAuth in the given BoxSession.
void	setAuthStorage(BoxAuthentication.AuthStorage storage) Set the storage to store auth information.
void	setRefreshProvider(BoxAuthentication.AuthenticationRefreshProvider refreshProvider)
protected void	startAuthenticateUI(BoxSession session) Start authentication UI.
void	startAuthenticationUI(BoxSession session) Launch ui to authenticate.

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_EXECUTOR

public static final java.util.concurrent.ThreadPoolExecutor AUTH_EXECUTOR

Method Detail

getAuthInfo

public BoxAuthentication.BoxAuthenticationInfo getAuthInfo(java.lang.String userId,
                                                           android.content.Context context)

Get the BoxAuthenticationInfo for a given user.

Parameters:

userId - the user id to get auth info for.

context - current context used for accessing resource.

Returns:

the BoxAuthenticationInfo for a given user.

getStoredAuthInfo

public java.util.Map<java.lang.String,BoxAuthentication.BoxAuthenticationInfo> getStoredAuthInfo(android.content.Context context)

Get a map of all stored auth information.

Parameters:

context - current context.

Returns:

a map with all stored user information, or null if no user info has been stored.

getLastAuthenticatedUserId

public java.lang.String getLastAuthenticatedUserId(android.content.Context context)

Get the user id that was last authenticated.

Parameters:

context - current context.

Returns:

the user id that was last authenticated or null if it does not exist or was removed.

getInstance

public static BoxAuthentication getInstance()

Get singleton instance of the BoxAuthentication object.

Returns:

singleton instance of the BoxAuthentication object.

setAuthStorage

public void setAuthStorage(BoxAuthentication.AuthStorage storage)

Set the storage to store auth information. By default, sharedpref is used. You can use this method to use your own storage class that extends the AuthStorage.

Parameters:

storage - set a custom implementation of AuthStorage.

getAuthStorage

public BoxAuthentication.AuthStorage getAuthStorage()

Returns:

Get the auth storage used to store auth information.

getRefreshProvider

public BoxAuthentication.AuthenticationRefreshProvider getRefreshProvider()

Get the refresh provider if singleton was created with one, or one was set.

Returns:

the custom refresh provider implementation if set.

setRefreshProvider

public void setRefreshProvider(BoxAuthentication.AuthenticationRefreshProvider refreshProvider)

Parameters:

refreshProvider - a custom refresh provider in case developer is using app user.

startAuthenticationUI

public void startAuthenticationUI(BoxSession session)

Launch ui to authenticate.

Parameters:

session - to authenticate using ui.

onAuthenticated

public void onAuthenticated(BoxAuthentication.BoxAuthenticationInfo info,
                            android.content.Context context)

Callback method to be called when authentication process finishes.

Parameters:

info - the authentication information that successfully authenticated.

context - the current application context (that can be used to launch ui or access resources).

onAuthenticationFailure

public void onAuthenticationFailure(BoxAuthentication.BoxAuthenticationInfo info,
                                    java.lang.Exception ex)

Callback method to be called if authentication process fails.

Parameters:

info - the authentication information associated with the failed authentication.

ex - the exception if appliable that caused the logout.

onLoggedOut

public void onLoggedOut(BoxAuthentication.BoxAuthenticationInfo info,
                        java.lang.Exception ex)

Callback method to be called on logout.

Parameters:

info - the authentication information associated with the user that was logged out.

ex - the exception if appliable that caused the logout.

getListeners

public java.util.Set<BoxAuthentication.AuthListener> getListeners()

Returns:

all listeners set to listen to authentication process

logout

public void logout(BoxSession session)

Log out current BoxSession. After logging out, the authentication information related to the Box user in this session will be gone.

Parameters:

session - session to logout user from

logoutAllUsers

public void logoutAllUsers(android.content.Context context)

Log out all users. After logging out, all authentication information will be gone.

Parameters:

context - current context

create

public java.util.concurrent.FutureTask<BoxAuthentication.BoxAuthenticationInfo> create(BoxSession session,
                                                                                       java.lang.String code)
                                                                                throws BoxException

Create Oauth for the first time. This method should be called by ui to authenticate the user for the first time.

Parameters:

session - a box session with all the necessary information to authenticate the user for the first time.

code - the code returned by web page necessary to authenticate.

Returns:

a future task allowing monitoring of the api call.

Throws:

BoxException - thrown if there are any errors in creating this session.

refresh

public java.util.concurrent.FutureTask<BoxAuthentication.BoxAuthenticationInfo> refresh(BoxSession session)
                                                                                 throws BoxException

Refresh the OAuth in the given BoxSession. This method is called when OAuth token expires.

Parameters:

session - a box session with all the necessary information to authenticate the user for the first time.

Returns:

a future task allowing monitoring of the api call.

Throws:

BoxException - thrown if there are any errors in refreshing this session.

addListener

public void addListener(BoxAuthentication.AuthListener listener)

Add listener to listen to the authentication process for this BoxSession.

Parameters:

listener - listener for authentication

startAuthenticateUI

protected void startAuthenticateUI(BoxSession session)

Start authentication UI.

Parameters:

session - the session to authenticate.

isBoxAuthAppAvailable

public static boolean isBoxAuthAppAvailable(android.content.Context context)

A check to see if an official box application supporting third party authentication is available. This lets users authenticate without re-entering credentials.

Parameters:

context - current context

Returns:

true if an official box application that supports third party authentication is installed.