com.screenscraper.scraper

Class RemoteScrapingSessionHandler

java.lang.Object

java.lang.Thread

com.screenscraper.scraper.RemoteScrapingSessionHandler

All Implemented Interfaces:

Notifiable, ScrapingSessionNotifiable, java.lang.Runnable

public class RemoteScrapingSessionHandler
extends java.lang.Thread
implements ScrapingSessionNotifiable

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.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface com.screenscraper.common.Notifiable

LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO, LEVEL_WARN, STR_LEVEL_DEBUG, STR_LEVEL_ERROR, STR_LEVEL_INFO, STR_LEVEL_WARN

Constructor Summary

Constructors

Constructor and Description
RemoteScrapingSessionHandler(java.net.Socket socket) The constructor.

Method Summary

Modifier and Type	Method and Description
void	block() Blocks and stops the handler.
void	disconnect() Kills the handler.
int	getLoggingLevel() Gets the current logging level.
boolean	isBlocked() Indicates whether or not the session is currently blocked.
void	log(java.lang.String message) Logs a messgae.
void	logDebug(java.lang.String message) Logs a message with LEVEL_DEBUG.
void	logError(java.lang.String message) Logs a message with LEVEL_ERROR.
void	logInfo(java.lang.String message) Logs a message with LEVEL_INFO.
void	logWarn(java.lang.String message) Logs a message with LEVEL_WARN.
void	pollForData(ScrapingSession scrapingSession, int pollFrequency) Polls the scraping session for data to send to the client.
void	run() Runs the session.
void	scrapingSessionCompleted() Indicates that the scraping session has ended.
void	setLoggingLevel(int loggingLevel) Sets the current logging level.
void	setManager(RemoteScrapingSessionHandlerManager manager) Sets the RemoteScrapingSessionHandlerManager that's managing this handler.
void	startService() Starts the handler up.

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, toString, 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.

Constructor Detail

RemoteScrapingSessionHandler

public RemoteScrapingSessionHandler(java.net.Socket socket)

The constructor.

Parameters:

socket - The socket used to communicate with the client.

Method Detail

setManager

public void setManager(RemoteScrapingSessionHandlerManager manager)

Sets the RemoteScrapingSessionHandlerManager that's managing this handler.

Parameters:

manager - A RemoteScrapingSessionHandlerManager.

startService

public void startService()

Starts the handler up.

disconnect

public void disconnect()

Kills the handler.

block

public void block()

Blocks and stops the handler.

isBlocked

public boolean isBlocked()

Indicates whether or not the session is currently blocked.

Returns:

A boolean.

run

public void run()

Runs the session.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

log

public void log(java.lang.String message)

Logs a messgae. Required by ScrapingSessionNotifiable.

Specified by:

log in interface Notifiable

Specified by:

log in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

getLoggingLevel

public int getLoggingLevel()

Gets the current logging level.

Specified by:

getLoggingLevel in interface Notifiable

Specified by:

getLoggingLevel in interface ScrapingSessionNotifiable

Returns:

The logging level, as defined by one of the "LOGGING" constants.

setLoggingLevel

public void setLoggingLevel(int loggingLevel)

Sets the current logging level.

Specified by:

setLoggingLevel in interface Notifiable

Specified by:

setLoggingLevel in interface ScrapingSessionNotifiable

Parameters:

loggingLevel - The logging level, as defined by one of the "LOGGING" constants.

logDebug

public void logDebug(java.lang.String message)

Logs a message with LEVEL_DEBUG.

Specified by:

logDebug in interface Notifiable

Specified by:

logDebug in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

logInfo

public void logInfo(java.lang.String message)

Logs a message with LEVEL_INFO.

Specified by:

logInfo in interface Notifiable

Specified by:

logInfo in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

logWarn

public void logWarn(java.lang.String message)

Logs a message with LEVEL_WARN.

Specified by:

logWarn in interface Notifiable

Specified by:

logWarn in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

logError

public void logError(java.lang.String message)

Logs a message with LEVEL_ERROR.

Specified by:

logError in interface Notifiable

Specified by:

logError in interface ScrapingSessionNotifiable

Parameters:

message - The message to be logged.

scrapingSessionCompleted

public void scrapingSessionCompleted()

Indicates that the scraping session has ended. Required by ScrapingSessionNotifiable.

Specified by:

scrapingSessionCompleted in interface ScrapingSessionNotifiable

pollForData

public void pollForData(@NotNull
                        ScrapingSession scrapingSession,
                        int pollFrequency)
                 throws java.io.IOException

Polls the scraping session for data to send to the client.

Parameters:

scrapingSession - The ScrapingSession to poll.

pollFrequency - The frequency seconds we're to poll.

Throws:

java.io.IOException