com.screenscraper.util.retry

Class RetryPolicyFactory

java.lang.Object

com.screenscraper.util.retry.RetryPolicyFactory

public class RetryPolicyFactory
extends java.lang.Object

Factory for creating a retry policies User: Mike Date: 11/9/11 Time: 5:14 PM

Method Summary

Modifier and Type	Method and Description
static RetryPolicy	getBasicPolicy(int retries, java.lang.Runnable runnableOnFail) Policy that retries if there was an error on the request by status code.
static RetryPolicy	getBasicPolicy(int retries, java.lang.String scriptOnFail) Policy that retries if there was an error on the request by status code.
static RetryPolicy	getEmptyPolicy() Policy that returns no error.
static RetryPolicy	getMatchingRegexPolicy(int retries, java.lang.String regex) Policy that requires a Regular Expression to match the page content (including headers) in order to be considered valid.
static RetryPolicy	getMatchingRegexPolicy(int retries, java.lang.String regex, java.lang.Runnable runnableOnFail) Policy that requires a Regular Expression to match the page content (including headers) in order to be considered valid.
static RetryPolicy	getMatchingRegexPolicy(int retries, java.lang.String regex, java.lang.String scriptOnFail) Policy that requires a Regular Expression to match the page content (including headers) in order to be considered valid.
static RetryPolicy	getMissingRegexPolicy(int retries, java.lang.String regex) Policy that requires a Regular Expression NOT to match the page content (including headers) in order to be considered valid.
static RetryPolicy	getMissingRegexPolicy(int retries, java.lang.String regex, java.lang.Runnable runnableOnFail) Policy that requires a Regular Expression NOT to match the page content (including headers) in order to be considered valid.
static RetryPolicy	getMissingRegexPolicy(int retries, java.lang.String regex, java.lang.String scriptOnFail) Policy that requires a Regular Expression NOT to match the page content (including headers) in order to be considered valid.
static RetryPolicy	getMultiRegexPolicy(int retries, java.util.Collection<java.lang.String> matchingRegex, java.util.Collection<java.lang.String> missingRegex) Policy that allows for multiple regex, with each being set to required or not.
static RetryPolicy	getMultiRegexPolicy(int retries, java.util.Collection<java.lang.String> matchingRegex, java.util.Collection<java.lang.String> missingRegex, java.lang.Runnable runnableOnFail) Policy that allows for multiple regex, with each being set to required or not.
static RetryPolicy	getMultiRegexPolicy(int retries, java.util.Collection<java.lang.String> matchingRegex, java.util.Collection<java.lang.String> missingRegex, java.lang.String scriptOnFail) Policy that allows for multiple regex, with each being set to required or not.
static RetryPolicy	getRegexPolicy(int retries, java.lang.String matchingRegex, java.lang.String missingRegex) Policy that allows for both a required regex and a regex that should not match.
static RetryPolicy	getRegexPolicy(int retries, java.lang.String matchingRegex, java.lang.String missingRegex, java.lang.Runnable runnableOnFail) Policy that allows for both a required regex and a regex that should not match.
static RetryPolicy	getRegexPolicy(int retries, java.lang.String matchingRegex, java.lang.String missingRegex, java.lang.String scriptOnFail) Policy that allows for both a required regex and a regex that should not match.

Methods inherited from class java.lang.Object

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

Method Detail

getEmptyPolicy

@NotNull
public static RetryPolicy getEmptyPolicy()

Policy that returns no error. Useful for having a session-wide retry policy, but then using this for a particular scrapeable file so it doesn't use the session's policy

Returns:

The RetryPolicy to set in the ScrapeableFile

getBasicPolicy

@NotNull
public static RetryPolicy getBasicPolicy(int retries,
                                                   java.lang.String scriptOnFail)

Policy that retries if there was an error on the request by status code. Executes the script given before retrying.

Parameters:

retries - How many times max to retry before failing

scriptOnFail - The name of the script to run

Returns:

The RetryPolicy to set in the ScrapeableFile

getBasicPolicy

@NotNull
public static RetryPolicy getBasicPolicy(int retries,
                                                   java.lang.Runnable runnableOnFail)

Policy that retries if there was an error on the request by status code. Executes the runnable given before retrying.

Parameters:

retries - How many times max to retry before failing

runnableOnFail - A Runnable to run before retrying

Returns:

The RetryPolicy to set in the ScrapeableFile

getMatchingRegexPolicy

@NotNull
public static RetryPolicy getMatchingRegexPolicy(int retries,
                                                           @NotNull
                                                           java.lang.String regex)

Policy that requires a Regular Expression to match the page content (including headers) in order to be considered valid.

Parameters:

retries - How many times max to retry before failing

regex - A Regular expression that must match for the page to be considered valid

Returns:

The RetryPolicy to set in the ScrapeableFile

getMatchingRegexPolicy

@NotNull
public static RetryPolicy getMatchingRegexPolicy(int retries,
                                                           @NotNull
                                                           java.lang.String regex,
                                                           java.lang.String scriptOnFail)

Policy that requires a Regular Expression to match the page content (including headers) in order to be considered valid.

Parameters:

retries - How many times max to retry before failing

regex - A Regular expression that must match for the page to be considered valid

scriptOnFail - The script to run before retrying

Returns:

The RetryPolicy to set in the ScrapeableFile

getMatchingRegexPolicy

@NotNull
public static RetryPolicy getMatchingRegexPolicy(int retries,
                                                           @NotNull
                                                           java.lang.String regex,
                                                           java.lang.Runnable runnableOnFail)

Policy that requires a Regular Expression to match the page content (including headers) in order to be considered valid.

Parameters:

retries - How many times max to retry before failing

regex - A Regular expression that must match for the page to be considered valid

runnableOnFail - The runnable to run before retrying

Returns:

The RetryPolicy to set in the ScrapeableFile

getMissingRegexPolicy

@NotNull
public static RetryPolicy getMissingRegexPolicy(int retries,
                                                          @NotNull
                                                          java.lang.String regex)

Policy that requires a Regular Expression NOT to match the page content (including headers) in order to be considered valid. In other words, if the Regular Expression matches, it means that the page should be rescraped.

Parameters:

retries - How many times max to retry before failing

regex - A Regular expression that must not match for the page to be considered valid

Returns:

The RetryPolicy to set in the ScrapeableFile

getMissingRegexPolicy

@NotNull
public static RetryPolicy getMissingRegexPolicy(int retries,
                                                          @NotNull
                                                          java.lang.String regex,
                                                          java.lang.String scriptOnFail)

Policy that requires a Regular Expression NOT to match the page content (including headers) in order to be considered valid. In other words, if the Regular Expression matches, it means that the page should be rescraped.

Parameters:

retries - How many times max to retry before failing

regex - A Regular expression that must not match for the page to be considered valid

scriptOnFail - The runnable to run before retrying

Returns:

The RetryPolicy to set in the ScrapeableFile

getMissingRegexPolicy

@NotNull
public static RetryPolicy getMissingRegexPolicy(int retries,
                                                          @NotNull
                                                          java.lang.String regex,
                                                          java.lang.Runnable runnableOnFail)

Policy that requires a Regular Expression NOT to match the page content (including headers) in order to be considered valid. In other words, if the Regular Expression matches, it means that the page should be rescraped.

Parameters:

retries - How many times max to retry before failing

regex - A Regular expression that must not match for the page to be considered valid

runnableOnFail - The runnable to run before retrying

Returns:

The RetryPolicy to set in the ScrapeableFile

getRegexPolicy

@NotNull
public static RetryPolicy getRegexPolicy(int retries,
                                                   @NotNull
                                                   java.lang.String matchingRegex,
                                                   @NotNull
                                                   java.lang.String missingRegex)

Policy that allows for both a required regex and a regex that should not match.

Parameters:

retries - How many times max to retry before failing

matchingRegex - A Regular expression that must match for the page to be considered valid

missingRegex - A Regular expression that must not match for the page to be considered valid

Returns:

The RetryPolicy to set in the ScrapeableFile

getRegexPolicy

@NotNull
public static RetryPolicy getRegexPolicy(int retries,
                                                   @NotNull
                                                   java.lang.String matchingRegex,
                                                   @NotNull
                                                   java.lang.String missingRegex,
                                                   java.lang.String scriptOnFail)

Policy that allows for both a required regex and a regex that should not match.

Parameters:

retries - How many times max to retry before failing

matchingRegex - A Regular expression that must match for the page to be considered valid

missingRegex - A Regular expression that must not match for the page to be considered valid

scriptOnFail - The runnable to run before retrying

Returns:

The RetryPolicy to set in the ScrapeableFile

getRegexPolicy

@NotNull
public static RetryPolicy getRegexPolicy(int retries,
                                                   @NotNull
                                                   java.lang.String matchingRegex,
                                                   @NotNull
                                                   java.lang.String missingRegex,
                                                   java.lang.Runnable runnableOnFail)

Policy that allows for both a required regex and a regex that should not match.

Parameters:

retries - How many times max to retry before failing

matchingRegex - A Regular expression that must match for the page to be considered valid

missingRegex - A Regular expression that must not match for the page to be considered valid

runnableOnFail - The runnable to run before retrying

Returns:

The RetryPolicy to set in the ScrapeableFile

getMultiRegexPolicy

@NotNull
public static RetryPolicy getMultiRegexPolicy(int retries,
                                                        @Nullable
                                                        java.util.Collection<java.lang.String> matchingRegex,
                                                        @Nullable
                                                        java.util.Collection<java.lang.String> missingRegex)

Policy that allows for multiple regex, with each being set to required or not. This allows for multiple regex checks using a single policy.

Parameters:

retries - How many times max to retry before failing

matchingRegex - Regular Expressions that must match for the page to be valid. If this is null, no matchingRegex will be added

missingRegex - Regular Expressions that must not match for the page to be valid. If this is null, no missingRegex will be added

Returns:

The RetryPolicy to set in the ScrapeableFile

getMultiRegexPolicy

@NotNull
public static RetryPolicy getMultiRegexPolicy(int retries,
                                                        @Nullable
                                                        java.util.Collection<java.lang.String> matchingRegex,
                                                        @Nullable
                                                        java.util.Collection<java.lang.String> missingRegex,
                                                        java.lang.String scriptOnFail)

Policy that allows for multiple regex, with each being set to required or not. This allows for multiple regex checks using a single policy

Parameters:

retries - How many times max to retry before failing

matchingRegex - Regular Expressions that must match for the page to be valid. If this is null, no matchingRegex will be added

missingRegex - Regular Expressions that must not match for the page to be valid. If this is null, no missingRegex will be added

scriptOnFail - The script to run before retrying

Returns:

The RetryPolicy to set in the ScrapeableFile

getMultiRegexPolicy

@NotNull
public static RetryPolicy getMultiRegexPolicy(int retries,
                                                        @Nullable
                                                        java.util.Collection<java.lang.String> matchingRegex,
                                                        @Nullable
                                                        java.util.Collection<java.lang.String> missingRegex,
                                                        java.lang.Runnable runnableOnFail)

Policy that allows for multiple regex, with each being set to required or not. This allows for multiple regex checks using a single policy

Parameters:

retries - How many times max to retry before failing

matchingRegex - Regular Expressions that must match for the page to be valid. If this is null, no matchingRegex will be added

missingRegex - Regular Expressions that must not match for the page to be valid. If this is null, no missingRegex will be added

runnableOnFail - The runnable to run before retrying

Returns:

The RetryPolicy to set in the ScrapeableFile