org.lockss.laaws.error

Class LockssRestServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.lockss.laaws.error.LockssRestServiceException

All Implemented Interfaces:

Serializable

public class LockssRestServiceException
extends RuntimeException

Unchecked exception to be thrown by REST service controllers and turned into a meaningful error message by the standard exception handling.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	LockssRestServiceException() Default constructor.
	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, String message) Constructor.
	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, String message, String parsedRequest) Constructor.
	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, String message, String parsedRequest, LocalDateTime utcTimestamp) Constructor.
	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, String message, Throwable cause) Constructor.
protected	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) Constructor.
protected	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace, String parsedRequest) Constructor.
protected	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace, String parsedRequest, LocalDateTime utcTimestamp) Constructor.
	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, String message, Throwable cause, String parsedRequest) Constructor.
	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, String message, Throwable cause, String parsedRequest, LocalDateTime utcTimestamp) Constructor.
	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, Throwable cause) Constructor.
	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, Throwable cause, String parsedRequest) Constructor.
	LockssRestServiceException(org.springframework.http.HttpStatus httpStatus, Throwable cause, String parsedRequest, LocalDateTime utcTimestamp) Constructor.
	LockssRestServiceException(String message) Constructor.
	LockssRestServiceException(String message, Throwable cause) Constructor.
protected	LockssRestServiceException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) Constructor.
	LockssRestServiceException(Throwable cause) Constructor.

Method Summary

Modifier and Type	Method and Description
org.springframework.http.HttpStatus	getHttpStatus() Provides the HTTP response status.
String	getParsedRequest() Provides a copy of the parsed HTTP request contents.
LocalDateTime	getUtcTimestamp() Provides the exception date and time.
LockssRestServiceException	setHttpStatus(org.springframework.http.HttpStatus httpStatus) Sets the HTTP response status.
LockssRestServiceException	setParsedRequest(String parsedRequest) Sets the copy of the parsed HTTP request contents.
LockssRestServiceException	setUtcTimestamp(LocalDateTime utcTimestamp) Sets the exception date and time.

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 Detail

LockssRestServiceException

public LockssRestServiceException()

Default constructor.

LockssRestServiceException

public LockssRestServiceException(String message)

Constructor.

Parameters:

message - A String with the detail message.

LockssRestServiceException

public LockssRestServiceException(String message,
                                  Throwable cause)

Constructor.

Parameters:

message - A String with the detail message.

cause - A Throwable with the cause.

LockssRestServiceException

public LockssRestServiceException(Throwable cause)

Constructor.

Parameters:

cause - A Throwable with the cause.

LockssRestServiceException

protected LockssRestServiceException(String message,
                                     Throwable cause,
                                     boolean enableSuppression,
                                     boolean writableStackTrace)

Constructor.

Parameters:

message - A String with the detail message.

cause - A Throwable with the cause.

enableSuppression - A boolean indicating whether suppression is enabled.

writableStackTrace - A boolean indicating whether the stack trace should be writable.

LockssRestServiceException

public LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                  String message)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

message - A String with the detail message.

LockssRestServiceException

public LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                  String message,
                                  String parsedRequest)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

message - A String with the detail message.

parsedRequest - A String with a copy of the parsed HTTP request contents.

LockssRestServiceException

public LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                  String message,
                                  String parsedRequest,
                                  LocalDateTime utcTimestamp)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

message - A String with the detail message.

parsedRequest - A String with a copy of the parsed HTTP request contents.

utcTimestamp - A LocalDateTime with the exception date and time.

LockssRestServiceException

public LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                  String message,
                                  Throwable cause)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

message - A String with the detail message.

cause - A Throwable with the cause.

LockssRestServiceException

public LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                  String message,
                                  Throwable cause,
                                  String parsedRequest)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

message - A String with the detail message.

cause - A Throwable with the cause.

parsedRequest - A String with a copy of the parsed HTTP request contents.

LockssRestServiceException

public LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                  String message,
                                  Throwable cause,
                                  String parsedRequest,
                                  LocalDateTime utcTimestamp)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

message - A String with the detail message.

cause - A Throwable with the cause.

parsedRequest - A String with a copy of the parsed HTTP request contents.

utcTimestamp - A LocalDateTime with the exception date and time.

LockssRestServiceException

public LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                  Throwable cause)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

cause - A Throwable with the cause.

LockssRestServiceException

public LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                  Throwable cause,
                                  String parsedRequest)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

cause - A Throwable with the cause.

parsedRequest - A String with a copy of the parsed HTTP request contents.

LockssRestServiceException

public LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                  Throwable cause,
                                  String parsedRequest,
                                  LocalDateTime utcTimestamp)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

cause - A Throwable with the cause.

parsedRequest - A String with a copy of the parsed HTTP request contents.

utcTimestamp - A LocalDateTime with the exception date and time.

LockssRestServiceException

protected LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                     String message,
                                     Throwable cause,
                                     boolean enableSuppression,
                                     boolean writableStackTrace)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

message - A String with the detail message.

cause - A Throwable with the cause.

enableSuppression - A boolean indicating whether suppression is enabled.

writableStackTrace - A boolean indicating whether the stack trace should be writable.

LockssRestServiceException

protected LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                     String message,
                                     Throwable cause,
                                     boolean enableSuppression,
                                     boolean writableStackTrace,
                                     String parsedRequest)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

message - A String with the detail message.

cause - A Throwable with the cause.

enableSuppression - A boolean indicating whether suppression is enabled.

writableStackTrace - A boolean indicating whether the stack trace should be writable.

parsedRequest - A String with a copy of the parsed HTTP request contents.

LockssRestServiceException

protected LockssRestServiceException(org.springframework.http.HttpStatus httpStatus,
                                     String message,
                                     Throwable cause,
                                     boolean enableSuppression,
                                     boolean writableStackTrace,
                                     String parsedRequest,
                                     LocalDateTime utcTimestamp)

Constructor.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

message - A String with the detail message.

cause - A Throwable with the cause.

enableSuppression - A boolean indicating whether suppression is enabled.

writableStackTrace - A boolean indicating whether the stack trace should be writable.

parsedRequest - A String with a copy of the parsed HTTP request contents.

utcTimestamp - A LocalDateTime with the exception date and time.

Method Detail

getHttpStatus

public org.springframework.http.HttpStatus getHttpStatus()

Provides the HTTP response status.

Returns:

an HttpStatus with the HTTP response status.

setHttpStatus

public LockssRestServiceException setHttpStatus(org.springframework.http.HttpStatus httpStatus)

Sets the HTTP response status.

Parameters:

httpStatus - An HttpStatus with the HTTP response status.

Returns:

a LockssRestServiceException with this object.

getParsedRequest

public String getParsedRequest()

Provides a copy of the parsed HTTP request contents.

Returns:

a String with a copy of the parsed HTTP request contents.

setParsedRequest

public LockssRestServiceException setParsedRequest(String parsedRequest)

Sets the copy of the parsed HTTP request contents.

Parameters:

parsedRequest - A String with a copy of the parsed HTTP request contents.

Returns:

a LockssRestServiceException with this object.

getUtcTimestamp

public LocalDateTime getUtcTimestamp()

Provides the exception date and time.

Returns:

a LocalDateTime with the exception date and time.

setUtcTimestamp

public LockssRestServiceException setUtcTimestamp(LocalDateTime utcTimestamp)

Sets the exception date and time.

Parameters:

utcTimestamp - A LocalDateTime with the exception date and time.

Returns:

a LockssRestServiceException with this object.