ai.preferred.venom.response

Class BaseResponse

java.lang.Object

ai.preferred.venom.response.BaseResponse

All Implemented Interfaces:

Response, Retrievable

public class BaseResponse
extends Object
implements Response, Retrievable

Author:

Maksim Tkachenko, Truong Quoc Tuan, Ween Jiann Lee

Constructor Summary

Constructors

Constructor and Description
BaseResponse(int statusCode, String baseUrl, byte[] content, org.apache.http.entity.ContentType contentType, org.apache.http.Header[] headers, org.apache.http.HttpHost proxy) Constructs a base response.
BaseResponse(int statusCode, String baseUrl, byte[] content, org.apache.http.entity.ContentType contentType, org.apache.http.Header[] headers, org.apache.http.HttpHost proxy, Validator validator, String sourceId) Constructs a base response.

Method Summary

Modifier and Type	Method and Description
String	getBaseUrl() Returns the base form of the url used in this request.
byte[]	getContent() Returns raw content of the response.
org.apache.http.entity.ContentType	getContentType() Returns the content type of the content fetched.
org.apache.http.Header[]	getHeaders() Returns the headers that were used to trigger this response.
org.apache.http.HttpHost	getProxy() Returns the proxy that was used to trigger this response.
String	getSourceId() Returns the id of the row where an archive of this response has been insert into a persistent storage.
int	getStatusCode() Returns status code of the response.
Validator	getValidator() Returns the instance of validator used to validate this response.
BaseResponse	setSourceId(String sourceId) Sets the source id where the raw response is saved.
BaseResponse	setValidator(Validator validator) Sets the validator used to validate this response.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseResponse

public BaseResponse(int statusCode,
                    String baseUrl,
                    byte[] content,
                    org.apache.http.entity.ContentType contentType,
                    org.apache.http.Header[] headers,
                    org.apache.http.HttpHost proxy)

Constructs a base response.

Parameters:

statusCode - Status code of the response

baseUrl - Base url of the response

content - Content from the response

contentType - Content type of the response

headers - Headers from the response

proxy - Proxy used to obtain the response

BaseResponse

public BaseResponse(int statusCode,
                    String baseUrl,
                    byte[] content,
                    org.apache.http.entity.ContentType contentType,
                    org.apache.http.Header[] headers,
                    org.apache.http.HttpHost proxy,
                    Validator validator,
                    String sourceId)

Constructs a base response.

Parameters:

statusCode - Status code of the response

baseUrl - Base url of the response

content - Content from the response

contentType - Content type of the response

headers - Headers from the response

proxy - Proxy used to obtain the response

validator - Validator used to validate this response

sourceId - `id` of the row the raw response is saved to

Method Detail

getStatusCode

public final int getStatusCode()

Description copied from interface: Response

Returns status code of the response.

Specified by:

getStatusCode in interface Response

Returns:

int code

getContent

public final byte[] getContent()

Description copied from interface: Response

Returns raw content of the response.

Specified by:

getContent in interface Response

Returns:

byte[] content

getContentType

public final org.apache.http.entity.ContentType getContentType()

Description copied from interface: Response

Returns the content type of the content fetched.

This is provided by the server or guessed by the server or an amalgamation of both.

Specified by:

getContentType in interface Response

Returns:

an instance of ContentType

getHeaders

public final org.apache.http.Header[] getHeaders()

Description copied from interface: Response

Returns the headers that were used to trigger this response.

Specified by:

getHeaders in interface Response

Returns:

an array of headers

getBaseUrl

public final String getBaseUrl()

Description copied from interface: Response

Returns the base form of the url used in this request.

Specified by:

getBaseUrl in interface Response

Returns:

stripped down version of requested url

getProxy

public final org.apache.http.HttpHost getProxy()

Description copied from interface: Response

Returns the proxy that was used to trigger this response.

Specified by:

getProxy in interface Response

Returns:

proxy used

getValidator

public final Validator getValidator()

Description copied from interface: Response

Returns the instance of validator used to validate this response.

Specified by:

getValidator in interface Response

Returns:

an instance of validator

setValidator

public final BaseResponse setValidator(Validator validator)

Sets the validator used to validate this response.

Parameters:

validator - Row id of the saved response

Returns:

A new instance of base response

getSourceId

public final String getSourceId()

Description copied from interface: Retrievable

Returns the id of the row where an archive of this response has been insert into a persistent storage.

This string should be null if no implementation of FileManager is specified during the initialisation of the fetcher.

Specified by:

getSourceId in interface Retrievable

Returns:

unique id of where an archive has been saved

setSourceId

public final BaseResponse setSourceId(String sourceId)

Sets the source id where the raw response is saved.

Parameters:

sourceId - Row id of the saved response

Returns:

A new instance of base response