Android Open Source - dropbox-android-core-sdk-mirror Android Auth Session

• Back to Development/dropbox  ↑

From Project

Back to project page dropbox-android-core-sdk-mirror.

License

The source code is released under:

Copyright (c) 2009-2011 Dropbox Inc., http://www.dropbox.com/ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "So...

Java Source Code

package com.dropbox.client2.android;
/*from   ww w .  j a va2s  .  co m*/
import android.app.Activity;
import android.content.Context;
import android.content.Intent;

import com.dropbox.client2.DropboxAPI;
import com.dropbox.client2.session.AbstractSession;
import com.dropbox.client2.session.AccessTokenPair;
import com.dropbox.client2.session.AppKeyPair;

/**
 * Keeps track of a logged in user and contains configuration options for the
 * {@link DropboxAPI}. Has methods specific to Android for authenticating
 * users via the Dropbox app or web site.
 * <br><br>
 * A typical authentication flow when no user access token pair is saved is as
 * follows:
 * <br>
 * <pre>
 * AndroidAuthSession session = new AndroidAuthSession(myAppKeys, myAccessType);
 *
 * // When user wants to link to Dropbox, within an activity:
 * session.startAuthentication(this);
 *
 * // When user returns to your activity, after authentication:
 * if (session.authenticationSuccessful()) {
 *   try {
 *     session.finishAuthentication();
 *
 *     AccessTokenPair tokens = session.getAccessTokenPair();
 *     // Store tokens.key, tokens.secret somewhere
 *   } catch (IllegalStateException e) {
 *     // Error handling
 *   }
 * }</pre>
 * <br>
 * When a user returns to your app and you have tokens stored, just create a
 * new session with them:
 * <br>
 * <pre>
 * AndroidAuthSession session = new AndroidAuthSession(
 *     myAppKeys, myAccessType, new AccessTokenPair(storedAccessKey, storedAccessSecret));
 * </pre>
 */
public class AndroidAuthSession extends AbstractSession {

    /**
     * Creates a new session to authenticate Android apps with the given app
     * key pair and access type. The session will not be linked because it has
     * no access token or secret.
     */
    public AndroidAuthSession(AppKeyPair appKeyPair, AccessType type) {
        super(appKeyPair, type);
    }

    /**
     * Creates a new session to authenticate Android apps with the given app
     * key pair and access type. The session will be linked to the account
     * corresponding to the given access token pair.
     */
    public AndroidAuthSession(AppKeyPair appKeyPair, AccessType type,
            AccessTokenPair accessTokenPair) {
        super(appKeyPair, type, accessTokenPair);
    }

    /**
     * Starts the Dropbox authentication process by launching an external app
     * (either the Dropbox app if available or a web browser) where the user
     * will log in and allow your app access.
     *
     * @param context the {@link Context} which to use to launch the
     *         Dropbox authentication activity. This will typically be an
     *         {@link Activity} and the user will be taken back to that
     *         activity after authentication is complete (i.e., your activity
     *         will receive an {@code onResume()}).
     *
     * @throws IllegalStateException if you have not correctly set up the
     *         AuthActivity in your manifest, meaning that the Dropbox app will
     *         not be able to redirect back to your app after auth.
     */
    public void startAuthentication(Context context) {
        AppKeyPair appKeyPair = getAppKeyPair();
        if (!AuthActivity.checkAppBeforeAuth(context, appKeyPair.key, true /*alertUser*/)) {
            return;
        }

        // Start Dropbox auth activity.
        Intent intent = new Intent(context, AuthActivity.class);
        intent.putExtra(AuthActivity.EXTRA_INTERNAL_APP_KEY,
                appKeyPair.key);
        intent.putExtra(AuthActivity.EXTRA_INTERNAL_APP_SECRET,
                appKeyPair.secret);
        if (!(context instanceof Activity)) {
            // If starting the intent outside of an Activity, must include
            // this. See startActivity(). Otherwise, we prefer to stay in
            // the same task.
            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
        }
        context.startActivity(intent);
    }

    /**
     * Returns whether the user successfully authenticated with Dropbox.
     * Reasons for failure include the user canceling authentication, network
     * errors, and improper setup from within your app.
     */
    public boolean authenticationSuccessful() {
        Intent data = AuthActivity.result;

        if (data == null) {
            return false;
        }

        String token = data.getStringExtra(AuthActivity.EXTRA_ACCESS_TOKEN);
        String secret = data.getStringExtra(AuthActivity.EXTRA_ACCESS_SECRET);
        String uid = data.getStringExtra(AuthActivity.EXTRA_UID);

        if (token != null && !token.equals("") &&
                secret != null && !secret.equals("") &&
                uid != null && !uid.equals("")) {
            return true;
        }

        return false;
    }

    /**
     * Sets up a user's access token and secret in this session when you return
     * to your activity from the Dropbox authentication process. Should be
     * called from your activity's {@code onActivityResult()} method, but only
     * after checking that {@link #authenticationSuccessful()} is {@code true}.
     *
     * @return the authenticated user's Dropbox UID.
     *
     * @throws IllegalStateException if authentication was not successful prior
     *         to this call (check with {@link #authenticationSuccessful()}.
     */
    public String finishAuthentication() throws IllegalStateException {
        Intent data = AuthActivity.result;

        if (data == null) {
            throw new IllegalStateException();
        }

        String token = data.getStringExtra(AuthActivity.EXTRA_ACCESS_TOKEN);
        String secret = data.getStringExtra(AuthActivity.EXTRA_ACCESS_SECRET);
        String uid = data.getStringExtra(AuthActivity.EXTRA_UID);

        if (token != null && !token.equals("") &&
                secret != null && !secret.equals("") &&
                uid != null && !uid.equals("")) {
            AccessTokenPair tokens = new AccessTokenPair(token, secret);
            setAccessTokenPair(tokens);
            return uid;
        }

        throw new IllegalStateException();
    }

    @Override
    public void unlink() {
        super.unlink();
        AuthActivity.result = null;
    }
}

Java Source Code List

• Back to Development/dropbox  ↑