Package com.linecorp.armeria.server

Class HttpStatusException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.linecorp.armeria.server.HttpStatusException

All Implemented Interfaces:

Serializable

public final class HttpStatusException
extends RuntimeException

A RuntimeException that is raised to send a simplistic HTTP response with minimal content by a Service. It is a general exception raised by a failed request or a reset stream.

Note that a raised HttpStatusException may not be applied to the next decorators if the HttpStatusException is not recovered before passed to the next decorator chain. For this reason, the thrown HttpStatusException should be converted into a normal HttpResponse using HttpResponse.recover(Function) or httpStatus(). For example:

 // Catch an HttpStatusException and convert into an HttpResponse
 try {
     throwableService();
 } catch (HttpStatusException ex) {
     return HttpResponse.of(ex.httpStatus());
 }

 // Recover the HttpStatusException using HttpResponse.recover()
 HttpResponse response = ...;
 response.recover(ex -> {
     if (ex instanceof HttpStatusException) {
         return HttpResponse.of(((HttpStatusException) ex).httpStatus());
     } else {
         return HttpResponse.ofFailure(ex);
     }
 })
 

An unhandled HttpStatusException will be recovered by the default ServerErrorHandler in the end. If you want to mutate the HttpResponse made of the HttpStatusException, you can add a custom ServerErrorHandler.

See Also:

• HttpResponseException
• Serialized Form

Method Summary

Modifier and Type	Method	Description
HttpStatus	httpStatus()	Returns the HttpStatus which would be sent back to the client who sent the corresponding request.
static HttpStatusException	of(int statusCode)	Returns a new HttpStatusException instance with the specified HTTP status code.
static HttpStatusException	of(int statusCode, Throwable cause)	Returns a new HttpStatusException instance with the specified HTTP status code and cause.
static HttpStatusException	of(HttpStatus status)	Returns a new HttpStatusException instance with the specified HttpStatus.
static HttpStatusException	of(HttpStatus status, Throwable cause)	Returns a new HttpStatusException instance with the specified HttpStatus and cause.

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

Method Details

of

public static HttpStatusException of(int statusCode)

Returns a new HttpStatusException instance with the specified HTTP status code.

of

public static HttpStatusException of(int statusCode,
 Throwable cause)

Returns a new HttpStatusException instance with the specified HTTP status code and cause.

of

public static HttpStatusException of(HttpStatus status)

Returns a new HttpStatusException instance with the specified HttpStatus.

of

public static HttpStatusException of(HttpStatus status,
 Throwable cause)

Returns a new HttpStatusException instance with the specified HttpStatus and cause.

httpStatus

public HttpStatus httpStatus()

Returns the HttpStatus which would be sent back to the client who sent the corresponding request.