Class StringResponseImpl

java.lang.Object

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

se.liu.ida.hefquin.federation.access.impl.response.StringResponseImpl

All Implemented Interfaces:

DataRetrievalResponse<String>, StringResponse

public class StringResponseImpl
extends DataRetrievalResponseBase<String>
implements StringResponse

Field Summary

Fields inherited from class se.liu.ida.hefquin.federation.access.impl.response.DataRetrievalResponseBase

data, errorDescription, errorStatusCode, exception, requestStartTime, retrievalEndTime

Constructor Summary

Constructors

Constructor	Description
StringResponseImpl(Exception exception, Date requestStartTime)	Constructs a defective response for the case that an exception was thrown when producing the response.
StringResponseImpl(Exception exception, Date requestStartTime, Date retrievalEndTime)	Constructs a defective response for the case that an exception was thrown when producing the response.
StringResponseImpl(Integer errorStatusCode, String errorDescription, Date requestStartTime)	Constructs a response for the case that the response was an error message.
StringResponseImpl(Integer errorStatusCode, String errorDescription, Date requestStartTime, Date retrievalEndTime)	Constructs a response for the case that the response was an error message.
StringResponseImpl(String response, Date requestStartTime)	Constructs a response with a string response and request start time.
StringResponseImpl(String response, Date requestStartTime, Date retrievalEndTime)	Constructs a response with a string response, request start time, and retrieval end time.

Method Summary

Methods inherited from class se.liu.ida.hefquin.federation.access.impl.response.DataRetrievalResponseBase

getErrorDescription, getErrorStatusCode, getException, getRequestStartTime, getResponseData, getRetrievalEndTime, throwExceptionIfNoResponseData

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

getErrorDescription, getErrorStatusCode, getException, getRequestDuration, getRequestStartTime, getResponseData, getRetrievalEndTime, isDefective, isError

Constructor Details

StringResponseImpl

public StringResponseImpl(String response,
 Date requestStartTime)

Constructs a response with a string response 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:

response - the response string (must not be null)

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

StringResponseImpl

public StringResponseImpl(String response,
 Date requestStartTime,
 Date retrievalEndTime)

Constructs a response with a string response, request start time, and retrieval end time. This constructor assumes no error occurred.

Parameters:

response - the response string (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)

StringResponseImpl

public StringResponseImpl(Integer 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)

StringResponseImpl

public StringResponseImpl(Integer 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)

StringResponseImpl

public StringResponseImpl(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)

StringResponseImpl

public StringResponseImpl(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)