| java.lang.Object
 com.meterware.httpunit.WebRequest
All known Subclasses: com.meterware.httpunit.HeaderOnlyWebRequest, com.meterware.httpunit.MessageBodyWebRequest,
| WebRequest | | abstract public class WebRequest (Code) | | A request sent to a web server.
|
| Constructor Summary | |
| protected | WebRequest(String urlString)
Constructs a web request using an absolute URL string. | | protected | WebRequest(URL urlBase, String urlString)
Constructs a web request using a base URL and a relative URL string. | | protected | WebRequest(WebRequest baseRequest, String urlString, String target)
Constructs a web request using a base request and a relative URL string. | | protected | WebRequest(URL urlBase, String urlString, String target)
Constructs a web request using a base URL, a relative URL string, and a target. | | protected | WebRequest(URL urlBase, String urlString, FrameSelector frame, String target)
Constructs a web request using a base URL, a relative URL string, and a target. | | protected | WebRequest(WebForm sourceForm, ParameterHolder parameterHolder, SubmitButton button, int x, int y)
Constructs a web request from a form. | | protected | WebRequest(WebRequestSource requestSource, ParameterHolder parameterHolder)
|
| Method Summary | |
| protected void | completeRequest(URLConnection connection)
Performs any additional processing necessary to complete the request. | | final protected String | getCharacterSet()
Returns the character set required for this request. | | protected String | getContentType()
Returns the content type of this request. | | Hashtable | getHeaderDictionary()
| | public Dictionary | getHeaders()
Returns a copy of the headers to be sent with this request. | | abstract public String | getMethod()
Returns the HTTP method defined for this request. | | public String | getParameter(String name)
Returns the value of a parameter in this web request. | | final protected ParameterHolder | getParameterHolder()
| | public String[] | getParameterValues(String name)
Returns the multiple default values of the named parameter. | | public String | getQueryString()
Returns the query string defined for this request. | | String | getReferer()
| | public String[] | getRequestParameterNames()
Returns an array of all parameter names defined as part of this web request. | | FrameSelector | getSourceFrame()
Returns the frame from which this request originates. | | public String | getTarget()
Returns the target for this web request. | | public URL | getURL()
Returns the final URL associated with this web request. | | final protected URL | getURLBase()
| | protected String | getURLString()
| | WebRequestSource | getWebRequestSource()
| | public boolean | isFileParameter(String name)
Returns true if the specified parameter is a file field. | | protected boolean | isMimeEncoded()
Returns true if this request is to be MIME-encoded. | | protected boolean | maySelectFile(String parameterName)
Returns true if selectFile may be called with this parameter. | | static ParameterHolder | newParameterHolder(WebRequestSource requestSource)
| | public void | removeParameter(String name)
Removes a parameter from this web request. | | public void | selectFile(String parameterName, File file)
Sets the file for a parameter upload in a web request. | | public void | selectFile(String parameterName, File file, String contentType)
Sets the file for a parameter upload in a web request. | | public void | selectFile(String parameterName, String fileName, InputStream inputStream, String contentType)
Sets the file for a parameter upload in a web request. | | public void | setHeaderField(String headerName, String headerValue)
Sets the value of a header to be sent with this request. | | public void | setImageButtonClickPosition(int x, int y)
Specifies the click position for the submit button. | | protected void | setMimeEncoded(boolean mimeEncoded)
Selects whether MIME-encoding will be used for this request. | | public void | setParameter(String name, String value)
Sets the value of a parameter in a web request. | | public void | setParameter(String name, String[] values)
Sets the multiple values of a parameter in a web request. | | public void | setParameter(String parameterName, UploadFileSpec[] files)
Sets the multiple values of a file upload parameter in a web request. | | public String | toString()
| | protected void | writeMessageBody(OutputStream stream)
Writes the contents of the message body to the specified stream. |
| NEW_WINDOW | | final static String NEW_WINDOW(Code) | | The target indicating a new, empty window. *
|
| PARENT_FRAME | | final static String PARENT_FRAME(Code) | | The target indicating the parent of a frame. *
|
| REFERER_HEADER_NAME | | final static String REFERER_HEADER_NAME(Code) | | |
| SAME_FRAME | | final static String SAME_FRAME(Code) | | The target indicating the same frame. *
|
| TOP_FRAME | | final static String TOP_FRAME(Code) | | The target indicating the topmost frame of a window. *
|
| WebRequest | | protected WebRequest(String urlString)(Code) | | Constructs a web request using an absolute URL string.
|
| WebRequest | | protected WebRequest(URL urlBase, String urlString)(Code) | | Constructs a web request using a base URL and a relative URL string.
|
| WebRequest | | protected WebRequest(URL urlBase, String urlString, String target)(Code) | | Constructs a web request using a base URL, a relative URL string, and a target.
|
| WebRequest | | protected WebRequest(URL urlBase, String urlString, FrameSelector frame, String target)(Code) | | Constructs a web request using a base URL, a relative URL string, and a target.
|
| completeRequest | | protected void completeRequest(URLConnection connection) throws IOException(Code) | | Performs any additional processing necessary to complete the request.
|
| getCharacterSet | | final protected String getCharacterSet()(Code) | | Returns the character set required for this request.
|
| getContentType | | protected String getContentType()(Code) | | Returns the content type of this request. If null, no content is specified.
|
| getHeaders | | public Dictionary getHeaders()(Code) | | Returns a copy of the headers to be sent with this request.
|
| getMethod | | abstract public String getMethod()(Code) | | Returns the HTTP method defined for this request.
|
| getParameter | | public String getParameter(String name)(Code) | | Returns the value of a parameter in this web request.
the value of the named parameter, or empty stringif it is not set. |
| getParameterValues | | public String[] getParameterValues(String name)(Code) | | Returns the multiple default values of the named parameter.
|
| getQueryString | | public String getQueryString()(Code) | | Returns the query string defined for this request. The query string is sent to the HTTP server as part of
the request header. This default implementation returns an empty string.
|
| getRequestParameterNames | | public String[] getRequestParameterNames()(Code) | | Returns an array of all parameter names defined as part of this web request.
since:
1.3.1 |
| getSourceFrame | | FrameSelector getSourceFrame()(Code) | | Returns the frame from which this request originates.
|
| getTarget | | public String getTarget()(Code) | | Returns the target for this web request.
|
| getURLBase | | final protected URL getURLBase()(Code) | | |
| isFileParameter | | public boolean isFileParameter(String name)(Code) | | Returns true if the specified parameter is a file field.
|
| isMimeEncoded | | protected boolean isMimeEncoded()(Code) | | Returns true if this request is to be MIME-encoded.
|
| maySelectFile | | protected boolean maySelectFile(String parameterName)(Code) | | Returns true if selectFile may be called with this parameter.
|
| removeParameter | | public void removeParameter(String name)(Code) | | Removes a parameter from this web request.
|
| selectFile | | public void selectFile(String parameterName, File file)(Code) | | Sets the file for a parameter upload in a web request.
|
| selectFile | | public void selectFile(String parameterName, File file, String contentType)(Code) | | Sets the file for a parameter upload in a web request.
|
| selectFile | | public void selectFile(String parameterName, String fileName, InputStream inputStream, String contentType)(Code) | | Sets the file for a parameter upload in a web request.
|
| setHeaderField | | public void setHeaderField(String headerName, String headerValue)(Code) | | Sets the value of a header to be sent with this request. A header set here will override any matching header set
in the WebClient when the request is actually sent.
|
| setImageButtonClickPosition | | public void setImageButtonClickPosition(int x, int y) throws IllegalRequestParameterException(Code) | | Specifies the click position for the submit button. When a user clioks on an image button, not only the name
and value of the button, but also the position of the mouse at the time of the click is submitted with the form.
This method allows the caller to override the position selected when this request was created.
exception:
IllegalRequestParameterException - thrown if the request was not created from a form with an image button. |
| setMimeEncoded | | protected void setMimeEncoded(boolean mimeEncoded)(Code) | | Selects whether MIME-encoding will be used for this request. MIME-encoding changes the way the request is sent
and is required for requests which include file parameters. This method may only be called for a POST request
which was not created from a form.
|
| setParameter | | public void setParameter(String name, String value)(Code) | | Sets the value of a parameter in a web request.
|
| setParameter | | public void setParameter(String name, String[] values)(Code) | | Sets the multiple values of a parameter in a web request.
|
| setParameter | | public void setParameter(String parameterName, UploadFileSpec[] files)(Code) | | Sets the multiple values of a file upload parameter in a web request.
|
| writeMessageBody | | protected void writeMessageBody(OutputStream stream) throws IOException(Code) | | Writes the contents of the message body to the specified stream.
|
|
|