cz.etnetera.seleniumbrowser.listener

Class BrowserListener

java.lang.Object

cz.etnetera.seleniumbrowser.listener.BrowserListener

Direct Known Subclasses:

PageSourceListener, ScreenshotListener

public class BrowserListener
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Browser	browser
protected Set<Class<? extends BrowserEvent>>	disabledEvents
protected Set<Class<? extends BrowserEvent>>	enabledEvents
protected String	label

Constructor Summary

Constructors

Constructor and Description
BrowserListener()

Method Summary

Modifier and Type	Method and Description
void	afterBrowserQuit(AfterBrowserQuitEvent event) Called after Browser.quit().
void	afterChangeValueOf(AfterChangeValueOfEvent event) Called after WebElement.clear(), WebElement.sendKeys(...)}.
void	afterClickOn(AfterClickOnEvent event) Called after WebElement.click().
void	afterFindBy(AfterFindByEvent event) Called after WebDriver.findElement(...), or WebDriver.findElements(...), or WebElement.findElement(...), or WebElement.findElements(...).
void	afterModuleInit(AfterModuleInitEvent event) Called after BrowserElement.init().
void	afterNavigateBack(AfterNavigateBackEvent event) Called after navigate().back().
void	afterNavigateForward(AfterNavigateForwardEvent event) Called after navigate().forward().
void	afterNavigateTo(AfterNavigateToEvent event) Called after get(String url) respectively navigate().to(String url).
void	afterPageInit(AfterPageInitEvent event) Called after Page.init().
void	afterScript(AfterScriptEvent event) Called after RemoteWebDriver.executeScript(java.lang.String, java.lang.Object[]) .
void	beforeBrowserQuit(BeforeBrowserQuitEvent event) Called before Browser.quit().
void	beforeChangeValueOf(BeforeChangeValueOfEvent event) Called before WebElement.clear(), WebElement.sendKeys(...).
void	beforeClickOn(BeforeClickOnEvent event) Called before WebElement.click().
void	beforeDriverConstruct(BeforeDriverConstructEvent event) Called before BrowserConfiguration.getDriver(org.openqa.selenium.remote.DesiredCapabilities).
void	beforeFindBy(BeforeFindByEvent event) Called before WebDriver.findElement(...), or WebDriver.findElements(...), or WebElement.findElement(...), or WebElement.findElements(...).
void	beforeModuleInit(BeforeModuleInitEvent event) Called before BrowserElement.init().
void	beforeNavigateBack(BeforeNavigateBackEvent event) Called before navigate().back().
void	beforeNavigateForward(BeforeNavigateForwardEvent event) Called before navigate().forward().
void	beforeNavigateTo(BeforeNavigateToEvent event) Called before get(String url) respectively navigate().to(String url).
void	beforePageInit(BeforePageInitEvent event) Called before Page.init().
void	beforeScript(BeforeScriptEvent event) Called before RemoteWebDriver.executeScript(java.lang.String, java.lang.Object[])
BrowserListener	disable(Class<? extends BrowserEvent>... events) Disables specific events only.
BrowserListener	enable(Class<? extends BrowserEvent>... events) Enables specific events only.
protected String	generateLabel()
protected String	getListenerFileName(String name)
void	init(Browser browser) Initialize listener.
boolean	isEnabled(BrowserEvent event)
boolean	isEnabled(Class<? extends BrowserEvent> event)
void	onException(OnExceptionEvent event) Called whenever an exception would be thrown.
void	onFileSave(OnFileSaveEvent event) Called on BrowserContext.saveFile(File, String, String) and similar methods.
void	onModuleInitException(OnModuleInitExceptionEvent event) Called whenever an exception would be thrown in BrowserElement.init().
void	onPageInitException(OnPageInitExceptionEvent event) Called whenever an exception would be thrown in Page.init().
void	onReport(OnReportEvent event) Called on BrowserContext.report(String label).
protected void	saveFile(BrowserEvent event, byte[] bytes, String name, String extension) Save bytes into output file with given name and extension.
protected void	saveFile(BrowserEvent event, File file, String name, String extension) Save file into output file with given name and extension.
protected void	saveFile(BrowserEvent event, String content, String name, String extension) Save string content into output file with given name and extension.

Methods inherited from class java.lang.Object

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

Field Detail

browser

protected Browser browser

label

protected String label

enabledEvents

protected Set<Class<? extends BrowserEvent>> enabledEvents

disabledEvents

protected Set<Class<? extends BrowserEvent>> disabledEvents

Constructor Detail

BrowserListener

public BrowserListener()

Method Detail

init

public void init(Browser browser)

Initialize listener. Is called from Browser directly and should not be called manually.

isEnabled

public boolean isEnabled(BrowserEvent event)

isEnabled

public boolean isEnabled(Class<? extends BrowserEvent> event)

enable

public BrowserListener enable(Class<? extends BrowserEvent>... events)

Enables specific events only. It overrides all disabled events.

Parameters:

events - Events to enable

Returns:

This instance

disable

public BrowserListener disable(Class<? extends BrowserEvent>... events)

Disables specific events only. It overrides all enabled events.

Parameters:

events - Events to enable

Returns:

This instance

onReport

public void onReport(OnReportEvent event)

Called on BrowserContext.report(String label).

Parameters:

event -

onFileSave

public void onFileSave(OnFileSaveEvent event)

Called on BrowserContext.saveFile(File, String, String) and similar methods.

Parameters:

event -

beforeDriverConstruct

public void beforeDriverConstruct(BeforeDriverConstructEvent event)

Called before BrowserConfiguration.getDriver(org.openqa.selenium.remote.DesiredCapabilities).

Parameters:

event -

beforePageInit

public void beforePageInit(BeforePageInitEvent event)

Called before Page.init().

Parameters:

event -

onPageInitException

public void onPageInitException(OnPageInitExceptionEvent event)

Called whenever an exception would be thrown in Page.init().

Parameters:

event -

afterPageInit

public void afterPageInit(AfterPageInitEvent event)

Called after Page.init().

Parameters:

event -

beforeModuleInit

public void beforeModuleInit(BeforeModuleInitEvent event)

Called before BrowserElement.init().

Parameters:

event -

onModuleInitException

public void onModuleInitException(OnModuleInitExceptionEvent event)

Called whenever an exception would be thrown in BrowserElement.init().

Parameters:

event -

afterModuleInit

public void afterModuleInit(AfterModuleInitEvent event)

Called after BrowserElement.init().

Parameters:

event -

beforeBrowserQuit

public void beforeBrowserQuit(BeforeBrowserQuitEvent event)

Called before Browser.quit().

Parameters:

event -

afterBrowserQuit

public void afterBrowserQuit(AfterBrowserQuitEvent event)

Called after Browser.quit().

Parameters:

event -

beforeNavigateTo

public void beforeNavigateTo(BeforeNavigateToEvent event)

Called before get(String url) respectively navigate().to(String url).

Parameters:

event -

afterNavigateTo

public void afterNavigateTo(AfterNavigateToEvent event)

Called after get(String url) respectively navigate().to(String url). Not called, if an exception is thrown.

Parameters:

event -

beforeNavigateBack

public void beforeNavigateBack(BeforeNavigateBackEvent event)

Called before navigate().back().

Parameters:

event -

afterNavigateBack

public void afterNavigateBack(AfterNavigateBackEvent event)

Called after navigate().back(). Not called, if an exception is thrown.

Parameters:

event -

beforeNavigateForward

public void beforeNavigateForward(BeforeNavigateForwardEvent event)

Called before navigate().forward().

Parameters:

event -

afterNavigateForward

public void afterNavigateForward(AfterNavigateForwardEvent event)

Called after navigate().forward(). Not called, if an exception is thrown.

Parameters:

event -

beforeFindBy

public void beforeFindBy(BeforeFindByEvent event)

Called before WebDriver.findElement(...), or WebDriver.findElements(...), or WebElement.findElement(...), or WebElement.findElements(...).

Parameters:

event -

afterFindBy

public void afterFindBy(AfterFindByEvent event)

Called after WebDriver.findElement(...), or WebDriver.findElements(...), or WebElement.findElement(...), or WebElement.findElements(...).

Parameters:

event -

beforeClickOn

public void beforeClickOn(BeforeClickOnEvent event)

Called before WebElement.click().

Parameters:

event -

afterClickOn

public void afterClickOn(AfterClickOnEvent event)

Called after WebElement.click(). Not called, if an exception is thrown.

Parameters:

event -

beforeChangeValueOf

public void beforeChangeValueOf(BeforeChangeValueOfEvent event)

Called before WebElement.clear(), WebElement.sendKeys(...).

Parameters:

event -

afterChangeValueOf

public void afterChangeValueOf(AfterChangeValueOfEvent event)

Called after WebElement.clear(), WebElement.sendKeys(...)}. Not called, if an exception is thrown.

Parameters:

event -

beforeScript

public void beforeScript(BeforeScriptEvent event)

Called before RemoteWebDriver.executeScript(java.lang.String, java.lang.Object[])

Parameters:

event -

afterScript

public void afterScript(AfterScriptEvent event)

Called after RemoteWebDriver.executeScript(java.lang.String, java.lang.Object[]) . Not called if an exception is thrown

Parameters:

event -

onException

public void onException(OnExceptionEvent event)

Called whenever an exception would be thrown.

Parameters:

event -

saveFile

protected void saveFile(BrowserEvent event,
                        String content,
                        String name,
                        String extension)

Save string content into output file with given name and extension.

Parameters:

event -

content -

name -

extension -

saveFile

protected void saveFile(BrowserEvent event,
                        byte[] bytes,
                        String name,
                        String extension)

Save bytes into output file with given name and extension.

Parameters:

event -

bytes -

name -

extension -

saveFile

protected void saveFile(BrowserEvent event,
                        File file,
                        String name,
                        String extension)

Save file into output file with given name and extension.

Parameters:

event -

file -

name -

extension -

getListenerFileName

protected String getListenerFileName(String name)

generateLabel

protected String generateLabel()