restx.WebException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restx-core Show documentation
There is a newer version: 1.2.0-rc2
package restx;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import restx.http.HttpStatus;

import java.io.IOException;

/**
 * A WebException can be raised to make restx return immediately an HTTP response with a specific HTTP status.
 */
public class WebException extends RuntimeException {
    private final static Logger logger = LoggerFactory.getLogger(WebException.class);

    private final HttpStatus status;

    public WebException(HttpStatus status) {
        super(status.getDesc());
        this.status = status;
    }

    public WebException(HttpStatus status, String message) {
        super(message);
        this.status = status;
    }

    public WebException(String message) {
        super(message);
        this.status = HttpStatus.BAD_REQUEST;
    }

    public HttpStatus getStatus() {
        return status;
    }

    /**
     * Returns the content type to use in the HTTP response generated for this exception.
     *
     * Developer's note: override to provide another content type than text-plain
     * Alternatively you can override the writeTo method for full control over the response.
     *
     * @return the content type to use in the response.
     */
    public String getContentType() {
        return "text/plain";
    }

    /**
     * Returns the content to use in the HTTP response generated for this exception.
     *
     * Developer's note: override to provide a content different from the exception message.
     * Alternatively you can override the writeTo method for full control over the response.
     *
     * @return the content to use in the response.
     */
    public String getContent() {
        return getMessage();
    }

    /**
     * Writes this web exception in a RestxResponse.
     *
     * This implementation uses the status, contentType and content found on the exception.
     * Override it to provide custom response.
     * Note that the implementation is also responsible for logging the exception.
     *
     *
     * @param restxRequest
     * @param restxResponse the response to write to
     * @throws IOException in case of IO error.
     */
    public void writeTo(RestxRequest restxRequest, RestxResponse restxResponse) throws IOException {
        // by default log stack trace at debug level only
        if (logger.isDebugEnabled()) {
            logger.debug("request raised WebException - " + restxRequest, this);
        }

        restxResponse.setStatus(getStatus());
        restxResponse.setContentType(getContentType());
        restxResponse.getWriter().print(getContent());
    }
}