Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.security.auth.callback

Class NameCallback

Implemented Interfaces:
Callback, Serializable
public class NameCallback
extends Object
implements Callback, Serializable
Underlying security services instantiate and pass a NameCallback to the handle() method of a CallbackHandler to retrieve name information.
See Also:
CallbackHandler, Serialized Form

Constructor Summary

NameCallback(String prompt)
Construct a NameCallback with a prompt.
NameCallback(String prompt, String defaultName)
Construct a NameCallback with a prompt and default name.

Method Summary

String
getDefaultName()
Get the default name.
String
getName()
Get the retrieved name.
String
getPrompt()
Get the prompt.
void
setName(String name)
Set the retrieved name.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NameCallback

public NameCallback(String prompt)
Construct a NameCallback with a prompt.
Parameters:
prompt - the prompt used to request the name.
Throws:
IllegalArgumentException - if prompt is null or if prompt has a length of 0.

NameCallback

public NameCallback(String prompt,
                    String defaultName)
            throws IllegalArgumentException
Construct a NameCallback with a prompt and default name.
Parameters:
prompt - the prompt used to request the information.
defaultName - the name to be used as the default name displayed with the prompt.
Throws:
IllegalArgumentException - if prompt is null or if prompt has a length of 0, if defaultName is null, or if defaultName has a length of 0.

Method Details

getDefaultName

public String getDefaultName()
Get the default name.
Returns:
the default name, or null if this NameCallback was not instantiated with a defaultName.

getName

public String getName()
Get the retrieved name.
Returns:
the retrieved name (which may be null)
See Also:
setName(String)

getPrompt

public String getPrompt()
Get the prompt.
Returns:
the prompt.

setName

public void setName(String name)
Set the retrieved name.
Parameters:
name - the retrieved name (which may be null).
See Also:
getName()
NameCallback.java -- callback for user names. Copyright (C) 2003, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath 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 Classpath 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 GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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.

Overview Package Class Use Source Tree Index Deprecated About