Class OptionsMethod

java.lang.Object
org.apache.commons.httpclient.HttpMethodBase
org.apache.commons.httpclient.methods.OptionsMethod
All Implemented Interfaces:
HttpMethod
public class OptionsMethod extends HttpMethodBase
Implements the HTTP OPTIONS method.

The HTTP OPTIONS method is defined in section 9.2 of RFC2616:

The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.

Since:
1.0
Version:
$Revision: 480424 $
Author:
Remy Maucherat, Mike Bowler, Jeff Dever

  • Constructor Details

    • OptionsMethod

      public OptionsMethod()
      Method constructor.
      Since:
      1.0

    • OptionsMethod

      public OptionsMethod(String uri)
      Constructor specifying a URI.
      Parameters:
      uri - either an absolute or relative URI
      Since:
      1.0

  • Method Details

    • getName

      public String getName()
      Get the name.
      Specified by:
      getName in interface HttpMethod
      Specified by:
      getName in class HttpMethodBase
      Returns:
      "OPTIONS"
      Since:
      2.0

    • isAllowed

      public boolean isAllowed(String method)
      Is the specified method allowed ?
      Parameters:
      method - The method to check.
      Returns:
      true if the specified method is allowed.
      Since:
      1.0

    • getAllowedMethods

      public Enumeration getAllowedMethods()
      Get a list of allowed methods.
      Returns:
      An enumeration of all the allowed methods.
      Since:
      1.0

    • processResponseHeaders

      protected void processResponseHeaders(HttpState state, HttpConnection conn)

      This implementation will parse the Allow header to obtain the set of methods supported by the resource identified by the Request-URI.

      Overrides:
      processResponseHeaders in class HttpMethodBase
      Parameters:
      state - the state information associated with this method
      conn - the connection used to execute this HTTP method
      Since:
      2.0
      See Also:

    • needContentLength

      public boolean needContentLength()
      Deprecated.
      only entity enclosing methods set content length header
      Return true if the method needs a content-length header in the request.
      Returns:
      true if a content-length header will be expected by the server
      Since:
      1.0