com.screenscraper.server

Class ScrapingSessionServerLog

java.lang.Object

com.screenscraper.server.ScrapingSessionServerLog

public class ScrapingSessionServerLog
extends java.lang.Object

Encapsulates a server log file corresponding to a scraping session.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ScrapingSessionServerLog(java.lang.String scrapingSessionLogName) Constructs a new class by parsing the name of a scraping session log.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getLog(java.lang.String filename) Return the content of a given log file.
static java.lang.String	getLog(java.lang.String filename, boolean start, int lines) Returns a portion of the content of a given log file.
java.lang.String	getLogFileName() Gets the name of the log file.
java.lang.String	getLogFileNameURLEncoded() Gets the name of the log file as a URL-encoded string.
static java.lang.String	getLogFolderPath() Gets a string representation of the path to the log folder.
static java.lang.String[]	getLogNames() Returns the names of all the files in the log directory of the remote server.
static long	getLogSize(java.lang.String filename) Return the size of the given logfile in bytes.
java.lang.String	getScrapingSessionName() Gets the name of the scraping session represented.
static java.util.ArrayList	getScrapingSessionServerLogs() Returns an ArrayList of all ScrapingSessionServerLogs.
long	getScrapingSessionStartTime() Gets the time the scraping session started, as a long.
java.lang.String	getScrapingSessionStartTimeFormatted() Gets the time the scraping session started, as a formatted date.
static boolean	removeLog(java.lang.String filename) Remove a log file from the log directory on the remote server.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static Logger log

Used for logging.

Constructor Detail

ScrapingSessionServerLog

public ScrapingSessionServerLog(java.lang.String scrapingSessionLogName)

Constructs a new class by parsing the name of a scraping session log.

Parameters:

scrapingSessionLogName - The name of the scraping session log.

Method Detail

getScrapingSessionName

public java.lang.String getScrapingSessionName()

Gets the name of the scraping session represented.

Returns:

The name of the scraping session.

getScrapingSessionStartTime

public long getScrapingSessionStartTime()

Gets the time the scraping session started, as a long.

Returns:

The start time.

getLogFileName

public java.lang.String getLogFileName()

Gets the name of the log file.

Returns:

The name of the log file

getLogFileNameURLEncoded

public java.lang.String getLogFileNameURLEncoded()

Gets the name of the log file as a URL-encoded string.

Returns:

The URL-encoded log file name.

getScrapingSessionStartTimeFormatted

public java.lang.String getScrapingSessionStartTimeFormatted()

Gets the time the scraping session started, as a formatted date.

Returns:

The formatted start time.

getLogFolderPath

public static java.lang.String getLogFolderPath()

Gets a string representation of the path to the log folder.

Returns:

The path to the log folder.

getScrapingSessionServerLogs

public static java.util.ArrayList getScrapingSessionServerLogs()

Returns an ArrayList of all ScrapingSessionServerLogs.

Returns:

The ArrayList.

getLogNames

@Nullable
public static java.lang.String[] getLogNames()

Returns the names of all the files in the log directory of the remote server.

Returns:

an array of the names of the log files, or null if there is no log directory.

getLogSize

public static long getLogSize(java.lang.String filename)
                       throws java.io.IOException

Return the size of the given logfile in bytes.

Parameters:

filename - the name of a file in the log directory.

Returns:

a long representing the length in bytes of this file, or 0 if the file does not exist or is empty.

Throws:

java.io.IOException - An exception if the log file doesn't exist or can't be read.

getLog

public static java.lang.String getLog(java.lang.String filename)

Return the content of a given log file.

Parameters:

filename - the name of the file to get the contents of.

Returns:

a String of the contents of the file, or "" if not possible.

getLog

@Nullable
public static java.lang.String getLog(java.lang.String filename,
                                                 boolean start,
                                                 int lines)

Returns a portion of the content of a given log file.

Parameters:

filename - the name of a log file.

start - true to return content from the beginning of a file, false to start counting lines from the end.

lines - the number of lines from the log file to return.

Returns:

a portion of the content of the given log file, or "" if anything goes wrong.

removeLog

public static boolean removeLog(java.lang.String filename)

Remove a log file from the log directory on the remote server.

Parameters:

filename - the name of the file to remove.

Returns:

true if the delete succeeded, false if it failed.