Package net.officefloor.server.http

Class HttpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.officefloor.server.http.HttpException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AccessTokenException, AuthenticationContinuationException, BadRequestHttpException, InvalidatedSessionHttpException, NotFoundHttpException, RefreshTokenException, RetrieveValueException, StoringSessionHttpException, ValidateKeysException

public class HttpException
extends java.lang.RuntimeException

HTTP Exception.

This is a RuntimeException as typically this is handled directly by the HttpServerImplementation to send a HttpResponse. It is typically not for application logic to handle.

Author:

Daniel Sagenschneider

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HttpException(int statusCode, java.lang.String errorMessage)	Convenience constructor for providing error message.
HttpException(java.lang.Throwable cause)	Enable wrapping Throwable in a HttpException for HttpStatus.INTERNAL_SERVER_ERROR.
HttpException(HttpStatus status)	Instantiate.
HttpException(HttpStatus status, java.lang.String errorMessage)	Convenience constructor for providing error message.
HttpException(HttpStatus status, java.lang.Throwable cause)	Instantiate.
HttpException(HttpStatus status, WritableHttpHeader[] headers, java.lang.String entity)	Instantiate.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getEntity()	Obtains the entity for the HttpResponse.
HttpHeader[]	getHttpHeaders()	Obtains the HttpHeader instances.
HttpStatus	getHttpStatus()	Obtains the HttpStatus for the HttpResponse.
java.lang.String	getMessage()
<B> void	writeHttpResponse(HttpVersion version, boolean isIncludeStackTrace, StreamBuffer<B> head, StreamBufferPool<B> bufferPool)	Writes the HTTP response for this HttpException.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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 Detail

HttpException

public HttpException(HttpStatus status)

Instantiate.

Parameters:

status - HttpStatus.

HttpException

public HttpException(HttpStatus status,
                     java.lang.Throwable cause)

Instantiate.

Parameters:

status - HttpStatus.

cause - Throwable cause.

HttpException

public HttpException(int statusCode,
                     java.lang.String errorMessage)

Convenience constructor for providing error message.

Parameters:

statusCode - Status code.

errorMessage - Error message.

HttpException

public HttpException(HttpStatus status,
                     java.lang.String errorMessage)

Convenience constructor for providing error message.

Parameters:

status - HttpStatus.

errorMessage - Error message.

HttpException

public HttpException(HttpStatus status,
                     WritableHttpHeader[] headers,
                     java.lang.String entity)

Instantiate.

Parameters:

status - HttpStatus.

headers - HttpHeader instances. May be null.

entity - Entity for the HttpResponse. May be null.

HttpException

public HttpException(java.lang.Throwable cause)

Enable wrapping Throwable in a HttpException for HttpStatus.INTERNAL_SERVER_ERROR.

Parameters:

cause - Throwable cause.

Method Detail

getHttpStatus

public HttpStatus getHttpStatus()

Obtains the HttpStatus for the HttpResponse.

Returns:

HttpStatus for the HttpResponse.

getHttpHeaders

public HttpHeader[] getHttpHeaders()

Obtains the HttpHeader instances.

Returns:

HttpHeader instances.

getEntity

public java.lang.String getEntity()

Obtains the entity for the HttpResponse.

Returns:

Entity for the HttpResponse.

writeHttpResponse

public <B> void writeHttpResponse(HttpVersion version,
                                  boolean isIncludeStackTrace,
                                  StreamBuffer<B> head,
                                  StreamBufferPool<B> bufferPool)

Writes the HTTP response for this HttpException.

Type Parameters:

B - Buffer type.

Parameters:

version - HttpVersion.

isIncludeStackTrace - Whether to include the stack trace.

head - Head StreamBuffer of the linked list of StreamBuffer instances.

bufferPool - StreamBufferPool.

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable