com.xmlmind.netutil

Class AuthenticatorModuleImpl

java.lang.Object

com.xmlmind.netutil.AuthenticatorModuleImpl

All Implemented Interfaces:

AuthenticatorModule

public class AuthenticatorModuleImpl
extends Object
implements AuthenticatorModule

An interactive AuthenticatorModuleImpl. The first time a password is required, the user is prompted to specify it. After that, this user name/password is cached for later reuse without having to prompt the user.

This class has facilities to serialize/deserialize (in plain text) user names/passwords specified this way.

Constructor Summary

Constructors

Constructor and Description
AuthenticatorModuleImpl() Creates an interactive authenticator module.

Method Summary

Modifier and Type	Method and Description
void	clearCredentials() If usernames/passwords are cached, invoking this method definitely clears such cached information.
Component	getDialogParent() Returns the component which is the parent of the graphical dialog box used to prompt the user.
ModularAuthenticator	getModularAuthenticator() Returns the modular authenticator to which this module belongs.
PasswordAuthentication	getPasswordAuthentication() Returns the PasswordAuthentication found for the context which can be queried using the ModularAuthenticator interface.
String	getPasswords() Returns the list of usernames/passwords used by this interactive authenticator module, a possibly empty string.
boolean	isInteractive() Returns true if this authenticator is allowed to prompt the user for her/his credentials; false otherwise.
void	setDialogParent(Component dialogParent) Specifies the component which is the parent of the graphical dialog box used to prompt the user.
void	setInteractive(boolean interactive) Specifies whether this authenticator is allowed to prompt the user for her/his credentials.
void	setModularAuthenticator(ModularAuthenticator authenticator) Invoked by the modular authenticator to specify to its module to which ``parent'' it belongs.
void	setPasswords(String passwords) Specifies the list of user names/passwords used by this interactive authenticator module.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatorModuleImpl

public AuthenticatorModuleImpl()

Creates an interactive authenticator module.

See Also:

setDialogParent(java.awt.Component), setPasswords(java.lang.String)

Method Detail

setModularAuthenticator

public void setModularAuthenticator(ModularAuthenticator authenticator)

Description copied from interface: AuthenticatorModule

Invoked by the modular authenticator to specify to its module to which ``parent'' it belongs.

Specified by:

setModularAuthenticator in interface AuthenticatorModule

getModularAuthenticator

public ModularAuthenticator getModularAuthenticator()

Description copied from interface: AuthenticatorModule

Returns the modular authenticator to which this module belongs.

Specified by:

getModularAuthenticator in interface AuthenticatorModule

clearCredentials

public void clearCredentials()

Description copied from interface: AuthenticatorModule

If usernames/passwords are cached, invoking this method definitely clears such cached information.

Specified by:

clearCredentials in interface AuthenticatorModule

setDialogParent

public void setDialogParent(Component dialogParent)

Specifies the component which is the parent of the graphical dialog box used to prompt the user.

Parameters:

dialogParent - parent of the dialog box. May be null, in such case, instead of using a graphical dialog box, the user has to type his user name/password in the console of the application.

getDialogParent

public Component getDialogParent()

Returns the component which is the parent of the graphical dialog box used to prompt the user. Returns null unless setDialogParent(java.awt.Component) has been previously invoked with a non-null argument.

setInteractive

public void setInteractive(boolean interactive)

Specifies whether this authenticator is allowed to prompt the user for her/his credentials.

By default, prompting the user is allowed.

Note that this is orthogonal to specifying whether a graphical dialog box or the console is used to prompt the user.

isInteractive

public boolean isInteractive()

Returns true if this authenticator is allowed to prompt the user for her/his credentials; false otherwise.

By default, returns true.

setPasswords

public void setPasswords(String passwords)

Specifies the list of user names/passwords used by this interactive authenticator module.

The format of this list is opaque. This list must have been returned by getPasswords(). At the end of a session, it is typically saved to a user preference file in order to be reloaded and reused in subsequent sessions.

getPasswords

public String getPasswords()

Returns the list of usernames/passwords used by this interactive authenticator module, a possibly empty string.

getPasswordAuthentication

public PasswordAuthentication getPasswordAuthentication()

Description copied from interface: AuthenticatorModule

Returns the PasswordAuthentication found for the context which can be queried using the ModularAuthenticator interface. Returns null if, given this context, this module cannot determine the PasswordAuthentication object.

Specified by:

getPasswordAuthentication in interface AuthenticatorModule