com.jniwrapper.win32.ie
Class HeadlessBrowser

java.lang.Object
  com.jniwrapper.win32.ie.HeadlessBrowser

All Implemented Interfaces:

ParentWindow, SingleThreadedComponent, WebBrowser

Direct Known Subclasses:

IEAutomation

public class HeadlessBrowser

extends java.lang.Object

implements WebBrowser

This class is the windowless implementation of WebBrowser iterface, specially designed for such operations that do not require a Java component.

Nested Class Summary

static class

HeadlessBrowser.ComServerParameters

Nested classes inherited from class com.jniwrapper.win32.ie.WebBrowser

WebBrowser.Properties

Constructor Summary

HeadlessBrowser()
Creates Internet Explorer wrapper for automated testing.

HeadlessBrowser(HeadlessBrowser.ComServerParameters parameters)
Creates Internet Explorer wrapper for automated testing.

HeadlessBrowser(HeadlessBrowser.ComServerParameters parameters, com.jniwrapper.win32.automation.OleMessageLoop oleMessageLoop)
Creates Internet Explorer wrapper for automated testing.

HeadlessBrowser(HeadlessBrowser.ComServerParameters parameters, com.jniwrapper.win32.automation.OleMessageLoop oleMessageLoop, java.lang.String pathKey)
Creates Internet Explorer wrapper for automated testing.

Method Summary

void	addBrowserWindowListener(BrowserWindowListener listener) Adds window listener.
void	addNavigationListener(NavigationEventListener listener) Adds browser navigation event listener.
void	addNewWindowListener(NewWindowEventListener listener) Adds new window listener.
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Adds a new property change listener.
void	addStatusListener(StatusEventListener listener) Adds browser status event listener.
void	close() Closes browser instance.
static HeadlessBrowser	createLightweightBrowser() Creates browser without event listening that uses InternetExplorer component.
void	execute(BrowserCommand command) Executes specified command.
java.lang.Object	executeScript(java.lang.String javaScript) Executes specified JavaScript code in a currently opened document.
void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
AuthenticateHandler	getAuthenticateHandler() Returns browser authenticate handler.
java.lang.Object	getBrowserPeer() Returns an instance of the native web browser peer.
BrowserWindowListener[]	getBrowserWindowListeners() Returns an array of window listeners.
java.lang.String	getContent() Returns the HTML content of a document, opened in a browser.
java.util.Set	getCookies(java.lang.String url) Returns cookies, that are associated with the specified URL.
DialogEventHandler	getDialogEventHandler() Gets dialog event handler.
HTMLDocument	getDocument() Returns DOM document for page loaded into the browser.
WebBrowserEventsHandler	getEventHandler() Returns browser event handler.
KeyFilter	getKeyFilter() Returns key filter.
java.lang.String	getLocationURL() Returns the URL of the resource that Internet Explorer is currently displaying.
java.util.List	getNavigationListeners() Returns browser navigation event listeners.
NewWindowEventHandler	getNewWindowHandler() Returns new window handler.
java.util.List	getNewWindowListeners() Returns new window listeners.
com.jniwrapper.win32.automation.OleMessageLoop	getOleMessageLoop() Return browser OLE message loop.
WebBrowser	getParentBrowser() Returns the parent of the browser.
WebBrowser.Properties	getProperties() Returns extended browser properties.
ReadyState	getReadyState() Returns the current ReadyState of the browser.
WebBrowser	getRecentChild() Returns recent created child object since last trackChildren() method call.
java.awt.Image	getScreenShot(boolean wholePage)
ScriptErrorListener	getScriptErrorListener() Returns script error listener for current page.
java.util.List	getStatusListeners() Returns browser status event listeners.
java.lang.String	getStatusText() Returns the status text of the browser.
void	goBack() Navigates backward one item in the history list.
void	goForward() Navigates forward one item in the history list.
void	goHome() Navigates to the home page.
boolean	isSilent() Return true if alert, confirmation and error dialogs are disabled else returns false.
void	navigate(java.lang.String location) Navigates to a resource specified by a URL or to the file identified by a full path.
void	navigate(java.lang.String location, java.lang.String postData) Navigates to a resource specified by a HTTP URL.
void	navigate(java.lang.String location, java.lang.String targetName, java.lang.String postData) Navigates the browser to a location that might not be able to be expressed as a URL, such as a pointer to an item identifier list (PIDL) for an entity in the Microsoft Windows shell namespace.
void	refresh() Reloads the file that is currently displayed in the object.
void	removeBrowserWindowListener(BrowserWindowListener listener) Removes window listener.
void	removeNavigationListener(NavigationEventListener listener) Removes browser navigation event listener.
void	removeNewWindowListener(NewWindowEventListener listener) Removes new window listener.
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Removes a specified property change listener.
void	removeStatusListener(StatusEventListener listener) Removes browser status event listener.
void	setAuthenticateHandler(AuthenticateHandler handler) Sets browser authenticate handler.
void	setContent(java.lang.String htmlContent) Sets new HTML content.
void	setCookie(java.lang.String url, Cookie cookie) Creates a new cookie for the specified URL using WinINet API.
void	setDialogEventHandler(DialogEventHandler handler) Sets dialog event handler.
void	setEventHandler(WebBrowserEventsHandler handler) Sets browser event handler.
void	setKeyFilter(KeyFilter keyFilter) Sets key filter.
void	setNewWindowHandler(NewWindowEventHandler newWindowHandler) Sets new window handler.
void	setParentBrowser(WebBrowser webBrowser) Sets the parent of the browser.
void	setScriptErrorListener(ScriptErrorListener listener) Setups javascript error listener for current page.
void	setSilent(boolean isSilent) Disables or enables alert, confirmation and error dialogs.
void	stop() Cancels any pending navigation or download operation and stops any dynamic page elements, such as background sounds and animations.
void	trackChildren() Starts to collect information about child object creation.
WebBrowser	waitChildCreation() Blocks execution until child is created since last trackChildren() call and returns this child.
WebBrowser	waitChildCreation(java.lang.Runnable operationThatCreatesChild) Executes operation specified in the parameter and returns when child created by the operation is opened.
void	waitReady() Causes a current thread to wait for the completion of the current operation in the browser.
void	waitReady(long timeout) Causes a current thread to wait for the completion of a current operation in the browser for a specified amount of milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeadlessBrowser

public HeadlessBrowser()

Creates Internet Explorer wrapper for automated testing.

HeadlessBrowser

public HeadlessBrowser(HeadlessBrowser.ComServerParameters parameters)

Creates Internet Explorer wrapper for automated testing.

HeadlessBrowser

public HeadlessBrowser(HeadlessBrowser.ComServerParameters parameters,
                       com.jniwrapper.win32.automation.OleMessageLoop oleMessageLoop)

Creates Internet Explorer wrapper for automated testing.

Parameters:

oleMessageLoop - the browser will be created in this message loop. May be null

HeadlessBrowser

public HeadlessBrowser(HeadlessBrowser.ComServerParameters parameters,
                       com.jniwrapper.win32.automation.OleMessageLoop oleMessageLoop,
                       java.lang.String pathKey)

Creates Internet Explorer wrapper for automated testing.

Parameters:

oleMessageLoop - oleMessageLoop the browser will be created in this message loop. May be null

pathKey - the registry subkey string where the host stores its registry settings

Method Detail

getStatusText

public java.lang.String getStatusText()

Returns the status text of the browser.

Specified by:

getStatusText in interface WebBrowser

Returns:

the status text of the browser.

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

Adds a new property change listener. The available property names are presented in the WebBrowser.Properties class.

Specified by:

addPropertyChangeListener in interface WebBrowser

Parameters:

propertyName - property name.

listener - listener instance.

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

Removes a specified property change listener. The available property names are represented in the WebBrowser.Properties class.

Specified by:

removePropertyChangeListener in interface WebBrowser

Parameters:

propertyName - property name.

listener - listener instance.

getDocument

public HTMLDocument getDocument()

Returns DOM document for page loaded into the browser.

Specified by:

getDocument in interface WebBrowser

Returns:

DOM document

Throws:

java.lang.IllegalStateException - if WebBrowser.waitReady() method isn't called after last call of WebBrowser.navigate() or WebBrowser.setContent() methods.

See Also:

WebBrowser.waitReady(), WebBrowser.navigate(String), WebBrowser.setContent(String)

getParentBrowser

public WebBrowser getParentBrowser()

Description copied from interface: WebBrowser

Returns the parent of the browser.

Specified by:

getParentBrowser in interface WebBrowser

Returns:

the parent of the browser or null if the browser not has the parent.

setParentBrowser

public void setParentBrowser(WebBrowser webBrowser)

Description copied from interface: WebBrowser

Sets the parent of the browser.

Specified by:

setParentBrowser in interface WebBrowser

Parameters:

webBrowser - the parent of the browser.

setContent

public void setContent(java.lang.String htmlContent)

Sets new HTML content.

Specified by:

setContent in interface WebBrowser

Parameters:

htmlContent - HTML content to set.

getContent

public java.lang.String getContent()

Returns the HTML content of a document, opened in a browser.

Specified by:

getContent in interface WebBrowser

Returns:

the HTML content of a document, opened in a browser.

navigate

public void navigate(java.lang.String location)

Navigates to a resource specified by a URL or to the file identified by a full path.

Specified by:

navigate in interface WebBrowser

Parameters:

location - URL to navigate to.

navigate

public void navigate(java.lang.String location,
                     java.lang.String postData)

Navigates to a resource specified by a HTTP URL.

Specified by:

navigate in interface WebBrowser

Parameters:

location - URL to navigate to.

postData - HTTP post data (for example, "name=Alex&product=Pizza")

navigate

public void navigate(java.lang.String location,
                     java.lang.String targetName,
                     java.lang.String postData)

Navigates the browser to a location that might not be able to be expressed as a URL, such as a pointer to an item identifier list (PIDL) for an entity in the Microsoft Windows shell namespace.

Specified by:

navigate in interface WebBrowser

Parameters:

location - URL to navigate to.

targetName - string that contains the name of the frame in which to display the resource.

postData - HTTP post data (for example, "name=Alex&product=Pizza").

getLocationURL

public java.lang.String getLocationURL()

Returns the URL of the resource that Internet Explorer is currently displaying.

Specified by:

getLocationURL in interface WebBrowser

Returns:

location URL

goForward

public void goForward()

Navigates forward one item in the history list.

Specified by:

goForward in interface WebBrowser

goBack

public void goBack()

Navigates backward one item in the history list.

Specified by:

goBack in interface WebBrowser

goHome

public void goHome()

Navigates to the home page.

Specified by:

goHome in interface WebBrowser

stop

public void stop()

Cancels any pending navigation or download operation and stops any dynamic page elements, such as background sounds and animations.

Specified by:

stop in interface WebBrowser

refresh

public void refresh()

Reloads the file that is currently displayed in the object.

Specified by:

refresh in interface WebBrowser

execute

public void execute(BrowserCommand command)

Executes specified command.

Specified by:

execute in interface WebBrowser

Parameters:

command - browser command.

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)

getReadyState

public ReadyState getReadyState()

Returns the current ReadyState of the browser.

Specified by:

getReadyState in interface WebBrowser

Returns:

the current state of the browser.

executeScript

public java.lang.Object executeScript(java.lang.String javaScript)

Executes specified JavaScript code in a currently opened document.

Specified by:

executeScript in interface WebBrowser

Parameters:

javaScript - JavaScript to execute.

Returns:

the result of JavaScript execution, if any.

getBrowserPeer

public java.lang.Object getBrowserPeer()

Returns an instance of the native web browser peer.

Specified by:

getBrowserPeer in interface WebBrowser

Returns:

native peer object.

Throws:

java.lang.IllegalStateException - if the passed browser does not have a native peer.

waitReady

public void waitReady()

Causes a current thread to wait for the completion of the current operation in the browser.

Important: successful call of this method guaranties that you can get DOM document of loaded page. Please see typical usage of this method in the code below:

     // navigate to Google page
     browser.navigate("google.com");
 

     // wait until page completely loaded
     browser.waitReady();
 

     // DOM document is available
     Document document = browser.getDocument();
 

If you miss WebBrowser.waitReady() call after navigation call then IllegalStateException is thrown in WebBrowser.getDocument() call.

Specified by:

waitReady in interface WebBrowser

See Also:

WebBrowser.navigate(String), WebBrowser.setContent(String), WebBrowser.getDocument()

waitReady

public void waitReady(long timeout)

Causes a current thread to wait for the completion of a current operation in the browser for a specified amount of milliseconds.

Specified by:

waitReady in interface WebBrowser

Parameters:

timeout - the number of milliseconds to wait.

addNavigationListener

public void addNavigationListener(NavigationEventListener listener)

Adds browser navigation event listener.

Specified by:

addNavigationListener in interface WebBrowser

Parameters:

listener - browser event listener.

addStatusListener

public void addStatusListener(StatusEventListener listener)

Adds browser status event listener.

Specified by:

addStatusListener in interface WebBrowser

Parameters:

listener - browser event listener.

getNavigationListeners

public java.util.List getNavigationListeners()

Returns browser navigation event listeners.

Specified by:

getNavigationListeners in interface WebBrowser

Returns:

list of browser event listeners

getStatusListeners

public java.util.List getStatusListeners()

Returns browser status event listeners.

Specified by:

getStatusListeners in interface WebBrowser

Returns:

list of browser event listeners

removeNavigationListener

public void removeNavigationListener(NavigationEventListener listener)

Removes browser navigation event listener.

Specified by:

removeNavigationListener in interface WebBrowser

Parameters:

listener - browser event listener.

removeStatusListener

public void removeStatusListener(StatusEventListener listener)

Removes browser status event listener.

Specified by:

removeStatusListener in interface WebBrowser

Parameters:

listener - browser event listener.

getEventHandler

public WebBrowserEventsHandler getEventHandler()

Returns browser event handler.

Specified by:

getEventHandler in interface WebBrowser

Returns:

browser event handler

setAuthenticateHandler

public void setAuthenticateHandler(AuthenticateHandler handler)

Sets browser authenticate handler.

Specified by:

setAuthenticateHandler in interface WebBrowser

Parameters:

handler - authenticate handler

getAuthenticateHandler

public AuthenticateHandler getAuthenticateHandler()

Returns browser authenticate handler.

Specified by:

getAuthenticateHandler in interface WebBrowser

Returns:

browser authenticate handler

setEventHandler

public void setEventHandler(WebBrowserEventsHandler handler)

Sets browser event handler.

Specified by:

setEventHandler in interface WebBrowser

Parameters:

handler - event handler

setScriptErrorListener

public void setScriptErrorListener(ScriptErrorListener listener)

Setups javascript error listener for current page.

Specified by:

setScriptErrorListener in interface WebBrowser

Parameters:

listener - javascript error listener

getScriptErrorListener

public ScriptErrorListener getScriptErrorListener()

Returns script error listener for current page.

Specified by:

getScriptErrorListener in interface WebBrowser

Returns:

script error listener

close

public void close()

Closes browser instance.

Note: Prior to 1.4, the non-daemon helper threads were never terminated. Starting with 1.4, the behavior has changed as a result of the fix for 4030718. With the current implementation, AWT terminates all its helper threads allowing the application to exit cleanly when the following three conditions are true:

• There are no displayable AWT or Swing components.
• There are no native events in the native event queue.
• There are no AWT events in java EventQueues.

The JExplorer's headless mode uses the Swing component like JWindow to hold an application durings its execution. To exit cleanly without calling System.exit you must to call this method for each instance in your application.

Specified by:

close in interface WebBrowser

setSilent

public void setSilent(boolean isSilent)

Disables or enables alert, confirmation and error dialogs.

Specified by:

setSilent in interface WebBrowser

Parameters:

isSilent - if true then enter to silent mode else leave silent mode.

isSilent

public boolean isSilent()

Return true if alert, confirmation and error dialogs are disabled else returns false.

Specified by:

isSilent in interface WebBrowser

Returns:

true if in silent mode else returns false.

getOleMessageLoop

public com.jniwrapper.win32.automation.OleMessageLoop getOleMessageLoop()

Return browser OLE message loop.

Specified by:

getOleMessageLoop in interface SingleThreadedComponent

Returns:

browser OLE message loop.

getDialogEventHandler

public DialogEventHandler getDialogEventHandler()

Gets dialog event handler.

Specified by:

getDialogEventHandler in interface WebBrowser

Returns:

dialog event handler

setDialogEventHandler

public void setDialogEventHandler(DialogEventHandler handler)

Sets dialog event handler.

Specified by:

setDialogEventHandler in interface WebBrowser

Parameters:

handler - dialog event handler

setNewWindowHandler

public void setNewWindowHandler(NewWindowEventHandler newWindowHandler)

Sets new window handler.

Specified by:

setNewWindowHandler in interface WebBrowser

Parameters:

newWindowHandler - new window handler

getNewWindowHandler

public NewWindowEventHandler getNewWindowHandler()

Returns new window handler.

Specified by:

getNewWindowHandler in interface WebBrowser

Returns:

new window handler

addNewWindowListener

public void addNewWindowListener(NewWindowEventListener listener)

Adds new window listener.

Specified by:

addNewWindowListener in interface WebBrowser

Parameters:

listener - new window listener

removeNewWindowListener

public void removeNewWindowListener(NewWindowEventListener listener)

Removes new window listener.

Specified by:

removeNewWindowListener in interface WebBrowser

Parameters:

listener - new window listener

getNewWindowListeners

public java.util.List getNewWindowListeners()

Returns new window listeners.

Specified by:

getNewWindowListeners in interface WebBrowser

Returns:

new window listeners

trackChildren

public void trackChildren()

Description copied from interface: ParentWindow

Starts to collect information about child object creation.

Specified by:

trackChildren in interface ParentWindow

getRecentChild

public WebBrowser getRecentChild()

Description copied from interface: ParentWindow

Returns recent created child object since last trackChildren() method call.

Specified by:

getRecentChild in interface ParentWindow

Returns:

recent opened child window after the last trackChildren() method call. If there isn't opened windows after this call then returns null.

waitChildCreation

public WebBrowser waitChildCreation()

Description copied from interface: ParentWindow

Blocks execution until child is created since last trackChildren() call and returns this child.

In other words, this method waits until getRecentChild() call returns non-null object.

Specified by:

waitChildCreation in interface ParentWindow

Returns:

recent created child

waitChildCreation

public WebBrowser waitChildCreation(java.lang.Runnable operationThatCreatesChild)

Description copied from interface: ParentWindow

Executes operation specified in the parameter and returns when child created by the operation is opened.

Specified by:

waitChildCreation in interface ParentWindow

Parameters:

operationThatCreatesChild - operation

Returns:

child created by the operation

setKeyFilter

public void setKeyFilter(KeyFilter keyFilter)

Description copied from interface: WebBrowser

Sets key filter.

Specified by:

setKeyFilter in interface WebBrowser

Parameters:

keyFilter - key filter

getKeyFilter

public KeyFilter getKeyFilter()

Description copied from interface: WebBrowser

Returns key filter.

Specified by:

getKeyFilter in interface WebBrowser

Returns:

key filter

setCookie

public void setCookie(java.lang.String url,
                      Cookie cookie)

Creates a new cookie for the specified URL using WinINet API. This is an analogue of the InternetSetCookie native function.

Specified by:

setCookie in interface WebBrowser

Parameters:

url - specifies an URL, a new cookie will be associated with.

cookie - specifies a new cookie.

getCookies

public java.util.Set getCookies(java.lang.String url)

Returns cookies, that are associated with the specified URL. This is an analogue of the InternetGetCookie native function.

Specified by:

getCookies in interface WebBrowser

Parameters:

url - specifies an URL.

Returns:

cookies, that are associated with the specified URL.

createLightweightBrowser

public static HeadlessBrowser createLightweightBrowser()

Creates browser without event listening that uses InternetExplorer component.

Returns:

web browser wrapper

getProperties

public WebBrowser.Properties getProperties()

Description copied from interface: WebBrowser

Returns extended browser properties.

Specified by:

getProperties in interface WebBrowser

Returns:

extended browser properties.

addBrowserWindowListener

public void addBrowserWindowListener(BrowserWindowListener listener)

Description copied from interface: WebBrowser

Adds window listener.

Specified by:

addBrowserWindowListener in interface WebBrowser

Parameters:

listener - the window listener

removeBrowserWindowListener

public void removeBrowserWindowListener(BrowserWindowListener listener)

Description copied from interface: WebBrowser

Removes window listener.

Specified by:

removeBrowserWindowListener in interface WebBrowser

Parameters:

listener - the window listener

getBrowserWindowListeners

public BrowserWindowListener[] getBrowserWindowListeners()

Description copied from interface: WebBrowser

Returns an array of window listeners.

Specified by:

getBrowserWindowListeners in interface WebBrowser

Returns:

an array of window listeners

getScreenShot

public java.awt.Image getScreenShot(boolean wholePage)