Package com.linecorp.armeria.server

Class HttpResponseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.linecorp.armeria.server.HttpResponseException

All Implemented Interfaces:

Serializable

public final class HttpResponseException
extends RuntimeException

A RuntimeException that is raised to send an HTTP response with the content specified by a user. This class holds an HttpResponse which would be sent back to the client who sent the corresponding request.

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

 // Catch the HttpResponseException and convert into an HttpResponse
 try {
     throwableService();
 } catch (HttpResponseException ex) {
     return ex.httpResponse();
 }

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

An unhandled HttpResponseException is recovered by the default ServerErrorHandler in the end. If you want to mutate the HttpResponse in the HttpResponseException, you can add a custom ServerErrorHandler.

See Also:

• HttpStatusException
• Serialized Form

Method Summary

Modifier and Type	Method	Description
Throwable	fillInStackTrace()
HttpResponse	httpResponse()	Returns the HttpResponse which would be sent back to the client who sent the corresponding request.
static HttpResponseException	of(int statusCode)	Deprecated. Use HttpStatusException.of(int) instead.
static HttpResponseException	of(AggregatedHttpResponse aggregatedResponse)	Returns a new HttpResponseException instance with the specified AggregatedHttpResponse.
static HttpResponseException	of(AggregatedHttpResponse aggregatedResponse, @Nullable Throwable cause)	Returns a new HttpResponseException instance with the specified AggregatedHttpResponse and Throwable.
static HttpResponseException	of(HttpResponse httpResponse)	Returns a new HttpResponseException instance with the specified HttpResponse.
static HttpResponseException	of(HttpResponse httpResponse, @Nullable Throwable cause)	Returns a new HttpResponseException instance with the specified HttpResponse and Throwable.
static HttpResponseException	of(HttpStatus httpStatus)	Deprecated. Use HttpStatusException.of(HttpStatus) instead.

Methods inherited from class java.lang.Throwable

addSuppressed, 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

@Deprecated
public static HttpResponseException of(int statusCode)

Deprecated.

Use HttpStatusException.of(int) instead.

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

of

@Deprecated
public static HttpResponseException of(HttpStatus httpStatus)

Deprecated.

Use HttpStatusException.of(HttpStatus) instead.

Returns a new HttpResponseException instance with the specified HttpStatus.

of

public static HttpResponseException of(AggregatedHttpResponse aggregatedResponse)

Returns a new HttpResponseException instance with the specified AggregatedHttpResponse.

of

public static HttpResponseException of(AggregatedHttpResponse aggregatedResponse,
 @Nullable
 @Nullable Throwable cause)

Returns a new HttpResponseException instance with the specified AggregatedHttpResponse and Throwable.

of

public static HttpResponseException of(HttpResponse httpResponse)

Returns a new HttpResponseException instance with the specified HttpResponse.

of

public static HttpResponseException of(HttpResponse httpResponse,
 @Nullable
 @Nullable Throwable cause)

Returns a new HttpResponseException instance with the specified HttpResponse and Throwable.

httpResponse

public HttpResponse httpResponse()

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

fillInStackTrace

public Throwable fillInStackTrace()

Overrides:

fillInStackTrace in class Throwable