src/com/owncloud/android/authentication/AccountAuthenticatorActivity.java

   1 /*
   2  * Copyright (C) 2009 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.owncloud.android.authentication;
  18
  19 import android.accounts.AccountAuthenticatorResponse;
  20 import android.accounts.AccountManager;
  21 import android.os.Bundle;
  22
  23 import com.actionbarsherlock.app.SherlockFragmentActivity;
  24
  25
  26 /*
  27  * Base class for implementing an Activity that is used to help implement an AbstractAccountAuthenticator.
  28  * If the AbstractAccountAuthenticator needs to use an activity to handle the request then it can have the activity extend
  29  * AccountAuthenticatorActivity. The AbstractAccountAuthenticator passes in the response to the intent using the following:
  30  * intent.putExtra(AccountManager.KEY_ACCOUNT_AUTHENTICATOR_RESPONSE, response);
  31  *
  32  * The activity then sets the result that is to be handed to the response via setAccountAuthenticatorResult(android.os.Bundle).
  33  * This result will be sent as the result of the request when the activity finishes. If this is never set or if it is set to null
  34  * then error AccountManager.ERROR_CODE_CANCELED will be called on the response.
  35  */
  36
  37 public class AccountAuthenticatorActivity extends SherlockFragmentActivity {
  38
  39     private AccountAuthenticatorResponse mAccountAuthenticatorResponse = null;
  40     private Bundle mResultBundle = null;
  41
  42
  43     /**
  44      * Set the result that is to be sent as the result of the request that caused this Activity to be launched.
  45      * If result is null or this method is never called then the request will be canceled.
  46      *
  47      * @param result this is returned as the result of the AbstractAccountAuthenticator request
  48      */
  49     public final void setAccountAuthenticatorResult(Bundle result) {
  50         mResultBundle = result;
  51     }
  52
  53     /**
  54      * Retreives the AccountAuthenticatorResponse from either the intent of the icicle, if the
  55      * icicle is non-zero.
  56      * @param icicle the save instance data of this Activity, may be null
  57      */
  58     protected void onCreate(Bundle icicle) {
  59         super.onCreate(icicle);
  60
  61         mAccountAuthenticatorResponse =
  62                 getIntent().getParcelableExtra(AccountManager.KEY_ACCOUNT_AUTHENTICATOR_RESPONSE);
  63
  64         if (mAccountAuthenticatorResponse != null) {
  65             mAccountAuthenticatorResponse.onRequestContinued();
  66         }
  67     }
  68
  69     /**
  70      * Sends the result or a Constants.ERROR_CODE_CANCELED error if a result isn't present.
  71      */
  72     public void finish() {
  73         if (mAccountAuthenticatorResponse != null) {
  74             // send the result bundle back if set, otherwise send an error.
  75             if (mResultBundle != null) {
  76                 mAccountAuthenticatorResponse.onResult(mResultBundle);
  77             } else {
  78                 mAccountAuthenticatorResponse.onError(AccountManager.ERROR_CODE_CANCELED,
  79                         "canceled");
  80             }
  81             mAccountAuthenticatorResponse = null;
  82         }
  83         super.finish();
  84     }
  85 }