com.kamontat.constance

Enum RequestMethod

java.lang.Object

java.lang.Enum<RequestMethod>

com.kamontat.constance.RequestMethod

All Implemented Interfaces:

Serializable, Comparable<RequestMethod>

public enum RequestMethod
extends Enum<RequestMethod>

Since:

Sun 26/Mar/2017 - 8:56 PM

Version:

1.0

Author:

kamontat

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECT The HTTP CONNECT method method starts two-way communications with the requested resource.
DELETE The HTTP DELETE request method deletes the specified resource.
GET The HTTP GET method requests a representation of the specified resource.
HEAD The HTTP HEAD method requests the headers that are returned if the specified resource would be requested with an HTTP GET method.
OPTIONS The HTTP OPTIONS method is used to describe the communication options for the target resource.
PATCH The HTTP PATCH request method applies partial modifications to a resource.
POST The HTTP POST method sends data to the server.
PUT The HTTP PUT request method creates a new resource or replaces a representation of the target resource with the request payload.

Method Summary

Modifier and Type	Method and Description
String	toString()
static RequestMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static RequestMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONNECT

public static final RequestMethod CONNECT

The HTTP CONNECT method method starts two-way communications with the requested resource. It can be used to open a tunnel.

For example, the CONNECT method can be used to access websites that use SSL (HTTPS). The client asks an HTTP Proxy server to tunnel the TCP connection to the desired destination. The server then proceeds to make the connection on behalf of the client. Once the connection has been established by the server, the Proxy server continues to proxy the TCP stream to and from the client.
learn more

GET

public static final RequestMethod GET

The HTTP GET method requests a representation of the specified resource. Requests using GET should only retrieve data.
learn more

POST

public static final RequestMethod POST

The HTTP POST method sends data to the server. The type of the body of the request is indicated by the Content-Type header.

The difference between PUT and POST is that PUT is idempotent: calling it once or several times successively has the same effect (that is no side effect), where successive identical POST may have additional effects, like passing an order several times.

A POST request is typically sent via an HTML form and results in a change on the server. In this case, the content type is selected by putting the adequate string in the enctype attribute of the <form> element or the formenctype attribute of the <input> or <button> elements:

• application/x-www-form-urlencoded: the values are encoded in key-value tuples separated by '&', with a '=' between the key and the value. Non-alphanumeric characters are percent encoded: this is the reason why this type is not suitable to use with binary data (use application/form-data instead)
• application/form-data
• text/plain

When the POST request is sent via another method that an HTML form, like via an XMLHttpRequest, the body can take any type. As described in the HTTP 1.1 specification, POST is designed to allow a uniform method to cover the following functions:

• Annotation of existing resources
• Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles;
• Providing a block of data, such as the result of submitting a form, to a data-handling process;
• Extending a database through an append operation.

learn more

PUT

public static final RequestMethod PUT

The HTTP PUT request method creates a new resource or replaces a representation of the target resource with the request payload.

The difference between PUT and POST is that PUT is idempotent: calling it once or several times successively has the same effect (that is no side effect), where successive identical POST may have additional effects, like passing an order several times.
learn more

PATCH

public static final RequestMethod PATCH

The HTTP PATCH request method applies partial modifications to a resource.

The HTTP PUT method is already defined to overwrite a resource with a complete new body, and for the POST method there is no standard way to discover patch format support. Unlike PUT, but like POST, PATCH is not idempotent, meaning successive identical patch requests will have different effects.

To find out whether a server supports PATCH, a server can advertise its support by adding it to the list in the Allow or Access-Control-Allow-Methods (for CORS) response headers.

Another (implicit) indication that PATCH is allowed, is the presence of the Accept-Patch header, which specifies the patch document formats accepted by the server.
learn more

HEAD

public static final RequestMethod HEAD

The HTTP HEAD method requests the headers that are returned if the specified resource would be requested with an HTTP GET method. Such a request can be done before deciding to download a large resource to save bandwidth, for example.

A response to a HEAD method should not have a body. If so, it must be ignored. Even so, entity headers describing the content of the body, like Content-Length may be included in the response. They don't relate to the body of the HEAD response, which should be empty, but to the body of similar request using the GET method would have returned as a response.

If the result of a HEAD request shows that a cached resource after a GET request is now outdated, the cache is invalidated, even if no GET request has been made.
learn more

OPTIONS

public static final RequestMethod OPTIONS

The HTTP OPTIONS method is used to describe the communication options for the target resource. The client can specify a specific URL for the OPTIONS method, or an asterisk (*) to refer to the entire server.
learn more

DELETE

public static final RequestMethod DELETE

The HTTP DELETE request method deletes the specified resource.
learn more

Method Detail

values

public static RequestMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RequestMethod c : RequestMethod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RequestMethod valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<RequestMethod>