org.openqa.selenium.remote.http

Class HttpRequest

java.lang.Object

org.openqa.selenium.remote.http.HttpRequest

public class HttpRequest
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
HttpRequest(HttpMethod method, java.lang.String uri)

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value)
void	addQueryParameter(java.lang.String name, java.lang.String value) Set a query parameter, adding to existing values if present.
java.io.InputStream	consumeContentStream() Get the underlying content stream, bypassing the caching mechanisms that allow it to be read again.
java.lang.Object	getAttribute(java.lang.String key) Retrieves a user-defined attribute of this message.
byte[]	getContent() Deprecated. There is an expectation that this class caches all input, which leads to leaks.
java.nio.charset.Charset	getContentEncoding()
java.io.Reader	getContentReader()
java.io.InputStream	getContentStream()
java.lang.String	getContentString()
java.lang.String	getHeader(java.lang.String name)
java.lang.Iterable<java.lang.String>	getHeaderNames()
java.lang.Iterable<java.lang.String>	getHeaders(java.lang.String name)
HttpMethod	getMethod()
java.lang.String	getQueryParameter(java.lang.String name) Get a query parameter.
java.lang.Iterable<java.lang.String>	getQueryParameterNames()
java.lang.Iterable<java.lang.String>	getQueryParameters(java.lang.String name)
java.lang.String	getUri()
void	removeAttribute(java.lang.String key)
void	removeHeader(java.lang.String name)
void	setAttribute(java.lang.String key, java.lang.Object value)
void	setContent(byte[] data)
void	setContent(java.io.InputStream toStreamFrom)
void	setHeader(java.lang.String name, java.lang.String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequest

public HttpRequest(HttpMethod method,
                   java.lang.String uri)

Method Detail

getUri

public java.lang.String getUri()

getMethod

public HttpMethod getMethod()

getQueryParameter

public java.lang.String getQueryParameter(java.lang.String name)

Get a query parameter. The implementation will take care of decoding from the percent encoding.

addQueryParameter

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

Set a query parameter, adding to existing values if present. The implementation will ensure that the name and value are properly encoded.

getQueryParameterNames

public java.lang.Iterable<java.lang.String> getQueryParameterNames()

getQueryParameters

public java.lang.Iterable<java.lang.String> getQueryParameters(java.lang.String name)

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

Retrieves a user-defined attribute of this message. Attributes are stored as simple key-value pairs and are not included in a message's serialized form.

Parameters:

key - attribute name

Returns:

attribute object

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)

removeAttribute

public void removeAttribute(java.lang.String key)

getHeaderNames

public java.lang.Iterable<java.lang.String> getHeaderNames()

getHeaders

public java.lang.Iterable<java.lang.String> getHeaders(java.lang.String name)

getHeader

public java.lang.String getHeader(java.lang.String name)

setHeader

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

addHeader

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

removeHeader

public void removeHeader(java.lang.String name)

getContentEncoding

public java.nio.charset.Charset getContentEncoding()

setContent

public void setContent(byte[] data)

setContent

public void setContent(java.io.InputStream toStreamFrom)

getContent

@Deprecated
public byte[] getContent()

Deprecated. There is an expectation that this class caches all input, which leads to leaks.

getContentString

public java.lang.String getContentString()

getContentReader

public java.io.Reader getContentReader()

getContentStream

public java.io.InputStream getContentStream()

consumeContentStream

public java.io.InputStream consumeContentStream()

Get the underlying content stream, bypassing the caching mechanisms that allow it to be read again.