com.gargoylesoftware.htmlunit
Class WebClient

java.lang.Object
  com.gargoylesoftware.htmlunit.WebClient

All Implemented Interfaces:

java.io.Serializable

public class WebClient
extends java.lang.Object
implements java.io.Serializable

An object that represents a web browser

Version:

$Revision: 1.3 $

Author:

Mike Bowler, Mike J. Bresnahan, Dominique Broeglin, Noboru Sinohara, Chen Jun, David K. Taylor, Christian Sell, Ben Curren, Marc Guillemot, Chris Erskine, Daniel Gredler, Sergey Gorelkin, Hans Donner, Paul King, Ahmed Ashour

See Also:

Serialized Form

Field Summary

static java.net.URL

URL_ABOUT_BLANK URL for "about:blank"

Constructor Summary

WebClient()
Creates a web client instance using the browser version returned by BrowserVersion.getDefault().

WebClient(BrowserVersion browserVersion)
Creates a web client instance using the specified BrowserVersion.

WebClient(BrowserVersion browserVersion, java.lang.String proxyHost, int proxyPort)
Create an instance that will use the specified BrowserVersion and proxy server

Method Summary

void	addHostsToProxyBypass(java.lang.String pattern) Any hosts matched by the specified regular expression pattern will bypass the configured proxy.
void	addRequestHeader(java.lang.String name, java.lang.String value) Set a header which will be sent up on EVERY request from this client.
void	addWebWindowListener(WebWindowListener listener) Add a listener for WebWindowEvent's.
void	assertionFailed(java.lang.String message) Throw an exception with the specified message.
void	deregisterWebWindow(WebWindow webWindow) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
static java.net.URL	expandUrl(java.net.URL baseUrl, java.lang.String relativeUrl) Expands a relative url relative to the specified base.
java.util.Map	getActiveXObjectMap() Return the active X object map for this webclient.
AjaxController	getAjaxController() Gets the current Ajax controller
AlertHandler	getAlertHandler() Return the alert handler for this webclient.
BrowserVersion	getBrowserVersion() Return the current browser version
ConfirmHandler	getConfirmHandler() Return the confirm handler.
org.apache.commons.httpclient.auth.CredentialsProvider	getCredentialsProvider() Returns the credentials provider for this client instance.
WebWindow	getCurrentWindow() Return the "current" window for this client.
java.lang.String	getHomePage() Returns the client's current homepage.
HTMLParserListener	getHTMLParserListener() Gets the configured listener for messages generated by the html parser.
static boolean	getIgnoreOutsideContent() Get the state of the flag to ignore content outside the BODY and HTML tags
IncorrectnessListener	getIncorrectnessListener() Gets the current listener for encountered incorrectness (except HTML parsing messages that are handled by the HTML parser listener).
Page	getPage(java.lang.String url) Convenient method to build an URL and load it into the current WebWindow
Page	getPage(java.net.URL url) Convenient method to load a URL into the current WebWindow
Page	getPage(WebRequestSettings request) Convenient method to load a web request into the current WebWindow
Page	getPage(WebWindow opener, java.lang.String target, WebRequestSettings params) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Page	getPage(WebWindow webWindow, WebRequestSettings parameters) Send a request to a server and return a Page that represents the response from the server.
PageCreator	getPageCreator() Return the current page creator.
boolean	getPrintContentOnFailingStatusCode() Return true if the content of the resulting document will be printed to the console in the event of a failing response code.
PromptHandler	getPromptHandler() Return the prompt handler.
RefreshHandler	getRefreshHandler() Return the current refresh handler or null if one has not been set.
ScriptEngine	getScriptEngine() This method is intended for testing only - use at your own risk.
ScriptPreProcessor	getScriptPreProcessor() Return the script pre processor for this webclient.
StatusHandler	getStatusHandler() Return the status handler for this webclient.
int	getTimeout() Gets the timeout value for the WebConnection
WebConnection	getWebConnection() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
WebWindow	getWebWindowByName(java.lang.String name) Return the first WebWindow that matches the specified name.
java.util.List	getWebWindows() Return an immutable list of open web windows (top windows or not).
java.lang.String	guessContentType(java.io.File file) Tries to guess the content type of the file.
void	initialize(Page newPage) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
void	initialize(WebWindow webWindow) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
void	initializeEmptyWindow(WebWindow webWindow) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
boolean	isCookiesEnabled() Return true if cookies are enabled.
boolean	isJavaScriptEnabled() Return true if javascript is enabled and the script engine was loaded successfully.
boolean	isRedirectEnabled() Return whether or not redirections will be followed automatically on receipt of a redirect status code from the server.
boolean	isThrowExceptionOnFailingStatusCode() Return true if an exception will be thrown in the event of a failing response code.
boolean	isThrowExceptionOnScriptError() Indicates if an exception should be thrown when a script execution fails (the default) or if it should be caught and just logged to allow page execution to continue.
WebResponse	loadWebResponse(WebRequestSettings webRequestSettings) Loads a WebResponse from the server
Page	loadWebResponseInto(WebResponse webResponse, WebWindow webWindow) Use the specified WebResponse to create a Page object which will then get inserted into the WebWindow.
WebWindow	openWindow(java.net.URL url, java.lang.String windowName) Open a new window with the specified name.
WebWindow	openWindow(java.net.URL url, java.lang.String windowName, WebWindow opener) Open a new window with the specified name.
WebWindow	popFirstWindow() Return the "first" window for this client.
void	pushClearFirstWindow() Clear the first window for this client.
void	registerWebWindow(WebWindow webWindow) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
void	removeHostsFromProxyBypass(java.lang.String pattern) Any hosts matched by the specified regular expression pattern will no longer bypass the configured proxy.
void	removeRequestHeader(java.lang.String name) Remove a header
void	removeWebWindowListener(WebWindowListener listener) Remove a listener for WebWindowEvent's.
void	setActiveXObjectMap(java.util.Map activeXObjectMap) Set the active X object map for this webclient.
void	setAjaxController(AjaxController newValue) Sets the current Ajax controller EXPERIMENTAL - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
void	setAlertHandler(AlertHandler alertHandler) Set the alert handler for this webclient.
void	setConfirmHandler(ConfirmHandler handler) Set the handler that will be executed when the javascript method Window.confirm() is called.
void	setCookiesEnabled(boolean isEnabled) Enable/disable cookies support.
void	setCredentialsProvider(org.apache.commons.httpclient.auth.CredentialsProvider credentialsProvider) Sets the credentials provider that will provide authentication information when trying to access protected information on a web server.
void	setCurrentWindow(WebWindow window) Set the current window for this client.
void	setHomePage(java.lang.String homePage) Sets the client's homepage.
void	setHTMLParserListener(HTMLParserListener listener) Defines a listener for messages generated by the html parser.
static void	setIgnoreOutsideContent(boolean ignoreOutsideContent) Set the flag on the HtmlParse to ignore the content that is outside of the BODY and HTML tags.
void	setIncorrectnessListener(IncorrectnessListener listener) Returns the current HTML incorrectness listener.
void	setJavaScriptEnabled(boolean isEnabled) Enable/disable javascript support.
void	setPageCreator(PageCreator pageCreator) Set the object that will be used to create pages.
void	setPrintContentOnFailingStatusCode(boolean enabled) Specify whether or not the content of the resulting document will be printed to the console in the event of a failing response code.
void	setPromptHandler(PromptHandler handler) Set the handler that will be executed when the javascript method Window.prompt() is called.
void	setRedirectEnabled(boolean enabled) Set whether or not redirections will be followed automatically on receipt of a redirect status code from the server.
void	setRefreshHandler(RefreshHandler handler) Set the handler to be used whenever a refresh is triggered.
void	setScriptEngine(ScriptEngine engine) This method is intended for testing only - use at your own risk.
void	setScriptPreProcessor(ScriptPreProcessor scriptPreProcessor) Set the script pre processor for this webclient.
void	setStatusHandler(StatusHandler statusHandler) Set the status handler for this webclient.
void	setThrowExceptionOnFailingStatusCode(boolean enabled) Specify whether or not an exception will be thrown in the event of a failing status code.
void	setThrowExceptionOnScriptError(boolean newValue) Changes the behavior of this webclient when a script error occurs.
void	setTimeout(int timeout) Sets the timeout of the WebConnection.
void	setWebConnection(WebConnection webConnection) Set the object that will resolve all url requests This method is intended for unit testing HtmlUnit itself.

Methods inherited from class java.lang.Object

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

Field Detail

URL_ABOUT_BLANK

public static final java.net.URL URL_ABOUT_BLANK

URL for "about:blank"

Constructor Detail

WebClient

public WebClient()

Creates a web client instance using the browser version returned by BrowserVersion.getDefault().

WebClient

public WebClient(BrowserVersion browserVersion)

Creates a web client instance using the specified BrowserVersion.

Parameters:

browserVersion - The browser version to simulate.

WebClient

public WebClient(BrowserVersion browserVersion,
                 java.lang.String proxyHost,
                 int proxyPort)

Create an instance that will use the specified BrowserVersion and proxy server

Parameters:

browserVersion - The browser version to simulate

proxyHost - The server that will act as proxy

proxyPort - The port to use on the proxy server

Method Detail

addHostsToProxyBypass

public void addHostsToProxyBypass(java.lang.String pattern)

Any hosts matched by the specified regular expression pattern will bypass the configured proxy.

Parameters:

pattern - A regular expression pattern that matches the hostnames of the hosts which should bypass the configured proxy.

See Also:

Pattern

addRequestHeader

public void addRequestHeader(java.lang.String name,
                             java.lang.String value)

Set a header which will be sent up on EVERY request from this client.

Parameters:

name - The name of the header

value - The value of the header

addWebWindowListener

public void addWebWindowListener(WebWindowListener listener)

Add a listener for WebWindowEvent's. All events from all windows associated with this client will be sent to the specified listener.

Parameters:

listener - A listener.

assertionFailed

public void assertionFailed(java.lang.String message)

Throw an exception with the specified message. If junit is found in the classpath then a junit.framework.AssertionFailedError will be thrown (the same behaviour as calling fail() in junit). If junit is not found then an IllegalStateException will be thrown instead of the AssertionFailedError.

Override this to provide custom behaviour.

Parameters:

message - The failure message

deregisterWebWindow

public void deregisterWebWindow(WebWindow webWindow)

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Remove a web window from the list of available windows.

Parameters:

webWindow - The WebWindow to remove

expandUrl

public static java.net.URL expandUrl(java.net.URL baseUrl,
                                     java.lang.String relativeUrl)
                              throws java.net.MalformedURLException

Expands a relative url relative to the specified base. In most situations this is the same as new URL(baseUrl, relativeUrl) but there are some cases that URL doesn't handle correctly. See RFC1808 regarding Relative Uniform Resource Locators for more information.

Parameters:

baseUrl - The base url

relativeUrl - The relative url

Returns:

See above

Throws:

java.net.MalformedURLException - If an error occurred when creating a URL object

getActiveXObjectMap

public java.util.Map getActiveXObjectMap()

Return the active X object map for this webclient.

Returns:

the active X object map.

getAjaxController

public AjaxController getAjaxController()

Gets the current Ajax controller

Returns:

the controller

getAlertHandler

public AlertHandler getAlertHandler()

Return the alert handler for this webclient.

Returns:

the alert handler or null if one hasn't been set.

getBrowserVersion

public BrowserVersion getBrowserVersion()

Return the current browser version

Returns:

the current browser version.

getConfirmHandler

public ConfirmHandler getConfirmHandler()

Return the confirm handler.

Returns:

the confirm handler or null if one hasn't been set.

getCredentialsProvider

public org.apache.commons.httpclient.auth.CredentialsProvider getCredentialsProvider()

Returns the credentials provider for this client instance. By default, this method returns an instance of DefaultCredentialsProvider.

Returns:

The credentials provider for this client instance.

getCurrentWindow

public WebWindow getCurrentWindow()

Return the "current" window for this client. This is the window that will be used when getPage() is called without specifying a window.

Returns:

The current window.

getHomePage

public java.lang.String getHomePage()

Returns the client's current homepage.

Returns:

the client's current homepage.

getHTMLParserListener

public HTMLParserListener getHTMLParserListener()

Gets the configured listener for messages generated by the html parser.

Returns:

null if no listener is defined (default value).

getIgnoreOutsideContent

public static boolean getIgnoreOutsideContent()

Get the state of the flag to ignore content outside the BODY and HTML tags

Returns:

- The current state

getIncorrectnessListener

public IncorrectnessListener getIncorrectnessListener()

Gets the current listener for encountered incorrectness (except HTML parsing messages that are handled by the HTML parser listener). Default value is an instance of IncorrectnessListenerImpl.

Returns:

the current listener (not null).

getPage

public Page getPage(java.lang.String url)
             throws java.io.IOException,
                    FailingHttpStatusCodeException,
                    java.net.MalformedURLException

Convenient method to build an URL and load it into the current WebWindow

Parameters:

url - The url of the new content.

Returns:

The new page.

Throws:

FailingHttpStatusCodeException - If the server returns a failing status code AND the property setThrowExceptionOnFailingStatusCode(boolean) is set to true.

java.io.IOException - If an IO problem occurs.

java.net.MalformedURLException - if no url can be created from the provided string

getPage

public Page getPage(java.net.URL url)
             throws java.io.IOException,
                    FailingHttpStatusCodeException

Convenient method to load a URL into the current WebWindow

Parameters:

url - The url of the new content.

Returns:

The new page.

Throws:

FailingHttpStatusCodeException - If the server returns a failing status code AND the property setThrowExceptionOnFailingStatusCode(boolean) is set to true.

java.io.IOException - If an IO problem occurs.

getPage

public Page getPage(WebRequestSettings request)
             throws java.io.IOException,
                    FailingHttpStatusCodeException

Convenient method to load a web request into the current WebWindow

Parameters:

request - The request parameters

Returns:

The new page.

Throws:

FailingHttpStatusCodeException - If the server returns a failing status code AND the property setThrowExceptionOnFailingStatusCode(boolean) is set to true.

java.io.IOException - If an IO problem occurs.

See Also:

getPage(WebWindow,WebRequestSettings)

getPage

public Page getPage(WebWindow opener,
                    java.lang.String target,
                    WebRequestSettings params)
             throws FailingHttpStatusCodeException,
                    java.io.IOException

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.

Open a new web window and populate it with a page loaded by getPage(WebWindow,WebRequestSettings)

Parameters:

opener - The web window that initiated the request.

target - The name of the window to be opened. This is the name that would be passed into the javascript open() method.

params - Any parameters

Returns:

The new page.

Throws:

FailingHttpStatusCodeException - If the server returns a failing status code AND the property setThrowExceptionOnFailingStatusCode(boolean) is set to true.

java.io.IOException - If an IO problem occurs.

getPage

public Page getPage(WebWindow webWindow,
                    WebRequestSettings parameters)
             throws java.io.IOException,
                    FailingHttpStatusCodeException

Send a request to a server and return a Page that represents the response from the server. This page will be used to populate this frame.

The type of Page will depend on the content type of the http response.

Content type	Type of page
"text/html"	HtmlPage
"text/xhtml"	HtmlPage
"application/xhtml+xml"	HtmlPage for now, in the future it will be XML validated as well
"text/*"	TextPage
Anything else	UnexpectedPage

Parameters:

webWindow - The WebWindow to load this request into

parameters - Parameter object for the web request

Returns:

See above

Throws:

java.io.IOException - If an IO error occurs

FailingHttpStatusCodeException - If the server returns a failing status code AND the property setThrowExceptionOnFailingStatusCode(boolean) is set to true

See Also:

WebRequestSettings

getPageCreator

public PageCreator getPageCreator()

Return the current page creator.

Returns:

the page creator

getPrintContentOnFailingStatusCode

public boolean getPrintContentOnFailingStatusCode()

Return true if the content of the resulting document will be printed to the console in the event of a failing response code.

Returns:

See above

See Also:

setPrintContentOnFailingStatusCode(boolean)

getPromptHandler

public PromptHandler getPromptHandler()

Return the prompt handler.

Returns:

the prompt handler or null if one hasn't been set.

getRefreshHandler

public RefreshHandler getRefreshHandler()

Return the current refresh handler or null if one has not been set.

Returns:

The current RefreshHandler or null

getScriptEngine

public ScriptEngine getScriptEngine()

This method is intended for testing only - use at your own risk.

Returns:

the current script engine

getScriptPreProcessor

public ScriptPreProcessor getScriptPreProcessor()

Return the script pre processor for this webclient.

Returns:

the pre processor or null of one hasn't been set.

getStatusHandler

public StatusHandler getStatusHandler()

Return the status handler for this webclient.

Returns:

the status handler or null if one hasn't been set.

getTimeout

public int getTimeout()

Gets the timeout value for the WebConnection

Returns:

The timeout value in milliseconds

See Also:

setTimeout(int)

getWebConnection

public WebConnection getWebConnection()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.

Return the object that will resolve all url requests

Returns:

The connection that will be used.

getWebWindowByName

public WebWindow getWebWindowByName(java.lang.String name)
                             throws WebWindowNotFoundException

Return the first WebWindow that matches the specified name.

Parameters:

name - The name to search for.

Returns:

The WebWindow with the specified name

Throws:

WebWindowNotFoundException - If the WebWindow can't be found.

getWebWindows

public java.util.List getWebWindows()

Return an immutable list of open web windows (top windows or not).

Returns:

The web windows

guessContentType

public java.lang.String guessContentType(java.io.File file)

Tries to guess the content type of the file.
This utility could be located in an helper class but we can compare this functionality for instance with the "Helper Applications" settings of Mozilla and therefore see it as a property of the "browser".

Parameters:

file - the file

Returns:

"application/octet-stream" if nothing could be guessed.

initialize

public void initialize(Page newPage)

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Initialize a new page for JavaScript.

Parameters:

newPage - The new page.

initialize

public void initialize(WebWindow webWindow)

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Initialize a new web window for JavaScript.

Parameters:

webWindow - The new WebWindow

initializeEmptyWindow

public void initializeEmptyWindow(WebWindow webWindow)

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Initialize a new empty web window for JavaScript.

Parameters:

webWindow - The new WebWindow

isCookiesEnabled

public boolean isCookiesEnabled()

Return true if cookies are enabled.

Returns:

true if cookies are enabled.

isJavaScriptEnabled

public boolean isJavaScriptEnabled()

Return true if javascript is enabled and the script engine was loaded successfully.

Returns:

true if javascript is enabled.

isRedirectEnabled

public boolean isRedirectEnabled()

Return whether or not redirections will be followed automatically on receipt of a redirect status code from the server.

Returns:

true if automatic redirection is enabled.

isThrowExceptionOnFailingStatusCode

public boolean isThrowExceptionOnFailingStatusCode()

Return true if an exception will be thrown in the event of a failing response code.

Returns:

See above

See Also:

setThrowExceptionOnFailingStatusCode(boolean)

isThrowExceptionOnScriptError

public boolean isThrowExceptionOnScriptError()

Indicates if an exception should be thrown when a script execution fails (the default) or if it should be caught and just logged to allow page execution to continue.

Returns:

true if an exception is thrown on script error (the default)

loadWebResponse

public final WebResponse loadWebResponse(WebRequestSettings webRequestSettings)
                                  throws java.io.IOException

Loads a WebResponse from the server

Parameters:

webRequestSettings - settings to use when making the request

Returns:

The WebResponse

Throws:

java.io.IOException - if an IO problem occurs

loadWebResponseInto

public Page loadWebResponseInto(WebResponse webResponse,
                                WebWindow webWindow)
                         throws java.io.IOException,
                                FailingHttpStatusCodeException

Use the specified WebResponse to create a Page object which will then get inserted into the WebWindow. All initialization and event notification will be handled here.

Parameters:

webResponse - The response that will be used to create the new page.

webWindow - The window that the new page will be placed within.

Returns:

The newly created page.

Throws:

java.io.IOException - If an IO error occurs.

FailingHttpStatusCodeException - If the server returns a failing status code AND the property setThrowExceptionOnFailingStatusCode(boolean) is set to true

openWindow

public WebWindow openWindow(java.net.URL url,
                            java.lang.String windowName)

Open a new window with the specified name. If the url is non-null then attempt to load a page from that location and put it in the new window.

Parameters:

url - The url to load content from or null if no content is to be loaded.

windowName - The name of the new window

Returns:

The new window.

openWindow

public WebWindow openWindow(java.net.URL url,
                            java.lang.String windowName,
                            WebWindow opener)

Open a new window with the specified name. If the url is non-null then attempt to load a page from that location and put it in the new window.

Parameters:

url - The url to load content from or null if no content is to be loaded.

windowName - The name of the new window

opener - The web window that is calling openWindow

Returns:

The new window.

popFirstWindow

public WebWindow popFirstWindow()

Return the "first" window for this client. This is the first window opened since pushClearFirstWindow() was last called.

Returns:

The first window.

pushClearFirstWindow

public void pushClearFirstWindow()

Clear the first window for this client.

registerWebWindow

public void registerWebWindow(WebWindow webWindow)

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Add a new web window to the list of available windows.

Parameters:

webWindow - The new WebWindow

removeHostsFromProxyBypass

public void removeHostsFromProxyBypass(java.lang.String pattern)

Any hosts matched by the specified regular expression pattern will no longer bypass the configured proxy.

Parameters:

pattern - The previously added regular expression pattern.

See Also:

Pattern

removeRequestHeader

public void removeRequestHeader(java.lang.String name)

Remove a header

Parameters:

name - Name of the header

See Also:

addRequestHeader(java.lang.String, java.lang.String)

removeWebWindowListener

public void removeWebWindowListener(WebWindowListener listener)

Remove a listener for WebWindowEvent's.

Parameters:

listener - A listener.

setActiveXObjectMap

public void setActiveXObjectMap(java.util.Map activeXObjectMap)

Set the active X object map for this webclient. The Map is used to map the string passed into the ActiveXObject constructor to a java class name. Therefore you can emulate ActiveXObjects in a web page's javascript by mapping the object name to a java class to emulate the active X object.

Parameters:

activeXObjectMap - The new preprocessor or null if none is specified

setAjaxController

public void setAjaxController(AjaxController newValue)

Sets the current Ajax controller EXPERIMENTAL - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.

Parameters:

newValue - the controller

setAlertHandler

public void setAlertHandler(AlertHandler alertHandler)

Set the alert handler for this webclient.

Parameters:

alertHandler - The new alerthandler or null if none is specified.

setConfirmHandler

public void setConfirmHandler(ConfirmHandler handler)

Set the handler that will be executed when the javascript method Window.confirm() is called.

Parameters:

handler - The new handler or null if no handler is to be used.

setCookiesEnabled

public void setCookiesEnabled(boolean isEnabled)

Enable/disable cookies support. By default, this property is enabled.

Parameters:

isEnabled - true to enable cookies support.

setCredentialsProvider

public void setCredentialsProvider(org.apache.commons.httpclient.auth.CredentialsProvider credentialsProvider)

Sets the credentials provider that will provide authentication information when trying to access protected information on a web server. This information is required when the server is using Basic HTTP authentication, NTLM authentication, or Digest authentication.

Parameters:

credentialsProvider - The new credentials provider to use to authenticate.

setCurrentWindow

public void setCurrentWindow(WebWindow window)

Set the current window for this client. This is the window that will be used when getPage() is called without specifying a window.

Parameters:

window - The new window.

setHomePage

public void setHomePage(java.lang.String homePage)

Sets the client's homepage.

Parameters:

homePage - the new homepage URL

setHTMLParserListener

public void setHTMLParserListener(HTMLParserListener listener)

Defines a listener for messages generated by the html parser.
Note: If getIgnoreOutsideContent() returns false, the parser will ignore closing <body> and <html> tags to be able to handle html content incorrectly located after the end of the html file. As a consequence it will finally notify as errors that <body> and <html> are not closed properly even if they were correctly present.

Parameters:

listener - the new listener, null if messages should be totally ignored.

setIgnoreOutsideContent

public static void setIgnoreOutsideContent(boolean ignoreOutsideContent)

Set the flag on the HtmlParse to ignore the content that is outside of the BODY and HTML tags.

Parameters:

ignoreOutsideContent - The boolean flag to enable or disable the support of content outside of the HTML and BODY tags

setIncorrectnessListener

public void setIncorrectnessListener(IncorrectnessListener listener)

Returns the current HTML incorrectness listener.

Parameters:

listener - the new value (not null)

setJavaScriptEnabled

public void setJavaScriptEnabled(boolean isEnabled)

Enable/disable javascript support. By default, this property is enabled.

Parameters:

isEnabled - true to enable javascript support.

setPageCreator

public void setPageCreator(PageCreator pageCreator)

Set the object that will be used to create pages. Set this if you want to customize the type of page that is returned for a given content type.

Parameters:

pageCreator - The new page creator

setPrintContentOnFailingStatusCode

public void setPrintContentOnFailingStatusCode(boolean enabled)

Specify whether or not the content of the resulting document will be printed to the console in the event of a failing response code. Successful response codes are in the range 200-299. The default is true.

Parameters:

enabled - True to enable this feature

setPromptHandler

public void setPromptHandler(PromptHandler handler)

Set the handler that will be executed when the javascript method Window.prompt() is called.

Parameters:

handler - The new handler or null if no handler is to be used.

setRedirectEnabled

public void setRedirectEnabled(boolean enabled)

Set whether or not redirections will be followed automatically on receipt of a redirect status code from the server.

Parameters:

enabled - true to enable automatic redirection.

setRefreshHandler

public void setRefreshHandler(RefreshHandler handler)

Set the handler to be used whenever a refresh is triggered. Refer to the documentation for RefreshHandler for more details.

Parameters:

handler - The new handler

setScriptEngine

public void setScriptEngine(ScriptEngine engine)

This method is intended for testing only - use at your own risk.

Parameters:

engine - The new script engine to use.

setScriptPreProcessor

public void setScriptPreProcessor(ScriptPreProcessor scriptPreProcessor)

Set the script pre processor for this webclient.

Parameters:

scriptPreProcessor - The new preprocessor or null if none is specified

setStatusHandler

public void setStatusHandler(StatusHandler statusHandler)

Set the status handler for this webclient.

Parameters:

statusHandler - The new alerthandler or null if none is specified.

setThrowExceptionOnFailingStatusCode

public void setThrowExceptionOnFailingStatusCode(boolean enabled)

Specify whether or not an exception will be thrown in the event of a failing status code. Successful status codes are in the range 200-299. The default is true.

Parameters:

enabled - True to enable this feature

setThrowExceptionOnScriptError

public void setThrowExceptionOnScriptError(boolean newValue)

Changes the behavior of this webclient when a script error occurs.

Parameters:

newValue - indicates if exception should be thrown or not

setTimeout

public void setTimeout(int timeout)

Sets the timeout of the WebConnection. Set to zero (the default) for an infinite wait. Note: The timeout is used twice. The first is for making the socket connection, the second is for data retrieval. If the time is critical you must allow for twice the time specified here.

Parameters:

timeout - The value of the timeout in milliseconds

setWebConnection

public void setWebConnection(WebConnection webConnection)

Set the object that will resolve all url requests

This method is intended for unit testing HtmlUnit itself. It is not expected to change but you shouldn't need to call it during normal use of HtmlUnit.

Parameters:

webConnection - The new web connection