Package org.exoplatform.webui.form.validator

Class UserConfigurableValidator

java.lang.Object

org.exoplatform.webui.form.validator.AbstractValidator

org.exoplatform.webui.form.validator.MultipleConditionsValidator

org.exoplatform.webui.form.validator.UserConfigurableValidator

All Implemented Interfaces:

Serializable, Validator

public class UserConfigurableValidator
extends MultipleConditionsValidator

A user-configurable validator. Several aspects of this validator can be configured via properties in the configuration.properties file found in the GateIn configuration directory (${gatein.conf.dir}). The validator supports several configurations that can be activated when a validator instance is created by passing it the name of the configuration to be activated. A configuration is created by adding an entry in configuration.properties using the KEY_PREFIX prefix followed by the name of the configuration, a period '.' and the name of the validation aspect to modify.
Currently supported validation aspects, where {configuration} is a configuration's name:

• KEY_PREFIX{configuration}.length.min: the minimal length of the validated field
• KEY_PREFIX{configuration}.length.max: the maximal length of the validated field
• KEY_PREFIX{configuration}.regexp: the regular expression to which the validated field must conform
• KEY_PREFIX{configuration}.format.message: a message to display providing details about the format of values the regular expression allows in case the validated field doesn't conform to it

Currently used configurations in the code are defined by the USERNAME and GROUPMEMBERSHIP names.

Author:

Chris Laprun

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_LOCALIZATION_KEY
static final String	EMAIL
static final String	EMAIL_VALIDATION_REGEX
static final String	GROUP_MEMBERSHIP_LOCALIZATION_KEY
static final String	GROUP_MEMBERSHIP_VALIDATION_REGEX	Note that this regular expression should actually validate comma-separated usernames.
static final String	GROUPMEMBERSHIP
static final String	KEY_PREFIX
protected static org.exoplatform.services.log.Log	log
static final String	PAGE_NAME
static final String	USERNAME

Fields inherited from class org.exoplatform.webui.form.validator.AbstractValidator

exceptionOnMissingMandatory, trimValue

Constructor Summary

Constructors

Constructor	Description
UserConfigurableValidator()
UserConfigurableValidator(String configurationName)
UserConfigurableValidator(String configurationName, String messageLocalizationKey)
UserConfigurableValidator(String configurationName, String messageLocalizationKey, Boolean exceptionOnMissingMandatory)

Method Summary

Modifier and Type	Method	Description
static final Set<String>	getConfigurationNames()	Provides a way to query what are the currently known policies from the configuration files.
protected void	validate(String value, String label, org.exoplatform.web.application.CompoundApplicationMessage messages, UIFormInput uiInput)
void	validate(UIFormInput uiInput)

Methods inherited from class org.exoplatform.webui.form.validator.MultipleConditionsValidator

getMessageLocalizationKey, isValid

Methods inherited from class org.exoplatform.webui.form.validator.AbstractValidator

createMessageException, createMessageException, getLabelFor, getMessageArgs, trimmedValueOrNullIfBypassed

Methods inherited from class java.lang.Object

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

Field Details

log

protected static org.exoplatform.services.log.Log log

USERNAME

public static final String USERNAME

See Also:

• Constant Field Values

GROUPMEMBERSHIP

public static final String GROUPMEMBERSHIP

See Also:

• Constant Field Values

PAGE_NAME

public static final String PAGE_NAME

See Also:

• Constant Field Values

EMAIL

public static final String EMAIL

See Also:

• Constant Field Values

DEFAULT_LOCALIZATION_KEY

public static final String DEFAULT_LOCALIZATION_KEY

See Also:

• Constant Field Values

GROUP_MEMBERSHIP_VALIDATION_REGEX

public static final String GROUP_MEMBERSHIP_VALIDATION_REGEX

Note that this regular expression should actually validate comma-separated usernames. This is not the case as some constraints (consecutive symbols for examples) are not taken into account.

See Also:

• Constant Field Values

GROUP_MEMBERSHIP_LOCALIZATION_KEY

public static final String GROUP_MEMBERSHIP_LOCALIZATION_KEY

See Also:

• Constant Field Values

EMAIL_VALIDATION_REGEX

public static final String EMAIL_VALIDATION_REGEX

See Also:

• Constant Field Values

KEY_PREFIX

public static final String KEY_PREFIX

See Also:

• Constant Field Values

Constructor Details

UserConfigurableValidator

public UserConfigurableValidator()

UserConfigurableValidator

public UserConfigurableValidator(String configurationName,
 String messageLocalizationKey)

UserConfigurableValidator

public UserConfigurableValidator(String configurationName,
 String messageLocalizationKey,
 Boolean exceptionOnMissingMandatory)

UserConfigurableValidator

public UserConfigurableValidator(String configurationName)

Method Details

validate

public void validate(UIFormInput uiInput)
              throws Exception

Specified by:

validate in interface Validator

Overrides:

validate in class MultipleConditionsValidator

Throws:

Exception

validate

protected void validate(String value,
 String label,
 org.exoplatform.web.application.CompoundApplicationMessage messages,
 UIFormInput uiInput)

Specified by:

validate in class MultipleConditionsValidator

getConfigurationNames

public static final Set<String> getConfigurationNames()

Provides a way to query what are the currently known policies from the configuration files. For instance, if an entry exists as gatein.validators.mycompanypasspolicy.regexp , then there's a configuration called "mycompanypasspolicy", and this will be returned by this method. Note: the built-in configurations are not returned by this method, only the custom-provided ones.

Returns:

a set containing all known configuration key names.