/*
 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.security.auth.callback;

Underlying security services instantiate and pass a NameCallback to the handle method of a CallbackHandler to retrieve name information.

See Also:
/** * <p> Underlying security services instantiate and pass a * {@code NameCallback} to the {@code handle} * method of a {@code CallbackHandler} to retrieve name information. * * @see javax.security.auth.callback.CallbackHandler */
public class NameCallback implements Callback, java.io.Serializable { private static final long serialVersionUID = 3770938795909392253L;
@serial
Since:1.4
/** * @serial * @since 1.4 */
private String prompt;
@serial
Since:1.4
/** * @serial * @since 1.4 */
private String defaultName;
@serial
Since:1.4
/** * @serial * @since 1.4 */
private String inputName;
Construct a NameCallback with a prompt.

Params:
  • prompt – the prompt used to request the name.
Throws:
/** * Construct a {@code NameCallback} with a prompt. * * <p> * * @param prompt the prompt used to request the name. * * @exception IllegalArgumentException if {@code prompt} is null * or if {@code prompt} has a length of 0. */
public NameCallback(String prompt) { if (prompt == null || prompt.length() == 0) throw new IllegalArgumentException(); this.prompt = prompt; }
Construct a NameCallback with a prompt and default name.

Params:
  • 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, if prompt has a length of 0, if defaultName is null, or if defaultName has a length of 0.
/** * Construct a {@code NameCallback} with a prompt * and default name. * * <p> * * @param prompt the prompt used to request the information. <p> * * @param defaultName the name to be used as the default name displayed * with the prompt. * * @exception IllegalArgumentException if {@code prompt} is null, * if {@code prompt} has a length of 0, * if {@code defaultName} is null, * or if {@code defaultName} has a length of 0. */
public NameCallback(String prompt, String defaultName) { if (prompt == null || prompt.length() == 0 || defaultName == null || defaultName.length() == 0) throw new IllegalArgumentException(); this.prompt = prompt; this.defaultName = defaultName; }
Get the prompt.

Returns:the prompt.
/** * Get the prompt. * * <p> * * @return the prompt. */
public String getPrompt() { return prompt; }
Get the default name.

Returns:the default name, or null if this NameCallback was not instantiated with a defaultName.
/** * Get the default name. * * <p> * * @return the default name, or null if this {@code NameCallback} * was not instantiated with a {@code defaultName}. */
public String getDefaultName() { return defaultName; }
Set the retrieved name.

Params:
  • name – the retrieved name (which may be null).
See Also:
/** * Set the retrieved name. * * <p> * * @param name the retrieved name (which may be null). * * @see #getName */
public void setName(String name) { this.inputName = name; }
Get the retrieved name.

See Also:
Returns:the retrieved name (which may be null)
/** * Get the retrieved name. * * <p> * * @return the retrieved name (which may be null) * * @see #setName */
public String getName() { return inputName; } }