org.lockss.plugin.ContentValidationException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lockss-core Show documentation
The Slimmed Down LOCKSS Daemon Core
The newest version!
/*
 * $Id$
 */

/*

Copyright (c) 2000-2016 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
STANFORD UNIVERSITY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of Stanford University shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Stanford University.

*/

package org.lockss.plugin;

/** Exceptions that represent validation errors on ingested content.
 * ContentValidator implementations should throw this or a subclass to
 * indicate validation failure */

public class ContentValidationException extends Exception {

  public ContentValidationException() {
    super();
  }

  public ContentValidationException(String msg) {
    super(msg);
  }

  public ContentValidationException(Throwable cause) {
    super(cause);
  }

  public ContentValidationException(String msg, Throwable cause) {
    super(msg, cause);
  }

  /** Thrown by wrappers for plugin java code in response to a
   * EmptyFile */
  public static class EmptyFile extends ContentValidationException {

    public EmptyFile() {
      super();
    }

    public EmptyFile(String msg) {
      super(msg);
    }

    public EmptyFile(Throwable cause) {
      super(cause);
    }

    public EmptyFile(String msg, Throwable cause) {
      super(msg, cause);
    }
  }

  /** The actual length of the received file differs from the
   * Content-Length header. */
  public static class WrongLength extends ContentValidationException {

    public WrongLength() {
      super();
    }

    public WrongLength(String msg) {
      super(msg);
    }

    public WrongLength(Throwable cause) {
      super(cause);
    }

    public WrongLength(String msg, Throwable cause) {
      super(msg, cause);
    }
  }

  /** A ContentValidationException that's mapped (by default) to a
   * warning-only CacheException.  Can be used to log a validation message
   * without causing a validation failure. */
  public static class LogOnly extends ContentValidationException {

    public LogOnly() {
      super();
    }

    public LogOnly(String msg) {
      super(msg);
    }

    public LogOnly(Throwable cause) {
      super(cause);
    }

    public LogOnly(String msg, Throwable cause) {
      super(msg, cause);
    }
  }

  /** An unexpected exception (not a subclass of
   * ContentValidationException) was thrown by a plugin-specified
   * ContentValidator. */
  public static class ValidatorExeception extends ContentValidationException {

    public ValidatorExeception() {
      super();
    }

    public ValidatorExeception(String msg) {
      super(msg);
    }

    public ValidatorExeception(Throwable cause) {
      super(cause);
    }

    public ValidatorExeception(String msg, Throwable cause) {
      super(msg, cause);
    }
  }

}