org.dmfs.httpessentials.methods

Class AbstractMethod

java.lang.Object

org.dmfs.httpessentials.methods.AbstractMethod

All Implemented Interfaces:

HttpMethod

Direct Known Subclasses:

IdempotentMethod, Method, SafeMethod

public abstract class AbstractMethod
extends java.lang.Object
implements HttpMethod

An abstract HttpMethod. By default this method is not safe and not idempotent.

Author:

Marten Gajda

Field Summary

Fields inherited from interface org.dmfs.httpessentials.HttpMethod

CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE

Constructor Summary

Constructors

Constructor and Description
AbstractMethod(java.lang.String verb, boolean supportsRequestPayload) Instantiates a new HttpMethod with the given verb.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()
boolean	supportsRequestPayload() Returns whether this HttpMethod allows to send a message body.
java.lang.String	verb() Returns the HTTP verb of this method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dmfs.httpessentials.HttpMethod

isIdempotent, isSafe

Constructor Detail

AbstractMethod

public AbstractMethod(java.lang.String verb,
              boolean supportsRequestPayload)

Instantiates a new HttpMethod with the given verb.

Parameters:

verb - The method verb.

supportsRequestPayload - whether this method support sending a request message body.

Method Detail

verb

public final java.lang.String verb()

Description copied from interface: HttpMethod

Returns the HTTP verb of this method.

Specified by:

verb in interface HttpMethod

Returns:

A String containing the verb of the method.

supportsRequestPayload

public final boolean supportsRequestPayload()

Description copied from interface: HttpMethod

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 HttpMethod.GET, HttpMethod.HEAD, HttpMethod.DELETE and HttpMethod.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.

Specified by:

supportsRequestPayload in interface HttpMethod

Returns:

true if this method supports a message body, false otherwise.

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object