Module io.helidon.http

Package io.helidon.http

Class HttpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.helidon.http.HttpException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BadRequestException, ForbiddenException, InternalServerException, NotFoundException, UnauthorizedException

public class HttpException
extends RuntimeException

Runtime exception for applications.

This exception may be thrown during request processing if a specific HTTP error response needs to be produced. Only effective if thrown before the status code is sent.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
HttpException(String message)	Creates HttpException associated with Status.INTERNAL_SERVER_ERROR_500.
HttpException(String message, Status status)	Creates HttpException.
HttpException(String message, Status status, boolean keepAlive)	Creates HttpException.
HttpException(String message, Status status, Throwable cause)	Creates HttpException.
HttpException(String message, Status status, Throwable cause, boolean keepAlive)	Creates HttpException.
HttpException(String message, Throwable cause)	Creates HttpException associated with Status.INTERNAL_SERVER_ERROR_500.

Method Summary

Modifier and Type	Method	Description
HttpException	header(Header header)	Set a response header that should be used if this exception is not handled.
Headers	headers()	Headers as currently configured in this exception.
boolean	keepAlive()	Whether we should attempt to keep the connection alive (if enabled for it).
final Status	status()	Obtain the associated http status.

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

public HttpException(String message)

Creates HttpException associated with Status.INTERNAL_SERVER_ERROR_500.

Parameters:

message - the message

HttpException

public HttpException(String message,
 Throwable cause)

Creates HttpException associated with Status.INTERNAL_SERVER_ERROR_500.

Parameters:

message - the message

cause - the cause of this exception

HttpException

public HttpException(String message,
 Status status)

Creates HttpException.

Parameters:

message - the message

status - the http status

HttpException

public HttpException(String message,
 Status status,
 boolean keepAlive)

Creates HttpException.

Parameters:

message - the message

status - the http status

keepAlive - whether to keep the connection alive

HttpException

public HttpException(String message,
 Status status,
 Throwable cause)

Creates HttpException.

Parameters:

message - the message

status - the http status

cause - the cause of this exception

HttpException

public HttpException(String message,
 Status status,
 Throwable cause,
 boolean keepAlive)

Creates HttpException.

Parameters:

message - the message

status - the http status

cause - the cause of this exception

keepAlive - whether to keep this connection alive

Method Details

status

public final Status status()

Obtain the associated http status.

Returns:

the http status

keepAlive

public boolean keepAlive()

Whether we should attempt to keep the connection alive (if enabled for it). Some exceptions may allow the connection to be further used (such as NotFoundException.

Returns:

whether to keep alive

header

public HttpException header(Header header)

Set a response header that should be used if this exception is not handled.

Parameters:

header - header to set

Returns:

updated instance

headers

public Headers headers()

Headers as currently configured in this exception.

Returns:

headers configured for this exception