io.guise.framework.component.PasswordAuthenticationPanel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
/*
* Copyright © 2005-2008 GlobalMentor, Inc. usernameControl;
/** The password text control. */
private final TextControl passwordControl;
/** The password verification text control. */
private final TextControl passwordVerificationControl;
/** Whether password verification is required, resulting in a separate password verification text input. */
private boolean passwordVerified = false;
/** @return Whether password verification is required, resulting in a separate password verification text input. */
public boolean isPasswordVerified() {
return passwordVerified;
}
/**
* Sets whether password verification is required This is a bound property of type Boolean. This method unconditionally clears the password
* verification control.
* @param newPasswordVerified Whether password verification is required, resulting in a separate password verification text input.
* @see #PASSWORD_VERIFIED_PROPERTY
*/
public void setPasswordVerified(final boolean newPasswordVerified) {
if(passwordVerified != newPasswordVerified) { //if the value is really changing
final boolean oldPasswordVerified = passwordVerified; //get the current value
passwordVerified = newPasswordVerified; //update the value
passwordVerificationControl.clearValue(); //always clear the password verification control, whatever the new value
update(); //update the other components that rely on this setting
firePropertyChange(PASSWORD_VERIFIED_PROPERTY, Boolean.valueOf(oldPasswordVerified), Boolean.valueOf(newPasswordVerified));
}
}
/** Default constructor with a default vertical flow layout. */
public PasswordAuthenticationPanel() {
this(new FlowLayout(Flow.PAGE)); //default to flowing vertically
}
/**
* Layout constructor.
* @param layout The layout definition for the container.
* @throws NullPointerException if the given layout is null.
*/
public PasswordAuthenticationPanel(final Layout layout) {
super(layout); //construct the parent class
//username
usernameControl = new TextControl(String.class); //create the username text control
usernameControl.setLabel(LABEL_USERNAME); //set the username control label
usernameControl.setGlyphURI(GLYPH_USER); //set the username control icon
add(usernameControl); //add the ID control to the panel
//password
passwordControl = new TextControl(char[].class); //create the password text control
passwordControl.setLabel(LABEL_PASSWORD); //set the password control label
passwordControl.setGlyphURI(GLYPH_PASSWORD); //set the password control icon
passwordControl.setMasked(true); //mask the password input
add(passwordControl); //add the password control to the panel
//password verification
passwordVerificationControl = new TextControl(char[].class); //create the password verification text control
passwordVerificationControl.setLabel(LABEL_PASSWORD); //set the password verification control label
passwordVerificationControl.setGlyphURI(GLYPH_PASSWORD); //set the password verification control icon
passwordVerificationControl.setMasked(true); //mask the password verification input
add(passwordVerificationControl); //add the password verification control to the panel
update(); //update the state of the password verification control based upon our password verification setting
}
/** @return The current username entered, or null if there is no username entered. */
public String getUsername() {
return usernameControl.getValue();
}
/**
* Sets the username shown in the panel.
* @param username The username to show.
* @throws PropertyVetoException if the provided value is not valid or the change has otherwise been vetoed.
*/
public void setUsername(final String username) throws PropertyVetoException {
usernameControl.setValue(username);
}
/** @return The validator for the username, or null if no validator is installed. */
public Validator getUsernameValidator() {
return usernameControl.getValidator();
}
/**
* Sets the username validator.
* @param newValidator The validator for the username, or null if no validator should be used.
*/
public void setUsernameValidator(final Validator newValidator) {
usernameControl.setValidator(newValidator);
}
/** @return The current password entered, or null if there is no password entered. */
public char[] getPassword() {
return passwordControl.getValue();
}
/**
* Sets the password shown in the panel.
* @param password The password to show.
* @throws PropertyVetoException if the provided value is not valid or the change has otherwise been vetoed.
*/
public void setPassword(final char[] password) throws PropertyVetoException {
passwordControl.setValue(password);
}
/** @return The validator for the password, or null if no validator is installed. */
public Validator getPasswordValidator() {
return passwordControl.getValidator();
}
/**
* Sets the password validator.
* @param newValidator The validator for the password, or null if no validator should be used.
*/
public void setPasswordValidator(final Validator newValidator) {
passwordControl.setValidator(newValidator);
passwordVerificationControl.setValidator(newValidator); //install the validator into both password controls
}
@Override
protected void update() {
passwordVerificationControl.setDisplayed(isPasswordVerified()); //only show the password verification if we should verify the password
}
/** @return true if both entered passwords are identical. */
protected boolean isPasswordMatch() {
return Arrays.equals(passwordControl.getValue(), passwordVerificationControl.getValue()); //see if the passwords match
}
/**
* {@inheritDoc}
*
* This version ensures the entered passwords match if password verification is enabled.
*
*/
@Override
protected boolean determineValid() {
return super.determineValid() && (!isPasswordVerified() || isPasswordMatch()); //add a check for password consistency if passwords are being verified
}
/**
* {@inheritDoc}
*
* This version adds errors for non-matching passwords if password verification is enabled.
*
*/
@Override
public boolean validate() {
super.validate(); //validate the component normally
if(isPasswordVerified() && !isPasswordMatch()) { //if we're verifying the password and it isn't valid
final Notification notification = new Notification(MESSAGE_PASSWORD_UNVERIFIED, Notification.Severity.ERROR); //create an error notification
passwordControl.setNotification(notification); //add the error notification to each password control
passwordVerificationControl.setNotification(notification);
}
return isValid(); //return the current valid state
}
/** Clears the username and password values. */
public void clearValues() {
usernameControl.clearValue(); //clear the username value
passwordControl.clearValue(); //clear the password value
}
}