Package com.crawljax.core.configuration

Class CrawljaxConfiguration

java.lang.Object

com.crawljax.core.configuration.CrawljaxConfiguration

public class CrawljaxConfiguration
extends Object

Configures the Crawler. Set it up using the builderFor(String) function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CrawljaxConfiguration.CrawljaxConfigurationBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private URI	basicAuthUrl
private BrowserConfiguration	browserConfig
private CrawlRules	crawlRules
private CrawlScope	crawlScope
private int	maximumDepth
private long	maximumRuntime
private int	maximumStates
private File	output
private File	pluginOutput	Output folder for data that is unique to each crawl (ie.
private com.google.common.collect.ImmutableList<Plugin>	plugins
private ProxyConfiguration	proxyConfiguration
private File	siteOutput	Output folder for data that is static to one site (ie.
private StateVertexFactory	stateVertexFactory
private URI	url

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CrawljaxConfiguration()

Method Summary

Modifier and Type	Method	Description
static CrawljaxConfiguration.CrawljaxConfigurationBuilder	builderFor(String url)
static CrawljaxConfiguration.CrawljaxConfigurationBuilder	builderFor(URI url)
boolean	equals(Object object)
URI	getBasicAuthUrl()
BrowserConfiguration	getBrowserConfig()
CrawlRules	getCrawlRules()
CrawlScope	getCrawlScope()
int	getMaximumDepth()
long	getMaximumRuntime()
int	getMaximumStates()
File	getOutputDir()
com.google.common.collect.ImmutableList<Plugin>	getPlugins()
ProxyConfiguration	getProxyConfiguration()
File	getSiteDir()
StateVertexFactory	getStateVertexFactory()
URI	getUrl()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

url

private URI url

basicAuthUrl

private URI basicAuthUrl

crawlScope

private CrawlScope crawlScope

browserConfig

private BrowserConfiguration browserConfig

plugins

private com.google.common.collect.ImmutableList<Plugin> plugins

proxyConfiguration

private ProxyConfiguration proxyConfiguration

crawlRules

private CrawlRules crawlRules

maximumStates

private int maximumStates

maximumRuntime

private long maximumRuntime

maximumDepth

private int maximumDepth

output

private File output

siteOutput

private File siteOutput

Output folder for data that is static to one site (ie. form data)

pluginOutput

private File pluginOutput

Output folder for data that is unique to each crawl (ie. plugin output)

stateVertexFactory

private StateVertexFactory stateVertexFactory

Constructor Detail

CrawljaxConfiguration

private CrawljaxConfiguration()

Method Detail

builderFor

public static CrawljaxConfiguration.CrawljaxConfigurationBuilder builderFor(URI url)

Parameters:

url - The url you want to setup a configuration for

Returns:

The builder to configure the crawler.

builderFor

public static CrawljaxConfiguration.CrawljaxConfigurationBuilder builderFor(String url)

Parameters:

url - The url you want to setup a configuration for

Returns:

The builder to configure the crawler.

getUrl

public URI getUrl()

getBasicAuthUrl

public URI getBasicAuthUrl()

getCrawlScope

public CrawlScope getCrawlScope()

getBrowserConfig

public BrowserConfiguration getBrowserConfig()

getPlugins

public com.google.common.collect.ImmutableList<Plugin> getPlugins()

getProxyConfiguration

public ProxyConfiguration getProxyConfiguration()

getCrawlRules

public CrawlRules getCrawlRules()

getMaximumStates

public int getMaximumStates()

getMaximumRuntime

public long getMaximumRuntime()

getMaximumDepth

public int getMaximumDepth()

getSiteDir

public File getSiteDir()

Returns:

The output directory for site-specific data such as form inputs.

getOutputDir

public File getOutputDir()

Returns:

The output directory for crawl-specific data such as crawl-overview output.

getStateVertexFactory

public StateVertexFactory getStateVertexFactory()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object