org.owasp.fileio.ValidationException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-file-io Show documentation
The OWASP Java File I/O Security Project provides an easy to use library for validating and sanitizing filenames, directory paths, and uploaded files.
The newest version!
/**
 * This file is part of the Open Web Application Security Project (OWASP) Java File IO Security project. For details, please see
 * https://www.owasp.org/index.php/OWASP_Java_File_I_O_Security_Project.
 *
 * Copyright (c) 2014 - The OWASP Foundation
 *
 * This API is published by OWASP under the Apache 2.0 license. You should read and accept the LICENSE before you use, modify, and/or redistribute this software.
 *
 * @author Jeff Williams Aspect Security - Original ESAPI author
 * @author August Detlefsen CodeMagi - Java File IO Security Project lead
 * @created 2014
 */
package org.owasp.fileio;

/**
 * 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.
 */
public class ValidationException extends Exception {

    protected static final long serialVersionUID = 1L;
    /**
     * The UI reference that caused this ValidationException
     */
    private String context;
    /**
     *
     */
    protected String logMessage = null;

    /**
     * Instantiates a new validation exception.
     */
    protected ValidationException() {
	// hidden
    }

    /**
     * Creates a new instance of ValidationException.
     *
     * @param userMessage the message to display to users
     * @param logMessage the message logged
     */
    public ValidationException(String userMessage, String logMessage) {
	super(userMessage);
	this.logMessage = logMessage;
    }

    /**
     * Instantiates a new ValidationException.
     *
     * @param userMessage the message to display to users
     * @param logMessage the message logged
     * @param cause the cause
     */
    public ValidationException(String userMessage, String logMessage, Throwable cause) {
	super(userMessage, cause);
	this.logMessage = logMessage;
    }

    /**
     * Creates a new instance of ValidationException.
     *
     * @param userMessage the message to display to users
     * @param logMessage the message logged
     * @param context the source that caused this exception
     */
    public ValidationException(String userMessage, String logMessage, String context) {
	super(userMessage);
	this.logMessage = logMessage;
	setContext(context);
    }

    /**
     * Instantiates a new ValidationException.
     *
     * @param userMessage the message to display to users
     * @param logMessage the message logged
     * @param cause the cause
     * @param context the source that caused this exception
     */
    public ValidationException(String userMessage, String logMessage, Throwable cause, String context) {
	super(userMessage, cause);
	this.logMessage = logMessage;
	setContext(context);
    }

    /**
     * Returns the UI reference that caused this ValidationException
     *
     * @return context, the source that caused the exception, stored as a string
     */
    public String getContext() {
	return context;
    }

    /**
     * Set's the UI reference that caused this ValidationException
     *
     * @param context the context to set, passed as a String
     */
    protected void setContext(String context) {
	this.context = context;
    }

    /**
     * Returns the UI reference that caused this ValidationException
     *
     * @return context, the source that caused the exception, stored as a string
     */
    public String getLogMessage() {
	return logMessage;
    }
}