Package 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	Description
HttpRequest(HttpMethod method, java.lang.String uri)

Method Summary

Modifier and Type	Method	Description
M	addHeader(java.lang.String name, java.lang.String value)
HttpRequest	addQueryParameter(java.lang.String name, java.lang.String value)	Set a query parameter, adding to existing values if present.
java.io.InputStream	consumeContentStream()	Deprecated. No direct replacement.
java.lang.Object	getAttribute(java.lang.String key)	Retrieves a user-defined attribute of this message.
java.lang.Iterable<java.lang.String>	getAttributeNames()
java.util.function.Supplier<java.io.InputStream>	getContent()
java.nio.charset.Charset	getContentEncoding()
java.io.Reader	getContentReader()	Deprecated. Use Contents.reader(HttpMessage) instead.
java.io.InputStream	getContentStream()	Deprecated. Use getContent() and call Supplier.get().
java.lang.String	getContentString()	Deprecated. Use Contents.string(HttpMessage) instead.
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()
M	removeAttribute(java.lang.String key)
M	removeHeader(java.lang.String name)
M	setAttribute(java.lang.String key, java.lang.Object value)
void	setContent(byte[] data)	Deprecated. Pass Contents.bytes(byte[]) to setContent(Supplier).
void	setContent(java.io.InputStream toStreamFrom)	Deprecated. Pass () -> toStreamFrom to setContent(Supplier).
M	setContent(java.util.function.Supplier<java.io.InputStream> supplier)
M	setHeader(java.lang.String name, java.lang.String value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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 HttpRequest 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)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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 M setAttribute(java.lang.String key,
                      java.lang.Object value)

removeAttribute

public M removeAttribute(java.lang.String key)

getAttributeNames

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

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 M setHeader(java.lang.String name,
                   java.lang.String value)

addHeader

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

removeHeader

public M removeHeader(java.lang.String name)

getContentEncoding

public java.nio.charset.Charset getContentEncoding()

setContent

@Deprecated
public void setContent(byte[] data)

Deprecated.

Pass Contents.bytes(byte[]) to setContent(Supplier).

setContent

@Deprecated
public void setContent(java.io.InputStream toStreamFrom)

Deprecated.

Pass () -> toStreamFrom to setContent(Supplier).

setContent

public M setContent(java.util.function.Supplier<java.io.InputStream> supplier)

getContent

public java.util.function.Supplier<java.io.InputStream> getContent()

getContentString

@Deprecated
public java.lang.String getContentString()

Deprecated.

Use Contents.string(HttpMessage) instead.

getContentReader

@Deprecated
public java.io.Reader getContentReader()

Deprecated.

Use Contents.reader(HttpMessage) instead.

getContentStream

@Deprecated
public java.io.InputStream getContentStream()

Deprecated.

Use getContent() and call Supplier.get().

consumeContentStream

@Deprecated
public java.io.InputStream consumeContentStream()

Deprecated.

No direct replacement. Use getContent() and call Supplier.get().

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