ninja.exceptions.ForbiddenRequestException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ninja-core Show documentation

There is a newer version: 7.0.0

/**
 * Copyright (C) the original author or authors.
 *
 * Licensed 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 ninja.exceptions;

import ninja.Result;

/**
 * A convenience unchecked exception. 
 * Allows you to wrap any exception (checked or unchecked) and throw it.
 * 
 * Should signal a html error 403 - forbidden (the client attempts something forbidden).
 * 
 * Useful inside controllers or filters for instance.
 * 
 * Ninja is supposed to pick it up and render an appropriate error page.
 * 
 */
public class ForbiddenRequestException extends NinjaException {  
    
    final static String DEFAULT_MESSAGE = "That's a forbidden request and all we know.";
    
    public ForbiddenRequestException() {
        super(Result.SC_403_FORBIDDEN, DEFAULT_MESSAGE);
    }

    public ForbiddenRequestException(String message) {
        super(Result.SC_403_FORBIDDEN, message);
    }
   
    public ForbiddenRequestException(String message, Throwable cause) {
        super(Result.SC_403_FORBIDDEN, message, cause);
    }

    public ForbiddenRequestException(Throwable cause) {
        super(Result.SC_403_FORBIDDEN, DEFAULT_MESSAGE, cause);
    }
}