com.crawljax.core.plugin

Class Plugins

java.lang.Object

com.crawljax.core.plugin.Plugins

public class Plugins
extends Object

Class for invoking plugins. The methods in this class are invoked from the Crawljax Core.

Constructor Summary

Constructors

Constructor and Description
Plugins(List<? extends Plugin> plugins)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
int	hashCode()
static Plugins	noPlugins()
com.google.common.collect.ImmutableSet<String>	pluginNames()
boolean	runDomChangeNotifierPlugins(CrawlerContext context, StateVertex stateBefore, Eventable event, StateVertex stateAfter) Load and run the DomChangeNotifierPlugin.
void	runOnBrowserCreatedPlugins(EmbeddedBrowser newBrowser) Load and run the OnBrowserCreatedPlugins, this call has been made from the browserpool when a new browser has been created and ready to be used by the Crawler.
void	runOnFireEventFailedPlugins(CrawlerContext context, Eventable eventable, List<Eventable> path) Load and run the OnFireEventFailedPlugins, this call has been made from the fireEvent when the event is not fireable.
void	runOnInvriantViolationPlugins(Invariant invariant, CrawlerContext context) Run the OnInvariantViolation plugins when an Invariant is violated.
void	runOnNewStatePlugins(CrawlerContext context, StateVertex newState) load and run the OnNewStatePlugins.
void	runOnRevisitStatePlugins(CrawlerContext context, StateVertex currentState) load and run the onRevisitStateValidator.
void	runOnUrlLoadPlugins(CrawlerContext context) load and run the OnUrlLoadPlugins.
void	runPostCrawlingPlugins(CrawlSession session, ExitNotifier.ExitStatus exitReason) load and run the postCrawlingPlugins.
void	runPreCrawlingPlugins(CrawljaxConfiguration config)
void	runPreStateCrawlingPlugins(CrawlerContext context, com.google.common.collect.ImmutableList<CandidateElement> candidateElements, StateVertex state) load and run the PreStateCrawlingPlugins.
void	runProxyServerPlugins(ProxyConfiguration config) Load and run the proxyServerPlugins.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugins

public Plugins(List<? extends Plugin> plugins)

Method Detail

noPlugins

public static Plugins noPlugins()

Returns:

An empty Plugins configuration.

runOnUrlLoadPlugins

public void runOnUrlLoadPlugins(CrawlerContext context)

load and run the OnUrlLoadPlugins. The OnURLloadPlugins are run just after the Browser has gone to the initial url. Not only the first time but also every time the Core navigates back. Warning the instance of the browser offered is not a clone but the current and after wards used browser instance, changes and operations may cause 'strange' behaviour.

This method can be called from multiple threads with different CrawlerContext

Parameters:

browser - the embedded browser instance to load in the plugin.

runOnNewStatePlugins

public void runOnNewStatePlugins(CrawlerContext context,
                        StateVertex newState)

load and run the OnNewStatePlugins. OnNewStatePlugins are plugins that are ran when a new state was found. This also happens for the Index State. Warning the session is not a clone, chaning the session can cause strange behaviour of Crawljax.

This method can be called from multiple threads with different CrawlerContext

Parameters:

session - the session to load in the plugin

newState - The new state

runOnInvriantViolationPlugins

public void runOnInvriantViolationPlugins(Invariant invariant,
                                 CrawlerContext context)

Run the OnInvariantViolation plugins when an Invariant is violated. Invariant are checked when the state machine is updated that is when the dom is changed after a click on a clickable. When a invariant fails this kind of plugins are executed. Warning the session is not a clone, chaning the session can cause strange behaviour of Crawljax.

Parameters:

invariant - the failed invariants

context - the session to load in the plugin

runPostCrawlingPlugins

public void runPostCrawlingPlugins(CrawlSession session,
                          ExitNotifier.ExitStatus exitReason)

load and run the postCrawlingPlugins. PostCrawlingPlugins are executed after the crawling is finished Warning: changing the session can change the behavior of other post crawl plugins. It is not a clone!

Parameters:

exitReason -

context - the session to load in the plugin

runOnRevisitStatePlugins

public void runOnRevisitStatePlugins(CrawlerContext context,
                            StateVertex currentState)

load and run the onRevisitStateValidator. As a difference to other SessionPlugins this plugin needs an explicit current state because the session.getCurrentState() does not contain the correct current state because we are in back-tracking

Parameters:

context - the session to load in the plugin

currentState - the state the 'back tracking' operation is currently in

runPreStateCrawlingPlugins

public void runPreStateCrawlingPlugins(CrawlerContext context,
                              com.google.common.collect.ImmutableList<CandidateElement> candidateElements,
                              StateVertex state)

load and run the PreStateCrawlingPlugins. Method that is called before the current state is crawled (before firing events on the current DOM state). Example: filter candidate elements. Warning the session and candidateElements are not clones, changes will result in changed behaviour.

Parameters:

session - the crawl session.

candidateElements - the elements which crawljax is about to crawl

state - The state being violated.

runProxyServerPlugins

public void runProxyServerPlugins(ProxyConfiguration config)

Load and run the proxyServerPlugins. proxyServerPlugins are used to Starts the proxy server and provides Crawljax with the correct settings such as port number. Warning the config argument is not a clone, changes will influence the behaviour of the Browser. Changes should be returned as new Object.

Parameters:

config - The ProxyConfiguration to use.

runPreCrawlingPlugins

public void runPreCrawlingPlugins(CrawljaxConfiguration config)

runOnFireEventFailedPlugins

public void runOnFireEventFailedPlugins(CrawlerContext context,
                               Eventable eventable,
                               List<Eventable> path)

Load and run the OnFireEventFailedPlugins, this call has been made from the fireEvent when the event is not fireable. the Path is the Path leading TO this eventable (not included).

Parameters:

eventable - the eventable not able to fire.

path - the path TO this eventable.

runOnBrowserCreatedPlugins

public void runOnBrowserCreatedPlugins(EmbeddedBrowser newBrowser)

Load and run the OnBrowserCreatedPlugins, this call has been made from the browserpool when a new browser has been created and ready to be used by the Crawler. The PreCrawling plugins are executed before these plugins are executed except that the precrawling plugins are only executed on the first created browser.

Parameters:

newBrowser - the new created browser object

runDomChangeNotifierPlugins

public boolean runDomChangeNotifierPlugins(CrawlerContext context,
                                  StateVertex stateBefore,
                                  Eventable event,
                                  StateVertex stateAfter)

Load and run the DomChangeNotifierPlugin.

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

pluginNames

public com.google.common.collect.ImmutableSet<String> pluginNames()

Returns:

A ImmutableSet of the Plugin#toString() that are installed.