Class DataRetrievalResponseBase<T>

java.lang.Object

se.liu.ida.hefquin.federation.access.impl.response.DataRetrievalResponseBase<T>

All Implemented Interfaces:

DataRetrievalResponse<T>

Direct Known Subclasses:

CachedCardinalityResponse, CardinalityResponseImpl, JSONResponseImpl, RecordsResponseImpl, SolMapsResponseImpl, StringResponseImpl, TPFResponseImpl

public class DataRetrievalResponseBase<T>
extends Object
implements DataRetrievalResponse<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	data
protected final String	errorDescription
protected final Integer	errorStatusCode
protected final Exception	exception
protected final Date	requestStartTime
protected final Date	retrievalEndTime

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataRetrievalResponseBase(int errorStatusCode, String errorDescription, Date requestStartTime)	Constructs a response for the case that the response was an error message.
protected	DataRetrievalResponseBase(int errorStatusCode, String errorDescription, Date requestStartTime, Date retrievalEndTime)	Constructs a response for the case that the response was an error message.
protected	DataRetrievalResponseBase(Exception exception, Date requestStartTime)	Constructs a defective response for the case that an exception was thrown when producing the response.
protected	DataRetrievalResponseBase(Exception exception, Date requestStartTime, Date retrievalEndTime)	Constructs a defective response for the case that an exception was thrown when producing the response.
protected	DataRetrievalResponseBase(T data, Date requestStartTime)	Constructs a response with the given data and request start time.
protected	DataRetrievalResponseBase(T data, Date requestStartTime, Date retrievalEndTime)	Constructs a response with the given data, request start time, and request end time.

Method Summary

Modifier and Type	Method	Description
String	getErrorDescription()	In case that DataRetrievalResponse.isError() is true, this method returns a short description of the error if available, or null otherwise.
Integer	getErrorStatusCode()	Returns the HTTP status code if the corresponding request resulted in an error, or null otherwise.
Exception	getException()	In case that issuing the request that was supposed to result in this response failed with an exception or reading the data obtained via the request failed with an exception, this method returns that exception; otherwise it returns null.
Date	getRequestStartTime()	Returns the time at which the corresponding data retrieval request (see invalid reference #getRequest() ) was started.
T	getResponseData()	Returns the data retrieved in this response, or throws an exception (UnsupportedOperationDueToRetrievalError) if either the response to the corresponding request was an error message (see DataRetrievalResponse.isError()) or the response is defective (see DataRetrievalResponse.isDefective()).
Date	getRetrievalEndTime()	Returns the time at which the retrieval of this response was completed.
protected void	throwExceptionIfNoResponseData()	Throws an UnsupportedOperationDueToRetrievalError exception if (DataRetrievalResponse.isError() is true or DataRetrievalResponse.isDefective() is true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface se.liu.ida.hefquin.federation.access.DataRetrievalResponse

getRequestDuration, isDefective, isError

Field Details

data

protected final T data

errorStatusCode

protected final Integer errorStatusCode

errorDescription

protected final String errorDescription

exception

protected final Exception exception

requestStartTime

protected final Date requestStartTime

retrievalEndTime

protected final Date retrievalEndTime

Constructor Details

DataRetrievalResponseBase

protected DataRetrievalResponseBase(T data,
 Date requestStartTime)

Constructs a response with the given data and request start time. The retrieval end time is automatically set to the current time at the moment of construction. This constructor assumes no error occurred.

Parameters:

data - the data contained in this response (must not be null)

requestStartTime - the time at which the request was initiated (must not be null)

DataRetrievalResponseBase

protected DataRetrievalResponseBase(T data,
 Date requestStartTime,
 Date retrievalEndTime)

Constructs a response with the given data, request start time, and request end time. This constructor assumes no error occurred.

Parameters:

data - the data contained in this response (must not be null)

requestStartTime - the time at which the request was initiated (must not be null)

retrievalEndTime - the time at which the retrieval of this response was completed (must not be null)

DataRetrievalResponseBase

protected DataRetrievalResponseBase(int errorStatusCode,
 String errorDescription,
 Date requestStartTime)

Constructs a response for the case that the response was an error message. The retrieval end time is automatically set to the current time at the moment of construction.

Parameters:

errorStatusCode - the HTTP status code of the error message (must not be null)

errorDescription - a short description of the error (may be null)

requestStartTime - the time at which the request was initiated (must not be null)

DataRetrievalResponseBase

protected DataRetrievalResponseBase(int errorStatusCode,
 String errorDescription,
 Date requestStartTime,
 Date retrievalEndTime)

Constructs a response for the case that the response was an error message.

Parameters:

errorStatusCode - the HTTP status code of the error message (must not be null)

errorDescription - a short description of the error (may be null)

requestStartTime - the time at which the request was initiated (must not be null)

retrievalEndTime - the time at which the retrieval of this response was completed (must not be null)

DataRetrievalResponseBase

protected DataRetrievalResponseBase(Exception exception,
 Date requestStartTime)

Constructs a defective response for the case that an exception was thrown when producing the response. The retrieval end time is automatically set to the current time at the moment of construction.

Parameters:

exception - the exception (must not be null)

requestStartTime - the time at which the request was initiated (must not be null)

DataRetrievalResponseBase

protected DataRetrievalResponseBase(Exception exception,
 Date requestStartTime,
 Date retrievalEndTime)

Constructs a defective response for the case that an exception was thrown when producing the response.

Parameters:

exception - the exception (must not be null)

requestStartTime - the time at which the request was initiated (must not be null)

retrievalEndTime - the time at which the creation of this response resulted in an exception (must not be null)

Method Details

getResponseData

public T getResponseData()
                  throws UnsupportedOperationDueToRetrievalError

Description copied from interface: DataRetrievalResponse

Returns the data retrieved in this response, or throws an exception (UnsupportedOperationDueToRetrievalError) if either the response to the corresponding request was an error message (see DataRetrievalResponse.isError()) or the response is defective (see DataRetrievalResponse.isDefective()).

Specified by:

getResponseData in interface DataRetrievalResponse<T>

Throws:

UnsupportedOperationDueToRetrievalError

getErrorStatusCode

public Integer getErrorStatusCode()

Description copied from interface: DataRetrievalResponse

Returns the HTTP status code if the corresponding request resulted in an error, or null otherwise.

Specified by:

getErrorStatusCode in interface DataRetrievalResponse<T>

getErrorDescription

public String getErrorDescription()

Description copied from interface: DataRetrievalResponse

In case that DataRetrievalResponse.isError() is true, this method returns a short description of the error if available, or null otherwise.

Specified by:

getErrorDescription in interface DataRetrievalResponse<T>

getException

public Exception getException()

Description copied from interface: DataRetrievalResponse

In case that issuing the request that was supposed to result in this response failed with an exception or reading the data obtained via the request failed with an exception, this method returns that exception; otherwise it returns null. The exception returned by this method (if any) should have a message that contains the right amount of detail to be shown to the user as part of an explanation that the query result produced by HeFQUIN may be incomplete.

Specified by:

getException in interface DataRetrievalResponse<T>

getRequestStartTime

public Date getRequestStartTime()

Description copied from interface: DataRetrievalResponse

Returns the time at which the corresponding data retrieval request (see

invalid reference

#getRequest()

) was started.

Specified by:

getRequestStartTime in interface DataRetrievalResponse<T>

getRetrievalEndTime

public Date getRetrievalEndTime()

Description copied from interface: DataRetrievalResponse

Returns the time at which the retrieval of this response was completed.

Specified by:

getRetrievalEndTime in interface DataRetrievalResponse<T>

throwExceptionIfNoResponseData

protected void throwExceptionIfNoResponseData()
                                       throws UnsupportedOperationDueToRetrievalError

Throws an UnsupportedOperationDueToRetrievalError exception if (DataRetrievalResponse.isError() is true or DataRetrievalResponse.isDefective() is true. Hence, this method can be used as an initial check in all methods that assume this response contains the requested data (i.e., the response to the corresponding request was an not error message and the response is not defective.

Throws:

UnsupportedOperationDueToRetrievalError