Package com.crawljax.core

Class CrawlerContext

java.lang.Object

com.crawljax.core.CrawlerContext

public class CrawlerContext
extends Object

A context for each Crawler that can be handed to a Plugin.

Field Summary

Fields

Modifier and Type	Field	Description
private EmbeddedBrowser	browser
private CrawljaxConfiguration	config
private CrawlPath	crawlpath
private ExitNotifier	exitNotifier
private FragmentManager	fragmentManager
private com.codahale.metrics.MetricRegistry	registry
private javax.inject.Provider<CrawlSession>	sessionProvider
private StateMachine	stateMachine

Constructor Summary

Constructors

Constructor	Description
CrawlerContext(EmbeddedBrowser browser, CrawljaxConfiguration config, javax.inject.Provider<CrawlSession> sessionProvider, ExitNotifier exitNotifier, com.codahale.metrics.MetricRegistry registry)

Method Summary

Modifier and Type	Method	Description
EmbeddedBrowser	getBrowser()
CrawljaxConfiguration	getConfig()
CrawlPath	getCrawlPath()
StateVertex	getCurrentState()
FragmentManager	getFragmentManager()
com.codahale.metrics.MetricRegistry	getRegistry()
CrawlSession	getSession()
(package private) StateMachine	getStateMachine()
protected void	setCrawlPath(CrawlPath path)
void	setFragmentManager(FragmentManager fragmentManager)
(package private) void	setStateMachine(StateMachine stateMachine)
void	stop()	Tells Crawljax to stop with Exit status ExitNotifier.ExitStatus.STOPPED.
EmbeddedBrowser	updateBrowser(EmbeddedBrowser browser)

Methods inherited from class java.lang.Object

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

Field Detail

sessionProvider

private final javax.inject.Provider<CrawlSession> sessionProvider

config

private final CrawljaxConfiguration config

exitNotifier

private final ExitNotifier exitNotifier

registry

private final com.codahale.metrics.MetricRegistry registry

browser

private EmbeddedBrowser browser

stateMachine

private StateMachine stateMachine

crawlpath

private CrawlPath crawlpath

fragmentManager

private FragmentManager fragmentManager

Constructor Detail

CrawlerContext

@Inject
public CrawlerContext(EmbeddedBrowser browser,
                      CrawljaxConfiguration config,
                      javax.inject.Provider<CrawlSession> sessionProvider,
                      ExitNotifier exitNotifier,
                      com.codahale.metrics.MetricRegistry registry)

Method Detail

getBrowser

public EmbeddedBrowser getBrowser()

Returns:

The browser of the current session. If you have configured multiple browsers this will return the EmbeddedBrowser that caused the given Plugin to fire.

updateBrowser

public EmbeddedBrowser updateBrowser(EmbeddedBrowser browser)

getSession

public CrawlSession getSession()

Returns:

The CrawlSession

getConfig

public CrawljaxConfiguration getConfig()

Returns:

The CrawljaxConfiguration for this crawl.

stop

public void stop()

Tells Crawljax to stop with Exit status ExitNotifier.ExitStatus.STOPPED. This is equivalent to calling CrawljaxRunner.stop().

getStateMachine

StateMachine getStateMachine()

setStateMachine

void setStateMachine(StateMachine stateMachine)

getCurrentState

public StateVertex getCurrentState()

Returns:

The current StateVertex or null when the Crawler isn't initialized yet.

getRegistry

public com.codahale.metrics.MetricRegistry getRegistry()

getCrawlPath

public CrawlPath getCrawlPath()

Returns:

The current CrawlPath in this context.

setCrawlPath

protected void setCrawlPath(CrawlPath path)

Parameters:

path - The current CrawlPath in this context.

getFragmentManager

public FragmentManager getFragmentManager()

setFragmentManager

public void setFragmentManager(FragmentManager fragmentManager)