Package org.springframework.http

Interface HttpRequest

All Superinterfaces:

HttpMessage

All Known Subinterfaces:

ClientHttpRequest, ServerHttpRequest, ServerHttpRequest

All Known Implementing Classes:

AbstractClientHttpRequest, AbstractServerHttpRequest, HttpRequestWrapper, MockClientHttpRequest, MockServerHttpRequest, RequestPartServletServerHttpRequest, ServerHttpRequestDecorator, ServletServerHttpRequest

public interface HttpRequest
extends HttpMessage

Represents an HTTP request message, consisting of a method and a URI.

Since:

3.1

Author:

Arjen Poutsma

Method Summary

Modifier and Type	Method	Description
HttpMethod	getMethod()	Return the HTTP method of the request.
default String	getMethodValue()	Deprecated, for removal: This API element is subject to removal in a future version. as of Spring Framework 6.0 in favor of getMethod() and HttpMethod.name()
URI	getURI()	Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).

Methods inherited from interface org.springframework.http.HttpMessage

getHeaders

Method Details

getMethod

HttpMethod getMethod()

Return the HTTP method of the request.

Returns:

the HTTP method as an HttpMethod value

See Also:

• HttpMethod.valueOf(String)

getMethodValue

@Deprecated(since="6.0",
            forRemoval=true)
default String getMethodValue()

Deprecated, for removal: This API element is subject to removal in a future version.

as of Spring Framework 6.0 in favor of getMethod() and HttpMethod.name()

Return the HTTP method of the request as a String value.

Returns:

the HTTP method as a plain String

Since:

5.0

See Also:

• getMethod()

getURI

URI getURI()

Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).

Returns:

the URI of the request (never null)