com.sshtools.ui.swing

Class PersistantAuthenticator

java.lang.Object

java.net.Authenticator

com.sshtools.ui.swing.PersistantAuthenticator

public class PersistantAuthenticator
extends Authenticator

Nested Class Summary

Nested classes/interfaces inherited from class java.net.Authenticator

Authenticator.RequestorType

Constructor Summary

Constructors

Constructor and Description
PersistantAuthenticator() Creates a new GruntspudAuthenticator.

Method Summary

Modifier and Type	Method and Description
Throwable	getException() Return the last exception
Icon	getIcon(String scheme, int iconSize)
int	getIconSize()
Component	getParent() Get the current parent component
protected PasswordAuthentication	getPasswordAuthentication()
PasswordPairList	getPasswordPairList() Return a list of all the password pairs
char[]	getPasswordSafeSecret(String message, String text, Component parent) Show a dialog asking for the password safe secret
void	init() Initialise the authenticator.
boolean	isForceAskForPassword() Get if the password will be asked for no matter what.
void	removePassword(PasswordPair pair) Remove a password pair from the list.
void	setAllowEmptyPassword(boolean allowEmptyPassword)
static void	setDirectory(File prefDir) Set the directory where the passwords will be store
void	setEmphasisePrompt(boolean emphasisePrompt) Set if the next request for a password should emphasise the 'prompt' field by colouring it red.
void	setForceAskForPassword(boolean forceAskForPassword) Set whether the master password should be asked for if it is needed.
void	setIconSize(int iconSize)
void	setInitialPassword(String initialPassword) Set the initial password.
void	setParentComponent(Component parent) Set the parent component to use as a parent for the modal authentication dialog (should it be displayed).
void	setUserName(String userName) Set the user name to use next time a password is requested
char[][]	showMasterPasswordConfirmationDialog(JComponent parent, String text, String title, boolean checkAgainstOld) Show a dialog asking the use for a new password safe secret.
void	updateUI()

Methods inherited from class java.net.Authenticator

getRequestingHost, getRequestingPort, getRequestingPrompt, getRequestingProtocol, getRequestingScheme, getRequestingSite, getRequestingURL, getRequestorType, requestPasswordAuthentication, requestPasswordAuthentication, requestPasswordAuthentication, setDefault

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistantAuthenticator

public PersistantAuthenticator()

Creates a new GruntspudAuthenticator.

Parameters:

context - context

Throws:

IOException

Method Detail

setInitialPassword

public void setInitialPassword(String initialPassword)

Set the initial password. This is used if no password has ever been stored. If this is set the password will not be prompted for unless force is or a password has already been stored. The value must be null to unset. The value is reset once the authenticator has been used.

Parameters:

initialPassword - initial password

getParent

public Component getParent()

Get the current parent component

Returns:

parent

setDirectory

public static void setDirectory(File prefDir)

Set the directory where the passwords will be store

Parameters:

dir - directory

getPasswordPairList

public PasswordPairList getPasswordPairList()

Return a list of all the password pairs

Returns:

password pair list

removePassword

public void removePassword(PasswordPair pair)
                    throws Exception

Remove a password pair from the list.

Parameters:

pair -

Throws:

Exception

init

public void init()
          throws IOException

Initialise the authenticator. Should be called just after instantiation

Parameters:

context - context

Throws:

IOException - if password list cannot be loaded

showMasterPasswordConfirmationDialog

public char[][] showMasterPasswordConfirmationDialog(JComponent parent,
                                                     String text,
                                                     String title,
                                                     boolean checkAgainstOld)

Show a dialog asking the use for a new password safe secret. The user must enter the same secret twice, then an 2 element array of the old password and new password as a char[] array is returned. If the user cancels null will be returned.

Parameters:

context - context

parent - parent component

text - help text

title - dialog title

checkAgainstOld - make sure the old secret matches first

Returns:

2 element array of char[], first element is old secret, second is new

getPasswordSafeSecret

public char[] getPasswordSafeSecret(String message,
                                    String text,
                                    Component parent)

Show a dialog asking for the password safe secret

Parameters:

message - message to show

text - text

parent - parent component

Returns:

password safe secret (or null if aborted)

setForceAskForPassword

public void setForceAskForPassword(boolean forceAskForPassword)

Set whether the master password should be asked for if it is needed. This should be set just before any operation that might require the use of a password is run.

Parameters:

forceAskForPassword - always ask for the master password next time it is needed

setEmphasisePrompt

public void setEmphasisePrompt(boolean emphasisePrompt)

Set if the next request for a password should emphasise the 'prompt' field by colouring it red. This would normally be used if this is the second request for a password as the first one was incorrect in some way.

Parameters:

emphasisePrompt - emphasis prompt

setParentComponent

public void setParentComponent(Component parent)

Set the parent component to use as a parent for the modal authentication dialog (should it be displayed).

Parameters:

parent - parent component

setUserName

public void setUserName(String userName)

Set the user name to use next time a password is requested

Parameters:

userName - user name

updateUI

public void updateUI()

setAllowEmptyPassword

public void setAllowEmptyPassword(boolean allowEmptyPassword)

getPasswordAuthentication

protected PasswordAuthentication getPasswordAuthentication()

Overrides:

getPasswordAuthentication in class Authenticator

setIconSize

public void setIconSize(int iconSize)

getIconSize

public int getIconSize()

getIcon

public Icon getIcon(String scheme,
                    int iconSize)

getException

public Throwable getException()

Return the last exception

Returns:

last exceptoion

isForceAskForPassword

public boolean isForceAskForPassword()

Get if the password will be asked for no matter what.

Returns:

force ask for password