org.owasp.esapi.reference.validation

Class DateValidationRule

java.lang.Object

org.owasp.esapi.reference.validation.BaseValidationRule

org.owasp.esapi.reference.validation.DateValidationRule

All Implemented Interfaces:

ValidationRule

public class DateValidationRule
extends BaseValidationRule

A validator performs syntax and possibly semantic validation of a single piece of data from an untrusted source.

Since:

June 1, 2007

Author:

Jeff Williams (jeff.williams .at. aspectsecurity.com) Aspect Security

See Also:

Validator

Field Summary

Fields inherited from class org.owasp.esapi.reference.validation.BaseValidationRule

allowNull, encoder

Constructor Summary

Constructors

Constructor and Description
DateValidationRule(String typeName, Encoder encoder, DateFormat newFormat)

Method Summary

Modifier and Type	Method and Description
Date	getValid(String context, String input) Parse the input, throw exceptions if validation fails
Date	sanitize(String context, String input) The method is similar to ValidationRuile.getSafe except that it returns a harmless object that may or may not have any similarity to the original input (in some cases you may not care).
Date	sanitize(String context, String input, ValidationErrorList errorList) Same as sanitize(String, String) except it returns any ValidationException generated in the provided errorList.
void	setDateFormat(DateFormat newFormat)

Methods inherited from class org.owasp.esapi.reference.validation.BaseValidationRule

assertValid, charArrayToSet, getEncoder, getSafe, getTypeName, getValid, isAllowNull, isValid, setAllowNull, setEncoder, setTypeName, whitelist, whitelist

Methods inherited from class java.lang.Object

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

Constructor Detail

DateValidationRule

public DateValidationRule(String typeName,
                          Encoder encoder,
                          DateFormat newFormat)

Method Detail

setDateFormat

public final void setDateFormat(DateFormat newFormat)

getValid

public Date getValid(String context,
                     String input)
              throws ValidationException

Parse the input, throw exceptions if validation fails

Parameters:

context - for logging

input - the value to be parsed

Returns:

a validated value

Throws:

ValidationException - Thrown if any validation rules fail, except when the ESAPI.properties> property "Validator.HtmlValidationAction" is set to clean. The default ESAPI.properties> property file has "Validator.HtmlValidationAction" is set to throw, which results in a ValidationException being thrown if any of the validation rules fail. releases. See ESAPI GitHub Issues 521 for futher details.

See Also:

ValidationRule.getValid(String context, String input, ValidationErrorList errorList)

sanitize

public Date sanitize(String context,
                     String input)

The method is similar to ValidationRuile.getSafe except that it returns a harmless object that may or may not have any similarity to the original input (in some cases you may not care). In most cases this should be the same as the getSafe method only instead of throwing an exception, return some default value.

Specified by:

sanitize in class BaseValidationRule

Returns:

a parsed version of the input or a default value.

sanitize

public Date sanitize(String context,
                     String input,
                     ValidationErrorList errorList)

Same as sanitize(String, String) except it returns any ValidationException generated in the provided errorList.

Parameters:

errorList - The error list to add any ValidationException to.

Returns:

The valid sanitized Date, or Date(0) if the supplied input was not a valid date.