Module org.eclipse.jetty.http

Package org.eclipse.jetty.http

Enum Class HttpMethod

java.lang.Object

java.lang.Enum<HttpMethod>

org.eclipse.jetty.http.HttpMethod

All Implemented Interfaces:

Serializable, Comparable<HttpMethod>, Constable

public enum HttpMethod
extends Enum<HttpMethod>

Known HTTP Methods

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACL
BASELINE_CONTROL
BIND
CHECKIN
CHECKOUT
CONNECT
COPY
DELETE
GET
HEAD
LABEL
LINK
LOCK
MERGE
MKACTIVITY
MKCALENDAR
MKCOL
MKREDIRECTREF
MKWORKSPACE
MOVE
OPTIONS
ORDERPATCH
PATCH
POST
PRI
PROPFIND
PROPPATCH
PROXY
PUT
REBIND
REPORT
SEARCH
TRACE
UNBIND
UNCHECKOUT
UNLINK
UNLOCK
UPDATE
UPDATEREDIRECTREF
VERSION_CONTROL

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACL_AS_INT
static final org.eclipse.jetty.util.Index<HttpMethod>	CACHE
static final int	GET_AS_INT
static final int	HEAD_AS_INT
static final org.eclipse.jetty.util.Index<HttpMethod>	INSENSITIVE_CACHE
static final org.eclipse.jetty.util.Index<HttpMethod>	LOOK_AHEAD
static final int	POST_AS_INT
static final int	PRI_AS_INT
static final int	PUT_AS_INT

Method Summary

Modifier and Type	Method	Description
ByteBuffer	asBuffer()
String	asString()
static HttpMethod	fromString(String method)	Converts the given String parameter to an HttpMethod.
byte[]	getBytes()
boolean	is(String s)
boolean	isIdempotent()	An idempotent HTTP method is an HTTP method that can be called many times without different outcomes.
boolean	isSafe()	An HTTP method is safe if it doesn't alter the state of the server.
static HttpMethod	lookAheadGet(ByteBuffer buffer)	Optimized lookup to find a method name and trailing space in a byte array.
String	toString()
static HttpMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HttpMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ACL

public static final HttpMethod ACL

BASELINE_CONTROL

public static final HttpMethod BASELINE_CONTROL

BIND

public static final HttpMethod BIND

CHECKIN

public static final HttpMethod CHECKIN

CHECKOUT

public static final HttpMethod CHECKOUT

CONNECT

public static final HttpMethod CONNECT

COPY

public static final HttpMethod COPY

DELETE

public static final HttpMethod DELETE

GET

public static final HttpMethod GET

HEAD

public static final HttpMethod HEAD

LABEL

public static final HttpMethod LABEL

LINK

public static final HttpMethod LINK

LOCK

public static final HttpMethod LOCK

MERGE

public static final HttpMethod MERGE

MKACTIVITY

public static final HttpMethod MKACTIVITY

MKCALENDAR

public static final HttpMethod MKCALENDAR

MKCOL

public static final HttpMethod MKCOL

MKREDIRECTREF

public static final HttpMethod MKREDIRECTREF

MKWORKSPACE

public static final HttpMethod MKWORKSPACE

MOVE

public static final HttpMethod MOVE

OPTIONS

public static final HttpMethod OPTIONS

ORDERPATCH

public static final HttpMethod ORDERPATCH

PATCH

public static final HttpMethod PATCH

POST

public static final HttpMethod POST

PRI

public static final HttpMethod PRI

PROPFIND

public static final HttpMethod PROPFIND

PROPPATCH

public static final HttpMethod PROPPATCH

PUT

public static final HttpMethod PUT

REBIND

public static final HttpMethod REBIND

REPORT

public static final HttpMethod REPORT

SEARCH

public static final HttpMethod SEARCH

TRACE

public static final HttpMethod TRACE

UNBIND

public static final HttpMethod UNBIND

UNCHECKOUT

public static final HttpMethod UNCHECKOUT

UNLINK

public static final HttpMethod UNLINK

UNLOCK

public static final HttpMethod UNLOCK

UPDATE

public static final HttpMethod UPDATE

UPDATEREDIRECTREF

public static final HttpMethod UPDATEREDIRECTREF

VERSION_CONTROL

public static final HttpMethod VERSION_CONTROL

PROXY

public static final HttpMethod PROXY

Field Details

INSENSITIVE_CACHE

public static final org.eclipse.jetty.util.Index<HttpMethod> INSENSITIVE_CACHE

CACHE

public static final org.eclipse.jetty.util.Index<HttpMethod> CACHE

LOOK_AHEAD

public static final org.eclipse.jetty.util.Index<HttpMethod> LOOK_AHEAD

ACL_AS_INT

public static final int ACL_AS_INT

See Also:

• Constant Field Values

GET_AS_INT

public static final int GET_AS_INT

See Also:

• Constant Field Values

PRI_AS_INT

public static final int PRI_AS_INT

See Also:

• Constant Field Values

PUT_AS_INT

public static final int PUT_AS_INT

See Also:

• Constant Field Values

POST_AS_INT

public static final int POST_AS_INT

See Also:

• Constant Field Values

HEAD_AS_INT

public static final int HEAD_AS_INT

See Also:

• Constant Field Values

Method Details

values

public static HttpMethod[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static HttpMethod valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getBytes

public byte[] getBytes()

is

public boolean is(String s)

isSafe

public boolean isSafe()

An HTTP method is safe if it doesn't alter the state of the server. In other words, a method is safe if it leads to a read-only operation. Several common HTTP methods are safe: GET , HEAD , or OPTIONS . All safe methods are also idempotent, but not all idempotent methods are safe

Returns:

if the method is safe.

isIdempotent

public boolean isIdempotent()

An idempotent HTTP method is an HTTP method that can be called many times without different outcomes. It would not matter if the method is called only once, or ten times over. The result should be the same.

Returns:

true if the method is idempotent.

asBuffer

public ByteBuffer asBuffer()

asString

public String asString()

toString

public String toString()

Overrides:

toString in class Enum<HttpMethod>

lookAheadGet

public static HttpMethod lookAheadGet(ByteBuffer buffer)

Optimized lookup to find a method name and trailing space in a byte array.

Parameters:

buffer - buffer containing ISO-8859-1 characters, it is not modified.

Returns:

An HttpMethod if a match or null if no easy match.

fromString

public static HttpMethod fromString(String method)

Converts the given String parameter to an HttpMethod. The string may differ from the Enum name as a '-' in the method name is represented as a '_' in the Enum name.

Parameters:

method - the String to get the equivalent HttpMethod from

Returns:

the HttpMethod or null if the parameter method is unknown