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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EmbeddedBrowser	getBrowser()
CrawljaxConfiguration	getConfig()
CrawlPath	getCrawlPath()
StateVertex	getCurrentState()
com.codahale.metrics.MetricRegistry	getRegistry()
CrawlSession	getSession()
protected void	setCrawlPath(CrawlPath path)
void	stop() Tells Crawljax to stop with Exit status ExitNotifier.ExitStatus.STOPPED.

Methods inherited from class java.lang.Object

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

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.

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().

getCurrentState

public StateVertex getCurrentState()

Returns:

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

getRegistry

public com.codahale.metrics.MetricRegistry getRegistry()

setCrawlPath

protected void setCrawlPath(CrawlPath path)

Parameters:

path - The current CrawlPath in this context.

getCrawlPath

public CrawlPath getCrawlPath()

Returns:

The current CrawlPath in this context.