Package io.webfolder.cdp.session

Class Session

java.lang.Object

io.webfolder.cdp.session.Session

All Implemented Interfaces:

Constant, Dom, JavaScript, Keyboard, Mouse, Navigator, Selector, AutoCloseable

public class Session
extends Object
implements AutoCloseable, Selector, Keyboard, Mouse, Navigator, JavaScript, Dom

Field Summary

Fields inherited from interface io.webfolder.cdp.session.Constant

BACKSPACE, DOM_PROPERTIES, DOWN_ARROW, EMPTY_ARGS, EMPTY_NODE_ID, ENTER, ESC, LEFT_ARROW, RIGHT_ARROW, SPECIAL_KEYS, TAB, UP_ARROW, WAIT_PERIOD, WAIT_TIMEOUT

Method Summary

Modifier and Type	Method	Description
void	activate()	Activate this browser window
void	addEventListener(EventListener eventListener)	Use Session#getListenerManager()
byte[]	captureScreenshot()	Capture page screenshot.
byte[]	captureScreenshot(boolean hideScrollbar)	Capture page screenshot.
byte[]	captureScreenshot(boolean hideScrollbar, ImageFormat format, Integer quality, Viewport clip, Boolean fromSurface)	Capture page screenshot.
void	close()	Close the this browser window
Session	enableConsoleLog()	Redirects javascript console logs to slf4j
Session	enableDetailLog()	Redirects runtime logs (network, security, storage etc..) to slf4j
Session	enableNetworkLog()	Redirects network logs to slf4j
boolean	equals(Object obj)
String	getBrowserContextId()
Command	getCommand()
Integer	getExecutionContextId()
String	getFrameId()
String	getId()
int	getMajorVersion()
String	getTargetId()
Session	getThis()
int	hashCode()
boolean	isConnected()
Session	navigate(String url)
Session	navigateAndWait(String url, WaitUntil condition)
Session	navigateAndWait(String url, WaitUntil condition, int timeout)
void	onTerminate(TerminateListener terminateListener)
void	removeEventEventListener(EventListener eventListener)	Use Session#getListenerManager()
String	toString()
Session	wait(int timeout)	Causes the current thread to wait until waiting time elapses.
Session	wait(int timeout, boolean log)	Causes the current thread to wait until waiting time elapses.
Session	waitDocumentReady()	waits until document is ready
Session	waitDocumentReady(int timeout)	waits until document is ready
boolean	waitUntil(Predicate<Session> predicate)
boolean	waitUntil(Predicate<Session> predicate, int timeout)
boolean	waitUntil(Predicate<Session> predicate, int timeout, int period)
boolean	waitUntil(Predicate<Session> predicate, int timeout, int period, boolean log)

Methods inherited from interface io.webfolder.cdp.session.Dom

clearOptions, clearOptions, focus, focus, focus, getAttribute, getAttribute, getAttribute, getAttributes, getAttributes, getAttributes, getBoxModel, getBoxModel, getClickablePoint, getClickablePoint, getOptions, getOptions, getOuterHtml, getOuterHtml, getSelectedIndex, getSelectedIndex, getText, getText, getValue, getValue, isChecked, isChecked, isDisabled, isDisabled, scrollIntoViewIfNeeded, scrollIntoViewIfNeeded, selectInputText, selectInputText, setAttribute, setAttribute, setAttribute, setChecked, setChecked, setDisabled, setDisabled, setFiles, setFiles, setSelectedIndex, setSelectedIndex, setSelectedOptions, setSelectedOptions, setValue, setValue

Methods inherited from interface io.webfolder.cdp.session.JavaScript

callFunction, callFunction, callFunction, evaluate, getVariable, setVariable

Methods inherited from interface io.webfolder.cdp.session.Keyboard

sendBackspace, sendDownArrow, sendEnter, sendEsc, sendKeyCode, sendKeys, sendLeftArrow, sendRightArrow, sendTab, sendUpArrow

Methods inherited from interface io.webfolder.cdp.session.Mouse

click, click, move

Methods inherited from interface io.webfolder.cdp.session.Navigator

back, clearCache, clearCookies, forward, getContent, getLocation, getPathname, getQueryString, getTitle, isDomReady, reload, setUserAgent, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.webfolder.cdp.session.Selector

getNodeId, getNodeId, getObjectId, getObjectId, getObjectId, getObjectIds, getObjectIds, getObjectIdWithContext, getProperty, getProperty, getPropertyByObjectId, getPropertyDescriptor, matches, matches, matches, releaseObject, setProperty, setProperty

Method Detail

getId

public String getId()

close

public void close()

Close the this browser window

Specified by:

close in interface AutoCloseable

isConnected

public boolean isConnected()

activate

public void activate()

Activate this browser window

addEventListener

public void addEventListener(EventListener eventListener)

Use Session#getListenerManager()

removeEventEventListener

public void removeEventEventListener(EventListener eventListener)

Use Session#getListenerManager()

waitDocumentReady

public Session waitDocumentReady()

waits until document is ready

Returns:

this

waitDocumentReady

public Session waitDocumentReady(int timeout)

waits until document is ready

Parameters:

timeout - the maximum time to wait in milliseconds

Returns:

this

waitUntil

public boolean waitUntil(Predicate<Session> predicate)

waitUntil

public boolean waitUntil(Predicate<Session> predicate,
                         int timeout)

waitUntil

public boolean waitUntil(Predicate<Session> predicate,
                         int timeout,
                         int period)

waitUntil

public boolean waitUntil(Predicate<Session> predicate,
                         int timeout,
                         int period,
                         boolean log)

navigate

public Session navigate(String url)

navigateAndWait

public Session navigateAndWait(String url,
                               WaitUntil condition)

navigateAndWait

public Session navigateAndWait(String url,
                               WaitUntil condition,
                               int timeout)

enableConsoleLog

public Session enableConsoleLog()

Redirects javascript console logs to slf4j

Returns:

this

enableDetailLog

public Session enableDetailLog()

Redirects runtime logs (network, security, storage etc..) to slf4j

Returns:

this

enableNetworkLog

public Session enableNetworkLog()

Redirects network logs to slf4j

Returns:

this

getThis

public Session getThis()

Specified by:

getThis in interface Dom

Specified by:

getThis in interface JavaScript

Specified by:

getThis in interface Keyboard

Specified by:

getThis in interface Mouse

Specified by:

getThis in interface Navigator

Specified by:

getThis in interface Selector

getFrameId

public String getFrameId()

captureScreenshot

public byte[] captureScreenshot()

Capture page screenshot.

captureScreenshot

public byte[] captureScreenshot(boolean hideScrollbar)

Capture page screenshot.

Parameters:

hideScrollbar - hides the scollbar

captureScreenshot

public byte[] captureScreenshot(boolean hideScrollbar,
                                ImageFormat format,
                                Integer quality,
                                Viewport clip,
                                Boolean fromSurface)

Capture page screenshot.

Parameters:

hideScrollbar - hides the scollbar

format - Image compression format (defaults to png).

quality - Compression quality from range [0..100] (jpeg only).

clip - Capture the screenshot of a given region only.

fromSurface - Capture the screenshot from the surface, rather than the view. Defaults to true.

wait

public Session wait(int timeout)

Causes the current thread to wait until waiting time elapses.

Parameters:

timeout - the maximum time to wait in milliseconds

Returns:

this

Throws:

CdpException - if the session held by another thread at the time of invocation.

wait

public Session wait(int timeout,
                    boolean log)

Causes the current thread to wait until waiting time elapses.

Parameters:

timeout - the maximum time to wait in milliseconds

Returns:

this

Throws:

CdpException - if the session held by another thread at the time of invocation.

onTerminate

public void onTerminate(TerminateListener terminateListener)

getCommand

public Command getCommand()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getMajorVersion

public int getMajorVersion()

getTargetId

public String getTargetId()

getBrowserContextId

public String getBrowserContextId()

getExecutionContextId

public Integer getExecutionContextId()

toString

public String toString()

Overrides:

toString in class Object