com.screenscraper.httpeek

Class HTTPTransaction

java.lang.Object

java.lang.Thread

com.screenscraper.httpeek.HTTPTransaction

All Implemented Interfaces:

java.lang.Comparable, java.lang.Runnable

public class HTTPTransaction
extends java.lang.Thread
implements java.lang.Comparable

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.
(package private) HTTPSession	session The HTTP session holding this transaction.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
HTTPTransaction(int httpTransactionID) Generates a new HTTPTransaction and loads it with its basic data based on its ID.
HTTPTransaction(int httpTransactionID, HTTPSession session, int sequence, java.lang.String note) Generates a new HTTPTransaction, loads it with its basic data, then loads it up with all of its HTTP requests and responses.
HTTPTransaction(int sequence, java.net.Socket socket) The constructor.

Method Summary

Modifier and Type	Method and Description
void	block() Blocks and stops the session.
int	compareTo(java.lang.Object httpTransaction) Required by the Comparable interface.
void	delete() Deletes the HTTP transaction.
void	deleteRequestsAndResponses() Deletes the requests and responses for this transaction.
void	disconnect() Kills the session.
HTTPRequest	getHTTPRequest() Gets the HTTP request received by the client for this session.
HTTPResponse	getHTTPResponse() Gets the HTTP response received by the server for this session.
HTTPSession	getHTTPSession() Gets the HTTP session associated with this transaction.
int	getID() Gets the ID.
java.lang.String	getNote() Gets the note associated with this transaction.
int	getSequence() Gets the sequence of this session.
java.lang.String	getStatus() Gets the current status of this transaction.
java.net.URL	getURL() Gets the URL this transaction is requesting.
boolean	isBlocked() Indicates whether or not the session is currently blocked.
protected void	load() Loads the HTTP transaction with its request and response.
void	run() Handles a single transaction.
void	save() Saves the information related to this transaction to the database.
void	setHTTPSession(HTTPSession session) Sets the HTTP session associated with this transaction.
void	setID(int httpTransactionID) Sets the ID.
void	setNote(java.lang.String note) Sets the note associated with this transaction.
void	setNotifiable(HTTPSessionNotifiable notifiable) Sets the object that will need to be notified when changes in the session take place.
void	setSequence(int sequence) Sets the sequence of this session.
boolean	shouldBeFiltered() Indicates whether or not the transaction should be filtered according to its usefulness.
java.lang.String	toString()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

session

HTTPSession session

The HTTP session holding this transaction.

Constructor Detail

HTTPTransaction

public HTTPTransaction(int sequence,
                       @Nullable
                       java.net.Socket socket)

The constructor.

Parameters:

sequence - The sequence of this session.

socket - The socket used to communicate with the client.

HTTPTransaction

public HTTPTransaction(int httpTransactionID,
                       HTTPSession session,
                       int sequence,
                       java.lang.String note)

Generates a new HTTPTransaction, loads it with its basic data, then loads it up with all of its HTTP requests and responses.

Parameters:

httpTransactionID - The ID.

session - The HTTP session holding this transaction.

sequence - The sequence of this transaction.

note - The note associated with the HTTP transaction.

HTTPTransaction

public HTTPTransaction(int httpTransactionID)

Generates a new HTTPTransaction and loads it with its basic data based on its ID.

Parameters:

httpTransactionID - The ID.

Method Detail

getID

public int getID()

Gets the ID.

Returns:

The ID.

setID

public void setID(int httpTransactionID)

Sets the ID.

Parameters:

httpTransactionID - The ID.

getHTTPSession

public HTTPSession getHTTPSession()

Gets the HTTP session associated with this transaction.

Returns:

The HTTPSession.

setHTTPSession

public void setHTTPSession(HTTPSession session)

Sets the HTTP session associated with this transaction.

Parameters:

session - The HTTPSession.

getSequence

public int getSequence()

Gets the sequence of this session.

Returns:

The sequence.

setSequence

public void setSequence(int sequence)

Sets the sequence of this session.

Parameters:

sequence - The sequence.

getNote

public java.lang.String getNote()

Gets the note associated with this transaction.

Returns:

The note.

setNote

public void setNote(java.lang.String note)

Sets the note associated with this transaction.

Parameters:

note - The note.

getHTTPRequest

public HTTPRequest getHTTPRequest()

Gets the HTTP request received by the client for this session.

Returns:

The request.

getHTTPResponse

public HTTPResponse getHTTPResponse()

Gets the HTTP response received by the server for this session.

Returns:

The response.

getURL

public java.net.URL getURL()

Gets the URL this transaction is requesting.

Returns:

The URL.

getStatus

public java.lang.String getStatus()

Gets the current status of this transaction.

Returns:

The status.

setNotifiable

public void setNotifiable(HTTPSessionNotifiable notifiable)

Sets the object that will need to be notified when changes in the session take place.

Parameters:

notifiable - An HTTPSessionNotifiable object.

disconnect

public void disconnect()

Kills the session.

block

public void block()

Blocks and stops the session.

isBlocked

public boolean isBlocked()

Indicates whether or not the session is currently blocked.

Returns:

A boolean.

run

public void run()

Handles a single transaction.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

shouldBeFiltered

public boolean shouldBeFiltered()

Indicates whether or not the transaction should be filtered according to its usefulness.

Returns:

A boolean.

save

public void save()

Saves the information related to this transaction to the database.

load

protected void load()

Loads the HTTP transaction with its request and response.

delete

public void delete()

Deletes the HTTP transaction.

deleteRequestsAndResponses

public void deleteRequestsAndResponses()

Deletes the requests and responses for this transaction.

compareTo

public int compareTo(@NotNull
                     java.lang.Object httpTransaction)

Required by the Comparable interface.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

httpTransaction - The transaction to compare to.

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Thread