Logo Search packages:      
Sourcecode: libgnucrypto-java version File versions  Download package

PasswordCallback.java

package javax.security.auth.callback;

// ----------------------------------------------------------------------------
// $Id: PasswordCallback.java,v 1.1 2003/05/10 18:45:12 raif Exp $
//
// Copyright (C) 2003, Free Software Foundation, Inc.
//
// This file is part of GNU Crypto.
//
// GNU Crypto 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, or (at your option)
// any later version.
//
// GNU Crypto 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; see the file COPYING.  If not, write to the
//
//    Free Software Foundation Inc.,
//    59 Temple Place - Suite 330,
//    Boston, MA 02111-1307
//    USA
//
// Linking this library statically or dynamically with other modules is
// making a combined work based on this library.  Thus, the terms and
// conditions of the GNU General Public License cover the whole
// combination.
//
// As a special exception, the copyright holders of this library give
// you permission to link this library with independent modules to
// produce an executable, regardless of the license terms of these
// independent modules, and to copy and distribute the resulting
// executable under terms of your choice, provided that you also meet,
// for each linked independent module, the terms and conditions of the
// license of that module.  An independent module is a module which is
// not derived from or based on this library.  If you modify this
// library, you may extend this exception to your version of the
// library, but you are not obligated to do so.  If you do not wish to
// do so, delete this exception statement from your version.
// ----------------------------------------------------------------------------

import java.io.Serializable;

/**
 * Underlying security services instantiate and pass a <code>PasswordCallback</code>
 * to the <code>handle()</code> method of a {@link CallbackHandler} to retrieve
 * password information.
 *
 * @see CallbackHandler,
 * @version $Revision: 1.1 $
 */
00056 public class PasswordCallback implements Callback, Serializable {

   // Constants and variables
   // -------------------------------------------------------------------------

   /**
    * @serial
    * @since 1.4
    */
00065    private String prompt;
   /**
    * @serial
    * @since 1.4
    */
00070    private boolean echoOn;
   /**
    * @serial
    * @since 1.4
    */
00075    private char[] inputPassword;

   // Constructor(s)
   // -------------------------------------------------------------------------

   /**
    * Construct a <code>PasswordCallback</code> with a prompt and a boolean
    * specifying whether the password should be displayed as it is being typed.
    *
    * @param prompt the prompt used to request the password.
    * @param echoOn <code>true</code> if the password should be displayed as it
    * is being typed.
    * @throws IllegalArgumentException if <code>prompt</code> is <code>null</code>
    * or if <code>prompt</code> has a length of <code>0</code>.
    */
00090    public PasswordCallback(String prompt, boolean echoOn) {
      super();

      setPrompt(prompt);
      this.echoOn = echoOn;
   }

   // Class methods
   // -------------------------------------------------------------------------

   // Instance methods
   // -------------------------------------------------------------------------

   /**
    * Get the prompt.
    *
    * @return the prompt.
    */
00108    public String getPrompt() {
      return prompt;
   }

   /**
    * Return whether the password should be displayed as it is being typed.
    *
    * @return the whether the password should be displayed as it is being typed.
    */
00117    public boolean isEchoOn() {
      return echoOn;
   }

   /**
    * <p>Set the retrieved password.</p>
    *
    * <p>This method makes a copy of the input password before storing it.</p>
    *
    * @param password the retrieved password, which may be <code>null</code>.
    * @see #getPassword()
    */
00129    public void setPassword(char[] password) {
      inputPassword = (password == null ? null : (char[]) password.clone());
   }

   /**
    * <p>Get the retrieved password.</p>
    *
    * <p>This method returns a copy of the retrieved password.</p>
    *
    * @return the retrieved password, which may be <code>null</code>.
    * @see #setPassword(char[])
    */
00141    public char[] getPassword() {
      return (inputPassword == null ? null : (char[]) inputPassword.clone());
   }

   /** Clear the retrieved password. */
00146    public void clearPassword() {
      if (inputPassword != null) {
         for (int i = 0; i < inputPassword.length; i++) {
            inputPassword[i] = '\0';
         }
         inputPassword = null;
      }
   }

   private void setPrompt(String prompt) throws IllegalArgumentException {
      if ((prompt == null) || (prompt.length() == 0)) {
         throw new IllegalArgumentException("invalid prompt");
      }
      this.prompt = prompt;
   }
}

Generated by  Doxygen 1.6.0   Back to index