Android Open Source - android-authenticator-framework User Credentials Auth Token

• Back to Framework/framework  ↑

From Project

Back to project page android-authenticator-framework.

License

The source code is released under:

GNU General Public License

Java Source Code

/*
 * Copyright (C) 2013 Marten Gajda <marten@dmfs.org>
 *//  w ww  .  j  a va 2  s. co  m
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2 of the License,
 * or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */

package org.dmfs.android.authenticator.secrets;

import android.content.Context;
import android.os.Parcel;
import android.os.Parcelable;


/**
 * An auth token suitable for authentication with user credentials, i.e. a username and a password.
 * 
 * @author Marten Gajda <marten@dmfs.org>
 */
public class UserCredentialsAuthToken extends AuthToken
{

  private final static String SCHEME = "user_creds_auth_token";

  /**
   * The username.
   */
  private String mUsername;

  /**
   * The password.
   */
  private String mPassword;

  /**
   * The realm.
   */
  private String mRealm;


  /**
   * Private constructor for unparceling.
   */
  private UserCredentialsAuthToken()
  {
  }


  /**
   * Create an auth token from the protected auth token string.
   * 
   * @param protectedSecret
   *            The obfuscated auth token.
   */
  public UserCredentialsAuthToken(String protectedSecret)
  {
    super(protectedSecret);
  }


  /**
   * Create an auth token from the user's credentials.
   * 
   * @param context
   *            A Context.
   * @param username
   *            The username.
   * @param password
   *            The password.
   * @param realm
   *            A realm or <code>null</code>.
   */
  public UserCredentialsAuthToken(Context context, String username, String password, String realm)
  {
    super(context, username, password, realm);
    mUsername = username;
    mPassword = password;
    mRealm = realm;
  }


  /*
   * (non-Javadoc)
   * 
   * @see org.dmfs.android.authenticator.secrets.ProtectedSecret#getScheme()
   */
  @Override
  public String getScheme()
  {
    return SCHEME;
  }


  /**
   * Get the username from the auth token. Ensure you've called {@link #unprotect(Context)} first if you retrieved this from a parcel or if your created this
   * instance with {@link #UserCredentialsAuthToken(String)}.
   * 
   * @return The username.
   */
  public String getUsername()
  {
    return mUsername;
  }


  /**
   * Get the password from the auth token. Ensure you've called {@link #unprotect(Context)} first if you retrieved this from a parcel or if your created this
   * instance with {@link #UserCredentialsAuthToken(String)}.
   * 
   * @return The password.
   */
  public String getPassword()
  {
    return mPassword;
  }


  /**
   * Get the realm from the auth token. Ensure you've called {@link #unprotect(Context)} first if you retrieved this from a parcel or if your created this
   * instance with {@link #UserCredentialsAuthToken(String)}.
   * 
   * @return The realm.
   */
  public String getRealm()
  {
    return mRealm;
  }


  /*
   * (non-Javadoc)
   * 
   * @see org.dmfs.android.authenticator.secrets.ProtectedSecret#parse(java.lang.String)
   */
  @Override
  protected void parse(String plainSecret)
  {
    String[] parts = split(plainSecret, 3);
    mUsername = parts[0];
    mPassword = parts[1];
    mRealm = parts[2];
  }

  public static final Parcelable.Creator<UserCredentialsAuthToken> CREATOR = new Parcelable.Creator<UserCredentialsAuthToken>()
  {
    /*
     * (non-Javadoc)
     * 
     * @see android.os.Parcelable.Creator#createFromParcel(android.os.Parcel)
     */
    @Override
    public UserCredentialsAuthToken createFromParcel(Parcel in)
    {
      final UserCredentialsAuthToken state = new UserCredentialsAuthToken();
      state.readFromParcel(in);
      return state;
    }


    /*
     * (non-Javadoc)
     * 
     * @see android.os.Parcelable.Creator#newArray(int)
     */
    @Override
    public UserCredentialsAuthToken[] newArray(int size)
    {
      return new UserCredentialsAuthToken[size];
    }
  };
}

Java Source Code List

• Back to Framework/framework  ↑