org.owasp.esapi.errors

Class ValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.owasp.esapi.errors.EnterpriseSecurityException

org.owasp.esapi.errors.ValidationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ValidationAvailabilityException, ValidationUploadException

public class ValidationException
extends EnterpriseSecurityException

A ValidationException should be thrown to indicate that the data provided by the user or from some other external source does not match the validation rules that have been specified for that data.

Author:

Jeff Williams (jeff.williams@aspectsecurity.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	serialVersionUID

Fields inherited from class org.owasp.esapi.errors.EnterpriseSecurityException

logger, logMessage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValidationException() Instantiates a new validation exception.
	ValidationException(String userMessage, String logMessage) Creates a new instance of ValidationException.
	ValidationException(String userMessage, String logMessage, String context) Creates a new instance of ValidationException.
	ValidationException(String userMessage, String logMessage, Throwable cause) Instantiates a new ValidationException.
	ValidationException(String userMessage, String logMessage, Throwable cause, String context) Instantiates a new ValidationException.

Method Summary

Methods

Modifier and Type	Method and Description
String	getContext() Returns the UI reference that caused this ValidationException
void	setContext(String context) Set's the UI reference that caused this ValidationException

Methods inherited from class org.owasp.esapi.errors.EnterpriseSecurityException

getLogMessage, getUserMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ValidationException

protected ValidationException()

Instantiates a new validation exception.

ValidationException

public ValidationException(String userMessage,
                   String logMessage)

Creates a new instance of ValidationException.

Parameters:

userMessage - the message to display to users

logMessage - the message logged

ValidationException

public ValidationException(String userMessage,
                   String logMessage,
                   Throwable cause)

Instantiates a new ValidationException.

Parameters:

userMessage - the message to display to users

logMessage - the message logged

cause - the cause

ValidationException

public ValidationException(String userMessage,
                   String logMessage,
                   String context)

Creates a new instance of ValidationException.

Parameters:

userMessage - the message to display to users

logMessage - the message logged

context - the source that caused this exception

ValidationException

public ValidationException(String userMessage,
                   String logMessage,
                   Throwable cause,
                   String context)

Instantiates a new ValidationException.

Parameters:

userMessage - the message to display to users

logMessage - the message logged

cause - the cause

context - the source that caused this exception

Method Detail

getContext

public String getContext()

Returns the UI reference that caused this ValidationException

Returns:

context, the source that caused the exception, stored as a string

setContext

public void setContext(String context)

Set's the UI reference that caused this ValidationException

Parameters:

context - the context to set, passed as a String