Package org.apache.webdav.lib.methods

Class OptionsMethod

java.lang.Object

org.apache.commons.httpclient.HttpMethodBase

org.apache.webdav.lib.methods.HttpRequestBodyMethodBase

org.apache.webdav.lib.methods.XMLResponseMethodBase

org.apache.webdav.lib.methods.OptionsMethod

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod

public class OptionsMethod
extends XMLResponseMethodBase

OPTIONS Method.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

XMLResponseMethodBase.OptionsResponse, XMLResponseMethodBase.Response, XMLResponseMethodBase.ResponseWithinMultistatus, XMLResponseMethodBase.SingleResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACL	ACL.
static final String	ADVANCED_COLLECTIONS	Advanced collections.
static final String	DASL	DASL.
static final String	DAV_LEVEL1	DAV level 1.
static final String	DAV_LEVEL2	DAV level 2.
static final String	DELTAV	Delta V.
static final int	OPTIONS_VERSION_HISTORY
static final int	OPTIONS_WORKSPACE

Fields inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

builder, decodeResponseHrefs, responseURLs

Fields inherited from class org.apache.commons.httpclient.HttpMethodBase

effectiveVersion, statusLine

Constructor Summary

Constructors

Constructor	Description
OptionsMethod()	Method constructor.
OptionsMethod(String path)	Method constructor.
OptionsMethod(String path, int type)	Method constructor.

Method Summary

Modifier and Type	Method	Description
void	addRequestHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)
protected String	generateRequestBody()	DAV requests that contain a body must override this function to generate that body.
Enumeration	getAllowedMethods()	Get a list of allowed methods.
Enumeration	getAllResponseURLs()	This method returns an enumeration of URL paths.
Enumeration	getDavCapabilities()	Get a list of supported DAV capabilities.
String	getName()
Enumeration	getResponseProperties()
boolean	isAllowed(String method)	Is the specified method allowed ?
boolean	isSupported(String capability)	Is DAV capability supported ?
void	parseResponse(InputStream input, org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)	Parse response.
protected Document	parseResponseContent(InputStream is)
void	processResponseHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)	Process response headers.

Methods inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

convertElementToProperty, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponses, getResponseURLs, parseXMLResponse, readResponseBody, recycle, setDebug, setDecodeResponseHrefs, setDocument, setResponseHashtable, writeRequestBody

Methods inherited from class org.apache.webdav.lib.methods.HttpRequestBodyMethodBase

isRequestContentAlreadySet, readContinueCode, setRequestBody, setRequestBody, setRequestBody, setRequestBody, setRequestBody

Methods inherited from class org.apache.commons.httpclient.HttpMethodBase

abort, addCookieRequestHeader, addHostRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, execute, generateRequestLine, getAuthenticationRealm, getContentCharSet, getDoAuthentication, getEffectiveVersion, getFollowRedirects, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getParams, getPath, getProxyAuthenticationRealm, getProxyAuthState, getQueryString, getRecoverableExceptionCount, getRequestCharSet, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isConnectionCloseForced, isHttp11, isRequestSent, isStrictMode, processCookieHeaders, processResponseBody, processStatusLine, readResponse, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setFollowRedirects, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setResponseStream, setStrictMode, setURI, shouldCloseConnection, validate, writeRequest, writeRequestHeaders, writeRequestLine

Methods inherited from class java.lang.Object

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

Field Details

DAV_LEVEL1

public static final String DAV_LEVEL1

DAV level 1. Mandatory.

See Also:

• Constant Field Values

DAV_LEVEL2

public static final String DAV_LEVEL2

DAV level 2.

See Also:

• Constant Field Values

ADVANCED_COLLECTIONS

public static final String ADVANCED_COLLECTIONS

Advanced collections.

See Also:

• Constant Field Values

DELTAV

public static final String DELTAV

Delta V.

See Also:

• Constant Field Values

ACL

public static final String ACL

ACL.

See Also:

• Constant Field Values

DASL

public static final String DASL

DASL.

See Also:

• Constant Field Values

OPTIONS_WORKSPACE

public static final int OPTIONS_WORKSPACE

See Also:

• Constant Field Values

OPTIONS_VERSION_HISTORY

public static final int OPTIONS_VERSION_HISTORY

See Also:

• Constant Field Values

Constructor Details

OptionsMethod

public OptionsMethod()

Method constructor.

OptionsMethod

public OptionsMethod(String path)

Method constructor.

OptionsMethod

public OptionsMethod(String path,
 int type)

Method constructor.

Method Details

isAllowed

public boolean isAllowed(String method)

Is the specified method allowed ?

getAllowedMethods

public Enumeration getAllowedMethods()

Get a list of allowed methods.

isSupported

public boolean isSupported(String capability)

Is DAV capability supported ?

getDavCapabilities

public Enumeration getDavCapabilities()

Get a list of supported DAV capabilities.

parseResponse

public void parseResponse(InputStream input,
 org.apache.commons.httpclient.HttpState state,
 org.apache.commons.httpclient.HttpConnection conn)
                   throws IOException,
org.apache.commons.httpclient.HttpException

Parse response.

Overrides:

parseResponse in class XMLResponseMethodBase

Parameters:

input - Input stream

Throws:

IOException

org.apache.commons.httpclient.HttpException

processResponseHeaders

public void processResponseHeaders(org.apache.commons.httpclient.HttpState state,
 org.apache.commons.httpclient.HttpConnection conn)

Process response headers. The contract of this method is that it only parses the response headers.

Overrides:

processResponseHeaders in class org.apache.commons.httpclient.HttpMethodBase

Parameters:

state - the state

conn - the connection

generateRequestBody

protected String generateRequestBody()

DAV requests that contain a body must override this function to generate that body.

The default behavior simply returns an empty body.

Overrides:

generateRequestBody in class XMLResponseMethodBase

getName

public String getName()

Specified by:

getName in interface org.apache.commons.httpclient.HttpMethod

Specified by:

getName in class org.apache.commons.httpclient.HttpMethodBase

addRequestHeaders

public void addRequestHeaders(org.apache.commons.httpclient.HttpState state,
 org.apache.commons.httpclient.HttpConnection conn)
                       throws IOException,
org.apache.commons.httpclient.HttpException

Overrides:

addRequestHeaders in class org.apache.commons.httpclient.HttpMethodBase

Throws:

IOException

org.apache.commons.httpclient.HttpException

getAllResponseURLs

public Enumeration getAllResponseURLs()

This method returns an enumeration of URL paths. If the PropFindMethod was sent to the URL of a collection, then there will be multiple URLs. The URLs are picked out of the <D:href> elements of the response.

Returns:

an enumeration of URL paths as Strings

getResponseProperties

public Enumeration getResponseProperties()

parseResponseContent

protected Document parseResponseContent(InputStream is)
                                 throws ParserConfigurationException,
SAXException,
IOException

Throws:

ParserConfigurationException

SAXException

IOException