org.apache.sling.api.SlingException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.sling.api Show documentation

The Apache Sling API defines an extension to the Servlet API 2.4 to provide access to content and unified access to request parameters hiding the differences between the different methods of transferring parameters from client to server. Note that the Apache Sling API bundle does not include the Servlet API but instead requires the API to be provided by the Servlet container in which the Apache Sling framework is running or by another bundle.

There is a newer version: 2.27.6

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.sling.api;

/**
 * The SlingException is the base exception used throughout the
 * Sling API. This exception should only be thrown if there is no more specific
 * exception defined in the Sling API for the cause and if a cause can be
 * supplied. Otherwise the more specific exception must be used.
 * 
 * The SlingException is a RuntimeException
 * because this exception is not intended to be caught by client code. Rather
 * this exception (and extensions thereof) should be passed through up to the
 * actual Sling error and exception handling.
 */
public class SlingException extends RuntimeException {

    /**
     * Serial Version ID for pre Java2 RMI
     */
    private static final long serialVersionUID = -1243027389278210618L;

    /**
     * Constructs a new Sling exception.
     */
    protected SlingException() {
        super();
    }

    /**
     * Constructs a new Sling exception with the given text. The Sling framework
     * may use the text to write it to a log.
     *
     * @param text the exception text
     */
    protected SlingException(String text) {
        super(text);
    }

    /**
     * Constructs a new Sling exception when the Servlet needs to do the
     * following:
     * 

     * throw an exception
     * 
include the "root cause" exception
     * 
include a description message
     * 
     *
     * @param text the exception text
     * @param cause the root cause
     */
    public SlingException(String text, Throwable cause) {
        super(text, cause);
    }

    /**
     * Constructs a new Sling exception when the Servlet needs to throw an
     * exception. The exception's message is based on the localized message of
     * the underlying exception.
     *
     * @param cause the root cause
     */
    protected SlingException(Throwable cause) {
        super(cause);
    }
}