io.inverno.mod.http.base.HttpException Maven / Gradle / Ivy
/*
* Copyright 2020 Jeremy KUHN
*
* 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 io.inverno.mod.http.base;
import io.inverno.mod.http.base.Status.Category;
/**
*
* Base exception class used to report HTTP errors.
*
*
* @author Jeremy Kuhn
* @since 1.0
*/
public class HttpException extends RuntimeException {
private static final long serialVersionUID = 2847460450871488615L;
/**
* The HTTP status code.
*/
private int statusCode;
/**
* The HTTP status reason phrase.
*/
private String statusReasonPhrase;
/**
* The HTTP status category.
*/
private Status.Category statusCategory;
/**
*
* Creates a HTTP exception with default status
* {@link Status#INTERNAL_SERVER_ERROR Internal Server Error (500)}.
*
*/
public HttpException() {
this(500);
}
/**
*
* Creates a HTTP exception with default status
* {@link Status#INTERNAL_SERVER_ERROR Internal Server Error (500)} and
* specified message.
*
*
* @param message a message
*/
public HttpException(String message) {
this(500, message);
}
/**
*
* Creates a HTTP exception with default status
* {@link Status#INTERNAL_SERVER_ERROR Internal Server Error (500)} and
* specified cause.
*
*
* @param cause a cause
*/
public HttpException(Throwable cause) {
this(500, cause);
}
/**
*
* Creates a HTTP exception with default status
* {@link Status#INTERNAL_SERVER_ERROR Internal Server Error (500)}, specified
* message and cause
*
*
* @param message a message
* @param cause a cause
*/
public HttpException(String message, Throwable cause) {
this(500, message, cause);
}
/**
*
* Creates a HTTP exception with specified HTTP status code.
*
*
* @param statusCode a HTTP status code
*
* @throws IllegalArgumentException if the specified status doesn't correspond
* to a known HTTP status
*/
public HttpException(int statusCode) throws IllegalArgumentException {
this.setStatusCode(statusCode);
}
/**
*
* Creates a HTTP exception with specified HTTP status code and message.
*
*
* @param statusCode a HTTP status code
* @param message a message
*
* @throws IllegalArgumentException if the specified status doesn't correspond
* to a known HTTP status
*/
public HttpException(int statusCode, String message) throws IllegalArgumentException {
super(message);
this.setStatusCode(statusCode);
}
/**
*
* Creates a HTTP exception with specified HTTP status code and cause.
*
*
* @param statusCode a HTTP status code
* @param cause a cause
*
* @throws IllegalArgumentException if the specified status doesn't correspond
* to a known HTTP status
*/
public HttpException(int statusCode, Throwable cause) throws IllegalArgumentException {
super(cause);
this.setStatusCode(statusCode);
}
/**
*
* Creates a HTTP exception with specified HTTP status code, message and cause.
*
*
* @param statusCode a HTTP status code
* @param message a message
* @param cause a cause
*
* @throws IllegalArgumentException if the specified status doesn't correspond
* to a known HTTP status
*/
public HttpException(int statusCode, String message, Throwable cause) throws IllegalArgumentException {
super(message, cause);
this.setStatusCode(statusCode);
}
/**
*
* Creates a HTTP exception with specified HTTP status.
*
*
* @param status a HTTP status
*/
public HttpException(Status status) {
this.setStatus(status);
}
/**
*
* Creates a HTTP exception with specified HTTP status and message.
*
*
* @param status a HTTP status
* @param message a message
*/
public HttpException(Status status, String message) {
super(message);
this.setStatus(status);
}
/**
*
* Creates a HTTP exception with specified HTTP status and cause.
*
*
* @param status a HTTP status
* @param cause a cause
*/
public HttpException(Status status, Throwable cause) {
super(cause);
this.setStatus(status);
}
/**
*
* Creates a HTTP exception with specified HTTP status, message and cause.
*
*
* @param status a HTTP status
* @param message a message
* @param cause a cause
*/
public HttpException(Status status, String message, Throwable cause) {
super(message, cause);
this.setStatus(status);
}
private void setStatus(Status status) {
this.statusCode = status.getCode();
this.statusReasonPhrase = status.getReasonPhrase();
this.statusCategory = status.getCategory();
}
private void setStatusCode(int statusCode) {
try {
Status status = Status.valueOf(statusCode);
this.statusCode = status.getCode();
this.statusReasonPhrase = status.getReasonPhrase();
}
catch(IllegalArgumentException e) {
this.statusCode = statusCode;
this.statusCategory = Status.Category.valueOf(statusCode);
}
}
/**
*
* Returns the HTTP status code.
*
*
* @return a HTTP status code
*/
public int getStatusCode() {
return this.statusCode;
}
/**
*
* Returns the HTTP status reason phrase.
*
*
* @return a reason phrase
*/
public String getStatusReasonPhrase() {
return this.statusReasonPhrase;
}
/**
*
* Returns the HTTP status category.
*
*
* @return a HTTP status category
*/
public Category getStatusCategory() {
return this.statusCategory;
}
}