com.screenscraper.common

Class HTTPResponse

java.lang.Object

com.screenscraper.common.HTTPResponse

All Implemented Interfaces:

RunningHTTPResponse

public class HTTPResponse
extends java.lang.Object
implements RunningHTTPResponse

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
HTTPResponse() Generates an empty HTTPResponse.
HTTPResponse(int responseID, java.lang.String statusLine, java.lang.String content) Generates a new HTTPResponse, loads it with its basic data, then loads it up with all of its HTTP headers.
HTTPResponse(java.lang.String rawResponse)

Method Summary

Modifier and Type	Method and Description
void	addHTTPHeader(HTTPHeader newHeader)
void	addHTTPHeader(java.lang.String key, java.lang.String value) Gets the value of a header, given its key.
boolean	containsCookie(java.lang.String key, java.lang.String value) Determines whether or not the response has a "Set-Cookie" header containing the given key/value pair.
boolean	contentIsBinary() Indicates whether or not the Content-Type header indicates that the content for this response is binary.
boolean	contentIsProbablyHTMLOrXML() Indicates whether or not the content is probably XML or HTML by examining the characters found in the first portion of it.
void	deleteHeaders() Deletes the headers corresponding to this response.
java.lang.String	determineCharacterSet(org.apache.http.HttpResponse httpResponse) Determines what the character should be from the method response.
java.lang.String	getCharacterSet() Gets the character encoding of the content given by the server.
byte[]	getContentAsByteArray() Returns the content as an array of bytes.
java.lang.String	getContentAsString() Returns the content as a string.
java.lang.String	getContentTypeHeader() Attempts to get the content type.
boolean	getContentUnencoded() If the content is gzip encoded, this will indicate when it has been unencoded.
boolean	getForceNonBinary() Indicates whether or not the contents of this response should be forced to be treated as non-binary.
java.lang.String	getHTTPHeader(java.lang.String key) Gets the value of a header, given its key.
java.util.Set<HTTPHeader>	getHTTPHeaders() Returns all of the headers.
java.util.Iterator	getHTTPHeadersIterator() Gets an Iterator over which the headers can be iterated.
java.lang.String	getHumanReadableContent() Returns the content in a human-readable format.
java.lang.String	getHumanReadableContentShort() Returns the content in a human-readable format, truncating it if it's too long.
int	getID() Gets the ID.
java.lang.String	getLocationHeader() Attempts to get the location header.
byte[]	getOriginalBytes() Allows the original bytes of the content to be preserved.
java.lang.String	getRawResponse() Returns a string representing the raw HTTP response held by this object.
int	getStatusCode() Gets the status code from the status line.
java.lang.String	getStatusLine() Gets the status line for the response.
boolean	isContentBinaryAccordingToMimeMagic() Indicates whether or not the content is binary by utilizing the mime magic library.
boolean	isUsefulAsScrapeableFile() Indicates whether or not this response would likely be made into a scrapeable file.
void	removeHTTPHeader(HTTPHeader oldHeader)
void	removeHTTPHeader(java.lang.String key) Removes an HTTP header
void	removeHTTPHeader(java.lang.String key, java.lang.String value) Removes an HTTPHeader.
void	save(int httpTransactionID) Saves the information related to this response to the database.
void	setCharacterSet(java.lang.String characterSet) Sets the character encoding of the content given by the server.
void	setContent(byte[] bContent) Sets the main body of content.
void	setContentAsString(java.lang.String newContent) Sets the main body of content.
void	setContentUnencoded(boolean contentUnencoded) If the content is gzip encoded, this will set when it has been unencoded.
void	setForceNonBinary(boolean forceNonBinary) Determines whether or not the contents of this response should be forced to be treated as non-binary.
void	setHeader(java.lang.String header) Sets a header, given a String representing a header.
void	setHeaders(java.util.Set<HTTPHeader> responseHeaders) Sets the headers.
void	setID(int responseID) Sets the ID.
void	setStatusLine(java.lang.String statusLine) Sets the status line for the response.
void	write(java.io.OutputStream os)
void	writeContentBytesToFile(java.lang.String filePath) Writes out the raw bytes of the content to a file (used for testing).

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

HTTPResponse

public HTTPResponse()

Generates an empty HTTPResponse.

HTTPResponse

public HTTPResponse(int responseID,
                    java.lang.String statusLine,
                    @NotNull
                    java.lang.String content)

Generates a new HTTPResponse, loads it with its basic data, then loads it up with all of its HTTP headers.

Parameters:

responseID - The ID.

statusLine - The status line of the response.

content - The content.

HTTPResponse

public HTTPResponse(@Nullable
                    java.lang.String rawResponse)

Parameters:

rawResponse - The raw response.

Method Detail

getID

public int getID()

Gets the ID.

Returns:

The ID.

setID

public void setID(int responseID)

Sets the ID.

Parameters:

responseID - The ID.

setHeaders

public void setHeaders(java.util.Set<HTTPHeader> responseHeaders)

Sets the headers.

Parameters:

responseHeaders - A Set of HTTPHeaders.

write

public void write(@NotNull
                  java.io.OutputStream os)
           throws java.lang.Exception

Throws:

java.lang.Exception

addHTTPHeader

public void addHTTPHeader(HTTPHeader newHeader)

addHTTPHeader

public void addHTTPHeader(java.lang.String key,
                          java.lang.String value)

Description copied from interface: RunningHTTPResponse

Gets the value of a header, given its key.

Specified by:

addHTTPHeader in interface RunningHTTPResponse

Parameters:

key - The name of the header

value - The value of the header

setHeader

public void setHeader(@NotNull
                      java.lang.String header)

Sets a header, given a String representing a header.

Parameters:

header - The header.

containsCookie

public boolean containsCookie(java.lang.String key,
                              java.lang.String value)

Determines whether or not the response has a "Set-Cookie" header containing the given key/value pair.

Parameters:

key - The cookie key.

value - The cookie value.

Returns:

A boolean.

getHTTPHeaders

public java.util.Set<HTTPHeader> getHTTPHeaders()

Returns all of the headers.

Specified by:

getHTTPHeaders in interface RunningHTTPResponse

Returns:

A Hashtable containing the headers.

getHTTPHeadersIterator

@NotNull
public java.util.Iterator getHTTPHeadersIterator()

Gets an Iterator over which the headers can be iterated.

Returns:

An Iterator pointing to HTTPHeader objects.

getStatusLine

@Nullable
public java.lang.String getStatusLine()

Gets the status line for the response.

Specified by:

getStatusLine in interface RunningHTTPResponse

Returns:

The status line.

setStatusLine

public void setStatusLine(java.lang.String statusLine)

Sets the status line for the response.

Specified by:

setStatusLine in interface RunningHTTPResponse

Parameters:

statusLine - The status line.

getStatusCode

public int getStatusCode()

Gets the status code from the status line.

Returns:

The status code; -1, if not found.

getHTTPHeader

@Nullable
public java.lang.String getHTTPHeader(@NotNull
                                                 java.lang.String key)

Gets the value of a header, given its key.

Parameters:

key - The key of the header.

Returns:

The value.

removeHTTPHeader

public void removeHTTPHeader(HTTPHeader oldHeader)

removeHTTPHeader

public void removeHTTPHeader(java.lang.String key,
                             java.lang.String value)

Description copied from interface: RunningHTTPResponse

Removes an HTTPHeader.

Specified by:

removeHTTPHeader in interface RunningHTTPResponse

Parameters:

key - The name of the header

value - The value of the header

removeHTTPHeader

public void removeHTTPHeader(java.lang.String key)

Removes an HTTP header

Parameters:

key - The key of the header to be removed.

writeContentBytesToFile

public void writeContentBytesToFile(@NotNull
                                    java.lang.String filePath)

Writes out the raw bytes of the content to a file (used for testing).

Parameters:

filePath - Path to the file bytes should be written to.

setContent

public void setContent(@Nullable
                       byte[] bContent)

Sets the main body of content.

Specified by:

setContent in interface RunningHTTPResponse

Parameters:

bContent - An array of bytes containing the content.

setContentAsString

public void setContentAsString(@NotNull
                               java.lang.String newContent)

Sets the main body of content.

Specified by:

setContentAsString in interface RunningHTTPResponse

Parameters:

newContent - The content to set, as a String

getContentAsByteArray

@Nullable
public byte[] getContentAsByteArray()

Returns the content as an array of bytes.

Returns:

An array of bytes.

isUsefulAsScrapeableFile

public boolean isUsefulAsScrapeableFile()

Indicates whether or not this response would likely be made into a scrapeable file.

Returns:

A boolean.

contentIsBinary

public boolean contentIsBinary()

Indicates whether or not the Content-Type header indicates that the content for this response is binary.

Returns:

A boolean value.

isContentBinaryAccordingToMimeMagic

public boolean isContentBinaryAccordingToMimeMagic()

Indicates whether or not the content is binary by utilizing the mime magic library.

Returns:

A boolean.

contentIsProbablyHTMLOrXML

public boolean contentIsProbablyHTMLOrXML()

Indicates whether or not the content is probably XML or HTML by examining the characters found in the first portion of it.

Returns:

A boolean.

getContentTypeHeader

@Nullable
public java.lang.String getContentTypeHeader()

Attempts to get the content type. Returns null if it can't be determined. The content type will be in all upper-case.

Returns:

The content type.

getLocationHeader

@Nullable
public java.lang.String getLocationHeader()

Attempts to get the location header. Returns null if it can't be determined.

Returns:

The value of the location header.

getHumanReadableContent

@Nullable
public java.lang.String getHumanReadableContent()

Returns the content in a human-readable format.

Returns:

If the content is text this function will simply return the content as a string. If the content is binary, the string "[Binary Data]" will be returned.

getHumanReadableContentShort

@Nullable
public java.lang.String getHumanReadableContentShort()

Returns the content in a human-readable format, truncating it if it's too long.

Returns:

If the content is text this function will simply return the content as a string. If the content is binary, the string "[Binary Data]" will be returned.

getContentAsString

@Nullable
public java.lang.String getContentAsString()

Returns the content as a string.

Specified by:

getContentAsString in interface RunningHTTPResponse

Returns:

A string.

getOriginalBytes

@Nullable
public byte[] getOriginalBytes()

Allows the original bytes of the content to be preserved.

Returns:

The bytes that represent the body of the original HTTP response. That is, before any decompression occurred.

getRawResponse

@NotNull
public java.lang.String getRawResponse()

Returns a string representing the raw HTTP response held by this object.

Returns:

The response.

save

public void save(int httpTransactionID)

Saves the information related to this response to the database.

Parameters:

httpTransactionID - The ID of the transaction holding this response.

deleteHeaders

public void deleteHeaders()

Deletes the headers corresponding to this response.

determineCharacterSet

public java.lang.String determineCharacterSet(@NotNull
                                              org.apache.http.HttpResponse httpResponse)
                                       throws java.lang.Exception

Determines what the character should be from the method response.

Parameters:

httpResponse - The HttpResponse.

Throws:

java.lang.Exception - If the chracter set can't be determined from the server headers.

getCharacterSet

@Nullable
public java.lang.String getCharacterSet()

Gets the character encoding of the content given by the server.

Returns:

The character encoding.

setCharacterSet

public void setCharacterSet(java.lang.String characterSet)

Sets the character encoding of the content given by the server.

Parameters:

characterSet - The character encoding.

getContentUnencoded

public boolean getContentUnencoded()

If the content is gzip encoded, this will indicate when it has been unencoded.

Returns:

A boolean.

setContentUnencoded

public void setContentUnencoded(boolean contentUnencoded)

If the content is gzip encoded, this will set when it has been unencoded.

Parameters:

contentUnencoded - A boolean.

getForceNonBinary

public boolean getForceNonBinary()

Indicates whether or not the contents of this response should be forced to be treated as non-binary.

Returns:

Whether or not it should be forced as binary.

setForceNonBinary

public void setForceNonBinary(boolean forceNonBinary)

Determines whether or not the contents of this response should be forced to be treated as non-binary.

Parameters:

forceNonBinary - Whether or not it should be forced as binary.