com.screenscraper.common

Interface RunningHTTPResponse

All Known Implementing Classes:

HTTPResponse

public interface RunningHTTPResponse

A facade to be used within scripts that provides limited access to a HTTPResponse.

Method Summary

Modifier and Type	Method and Description
void	addHTTPHeader(java.lang.String key, java.lang.String value) Gets the value of a header, given its key.
java.lang.String	getContentAsString() Returns the content as a string.
java.util.Set<HTTPHeader>	getHTTPHeaders() Returns all of the headers.
java.lang.String	getStatusLine() Gets the status line for the response.
void	removeHTTPHeader(java.lang.String key, java.lang.String value) Removes an HTTPHeader.
void	setContent(byte[] bContent) Sets the main body of content.
void	setContentAsString(java.lang.String newContent) Sets the main body of content.
void	setStatusLine(java.lang.String statusLine) Sets the status line for the response.

Method Detail

getContentAsString

@Nullable
java.lang.String getContentAsString()

Returns the content as a string.

Returns:

A string.

setContent

void setContent(byte[] bContent)

Sets the main body of content.

Parameters:

bContent - An array of bytes containing the content.

setContentAsString

void setContentAsString(java.lang.String newContent)

Sets the main body of content.

Parameters:

newContent - The content to set, as a String

addHTTPHeader

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

Gets the value of a header, given its key.

Parameters:

key - The name of the header

value - The value of the header

removeHTTPHeader

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

Removes an HTTPHeader.

Parameters:

key - The name of the header

value - The value of the header

getHTTPHeaders

java.util.Set<HTTPHeader> getHTTPHeaders()

Returns all of the headers.

Returns:

A Hashtable containing the headers.

getStatusLine

@Nullable
java.lang.String getStatusLine()

Gets the status line for the response.

Returns:

The status line.

setStatusLine

void setStatusLine(java.lang.String statusLine)

Sets the status line for the response.

Parameters:

statusLine - The status line.