ScrapingSessionManager

java.lang.Object
- java.lang.Enum<ScrapingSessionManager>
- - com.screenscraper.scraper.ScrapingSessionManager

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScrapingSessionManager>
```
public enum ScrapingSessionManager
extends java.lang.Enum<ScrapingSessionManager>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description

INSTANCE
The scraping session manager instance

Enum Constants
Enum Constant and Description
`INSTANCE` The scraping session manager instance

Field Summary

Fields
Modifier and Type	Field and Description
`static org.apache.log4j.Logger`	`log`
`static int`	`MAX_BASIC_EDITION_SCRAPING_SESSIONS`
`(package private) java.util.concurrent.atomic.AtomicInteger`	`numRunning`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScrapingSession`	`addNewScrapingSession(Folder folder)` Adds a blank `ScrapingSession`.
`void`	`addScrapingSession(ScrapingSession scrapingSession)` Adds a scraping session to be managed.
`static ScrapingSessionManager`	`getInstance()` Returns the manager instance
`int`	`getNumRunnableScrapingSessions()` Gets the number of runnable `ScrapingSession`s.
`int`	`getNumRunningScrapingSessions()` Gets the number of running `ScrapingSession`s.
`int`	`getNumRunningScrapingSessions(java.lang.String scrapingSessionName)` Gets the number of named running `ScrapingSession`s.
`int`	`getNumScrapingSessions()` Gets the number of `ScrapingSession`s.
`int`	`getNumScrapingSessionsWithName(java.lang.String name)` Gets the number of scraping sessions carrying the given name.
`ScrapingSession`	`getRunningScrapingSession(java.lang.String name)` Gets a running scraping session, based on the name of the scraping session.
`java.util.List<ScrapingSession>`	`getRunningScrapingSessions()` Returns a `HashSet` containing running `ScrapingSession` objects.
`ScrapingSession`	`getScrapingSession(int id)` Gets a scraping session, based on the ID of the scraping session.
`ScrapingSession`	`getScrapingSession(java.lang.String name)` Gets a scraping session, based on the name of the scraping session.
`ScrapingSession`	`getScrapingSessionBySequence(int sequence)` Gets a `ScrapingSession` based on a sequence, assuming the scraping sessions are sorted alphabetically.
`ScrapingSession`	`getScrapingSessionCopy(java.lang.String name)` Gets a copy of an existing scraping session, based on the name of the scraping session.
`java.util.Date`	`getScrapingSessionLastImportTime(java.lang.String scrapeName)` Returns the last time the scrape with the given name was imported, or if it hasn't been imported since the instance was launched (or isn't in the instance) returns the time the server was launched
`java.util.Set<ScrapingSession>`	`getScrapingSessions()` Returns a set of the current sessions
`java.util.TreeSet<ScrapingSession>`	`getScrapingSessionsAsTreeSet()` Returns a sorted `TreeSet` containing the `ScrapingSession` objects.
`java.util.Iterator<ScrapingSession>`	`getScrapingSessionsIterator()` Returns an iterator over the current sessions
`int`	`getSequenceForScrapingSession(ScrapingSession scrapingSession)` Gets the sequence of the given scraping session.
`void`	`hotSwapScrapingSessionsFromDatabase()` Hot swaps scraping sessions from the database.
`void`	`hotSwapScrapingSessionsFromFiles()` Checks for existing scraping sessions in the "import" directory, and if they exist, hot swaps them in.
`java.lang.Object`	`importFromFile(java.io.File file, Folder folder, boolean promptForOverwrite)` Imports a file that may either contain a `ScrapingSession` or `Script`.
`java.lang.Object`	`importFromReader(java.io.Reader reader, Folder folder, boolean promptForOverwrite)` Imports an object pointed to by the given reader that may either contain a `ScrapingSession` or `Script`.
`boolean`	`isScrapingSessionRunning(ScrapingSession scrapingSession)` Indicates whether or not the given scraping session is currently running.
`void`	`loadScrapingSessions(ScrapingSessionNotifiable scrapingSessionNotifiable)` Causes the manager to load itself with all available scraping sessions.
`void`	`removeAllScrapingSessions()` Clears all scraping sessions.
`void`	`removeScrapingSession(ScrapingSession scrapingSession)` Removes a `ScrapingSession` from the manager.
`void`	`runScrapingSession(ScrapingSession session)` Runs or queues to be run a scraping session.
`void`	`save()` Saves all of the scraping sessions held by the manager.
`void`	`scrapingSessionFinished(ScrapingSession scrapingSession)` Performs a few functions that need to take place when a scraping session has finished.
`java.util.List<GlobalSearchResult>`	`searchLastRequestsAndResponses(java.lang.String textToFind, boolean isCaseSensitive)` Searches the last requests and responses for the given text.
`void`	`setDefaultProxySettingsOnAllScrapingSessions()` Sets all scraping session proxy settings using the default settings.
`static void`	`setMaxConcurrentScrapingSessions(int maxConcurrentScrapingSessions)` Sets the maximum number of concurrent sessions to allow (in basic this is capped)
`void`	`setScrapingSessionNotifiable(ScrapingSession scrapingSession, ScrapingSessionNotifiable notifiable)` This method gives all scraping sessions (current, running, or runnable) matching the one passed in a reference to the given notifiable.
`void`	`shutdown()`
`void`	`stopAllRunningScrapingSessions()` Stops all running `ScrapingSession`s.
`void`	`stopScrapingSessions(java.lang.String name)` Stops any scraping sessions with the given name.
`static ScrapingSessionManager`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ScrapingSessionManager[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - INSTANCE
```
public static final ScrapingSessionManager INSTANCE
```
    The scraping session manager instance
- Field Detail
  - log
```
public static org.apache.log4j.Logger log
```
  - numRunning
```
@NotNull
java.util.concurrent.atomic.AtomicInteger numRunning
```
  - MAX_BASIC_EDITION_SCRAPING_SESSIONS
```
public static final int MAX_BASIC_EDITION_SCRAPING_SESSIONS
```
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static ScrapingSessionManager[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ScrapingSessionManager c : ScrapingSessionManager.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ScrapingSessionManager valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getInstance
```
@NotNull
public static ScrapingSessionManager getInstance()
```
    Returns the manager instance
  - setMaxConcurrentScrapingSessions
```
public static void setMaxConcurrentScrapingSessions(int maxConcurrentScrapingSessions)
```
    Sets the maximum number of concurrent sessions to allow (in basic this is capped)
    
    Parameters:
    
    maxConcurrentScrapingSessions - The maximum number of sessions to allow
  - getScrapingSessions
```
public java.util.Set<ScrapingSession> getScrapingSessions()
```
    Returns a set of the current sessions
    
    Returns:
    
    A set of the current sessions
  - getScrapingSessionsAsTreeSet
```
public java.util.TreeSet<ScrapingSession> getScrapingSessionsAsTreeSet()
```
    Returns a sorted TreeSet containing the ScrapingSession objects.
    
    Returns:
    
    A TreeSet.
  - getScrapingSessionsIterator
```
public java.util.Iterator<ScrapingSession> getScrapingSessionsIterator()
```
    Returns an iterator over the current sessions
    
    Returns:
    
    An iterator over the current sessions
  - getScrapingSessionBySequence
```
@Nullable
public ScrapingSession getScrapingSessionBySequence(int sequence)
```
    Gets a ScrapingSession based on a sequence, assuming the scraping sessions are sorted alphabetically.
    
    Parameters:
    
    sequence - The sequence corresponding to the desired ScrapingSession.
    
    Returns:
    
    The ScrapingSession if the sequence is valid. Returns null, otherwise.
  - getSequenceForScrapingSession
```
public int getSequenceForScrapingSession(ScrapingSession scrapingSession)
```
    Gets the sequence of the given scraping session.
    
    Parameters:
    
    scrapingSession - The session to the the sequence for
    
    Returns:
    
    The sequence.
  - getNumScrapingSessions
```
public int getNumScrapingSessions()
```
    Gets the number of ScrapingSessions.
    
    Returns:
    
    The number.
  - getRunningScrapingSessions
```
public java.util.List<ScrapingSession> getRunningScrapingSessions()
```
    Returns a HashSet containing running ScrapingSession objects.
    
    Returns:
    
    A HashSet.
  - getRunningScrapingSession
```
@Nullable
public ScrapingSession getRunningScrapingSession(java.lang.String name)
```
    Gets a running scraping session, based on the name of the scraping session.
    
    Parameters:
    
    name - The name of the desired scraping session.
    
    Returns:
    
    The running session with the given name, or null if no match is found
  - isScrapingSessionRunning
```
public boolean isScrapingSessionRunning(@NotNull
                                        ScrapingSession scrapingSession)
```
    Indicates whether or not the given scraping session is currently running.
    
    Parameters:
    
    scrapingSession - The ScrapingSession.
    
    Returns:
    
    True if there is a copy of the current session running
  - getNumRunnableScrapingSessions
```
public int getNumRunnableScrapingSessions()
```
    Gets the number of runnable ScrapingSessions.
    
    Returns:
    
    The number.
  - getNumRunningScrapingSessions
```
public int getNumRunningScrapingSessions()
```
    Gets the number of running ScrapingSessions.
    
    Returns:
    
    The number.
  - getNumRunningScrapingSessions
```
public int getNumRunningScrapingSessions(@Nullable
                                         java.lang.String scrapingSessionName)
```
    Gets the number of named running ScrapingSessions.
    
    Parameters:
    
    scrapingSessionName - The name of the scraping session to check.
    
    Returns:
    
    The number.
  - addScrapingSession
```
public void addScrapingSession(@Nullable
                               ScrapingSession scrapingSession)
```
    Adds a scraping session to be managed.
    
    Parameters:
    
    scrapingSession - The ScrapingSession.
  - getScrapingSessionLastImportTime
```
@NotNull
public java.util.Date getScrapingSessionLastImportTime(@NotNull
                                                                 java.lang.String scrapeName)
```
    Returns the last time the scrape with the given name was imported, or if it hasn't been imported since the instance was launched (or isn't in the instance) returns the time the server was launched
    
    Parameters:
    
    scrapeName - The name of the scrape to check
    
    Returns:
    
    The last time the given scrape was imported, or the current time if it wasn't imported since the instance started
  - addNewScrapingSession
```
@NotNull
public ScrapingSession addNewScrapingSession(Folder folder)
```
    Adds a blank ScrapingSession.
    
    Parameters:
    
    folder - The folder that should contain the generated scraping session.
    
    Returns:
    
    The generated scraping session.
  - hotSwapScrapingSessionsFromFiles
```
public void hotSwapScrapingSessionsFromFiles()
```
    Checks for existing scraping sessions in the "import" directory, and if they exist, hot swaps them in.
  - importFromFile
```
@Nullable
public java.lang.Object importFromFile(@NotNull
                                                  java.io.File file,
                                                  @Nullable
                                                  Folder folder,
                                                  boolean promptForOverwrite)
                                           throws java.lang.Exception
```
    Imports a file that may either contain a ScrapingSession or Script.
    
    Parameters:
    
    file - The file to import.
    
    folder - A Folder to contain the imported object. If this parameter is null, the object will be placed into the root folder.
    
    promptForOverwrite - Indicates whether or not the user should be prompted to overwrite existing objects.
    
    Returns:
    
    The imported object (either a ScrapingSession or Script.
    
    Throws:
    
    java.lang.Exception - An exception with a good error message if something goes wrong.
  - importFromReader
```
public java.lang.Object importFromReader(@NotNull
                                         java.io.Reader reader,
                                         Folder folder,
                                         boolean promptForOverwrite)
                                  throws java.lang.Exception
```
    Imports an object pointed to by the given reader that may either contain a ScrapingSession or Script.
    
    Parameters:
    
    reader - A reader pointing to the object to import.
    
    folder - A Folder to contain the imported object. If this parameter is null, the object will be placed into the root folder.
    
    promptForOverwrite - Indicates whether or not the user should be prompted to overwrite existing objects.
    
    Returns:
    
    The imported object (either a ScrapingSession or Script.
    
    Throws:
    
    java.lang.Exception - An exception with a good error message if something goes wrong.
  - hotSwapScrapingSessionsFromDatabase
```
public void hotSwapScrapingSessionsFromDatabase()
```
    Hot swaps scraping sessions from the database.
  - save
```
public void save()
```
    Saves all of the scraping sessions held by the manager.
  - scrapingSessionFinished
```
public void scrapingSessionFinished(@Nullable
                                    ScrapingSession scrapingSession)
```
    Performs a few functions that need to take place when a scraping session has finished.
    
    Parameters:
    
    scrapingSession - The ScrapingSession that finished.
  - stopAllRunningScrapingSessions
```
public void stopAllRunningScrapingSessions()
```
    Stops all running ScrapingSessions.
  - runScrapingSession
```
public void runScrapingSession(@NotNull
                               ScrapingSession session)
```
    Runs or queues to be run a scraping session.
    
    Parameters:
    
    session - The ScrapingSession.
  - stopScrapingSessions
```
public void stopScrapingSessions(java.lang.String name)
```
    Stops any scraping sessions with the given name.
    
    Parameters:
    
    name - The name of the scraping sessions that should be stopped.
  - getScrapingSessionCopy
```
@Nullable
public ScrapingSession getScrapingSessionCopy(java.lang.String name)
```
    Gets a copy of an existing scraping session, based on the name of the scraping session.
    
    Parameters:
    
    name - The name of the desired scraping session.
    
    Returns:
    
    The scraping session, or null if not found
  - searchLastRequestsAndResponses
```
@NotNull
public java.util.List<GlobalSearchResult> searchLastRequestsAndResponses(java.lang.String textToFind,
                                                                                   boolean isCaseSensitive)
```
    Searches the last requests and responses for the given text.
    
    Parameters:
    
    textToFind - The text to search for.
    
    isCaseSensitive - Case sensitive?
  - getScrapingSession
```
@Nullable
public ScrapingSession getScrapingSession(java.lang.String name)
```
    Gets a scraping session, based on the name of the scraping session.
    
    Parameters:
    
    name - The name of the desired scraping session.
    
    Returns:
    
    The scraping session, or null if not found
  - getScrapingSession
```
@Nullable
public ScrapingSession getScrapingSession(int id)
```
    Gets a scraping session, based on the ID of the scraping session.
    
    Parameters:
    
    id - The ID of the desired scraping session.
    
    Returns:
    
    The scraping session, or null if not found
  - getNumScrapingSessionsWithName
```
public int getNumScrapingSessionsWithName(@Nullable
                                          java.lang.String name)
```
    Gets the number of scraping sessions carrying the given name.
    
    Parameters:
    
    name - The name of the scraping session.
    
    Returns:
    
    The number found.
  - removeScrapingSession
```
public void removeScrapingSession(@NotNull
                                  ScrapingSession scrapingSession)
```
    Removes a ScrapingSession from the manager.
    
    Parameters:
    
    scrapingSession - The ScrapingSession to remove.
  - removeAllScrapingSessions
```
public void removeAllScrapingSessions()
```
    Clears all scraping sessions.
  - setScrapingSessionNotifiable
```
public void setScrapingSessionNotifiable(@Nullable
                                         ScrapingSession scrapingSession,
                                         @Nullable
                                         ScrapingSessionNotifiable notifiable)
```
    This method gives all scraping sessions (current, running, or runnable) matching the one passed in a reference to the given notifiable. This method is primarily used to that the GUI can be updated while a scraping session is running in the workbench.
    
    Parameters:
    
    scrapingSession - The ScrapingSession to match.
    
    notifiable - The ScrapingSessionNotifiable object the matching scraping sessions should be given a reference to.
  - setDefaultProxySettingsOnAllScrapingSessions
```
public void setDefaultProxySettingsOnAllScrapingSessions()
```
    Sets all scraping session proxy settings using the default settings.
  - loadScrapingSessions
```
public void loadScrapingSessions(@Nullable
                                 ScrapingSessionNotifiable scrapingSessionNotifiable)
```
    Causes the manager to load itself with all available scraping sessions.
    
    Parameters:
    
    scrapingSessionNotifiable - The ScrapingSessionNotifiable to give to the ScrapingSessions that get created. Note that this parameter is optional.
  - shutdown
```
public void shutdown()
```

Enum ScrapingSessionManager

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INSTANCE

Field Detail

log

numRunning

MAX_BASIC_EDITION_SCRAPING_SESSIONS

Method Detail

values

valueOf

getInstance

setMaxConcurrentScrapingSessions

getScrapingSessions

getScrapingSessionsAsTreeSet

getScrapingSessionsIterator

getScrapingSessionBySequence

getSequenceForScrapingSession

getNumScrapingSessions

getRunningScrapingSessions

getRunningScrapingSession

isScrapingSessionRunning

getNumRunnableScrapingSessions

getNumRunningScrapingSessions

getNumRunningScrapingSessions

addScrapingSession

getScrapingSessionLastImportTime

addNewScrapingSession

hotSwapScrapingSessionsFromFiles

importFromFile

importFromReader

hotSwapScrapingSessionsFromDatabase

save

scrapingSessionFinished

stopAllRunningScrapingSessions

runScrapingSession

stopScrapingSessions

getScrapingSessionCopy

searchLastRequestsAndResponses

getScrapingSession

getScrapingSession

getNumScrapingSessionsWithName

removeScrapingSession

removeAllScrapingSessions

setScrapingSessionNotifiable

setDefaultProxySettingsOnAllScrapingSessions

loadScrapingSessions

shutdown