Package com.meterware.httpunit
Class WebClient
java.lang.Object
com.meterware.httpunit.WebClient
- Direct Known Subclasses:
ServletUnitClient
,WebConversation
The context for a series of web requests. This class manages cookies used to maintain
session context, computes relative URLs, and generally emulates the browser behavior
needed to build an automated test of a web site.
- Author:
- Russell Gold, Jan Ohrstrom, Seth Ladd, Oliver Imbusch
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addClientListener
(WebClientListener listener) Adds a listener to watch for requests and responses.void
Deprecated.as of 1.6, use #putCookie instead.void
addWindowListener
(WebWindowListener listener) Adds a listener to watch for window openings and closings.void
Resets the state of this client, removing all cookies, frames, and per-client headers.void
Clears the proxy server settings.Returns the properties associated with this client.getCookieDetails
(String name) Returns an object containing the details of the named cookieDeprecated.- use with care - was not public in the pastString[]
Returns the name of all the active cookies which will be sent to the server.getCookieValue
(String name) Returns the value of the specified cookie.Returns the response representing the current top page in the main window.boolean
Returns true if an exception will be thrown when an error status (4xx or 5xx) is detected on a response.getFrameContents
(FrameSelector targetFrame) Returns the response associated with the specified frame name in the main window.getFrameContents
(String frameName) Returns the response associated with the specified frame name in the main window.String[]
Returns the name of the currently active frames in the main window.getHeaderField
(String fieldName) Returns the value for the header field with the specified name.protected Dictionary
getHeaderFields
(URL targetURL) Returns the value of all current header fields.Returns the next javascript alert without removing it from the queue.getOpenWindow
(String name) Returns the name of the active proxy server.int
Returns the number of the active proxy port, or 0 is none is specified.getResource
(WebRequest request) Returns the resource specified by the request.getResponse
(WebRequest request) Submits a web request and returns a response, using all state developed so far as stored in cookies as requested by the server.getResponse
(String urlString) Submits a GET method request and returns a response.Deprecated.as of 1.4.6.protected abstract WebResponse
newResponse
(WebRequest request, FrameSelector targetFrame) Creates a web response object which represents the response to the specified web request.Returns the next javascript alert and removes it from the queue.void
Defines a cookie to be sent to the server on every request.void
removeClientListener
(WebClientListener listener) Removes a listener to watch for requests and responses.void
removeWindowListener
(WebWindowListener listener) Removes a listener to watch for window openings and closings.sendRequest
(WebRequest request) Submits a web request and returns a response.void
setAuthentication
(String realm, String username, String password) Specifies a username and password for on-demand authentication.void
setAuthorization
(String userName, String password) Deprecated.as of 1.7.void
setDialogResponder
(DialogResponder responder) Specifies the object which will respond to all dialogs.void
setExceptionsThrownOnErrorStatus
(boolean throwExceptions) Specifies whether an exception will be thrown when an error status (4xx or 5xx) is detected on a response.void
setHeaderField
(String fieldName, String fieldValue) Sets the value for a header field to be sent with all requests.void
setMainWindow
(WebWindow mainWindow) abstract void
setProxyServer
(String proxyHost, int proxyPort) Specifies a proxy server to use for requests from this client.void
setProxyServer
(String proxyHost, int proxyPort, String userName, String password) Specifies a proxy server to use, along with a user and password for authentication.void
setUserAgent
(String userAgent) Deprecated.as of 1.4.6.protected final void
updateMainWindow
(FrameSelector frame, WebResponse response) Updates this web client based on a received response.protected final void
writeMessageBody
(WebRequest request, OutputStream stream) Writes the message body for the request.
-
Constructor Details
-
WebClient
protected WebClient()
-
-
Method Details
-
getMainWindow
-
setMainWindow
-
getOpenWindows
-
getOpenWindow
-
getResponse
Submits a GET method request and returns a response.- Throws:
SAXException
- thrown if there is an error parsing the retrieved pageIOException
-
sendRequest
Submits a web request and returns a response. This is an alternate name for the getResponse method.- Throws:
IOException
SAXException
-
getCurrentPage
Returns the response representing the current top page in the main window. -
getResponse
Submits a web request and returns a response, using all state developed so far as stored in cookies as requested by the server.- Throws:
SAXException
- thrown if there is an error parsing the retrieved pageIOException
-
getFrameNames
Returns the name of the currently active frames in the main window. -
getFrameContents
Returns the response associated with the specified frame name in the main window. Throws a runtime exception if no matching frame is defined. -
getFrameContents
Returns the response associated with the specified frame name in the main window. Throws a runtime exception if no matching frame is defined.- Since:
- 1.6
-
getResource
Returns the resource specified by the request. Does not update the client or load included framesets or scripts. May return null if the resource is a JavaScript URL which would normally leave the client unchanged.- Throws:
IOException
-
clearContents
public void clearContents()Resets the state of this client, removing all cookies, frames, and per-client headers. This does not affect any listeners or preferences which may have been set. -
addCookie
Deprecated.as of 1.6, use #putCookie instead.Defines a cookie to be sent to the server on every request. -
putCookie
Defines a cookie to be sent to the server on every request. This overrides any previous setting for this cookie name. -
getCookieNames
Returns the name of all the active cookies which will be sent to the server. -
getCookieDetails
Returns an object containing the details of the named cookie- Since:
- [ 1488617 ] alternate patch for cookie bug #1371204
-
getCookieValue
Returns the value of the specified cookie. -
getClientProperties
Returns the properties associated with this client. -
setUserAgent
Deprecated.as of 1.4.6. Use ClientProperties#setUserAgent instead.Specifies the user agent identification. Used to trigger browser-specific server behavior. -
getUserAgent
Deprecated.as of 1.4.6. Use ClientProperties#getUserAgent instead.Returns the current user agent setting. -
setAuthorization
Deprecated.as of 1.7. Use #setAuthentication for more accurate emulation of browser behavior.Sets a username and password for a basic authentication scheme. -
setAuthentication
Specifies a username and password for on-demand authentication. Will only send the authorization header when challenged for the specified realm.- Parameters:
realm
- the realm for which the credentials apply.username
- the user to authenticatepassword
- the credentials for the user
-
setProxyServer
Specifies a proxy server to use for requests from this client. -
setProxyServer
Specifies a proxy server to use, along with a user and password for authentication.- Since:
- 1.6
-
clearProxyServer
public void clearProxyServer()Clears the proxy server settings. -
getProxyHost
Returns the name of the active proxy server. -
getProxyPort
public int getProxyPort()Returns the number of the active proxy port, or 0 is none is specified. -
setHeaderField
Sets the value for a header field to be sent with all requests. If the value set is null, removes the header from those to be sent. -
getHeaderField
Returns the value for the header field with the specified name. This method will ignore the case of the field name. -
setExceptionsThrownOnErrorStatus
public void setExceptionsThrownOnErrorStatus(boolean throwExceptions) Specifies whether an exception will be thrown when an error status (4xx or 5xx) is detected on a response. Defaults to the value returned by HttpUnitOptions.getExceptionsThrownOnErrorStatus. -
getExceptionsThrownOnErrorStatus
public boolean getExceptionsThrownOnErrorStatus()Returns true if an exception will be thrown when an error status (4xx or 5xx) is detected on a response. -
addClientListener
Adds a listener to watch for requests and responses. -
removeClientListener
Removes a listener to watch for requests and responses. -
addWindowListener
Adds a listener to watch for window openings and closings. -
removeWindowListener
Removes a listener to watch for window openings and closings. -
getNextAlert
Returns the next javascript alert without removing it from the queue. -
popNextAlert
Returns the next javascript alert and removes it from the queue. If the queue is empty, will return an empty string. -
setDialogResponder
Specifies the object which will respond to all dialogs. -
newResponse
protected abstract WebResponse newResponse(WebRequest request, FrameSelector targetFrame) throws IOException Creates a web response object which represents the response to the specified web request.- Parameters:
request
- the request to which the response should be generatedtargetFrame
- the frame in which the response should be stored- Throws:
IOException
-
writeMessageBody
Writes the message body for the request.- Throws:
IOException
-
getHeaderFields
Returns the value of all current header fields. -
updateMainWindow
protected final void updateMainWindow(FrameSelector frame, WebResponse response) throws IOException, SAXException Updates this web client based on a received response. This includes updating cookies and frames. This method is required by ServletUnit, which cannot call the updateWindow method directly.- Throws:
IOException
SAXException
-
getCookieJar
Deprecated.- use with care - was not public in the pastSupport Request [ 1288796 ] getCookieJar() in WebClient- Returns:
- the cookie jar
-