Package com.linecorp.armeria.server

Interface ExceptionHandler

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@UnstableApi
@FunctionalInterface
public interface ExceptionHandler

Converts a Throwable to an AggregatedHttpResponse. Use this ExceptionHandler to send a different response depending on the Throwable:

 ExceptionHandler handler = (ctx, cause) -> {
     if (cause instanceof IllegalArgumentException) {
         return HttpResponse.of(HttpStatus.BAD_REQUEST);
     }

     // You can return a different response using the path.
     if ("/outage".equals(ctx.path())) {
         return HttpResponse.of(HttpStatus.INTERNAL_SERVER_ERROR,
                                MediaType.PLAIN_TEXT, "Oops, something went wrong.");
     }

     // Return null to let ExceptionHandler.ofDefault() convert the exception.
     return null;
 }

 Server.builder().exceptionHandler(handler)...

 

See Also:

ServerBuilder.exceptionHandler(ExceptionHandler)

Method Summary

Modifier and Type	Method	Description
@Nullable HttpResponse	convert(ServiceRequestContext context, Throwable cause)	Converts the given Throwable to an AggregatedHttpResponse.
static ExceptionHandler	ofDefault()	Returns the default ExceptionHandler.
default ExceptionHandler	orElse(ExceptionHandler other)	Creates a new ExceptionHandler that tries this ExceptionHandler first and then the specified ExceptionHandler when this ExceptionHandler returns null.

Method Details

ofDefault

static ExceptionHandler ofDefault()

Returns the default ExceptionHandler.

convert

@Nullable
@Nullable HttpResponse convert(ServiceRequestContext context,
 Throwable cause)

Converts the given Throwable to an AggregatedHttpResponse. When null is returned, ofDefault() converts the Throwable.

See Also:

orElse(ExceptionHandler)

orElse

default ExceptionHandler orElse(ExceptionHandler other)

Creates a new ExceptionHandler that tries this ExceptionHandler first and then the specified ExceptionHandler when this ExceptionHandler returns null.