com.box.androidsdk.content.auth

Class OAuthActivity

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.view.ContextThemeWrapper

android.app.Activity

com.box.androidsdk.content.auth.OAuthActivity

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.view.KeyEvent.Callback, android.view.LayoutInflater.Factory, android.view.LayoutInflater.Factory2, android.view.View.OnCreateContextMenuListener, android.view.Window.Callback, ChooseAuthenticationFragment.OnAuthenticationChosen, OAuthWebView.OAuthWebViewClient.WebEventListener, OAuthWebView.OnPageFinishedListener

public class OAuthActivity
extends android.app.Activity
implements ChooseAuthenticationFragment.OnAuthenticationChosen, OAuthWebView.OAuthWebViewClient.WebEventListener, OAuthWebView.OnPageFinishedListener

Activity for OAuth. Use this activity by using the intent from createOAuthActivityIntent method. On completion, this activity will put the parcelable BoxAndroidClient into the activity result. In the case of failure, the activity result will be Activity.RESULT_CANCELED together will a error message in the intent extra.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTH_CODE
static java.lang.String	AUTH_INFO
static int	AUTH_TYPE_APP
static int	AUTH_TYPE_WEBVIEW
static java.lang.String	EXTRA_DISABLE_ACCOUNT_CHOOSING An optional boolean that can be set when creating the intent to launch this activity.
static java.lang.String	EXTRA_SESSION
static java.lang.String	EXTRA_USER_ID_RESTRICTION
protected static java.lang.String	IS_LOGGING_IN_VIA_BOX_APP
protected static java.lang.String	LOGIN_VIA_BOX_APP
protected OAuthWebView.OAuthWebViewClient	oauthClient
protected OAuthWebView	oauthView
static int	REQUEST_BOX_APP_FOR_AUTH_CODE
static java.lang.String	USER_ID

Fields inherited from class android.app.Activity

DEFAULT_KEYS_DIALER, DEFAULT_KEYS_DISABLE, DEFAULT_KEYS_SEARCH_GLOBAL, DEFAULT_KEYS_SEARCH_LOCAL, DEFAULT_KEYS_SHORTCUT, FOCUSED_STATE_SET, RESULT_CANCELED, RESULT_FIRST_USER, RESULT_OK

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, FINGERPRINT_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
OAuthActivity()

Method Summary

Modifier and Type	Method and Description
static android.content.Intent	createOAuthActivityIntent(android.content.Context context, BoxSession session, boolean loginViaBoxApp) Create intent to launch OAuthActivity using information from the given session.
static android.content.Intent	createOAuthActivityIntent(android.content.Context context, java.lang.String clientId, java.lang.String clientSecret, java.lang.String redirectUrl, boolean loginViaBoxApp) Create intent to launch OAuthActivity.
protected OAuthWebView	createOAuthView()
protected OAuthWebView.OAuthWebViewClient	createOAuthWebViewClient()
protected void	dismissSpinner()
protected void	dismissSpinnerAndFailAuthenticate(java.lang.Exception e)
protected void	dismissSpinnerAndFinishAuthenticate(BoxAuthentication.BoxAuthenticationInfo auth)
void	finish()
protected android.content.Intent	getBoxAuthApp()
protected int	getContentView()
protected int	getOAuthWebViewRId()
protected void	onActivityResult(int requestCode, int resultCode, android.content.Intent data)
void	onAuthenticationChosen(BoxAuthentication.BoxAuthenticationInfo authInfo)
boolean	onAuthFailure(OAuthWebView.AuthFailure failure) Callback method to be called when authentication failed.
void	onBackPressed()
void	onCreate(android.os.Bundle savedInstanceState)
void	onDestroy()
void	onDifferentAuthenticationChosen() Called if a user chooses to login as a "different account".
void	onPageFinished(android.webkit.WebView view, java.lang.String url)
void	onReceivedAuthCode(java.lang.String code) Callback method to be called when authentication code is received.
void	onReceivedAuthCode(java.lang.String code, java.lang.String baseDomain) Callback method to be called when authentication code is received along with a base domain.
protected void	onResume()
protected void	onSaveInstanceState(android.os.Bundle outState)
protected android.app.Dialog	showDialogWhileWaitingForAuthenticationAPICall() If you don't need the dialog, just return null.
protected void	showSpinner()
protected void	startMakingOAuthAPICall(java.lang.String code, java.lang.String baseDomain) Start to create OAuth after getting the code.
protected void	startOAuth()

Methods inherited from class android.app.Activity

addContentView, closeContextMenu, closeOptionsMenu, createPendingResult, dismissDialog, dispatchGenericMotionEvent, dispatchKeyEvent, dispatchKeyShortcutEvent, dispatchPopulateAccessibilityEvent, dispatchTouchEvent, dispatchTrackballEvent, dump, findViewById, finishActivity, finishActivityFromChild, finishAffinity, finishAfterTransition, finishAndRemoveTask, finishFromChild, getActionBar, getApplication, getCallingActivity, getCallingPackage, getChangingConfigurations, getComponentName, getContentScene, getContentTransitionManager, getCurrentFocus, getFragmentManager, getIntent, getLastNonConfigurationInstance, getLayoutInflater, getLoaderManager, getLocalClassName, getMediaController, getMenuInflater, getParent, getParentActivityIntent, getPreferences, getReferrer, getRequestedOrientation, getSearchEvent, getSystemService, getTaskId, getTitle, getTitleColor, getVoiceInteractor, getVolumeControlStream, getWindow, getWindowManager, hasWindowFocus, invalidateOptionsMenu, isChangingConfigurations, isChild, isDestroyed, isFinishing, isImmersive, isTaskRoot, isVoiceInteraction, isVoiceInteractionRoot, managedQuery, moveTaskToBack, navigateUpTo, navigateUpToFromChild, onActionModeFinished, onActionModeStarted, onActivityReenter, onApplyThemeResource, onAttachedToWindow, onAttachFragment, onChildTitleChanged, onConfigurationChanged, onContentChanged, onContextItemSelected, onContextMenuClosed, onCreate, onCreateContextMenu, onCreateDescription, onCreateDialog, onCreateDialog, onCreateNavigateUpTaskStack, onCreateOptionsMenu, onCreatePanelMenu, onCreatePanelView, onCreateThumbnail, onCreateView, onCreateView, onDetachedFromWindow, onEnterAnimationComplete, onGenericMotionEvent, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyShortcut, onKeyUp, onLowMemory, onMenuItemSelected, onMenuOpened, onNavigateUp, onNavigateUpFromChild, onNewIntent, onOptionsItemSelected, onOptionsMenuClosed, onPanelClosed, onPause, onPostCreate, onPostCreate, onPostResume, onPrepareDialog, onPrepareDialog, onPrepareNavigateUpTaskStack, onPrepareOptionsMenu, onPreparePanel, onProvideAssistContent, onProvideAssistData, onProvideReferrer, onRequestPermissionsResult, onRestart, onRestoreInstanceState, onRestoreInstanceState, onRetainNonConfigurationInstance, onSaveInstanceState, onSearchRequested, onSearchRequested, onStart, onStateNotSaved, onStop, onTitleChanged, onTouchEvent, onTrackballEvent, onTrimMemory, onUserInteraction, onUserLeaveHint, onVisibleBehindCanceled, onWindowAttributesChanged, onWindowFocusChanged, onWindowStartingActionMode, onWindowStartingActionMode, openContextMenu, openOptionsMenu, overridePendingTransition, postponeEnterTransition, recreate, registerForContextMenu, releaseInstance, removeDialog, reportFullyDrawn, requestPermissions, requestVisibleBehind, requestWindowFeature, runOnUiThread, setActionBar, setContentTransitionManager, setContentView, setContentView, setContentView, setDefaultKeyMode, setEnterSharedElementCallback, setExitSharedElementCallback, setFeatureDrawable, setFeatureDrawableAlpha, setFeatureDrawableResource, setFeatureDrawableUri, setFinishOnTouchOutside, setImmersive, setIntent, setMediaController, setProgress, setProgressBarIndeterminate, setProgressBarIndeterminateVisibility, setProgressBarVisibility, setRequestedOrientation, setResult, setResult, setSecondaryProgress, setTaskDescription, setTitle, setTitle, setTitleColor, setVisible, setVolumeControlStream, shouldShowRequestPermissionRationale, shouldUpRecreateTask, showAssist, showDialog, showDialog, showLockTaskEscapeMessage, startActionMode, startActionMode, startActivities, startActivities, startActivity, startActivity, startActivityForResult, startActivityForResult, startActivityFromChild, startActivityFromChild, startActivityFromFragment, startActivityFromFragment, startActivityIfNeeded, startActivityIfNeeded, startIntentSender, startIntentSender, startIntentSenderForResult, startIntentSenderForResult, startIntentSenderFromChild, startIntentSenderFromChild, startLockTask, startManagingCursor, startNextMatchingActivity, startNextMatchingActivity, startPostponedEnterTransition, startSearch, stopLockTask, stopManagingCursor, takeKeyEvents, triggerSearch, unregisterForContextMenu

Methods inherited from class android.view.ContextThemeWrapper

applyOverrideConfiguration, attachBaseContext, getResources, getTheme, setTheme

Methods inherited from class android.content.ContextWrapper

bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getSharedPreferences, getSystemServiceName, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isRestricted, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setWallpaper, setWallpaper, startInstrumentation, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_BOX_APP_FOR_AUTH_CODE

public static final int REQUEST_BOX_APP_FOR_AUTH_CODE

See Also:

Constant Field Values

AUTH_CODE

public static final java.lang.String AUTH_CODE

See Also:

Constant Field Values

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

EXTRA_USER_ID_RESTRICTION

public static final java.lang.String EXTRA_USER_ID_RESTRICTION

See Also:

Constant Field Values

EXTRA_SESSION

public static final java.lang.String EXTRA_SESSION

See Also:

Constant Field Values

EXTRA_DISABLE_ACCOUNT_CHOOSING

public static final java.lang.String EXTRA_DISABLE_ACCOUNT_CHOOSING

An optional boolean that can be set when creating the intent to launch this activity. If set to true it will go directly to login flow, otherwise UI will be shown to let the user choose an already authenticated account first.

See Also:

Constant Field Values

AUTH_TYPE_WEBVIEW

public static final int AUTH_TYPE_WEBVIEW

See Also:

Constant Field Values

AUTH_TYPE_APP

public static final int AUTH_TYPE_APP

See Also:

Constant Field Values

LOGIN_VIA_BOX_APP

protected static final java.lang.String LOGIN_VIA_BOX_APP

See Also:

Constant Field Values

IS_LOGGING_IN_VIA_BOX_APP

protected static final java.lang.String IS_LOGGING_IN_VIA_BOX_APP

See Also:

Constant Field Values

AUTH_INFO

public static final java.lang.String AUTH_INFO

See Also:

Constant Field Values

oauthView

protected OAuthWebView oauthView

oauthClient

protected OAuthWebView.OAuthWebViewClient oauthClient

Constructor Detail

OAuthActivity

public OAuthActivity()

Method Detail

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

Overrides:

onCreate in class android.app.Activity

onResume

protected void onResume()

Overrides:

onResume in class android.app.Activity

onSaveInstanceState

protected void onSaveInstanceState(android.os.Bundle outState)

Overrides:

onSaveInstanceState in class android.app.Activity

onReceivedAuthCode

public void onReceivedAuthCode(java.lang.String code)

Callback method to be called when authentication code is received. The code will then be used to make an API call to create OAuth tokens.

Specified by:

onReceivedAuthCode in interface OAuthWebView.OAuthWebViewClient.WebEventListener

onReceivedAuthCode

public void onReceivedAuthCode(java.lang.String code,
                               java.lang.String baseDomain)

Callback method to be called when authentication code is received along with a base domain. The code will then be used to make an API call to create OAuth tokens.

Specified by:

onReceivedAuthCode in interface OAuthWebView.OAuthWebViewClient.WebEventListener

finish

public void finish()

Overrides:

finish in class android.app.Activity

onPageFinished

public void onPageFinished(android.webkit.WebView view,
                           java.lang.String url)

Specified by:

onPageFinished in interface OAuthWebView.OnPageFinishedListener

onAuthFailure

public boolean onAuthFailure(OAuthWebView.AuthFailure failure)

Callback method to be called when authentication failed.

Specified by:

onAuthFailure in interface OAuthWebView.OAuthWebViewClient.WebEventListener

Parameters:

failure - the failure that caused authentication to fail.

Returns:

true if this is handled by the client and should not be handled by webview.

getContentView

protected int getContentView()

startOAuth

protected void startOAuth()

getBoxAuthApp

protected android.content.Intent getBoxAuthApp()

onBackPressed

public void onBackPressed()

Overrides:

onBackPressed in class android.app.Activity

onAuthenticationChosen

public void onAuthenticationChosen(BoxAuthentication.BoxAuthenticationInfo authInfo)

Specified by:

onAuthenticationChosen in interface ChooseAuthenticationFragment.OnAuthenticationChosen

Parameters:

authInfo - the auth info chosen by the user, returns a new empty instance of DifferentAuthenticationInfo if the user chose to use a different account.

onDifferentAuthenticationChosen

public void onDifferentAuthenticationChosen()

Description copied from interface: ChooseAuthenticationFragment.OnAuthenticationChosen

Called if a user chooses to login as a "different account". If this is called the instantiater of this fragment should show appropriate ui to allow a new user to login.

Specified by:

onDifferentAuthenticationChosen in interface ChooseAuthenticationFragment.OnAuthenticationChosen

onActivityResult

protected void onActivityResult(int requestCode,
                                int resultCode,
                                android.content.Intent data)

Overrides:

onActivityResult in class android.app.Activity

startMakingOAuthAPICall

protected void startMakingOAuthAPICall(java.lang.String code,
                                       java.lang.String baseDomain)

Start to create OAuth after getting the code.

Parameters:

code - OAuth 2 authorization code

baseDomain - base domain used for changing host if applicable.

dismissSpinnerAndFinishAuthenticate

protected void dismissSpinnerAndFinishAuthenticate(BoxAuthentication.BoxAuthenticationInfo auth)

dismissSpinnerAndFailAuthenticate

protected void dismissSpinnerAndFailAuthenticate(java.lang.Exception e)

createOAuthView

protected OAuthWebView createOAuthView()

createOAuthWebViewClient

protected OAuthWebView.OAuthWebViewClient createOAuthWebViewClient()

getOAuthWebViewRId

protected int getOAuthWebViewRId()

showDialogWhileWaitingForAuthenticationAPICall

protected android.app.Dialog showDialogWhileWaitingForAuthenticationAPICall()

If you don't need the dialog, just return null.

Returns:

A dialog showing ui showing authentication is in progress

showSpinner

protected void showSpinner()

dismissSpinner

protected void dismissSpinner()

onDestroy

public void onDestroy()

Overrides:

onDestroy in class android.app.Activity

createOAuthActivityIntent

public static android.content.Intent createOAuthActivityIntent(android.content.Context context,
                                                               java.lang.String clientId,
                                                               java.lang.String clientSecret,
                                                               java.lang.String redirectUrl,
                                                               boolean loginViaBoxApp)

Create intent to launch OAuthActivity. Notes about redirect url parameter: If you already set redirect url in box dev console, you should pass in the same redirect url or use null for redirect url. If you didn't set it in box dev console, you should pass in a url. In case you don't have a redirect server you can simply use "http://localhost".

Parameters:

context - context

clientId - your box client id

clientSecret - your box client secret

redirectUrl - redirect url, if you already set redirect url in box dev console, leave this null or use the same url, otherwise this field is required. You can use "http://localhost" if you don't have a redirect server.

loginViaBoxApp - Whether login should be handled by the installed box android app. Set this to true only when you are sure or want to make sure user installed box android app and want to use box android app to login.

Returns:

intent to launch OAuthActivity.

createOAuthActivityIntent

public static android.content.Intent createOAuthActivityIntent(android.content.Context context,
                                                               BoxSession session,
                                                               boolean loginViaBoxApp)

Create intent to launch OAuthActivity using information from the given session.

Parameters:

context - context

session - the BoxSession to use to get parameters required to authenticate via this activity.

loginViaBoxApp - Whether login should be handled by the installed box android app. Set this to true only when you are sure or want to make sure user installed box android app and want to use box android app to login.

Returns:

intent to launch OAuthActivity.