org.markysoft.vani.core.locating.page

Class DefaultPageCrawler

java.lang.Object

org.markysoft.vani.core.locating.page.DefaultPageCrawler

All Implemented Interfaces:

PageCrawler

public class DefaultPageCrawler
extends Object
implements PageCrawler

This implementation collects all classes annotated with PageHandler and use its declarations of UrlMapping as applicable url patterns.

Author:

Thomas

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkUtils	linkUtils
protected org.apache.commons.logging.Log	logger
protected PageHandlerFactory	pageHandlerFactory
protected List<PageHandler>	pageHandlers
protected int	pageLoadAjaxSeconds
protected int	pageLoadWaitSeconds
protected Set<String>	urlPatterns
protected VaniContext	vaniContext
protected WaitUtil	waitUtil
protected org.openqa.selenium.WebDriver	webDriver

Constructor Summary

Constructors

Constructor and Description
DefaultPageCrawler()

Method Summary

Modifier and Type	Method and Description
protected void	crawl() This method does the crawling.
protected List<String>	getApplicableUrls() This method look for all urls on current page, which matches the declared url patterns.
protected void	handle(String url) This method opens given url, executes waits and calls all applicable PageHandler.
void	initializeHandlers() This method looks for classes annotated with PageHandler.
protected boolean	isVisited(String url, Set<String> visitedUrls) This method will check whether provided url is in given visitedUrls set.
protected String	removeJSessionId(String url) This method removes the JSESSIONID from provided url.
void	start() This method will crawl all applicable urls with WebDriver resolved by spring context.
void	start(org.openqa.selenium.WebDriver webDriver) This method will crawl all applicable urls with specified WebDriver.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

urlPatterns

protected Set<String> urlPatterns

webDriver

protected org.openqa.selenium.WebDriver webDriver

vaniContext

@Autowired
protected VaniContext vaniContext

pageHandlerFactory

@Autowired
protected PageHandlerFactory pageHandlerFactory

waitUtil

@Autowired
protected WaitUtil waitUtil

linkUtils

@Autowired
protected LinkUtils linkUtils

pageLoadWaitSeconds

@Value(value="${vani.pageCrawler.pageLoadWaitSeconds:1}")
protected int pageLoadWaitSeconds

pageLoadAjaxSeconds

@Value(value="${vani.pageCrawler.pageLoadAjaxSeconds:1}")
protected int pageLoadAjaxSeconds

pageHandlers

protected List<PageHandler> pageHandlers

Constructor Detail

DefaultPageCrawler

public DefaultPageCrawler()

Method Detail

initializeHandlers

@PostConstruct
public void initializeHandlers()

This method looks for classes annotated with PageHandler. The found classes will be instantiated by PageHandlerFactory and the declared url patterns are registered.

start

public void start(org.openqa.selenium.WebDriver webDriver)

Description copied from interface: PageCrawler

This method will crawl all applicable urls with specified WebDriver.

Specified by:

start in interface PageCrawler

start

public void start()

Description copied from interface: PageCrawler

This method will crawl all applicable urls with WebDriver resolved by spring context.

Specified by:

start in interface PageCrawler

crawl

protected void crawl()

This method does the crawling. It collects all applicable urls of current page and open each url. After that the opened page wil be searched for new applicable urls again. If no applicable urls exists, which are not already visited, method will be ended.

handle

protected void handle(String url)

This method opens given url, executes waits and calls all applicable PageHandler.

Parameters:

url -

isVisited

protected boolean isVisited(String url,
                            Set<String> visitedUrls)

This method will check whether provided url is in given visitedUrls set. If specified url contains a jSessionId, it will be remove before checking.

Parameters:

url -

visitedUrls - set of all visited urls

Returns:

true if given visitedUrls contains provided url (without jSessionId), else false

removeJSessionId

protected String removeJSessionId(String url)

This method removes the JSESSIONID from provided url. It checks uppercase and lowercase.

Parameters:

url -

Returns:

returns url without JSESSIONID or provided url if it doesn't contains the marker.

getApplicableUrls

protected List<String> getApplicableUrls()

This method look for all urls on current page, which matches the declared url patterns.

Returns:

returns a list of href-properties of all found matches.