AbstractRetryPolicy

java.lang.Object
- com.screenscraper.util.retry.AbstractRetryPolicy

All Implemented Interfaces:

RetryPolicy

Direct Known Subclasses:

EmptyRetryPolicy, MultiplePolicyRetryPolicy, StandardRetryPolicy
```
public abstract class AbstractRetryPolicy
extends java.lang.Object
implements RetryPolicy
```
No Description User: Mike Date: 11/10/11 Time: 9:17 AM

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,java.lang.Object>`	`errorOutputMap` A map of failure results
`protected int`	`maxNumberOfRetries` The maximum number of attempts to retry before failing
`protected boolean`	`resetReferrerBeforeRescrape` Flag used to indicate whether or not the referrer should be reset if this policy shows an error on the page
`protected boolean`	`resetSessionVariablesBeforeRescrape` Flag used to indicate whether or not the session variables should be reset if this policy shows an error on the page
`protected ScrapingSession`	`scrapingSession` The scraping session this is running under
`protected ScriptContext`	`scriptContext` The script context, used to allow scrapeableFile to have a value in an executed script
`protected ScrapeableFile`	`theScrapeableFile` The scrapeable file to use

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractRetryPolicy()
Default constructor, used to initialize the default values of all the variables

Constructors
Modifier	Constructor and Description
`protected`	`AbstractRetryPolicy()` Default constructor, used to initialize the default values of all the variables

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbstractRetryPolicy`	`duplicate()` Duplicates this retry policy, copying any needed values to the new AbstractRetryPolicy.
`java.util.Map<java.lang.String,?>`	`getErrorChecksMap()` Returns a map that can be used to output an error message to indicate what checks failed.
`int`	`getMaxRetryAttempts()` Return the maximum number of times this policy allows for a retry before terminating in an error
`ScriptContext`	`getScriptContext()` Get the current script context (as last set)
`boolean`	`isError()` Checks to see if the page loaded incorrectly
`boolean`	`resetReferrerBeforeRescrape()` Returns true if the referrer should be reset before attempting to rescrape the file, if there was an error.
`boolean`	`resetSessionVariablesBeforeRescrape()` Returns true if the session variables should be reset before attempting to rescrape the file, if there was an error.
`void`	`runOnAllAttemptsFailed()` This will be called if all the retry attempts for the scrapeable file failed.
`void`	`setMaxNumberOfRetries(int retries)` Sets the maximum number of retry attempts for this policy
`void`	`setResetReferrerBeforeRescrape(boolean resetReferrerBeforeRescrape)` Sets whether or not this policy requests session variables to be reset before a rescrape is attempted
`void`	`setResetSessionVariablesBeforeRescrape(boolean resetSessionVariablesBeforeRescrape)` Sets whether or not this policy requests session variables to be reset before a rescrape is attempted
`void`	`setScrapeableFile(ScrapeableFile scrapeableFile)` Sets the scrapeable file this policy will use to get the downloaded content
`void`	`setScrapingSession(ScrapingSession session)` Sets the scraping session for this policy to access, if need be
`void`	`setScriptContext(ScriptContext scriptContext)` Sets the current script context
`boolean`	`shouldLogErrors()` Returns true if errors should be logged to the log/web interface when they occur

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.screenscraper.util.retry.RetryPolicy
runOnError

- Field Detail
  - maxNumberOfRetries
```
protected int maxNumberOfRetries
```
    The maximum number of attempts to retry before failing
  - theScrapeableFile
```
@Nullable
protected ScrapeableFile theScrapeableFile
```
    The scrapeable file to use
  - scrapingSession
```
@Nullable
protected ScrapingSession scrapingSession
```
    The scraping session this is running under
  - errorOutputMap
```
@Nullable
protected java.util.Map<java.lang.String,java.lang.Object> errorOutputMap
```
    A map of failure results
  - resetSessionVariablesBeforeRescrape
```
protected boolean resetSessionVariablesBeforeRescrape
```
    Flag used to indicate whether or not the session variables should be reset if this policy shows an error on the page
  - resetReferrerBeforeRescrape
```
protected boolean resetReferrerBeforeRescrape
```
    Flag used to indicate whether or not the referrer should be reset if this policy shows an error on the page
  - scriptContext
```
protected ScriptContext scriptContext
```
    The script context, used to allow scrapeableFile to have a value in an executed script
- Constructor Detail
  - AbstractRetryPolicy
```
protected AbstractRetryPolicy()
```
    Default constructor, used to initialize the default values of all the variables
- Method Detail
  - duplicate
```
@Nullable
public AbstractRetryPolicy duplicate()
```
    Duplicates this retry policy, copying any needed values to the new AbstractRetryPolicy. Duplicating a retry policy allows for safe multithreading. Returns null if the policy should not be duplicated for whatever reason.
    Note that the copy can share internal references if necessary for the functionality of the policy. For example, if the policy is tracking total number of failures it may have a shared AtomicInteger reference for counting, which is passed in to the duplicate policy by reference. Therefore, duplicate isn't necessarily an independent duplicate. It should be noted though that a "duplicate" copy of the policy is used for each scrapeable file when called
    
    Returns:
    
    A new retry policy that performs the same functions as the current policy, or null if by nature of the policy it cannot be duplicated.
  - isError
```
public boolean isError()
                throws java.lang.Exception
```
    Description copied from interface: RetryPolicy
    
    Checks to see if the page loaded incorrectly
    
    Specified by:
    
    isError in interface RetryPolicy
    
    Returns:
    
    True on errors, false otherwise
    
    Throws:
    
    java.lang.Exception - If something goes wrong while executing this method
  - setScrapeableFile
```
public void setScrapeableFile(ScrapeableFile scrapeableFile)
```
    Sets the scrapeable file this policy will use to get the downloaded content
    
    Parameters:
    
    scrapeableFile - The scrapeable file to use
  - setScrapingSession
```
public void setScrapingSession(ScrapingSession session)
```
    Sets the scraping session for this policy to access, if need be
    
    Parameters:
    
    session - The current scraping session
  - getErrorChecksMap
```
@Nullable
public java.util.Map<java.lang.String,?> getErrorChecksMap()
```
    Description copied from interface: RetryPolicy
    
    Returns a map that can be used to output an error message to indicate what checks failed. For instance, you could set a key to the value "Status Code" and the value '200', or a key with "Valid Page" and value 'false'
    
    Specified by:
    
    getErrorChecksMap in interface RetryPolicy
    
    Returns:
    
    Map of keys, or null if no values are indicated
  - resetSessionVariablesBeforeRescrape
```
public boolean resetSessionVariablesBeforeRescrape()
```
    Description copied from interface: RetryPolicy
    
    Returns true if the session variables should be reset before attempting to rescrape the file, if there was an error. This can be useful especially if extractors null session variables when they don't match, but the value is needed to rescrape the file. If this returns true, the session variables will be reset BEFORE calling RetryPolicy.runOnError()
    
    Specified by:
    
    resetSessionVariablesBeforeRescrape in interface RetryPolicy
    
    Returns:
    
    True if session variables should be reset if there was an error, false otherwise.
  - resetReferrerBeforeRescrape
```
public boolean resetReferrerBeforeRescrape()
```
    Description copied from interface: RetryPolicy
    
    Returns true if the referrer should be reset before attempting to rescrape the file, if there was an error. This can be useful to reset so the referrer doesn't show the page you just requested. If this returns true, the referrer will be reset BEFORE calling RetryPolicy.runOnError()
    
    Specified by:
    
    resetReferrerBeforeRescrape in interface RetryPolicy
    
    Returns:
    
    True if the referrer should be reset if there was an error, false otherwise.
  - shouldLogErrors
```
public boolean shouldLogErrors()
```
    Description copied from interface: RetryPolicy
    
    Returns true if errors should be logged to the log/web interface when they occur
    
    Specified by:
    
    shouldLogErrors in interface RetryPolicy
    
    Returns:
    
    True if errors should be logged to the log/web interface when they occur
  - setMaxNumberOfRetries
```
public void setMaxNumberOfRetries(int retries)
```
    Sets the maximum number of retry attempts for this policy
    
    Parameters:
    
    retries - How many times this policy will retry before failing
  - getMaxRetryAttempts
```
public int getMaxRetryAttempts()
```
    Description copied from interface: RetryPolicy
    
    Return the maximum number of times this policy allows for a retry before terminating in an error
    
    Specified by:
    
    getMaxRetryAttempts in interface RetryPolicy
    
    Returns:
    
    The maximum number of times to allow the ScrapeableFile to be rescraped before resulting in an error
  - setResetSessionVariablesBeforeRescrape
```
public void setResetSessionVariablesBeforeRescrape(boolean resetSessionVariablesBeforeRescrape)
```
    Sets whether or not this policy requests session variables to be reset before a rescrape is attempted
    
    Parameters:
    
    resetSessionVariablesBeforeRescrape - True to reset session variables before a rescrape
  - setResetReferrerBeforeRescrape
```
public void setResetReferrerBeforeRescrape(boolean resetReferrerBeforeRescrape)
```
    Sets whether or not this policy requests session variables to be reset before a rescrape is attempted
    
    Parameters:
    
    resetReferrerBeforeRescrape - True to reset the referrer before a rescrape
  - getScriptContext
```
public ScriptContext getScriptContext()
```
    Get the current script context (as last set)
    
    Returns:
    
    The currently set script context
  - setScriptContext
```
public void setScriptContext(ScriptContext scriptContext)
```
    Sets the current script context
    
    Parameters:
    
    scriptContext - The current script context
  - runOnAllAttemptsFailed
```
public void runOnAllAttemptsFailed()
                            throws java.lang.Exception
```
    Description copied from interface: RetryPolicy
    
    This will be called if all the retry attempts for the scrapeable file failed. In other words, if the policy said to retry 25 times, after 25 failures this method will be called. Note that RetryPolicy.runOnError() will be called just before this, as it is called after each time the scrapeable file fails to load correctly, including the last time it fails to load.
    This should only contain code that handles the final error. Any proxy rotating, cookie clearing, etc... should generally be done in the RetryPolicy.runOnError() method, especially since it will still be called after the final error.
    
    Specified by:
    
    runOnAllAttemptsFailed in interface RetryPolicy
    
    Throws:
    
    java.lang.Exception - If the contents of this method throw an exception in the child class

Class AbstractRetryPolicy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.screenscraper.util.retry.RetryPolicy

Field Detail

maxNumberOfRetries

theScrapeableFile

scrapingSession

errorOutputMap

resetSessionVariablesBeforeRescrape

resetReferrerBeforeRescrape

scriptContext

Constructor Detail

AbstractRetryPolicy

Method Detail

duplicate

isError

setScrapeableFile

setScrapingSession

getErrorChecksMap

resetSessionVariablesBeforeRescrape

resetReferrerBeforeRescrape

shouldLogErrors

setMaxNumberOfRetries

getMaxRetryAttempts

setResetSessionVariablesBeforeRescrape

setResetReferrerBeforeRescrape

getScriptContext

setScriptContext

runOnAllAttemptsFailed