HttpMethod

All Known Implementing Classes:

AbstractMethod, IdempotentMethod, Method, SafeMethod
```
public interface HttpMethod
```
Represents an HTTP method and provides static members for HTTP methods defined in RFC 7231, section 4.3 and RFC 5789

Author:

Marten Gajda

See Also:
RFC 7231, section 4

Field Summary

Fields
Modifier and Type	Field and Description
`static HttpMethod`	`CONNECT` HTTP Method CONNECT
`static HttpMethod`	`DELETE` HTTP Method DELETE
`static HttpMethod`	`GET` HTTP Method GET
`static HttpMethod`	`HEAD` HTTP Method HEAD
`static HttpMethod`	`OPTIONS` HTTP Method OPTIONS
`static HttpMethod`	`PATCH` HTTP Method PATCH
`static HttpMethod`	`POST` HTTP Method POST
`static HttpMethod`	`PUT` HTTP Method PUT
`static HttpMethod`	`TRACE` HTTP Method TRACE

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`isIdempotent()` Returns if this request method is idempotent, which means that sending multiple identical requests with that method has the same effect as sending one single request to the server.
`boolean`	`isSafe()` Returns if this request method is safe, which means that the request is not intended and not expected to change any state on the server.
`boolean`	`supportsRequestPayload()` Returns whether this `HttpMethod` allows to send a message body.
`java.lang.String`	`verb()` Returns the HTTP verb of this method.

- Field Detail
  - GET
```
static final HttpMethod GET
```
    HTTP Method GET
    
    See Also:
    RFC 7231, section 4.3.1
  - HEAD
```
static final HttpMethod HEAD
```
    HTTP Method HEAD
    
    See Also:
    RFC 7231, section 4.3.2
  - POST
```
static final HttpMethod POST
```
    HTTP Method POST
    
    See Also:
    RFC 7231, section 4.3.3
  - PUT
```
static final HttpMethod PUT
```
    HTTP Method PUT
    
    See Also:
    RFC 7231, section 4.3.4
  - DELETE
```
static final HttpMethod DELETE
```
    HTTP Method DELETE
    
    See Also:
    RFC 7231, section 4.3.5
  - CONNECT
```
static final HttpMethod CONNECT
```
    HTTP Method CONNECT
    
    See Also:
    RFC 7231, section 4.3.6
  - OPTIONS
```
static final HttpMethod OPTIONS
```
    HTTP Method OPTIONS
    
    See Also:
    RFC 7231, section 4.3.7
  - TRACE
```
static final HttpMethod TRACE
```
    HTTP Method TRACE
    
    See Also:
    RFC 7231, section 4.3.8
  - PATCH
```
static final HttpMethod PATCH
```
    HTTP Method PATCH
    
    See Also:
    RFC 5789
- Method Detail
  - verb
```
java.lang.String verb()
```
    Returns the HTTP verb of this method.
    
    Returns:
    A String containing the verb of the method.
  - isSafe
```
boolean isSafe()
```
    Returns if this request method is safe, which means that the request is not intended and not expected to change any state on the server. In effect the semantics are to be considered read-only.
    
    See Also:
    RFC 7231, Section 4.2.1
  - isIdempotent
```
boolean isIdempotent()
```
    Returns if this request method is idempotent, which means that sending multiple identical requests with that method has the same effect as sending one single request to the server.
    
    See Also:
    RFC 7231, Section 4.2.2
  - supportsRequestPayload
```
boolean supportsRequestPayload()
```
    Returns whether this HttpMethod allows to send a message body.
    Note that RFC 7231 does not explicitly forbid a message payload for some methods (in particular these are GET, HEAD, DELETE and CONNECT). Instead is says something like this:
```
 A payload within a XXX request message has no defined semantics;
 sending a payload body on a XXX request might cause some existing
 implementations to reject the request.
 
```
    The predefined methods in HttpMethod interpret this rather strict and return false for such methods.
    Returns:
    true if this method supports a message body, false otherwise.

Interface HttpMethod

Field Summary

Method Summary

Field Detail

GET

HEAD

POST

PUT

DELETE

CONNECT

OPTIONS

TRACE

PATCH

Method Detail

verb

isSafe

isIdempotent

supportsRequestPayload