|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.meterware.httpunit.WebClient
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.
Nested Class Summary | |
static class |
WebClient.HeaderDictionary
|
Constructor Summary | |
protected |
WebClient()
|
Method Summary | |
void |
addClientListener(WebClientListener listener)
Adds a listener to watch for requests and responses. |
void |
addCookie(java.lang.String name,
java.lang.String value)
Defines a cookie to be sent to the server on every request. |
void |
clearContents()
Resets the state of this client, removing all cookies, frames, and per-client headers. |
protected java.lang.String |
getCookieHeaderField()
Returns the value of the cookie header, or null if none is defined. |
java.lang.String[] |
getCookieNames()
Returns the name of all the active cookies which will be sent to the server. |
java.lang.String |
getCookieValue(java.lang.String name)
Returns the value of the specified cookie. |
boolean |
getExceptionsThrownOnErrorStatus()
Returns true if an exception will be thrown when an error status (4xx or 5xx) is detected on a response. |
WebResponse |
getFrameContents(java.lang.String frameName)
Returns the response associated with the specified frame name. |
java.lang.String[] |
getFrameNames()
Returns the name of the currently active frames. |
java.lang.String |
getHeaderField(java.lang.String fieldName)
Returns the value for the header field with the specified name. |
protected java.util.Dictionary |
getHeaderFields()
Returns the value of all current header fields. |
WebResponse |
getResponse(java.lang.String urlString)
Submits a GET method request and returns a response. |
WebResponse |
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. |
java.lang.String |
getUserAgent()
Returns the current user agent setting. |
protected abstract WebResponse |
newResponse(WebRequest request)
Creates a web response object which represents the response to the specified web request. |
void |
removeClientListener(WebClientListener listener)
Removes a listener to watch for requests and responses. |
WebResponse |
sendRequest(WebRequest request)
Submits a web request and returns a response. |
void |
setAuthorization(java.lang.String userName,
java.lang.String password)
Sets a username and password for a basic authentication scheme. |
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(java.lang.String fieldName,
java.lang.String fieldValue)
Sets the value for a header field to be sent with all requests. |
void |
setUserAgent(java.lang.String userAgent)
Specifies the user agent identification. |
protected void |
updateClient(WebResponse response)
Updates this web client based on a received response. |
protected void |
writeMessageBody(WebRequest request,
java.io.OutputStream stream)
Writes the message body for the request. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected WebClient()
Method Detail |
public WebResponse getResponse(java.lang.String urlString) throws java.net.MalformedURLException, java.io.IOException, org.xml.sax.SAXException
org.xml.sax.SAXException
- thrown if there is an error parsing the retrieved page
java.net.MalformedURLException
java.io.IOException
public WebResponse sendRequest(WebRequest request) throws java.net.MalformedURLException, java.io.IOException, org.xml.sax.SAXException
java.net.MalformedURLException
java.io.IOException
org.xml.sax.SAXException
public WebResponse getResponse(WebRequest request) throws java.net.MalformedURLException, java.io.IOException, org.xml.sax.SAXException
org.xml.sax.SAXException
- thrown if there is an error parsing the retrieved page
java.net.MalformedURLException
java.io.IOException
public void clearContents()
public java.lang.String[] getFrameNames()
public WebResponse getFrameContents(java.lang.String frameName)
getFrameContents
in interface com.meterware.httpunit.FrameHolder
public void addCookie(java.lang.String name, java.lang.String value)
public java.lang.String[] getCookieNames()
public java.lang.String getCookieValue(java.lang.String name)
public void setUserAgent(java.lang.String userAgent)
public java.lang.String getUserAgent()
public void setAuthorization(java.lang.String userName, java.lang.String password)
public void setHeaderField(java.lang.String fieldName, java.lang.String fieldValue)
public java.lang.String getHeaderField(java.lang.String fieldName)
public void setExceptionsThrownOnErrorStatus(boolean throwExceptions)
public boolean getExceptionsThrownOnErrorStatus()
public void addClientListener(WebClientListener listener)
public void removeClientListener(WebClientListener listener)
protected abstract WebResponse newResponse(WebRequest request) throws java.net.MalformedURLException, java.io.IOException
java.net.MalformedURLException
java.io.IOException
protected final void writeMessageBody(WebRequest request, java.io.OutputStream stream) throws java.io.IOException
java.io.IOException
protected java.lang.String getCookieHeaderField()
protected java.util.Dictionary getHeaderFields()
protected final void updateClient(WebResponse response) throws java.net.MalformedURLException, java.io.IOException, org.xml.sax.SAXException
java.net.MalformedURLException
java.io.IOException
org.xml.sax.SAXException
|
Copyright © 2000-2002 Russell Gold. See license agreement for rights granted. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |