Class CardinalityResponseImpl

java.lang.Object

se.liu.ida.hefquin.engine.federation.access.impl.response.CardinalityResponseImpl

All Implemented Interfaces:

CardinalityResponse, DataRetrievalResponse<Integer>

Direct Known Subclasses:

CardinalityResponseImplWithoutCardinality

public class CardinalityResponseImpl
extends Object
implements CardinalityResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	cardinality
protected final DataRetrievalRequest	request
protected final DataRetrievalResponse<?>	wrappedResponse

Constructor Summary

Constructors

Constructor	Description
CardinalityResponseImpl(DataRetrievalResponse<?> wrappedResponse, DataRetrievalRequest request, int cardinality)	Constructs a cardinality response that wraps the given data retrieval response and associates it with a request and a cardinality value.

Method Summary

Modifier and Type	Method	Description
String	getErrorDescription()	Returns a short description of the error from the wrapped response, if available.
Integer	getErrorStatusCode()	Returns the error status code from the wrapped response, if any.
FederationMember	getFederationMember()	Returns the federation member associated with the wrapped response.
DataRetrievalRequest	getRequest()	Returns the data retrieval request associated with this response.
Duration	getRequestDuration()	Returns the duration between the request start and the retrieval end time, as reported by the wrapped response.
Date	getRequestStartTime()	Returns the timestamp indicating when the original request was initiated.
Integer	getResponseData()	Returns the cardinality value as the response data.
Date	getRetrievalEndTime()	Returns the timestamp indicating when the retrieval of the wrapped response completed.
DataRetrievalResponse<?>	getWrappedResponse()	Returns the original data retrieval response that this object wraps.
boolean	isError()	Indicates whether an error occurred during data retrieval, based on the wrapped response.

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.CardinalityResponse

getCardinality

Field Details

wrappedResponse

protected final DataRetrievalResponse<?> wrappedResponse

request

protected final DataRetrievalRequest request

cardinality

protected final int cardinality

Constructor Details

CardinalityResponseImpl

public CardinalityResponseImpl(DataRetrievalResponse<?> wrappedResponse,
 DataRetrievalRequest request,
 int cardinality)

Constructs a cardinality response that wraps the given data retrieval response and associates it with a request and a cardinality value.

Parameters:

wrappedResponse - the wrapped data retrieval response (must not be null)

request - the original data retrieval request (must not be null)

cardinality - the cardinality of the request

Method Details

getWrappedResponse

public DataRetrievalResponse<?> getWrappedResponse()

Returns the original data retrieval response that this object wraps.

Returns:

the wrapped DataRetrievalResponse instance

getFederationMember

public FederationMember getFederationMember()

Returns the federation member associated with the wrapped response.

Specified by:

getFederationMember in interface DataRetrievalResponse<Integer>

Returns:

the corresponding federation member

getRequest

public DataRetrievalRequest getRequest()

Returns the data retrieval request associated with this response.

Specified by:

getRequest in interface DataRetrievalResponse<Integer>

Returns:

the associated DataRetrievalRequest

getRequestStartTime

public Date getRequestStartTime()

Returns the timestamp indicating when the original request was initiated.

Specified by:

getRequestStartTime in interface DataRetrievalResponse<Integer>

Returns:

the request start time

getRetrievalEndTime

public Date getRetrievalEndTime()

Returns the timestamp indicating when the retrieval of the wrapped response completed.

Specified by:

getRetrievalEndTime in interface DataRetrievalResponse<Integer>

Returns:

the retrieval end time

getRequestDuration

public Duration getRequestDuration()

Returns the duration between the request start and the retrieval end time, as reported by the wrapped response.

Specified by:

getRequestDuration in interface DataRetrievalResponse<Integer>

Returns:

the total duration of the request

isError

public boolean isError()

Indicates whether an error occurred during data retrieval, based on the wrapped response.

Specified by:

isError in interface DataRetrievalResponse<Integer>

Returns:

true if an error occurred. otherwise false

getErrorStatusCode

public Integer getErrorStatusCode()

Returns the error status code from the wrapped response, if any.

Specified by:

getErrorStatusCode in interface DataRetrievalResponse<Integer>

Returns:

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

getErrorDescription

public String getErrorDescription()

Returns a short description of the error from the wrapped response, if available.

Specified by:

getErrorDescription in interface DataRetrievalResponse<Integer>

Returns:

the error description, or null if no error occurred

getResponseData

public Integer getResponseData()
                        throws UnsupportedOperationDueToRetrievalError

Returns the cardinality value as the response data. If the wrapped response indicates an error, this method throws an exception instead of returning a value.

Specified by:

getResponseData in interface DataRetrievalResponse<Integer>

Returns:

the cardinality value

Throws:

UnsupportedOperationDueToRetrievalError - if the wrapped response indicates an error