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

See Also:

Validator

Field Summary

Fields

Modifier and Type	Field and Description
private java.text.DateFormat	format

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

allowNull, encoder

Constructor Summary

Constructors

Constructor and Description
DateValidationRule(java.lang.String typeName, Encoder encoder, java.text.DateFormat newFormat)

Method Summary

Modifier and Type	Method and Description
java.util.Date	getValid(java.lang.String context, java.lang.String input) Parse the input, throw exceptions if validation fails
private java.util.Date	safelyParse(java.lang.String context, java.lang.String input)
java.util.Date	sanitize(java.lang.String context, java.lang.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).
void	setDateFormat(java.text.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

Field Detail

format

private java.text.DateFormat format

Constructor Detail

DateValidationRule

public DateValidationRule(java.lang.String typeName,
                          Encoder encoder,
                          java.text.DateFormat newFormat)

Method Detail

setDateFormat

public final void setDateFormat(java.text.DateFormat newFormat)

getValid

public java.util.Date getValid(java.lang.String context,
                               java.lang.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 - if any validation rules fail

sanitize

public java.util.Date sanitize(java.lang.String context,
                               java.lang.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. Calls sanitize(String, String, DateFormat) with DateFormat.getInstance()

Specified by:

sanitize in class BaseValidationRule

Returns:

a parsed version of the input or a default value.

safelyParse

private java.util.Date safelyParse(java.lang.String context,
                                   java.lang.String input)
                            throws ValidationException

Throws:

ValidationException