org.openqa.selenium.remote.server

Class ServletRequestWrappingHttpRequest

java.lang.Object

org.openqa.selenium.remote.http.HttpRequest

org.openqa.selenium.remote.server.ServletRequestWrappingHttpRequest

public class ServletRequestWrappingHttpRequest
extends HttpRequest

Read-only adapter of HttpServletRequest to a HttpRequest. This class is not thread-safe, and you can only expect to read the content once.

Constructor Summary

Constructors

Constructor and Description
ServletRequestWrappingHttpRequest(javax.servlet.http.HttpServletRequest req)

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()
java.nio.charset.Charset	getContentEncoding()
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)
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)
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 org.openqa.selenium.remote.http.HttpRequest

getMethod, getUri

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletRequestWrappingHttpRequest

public ServletRequestWrappingHttpRequest(javax.servlet.http.HttpServletRequest req)

Method Detail

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)

removeHeader

public void removeHeader(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)

getQueryParameter

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

Description copied from class: HttpRequest

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

Overrides:

getQueryParameter in class HttpRequest

addQueryParameter

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

Description copied from class: HttpRequest

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

Overrides:

addQueryParameter in class HttpRequest

getQueryParameterNames

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

Overrides:

getQueryParameterNames in class HttpRequest

getQueryParameters

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

Overrides:

getQueryParameters in class HttpRequest

setContent

public void setContent(byte[] data)

setContent

public void setContent(java.io.InputStream toStreamFrom)

consumeContentStream

public java.io.InputStream consumeContentStream()

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

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)

getContentEncoding

public java.nio.charset.Charset getContentEncoding()

getContent

public byte[] getContent()

getContentString

public java.lang.String getContentString()