javax.security.auth.message.callback

Class PasswordValidationCallback

java.lang.Object

javax.security.auth.message.callback.PasswordValidationCallback

All Implemented Interfaces:

Callback

public class PasswordValidationCallback
extends Object
implements Callback

Callback for PasswordValidation. This callback may be used by an authentication module to employ the password validation facilities of its containing runtime. This Callback would typically be called by a ServerAuthModule during validateRequest processing.

Since:

May 11, 2006

Version:

$Revision$

Author:

Anil Saldhana, Charlie Lai, Ron Monzillo (Javadoc for JSR-196)

Constructor Summary

Constructors

Constructor and Description
PasswordValidationCallback(Subject subject, String username, char[] password) Create a PasswordValidationCallback.

Method Summary

Modifier and Type	Method and Description
void	clearPassword() Clear the password.
char[]	getPassword() Get the password.
boolean	getResult() Get the authentication result.
Subject	getSubject() Get the subject.
String	getUsername() Get the username.
void	setResult(boolean result) Set the authentication result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PasswordValidationCallback

public PasswordValidationCallback(Subject subject,
                                  String username,
                                  char[] password)

Create a PasswordValidationCallback.

Parameters:

subject - The subject for authentication

username - The username to authenticate

password - The user's password, which may be null.

Method Detail

clearPassword

public void clearPassword()

Clear the password.

getPassword

public char[] getPassword()

Get the password.

Note that this method returns a reference to the password. If a clone of the array is created it is the caller's responsibility to zero out the password information after it is no longer needed.

Returns:

the password, which may be null.

getSubject

public Subject getSubject()

Get the subject.

Returns:

The subject.

getResult

public boolean getResult()

Get the authentication result.

Returns:

true if authentication succeeded, false otherwise.

getUsername

public String getUsername()

Get the username.

Returns:

The username.

setResult

public void setResult(boolean result)

Set the authentication result.

Parameters:

result - True if authentication succeeded, false otherwise.