Package google.registry.request

Class HttpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

google.registry.request.HttpException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HttpException.BadRequestException, HttpException.ConflictException, HttpException.InternalServerErrorException, HttpException.NoContentException, HttpException.NotFoundException, HttpException.NotImplementedException, HttpException.NotModifiedException, HttpException.ServiceUnavailableException, HttpException.UnprocessableEntityException, HttpException.UnsupportedMediaTypeException

public abstract class HttpException
extends RuntimeException

Base for exceptions that cause an HTTP error response.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpException.BadRequestException	Exception that causes a 400 response.
static final class	HttpException.ConflictException	Exception that causes a 409 response.
static final class	HttpException.InternalServerErrorException	Exception that causes a 500 response.
static final class	HttpException.NoContentException	Exception that causes a 204 response.
static final class	HttpException.NotFoundException	Exception that causes a 404 response.
static final class	HttpException.NotImplementedException	Exception that causes a 501 response.
static final class	HttpException.NotModifiedException	Exception that causes a 304 response.
static final class	HttpException.ServiceUnavailableException	Exception that causes a 503 response.
static final class	HttpException.UnprocessableEntityException	Exception that causes a 422 response.
static final class	HttpException.UnsupportedMediaTypeException	Exception that causes a 415 response.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpException(int responseCode, String message, Throwable cause)
protected	HttpException(int responseCode, String message, Throwable cause, Level logLevel)

Method Summary

Modifier and Type	Method	Description
final int	getResponseCode()
String	getResponseCodeString()	Returns the string associated with a particular response code.
final void	send(jakarta.servlet.http.HttpServletResponse rsp)	Transmits the error response to the client.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

HttpException

protected HttpException(int responseCode,
 String message,
 @Nullable
 Throwable cause,
 Level logLevel)

HttpException

protected HttpException(int responseCode,
 String message,
 @Nullable
 Throwable cause)

Method Details

getResponseCode

public final int getResponseCode()

getResponseCodeString

public String getResponseCodeString()

Returns the string associated with a particular response code. Unlike Throwable.getMessage(), which is meant to describe the circumstances under which this particular exception occurred, this method always returns the same string (e.g. "Not Found" for a 400 error), and so should always be the same for a given subclass of HttpException.

send

public final void send(jakarta.servlet.http.HttpServletResponse rsp)
                throws IOException

Transmits the error response to the client.

Throwable.getMessage() will be sent to the browser, whereas Throwable.toString() and Throwable.getCause() will be logged.

Throws:

IOException