com.screenscraper.httpeek

Class ProxySearchResult

java.lang.Object

com.screenscraper.httpeek.ProxySearchResult

All Implemented Interfaces:

java.lang.Comparable

public class ProxySearchResult
extends java.lang.Object
implements java.lang.Comparable

Contains info about a proxy search result.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.
static java.lang.String	SEARCH_RESULT_NOTES
static java.lang.String	SEARCH_RESULT_POST_DATA
static java.lang.String	SEARCH_RESULT_REQUEST_HEADER_KEY
static java.lang.String	SEARCH_RESULT_REQUEST_HEADER_VALUE
static java.lang.String	SEARCH_RESULT_REQUEST_LINE
static java.lang.String	SEARCH_RESULT_RESPONSE_BODY
static java.lang.String	SEARCH_RESULT_RESPONSE_HEADER_KEY
static java.lang.String	SEARCH_RESULT_RESPONSE_HEADER_VALUE
static java.lang.String	SEARCH_RESULT_RESPONSE_STATUS_LINE

Constructor Summary

Constructors

Constructor and Description
ProxySearchResult(HTTPTransaction httpTransaction, java.lang.String location, int startPoint, int length)
ProxySearchResult(HTTPTransaction httpTransaction, java.lang.String location, int startPoint, int length, java.lang.String headerName)
ProxySearchResult(HTTPTransaction httpTransaction, java.lang.String location, int startPoint, int length, java.lang.String headerName, java.lang.String cookie)

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object psr) Required by the Comparable interface.
void	dumpToLog() Dumps the object to the log.
java.lang.String	getCookie() If we're displaying JavaScript cookie search results this will get the key and value of the cookie.
java.lang.String	getHeaderName() Gets the name of the header containing the result.
HTTPTransaction	getHTTPTransaction() Gets the HTTP transaction containing the found text.
int	getLength() Gets the length of the found text.
java.lang.String	getLocation() Gets the location of the search result, as defined by one of the constants in this class.
int	getStartPoint() Gets the start point of the found text.
void	setCookie(java.lang.String cookie) If we're displaying JavaScript cookie search results this will set the key and value of the cookie.
void	setLength(int length) Sets the length of the found text.
void	setStartPoint(int startPoint) Sets the start point of the found text.

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.

SEARCH_RESULT_REQUEST_LINE

public static final java.lang.String SEARCH_RESULT_REQUEST_LINE

See Also:

Constant Field Values

SEARCH_RESULT_REQUEST_HEADER_KEY

public static final java.lang.String SEARCH_RESULT_REQUEST_HEADER_KEY

See Also:

Constant Field Values

SEARCH_RESULT_REQUEST_HEADER_VALUE

public static final java.lang.String SEARCH_RESULT_REQUEST_HEADER_VALUE

See Also:

Constant Field Values

SEARCH_RESULT_POST_DATA

public static final java.lang.String SEARCH_RESULT_POST_DATA

See Also:

Constant Field Values

SEARCH_RESULT_RESPONSE_STATUS_LINE

public static final java.lang.String SEARCH_RESULT_RESPONSE_STATUS_LINE

See Also:

Constant Field Values

SEARCH_RESULT_RESPONSE_HEADER_KEY

public static final java.lang.String SEARCH_RESULT_RESPONSE_HEADER_KEY

See Also:

Constant Field Values

SEARCH_RESULT_RESPONSE_HEADER_VALUE

public static final java.lang.String SEARCH_RESULT_RESPONSE_HEADER_VALUE

See Also:

Constant Field Values

SEARCH_RESULT_RESPONSE_BODY

public static final java.lang.String SEARCH_RESULT_RESPONSE_BODY

See Also:

Constant Field Values

SEARCH_RESULT_NOTES

public static final java.lang.String SEARCH_RESULT_NOTES

See Also:

Constant Field Values

Constructor Detail

ProxySearchResult

public ProxySearchResult(HTTPTransaction httpTransaction,
                         java.lang.String location,
                         int startPoint,
                         int length)

ProxySearchResult

public ProxySearchResult(HTTPTransaction httpTransaction,
                         java.lang.String location,
                         int startPoint,
                         int length,
                         @Nullable
                         java.lang.String headerName)

ProxySearchResult

public ProxySearchResult(HTTPTransaction httpTransaction,
                         java.lang.String location,
                         int startPoint,
                         int length,
                         java.lang.String headerName,
                         java.lang.String cookie)

Method Detail

getHTTPTransaction

public HTTPTransaction getHTTPTransaction()

Gets the HTTP transaction containing the found text.

Returns:

The HTTPTransaction.

getLocation

public java.lang.String getLocation()

Gets the location of the search result, as defined by one of the constants in this class.

Returns:

The location.

getHeaderName

public java.lang.String getHeaderName()

Gets the name of the header containing the result. This may be null if the search result isn't found in a header.

Returns:

The name of the header.

getStartPoint

public int getStartPoint()

Gets the start point of the found text.

Returns:

The start point.

setStartPoint

public void setStartPoint(int startPoint)

Sets the start point of the found text.

Parameters:

startPoint - The start point.

getLength

public int getLength()

Gets the length of the found text.

Returns:

The length.

setLength

public void setLength(int length)

Sets the length of the found text.

Parameters:

length - The length.

getCookie

public java.lang.String getCookie()

If we're displaying JavaScript cookie search results this will get the key and value of the cookie.

Returns:

The cookie.

setCookie

public void setCookie(java.lang.String cookie)

If we're displaying JavaScript cookie search results this will set the key and value of the cookie.

Parameters:

cookie - The cookie in the form key=value.

compareTo

public int compareTo(java.lang.Object psr)

Required by the Comparable interface.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

psr - The result to compare to.

Returns:

An int indicating how the given object compares to this object.

dumpToLog

public void dumpToLog()

Dumps the object to the log.