Class DataRetrievalResponseBase<T>

java.lang.Object

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

All Implemented Interfaces:

DataRetrievalResponse<T>

Direct Known Subclasses:

CachedCardinalityResponseImpl, JSONResponseImpl, RecordsResponseImpl, SolMapsResponseImpl, StringResponseImpl, TPFResponseImpl, TriplesResponseImpl

public abstract 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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataRetrievalResponseBase(T data, FederationMember fm, DataRetrievalRequest request, Date requestStartTime)	Constructs a response with the given data, federation member, request, and request start time.
protected	DataRetrievalResponseBase(T data, FederationMember fm, DataRetrievalRequest request, Date requestStartTime, Integer errorStatusCode, String errorDescription)	Constructs a response with the given data, federation member, request, request start time, and error details.
protected	DataRetrievalResponseBase(T data, FederationMember fm, DataRetrievalRequest request, Date requestStartTime, Date retrievalEndTime)	Constructs a response with the given data, federation member, request, request start time, and request end time.
protected	DataRetrievalResponseBase(T data, FederationMember fm, DataRetrievalRequest request, Date requestStartTime, Date retrievalEndTime, Integer errorStatusCode, String errorDescription)	Constructs a response with the given data, federation member, request, request start time, retrieval end time, and error details.

Method Summary

Modifier and Type	Method	Description
String	getErrorDescription()	Returns a short textual description of the error, if available.
Integer	getErrorStatusCode()	Returns the HTTP status code associated with an error, if any.
FederationMember	getFederationMember()	Returns the federation member from which this response originates.
DataRetrievalRequest	getRequest()	Returns the data retrieval request that led to this response.
Date	getRequestStartTime()	Returns the timestamp indicating when the data retrieval request was initiated.
T	getResponseData()	Returns the data retrieved in response to the corresponding request, or throws UnsupportedOperationDueToRetrievalError if an error occurred during data retrieval.
Date	getRetrievalEndTime()	Returns the timestamp indicating when the data retrieval was completed.

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.engine.federation.access.DataRetrievalResponse

getRequestDuration, isError

Field Details

data

protected final T data

errorStatusCode

protected final Integer errorStatusCode

errorDescription

protected final String errorDescription

Constructor Details

DataRetrievalResponseBase

protected DataRetrievalResponseBase(T data,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime)

Constructs a response with the given data, federation member, request, 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)

fm - the federation member from which this response originates (must not be null)

request - the request associated with this response (must not be null)

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

DataRetrievalResponseBase

protected DataRetrievalResponseBase(T data,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime,
 Date retrievalEndTime)

Constructs a response with the given data, federation member, request, 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)

fm - the federation member from which this response originates (must not be null)

request - the request associated with 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(T data,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime,
 Integer errorStatusCode,
 String errorDescription)

Constructs a response with the given data, federation member, request, request start time, and error details. The retrieval end time is automatically set to the current time at the moment of construction.

Parameters:

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

fm - the federation member from which this response originates (must not be null)

request - the request associated with this response (must not be null)

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

errorStatusCode - the HTTP status code representing an error, or null if no error occurred

errorDescription - a short description of the error, or null if no error occurred

DataRetrievalResponseBase

protected DataRetrievalResponseBase(T data,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime,
 Date retrievalEndTime,
 Integer errorStatusCode,
 String errorDescription)

Constructs a response with the given data, federation member, request, request start time, retrieval end time, and error details.

Parameters:

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

fm - the federation member from which this response originates (must not be null)

request - the request associated with 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)

errorStatusCode - the HTTP status code representing an error, or null if no error occurred

errorDescription - a short description of the error, or null if no error occurred

Method Details

getFederationMember

public FederationMember getFederationMember()

Returns the federation member from which this response originates.

Specified by:

getFederationMember in interface DataRetrievalResponse<T>

Returns:

the corresponding federation member

getRequest

public DataRetrievalRequest getRequest()

Returns the data retrieval request that led to this response.

Specified by:

getRequest in interface DataRetrievalResponse<T>

Returns:

the associated data retrieval request

getRequestStartTime

public Date getRequestStartTime()

Returns the timestamp indicating when the data retrieval request was initiated.

Specified by:

getRequestStartTime in interface DataRetrievalResponse<T>

Returns:

the request start time

getRetrievalEndTime

public Date getRetrievalEndTime()

Returns the timestamp indicating when the data retrieval was completed.

Specified by:

getRetrievalEndTime in interface DataRetrievalResponse<T>

Returns:

the retrieval end time

getErrorStatusCode

public Integer getErrorStatusCode()

Returns the HTTP status code associated with an error, if any.

Specified by:

getErrorStatusCode in interface DataRetrievalResponse<T>

Returns:

the error status code, or null if no error occurred

getErrorDescription

public String getErrorDescription()

Returns a short textual description of the error, if available.

Specified by:

getErrorDescription in interface DataRetrievalResponse<T>

Returns:

the error description, or null if no error occurred

getResponseData

public T getResponseData()
                  throws UnsupportedOperationDueToRetrievalError

Returns the data retrieved in response to the corresponding request, or throws UnsupportedOperationDueToRetrievalError if an error occurred during data retrieval.

Specified by:

getResponseData in interface DataRetrievalResponse<T>

Returns:

the data retrieved in this response

Throws:

UnsupportedOperationDueToRetrievalError