org.openestate.is24.restapi.utils

Class RequestFailedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.openestate.is24.restapi.utils.RequestFailedException

All Implemented Interfaces:

Serializable

public class RequestFailedException
extends Exception

Exception for failed Webservice requests.

This exception is thrown, when a request to the Webservice failed. The exception holds further informations about the failed request.

Since:

0.1

Author:

Andreas Rudolph

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	requestRefNumber Unique identifier of the failed HTTP request.
Messages	responseMessages Messages, that were received in the body of the HTTP response.
int	statusCode Status code of the failed HTTP request.
String	statusMessage Status message of the failed HTTP request.

Constructor Summary

Constructors

Constructor and Description
RequestFailedException(Response response, String message)
RequestFailedException(Response response, String message, Throwable cause)

Method Summary

Methods

Modifier and Type	Method and Description
String	getRequestRefNumber() Return the unique identifier of the failed HTTP request.
Messages	getResponseMessages() Return the Messages, that were received in the body of the HTTP response.
int	getStatusCode() Return the status code of the HTTP response.
String	getStatusMessage() Return the status message of the HTTP response.

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

Field Detail

statusCode

public final int statusCode

Status code of the failed HTTP request.

statusMessage

public final String statusMessage

Status message of the failed HTTP request.

requestRefNumber

public final String requestRefNumber

Unique identifier of the failed HTTP request.

Since:

0.2.2

responseMessages

public final Messages responseMessages

Messages, that were received in the body of the HTTP response.

Constructor Detail

RequestFailedException

public RequestFailedException(Response response,
                      String message)

RequestFailedException

public RequestFailedException(Response response,
                      String message,
                      Throwable cause)

Method Detail

getRequestRefNumber

public String getRequestRefNumber()

Return the unique identifier of the failed HTTP request.

This values was passed through the L-IS24-RequestRefnum header of the HTTP response.

Returns:

unique identifier

Since:

0.2.2

getResponseMessages

public Messages getResponseMessages()

Return the Messages, that were received in the body of the HTTP response.

Returns:

messages

Since:

0.2.2

getStatusCode

public int getStatusCode()

Return the status code of the HTTP response.

Returns:

status code

Since:

0.2.2

getStatusMessage

public String getStatusMessage()

Return the status message of the HTTP response.

Returns:

status message

Since:

0.2.2