org.apache.webdav.lib.methods

Class VersionControlMethod

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.VersionControlMethod

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod, DepthSupport

public class VersionControlMethod
extends XMLResponseMethodBase
implements DepthSupport

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 inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

builder, decodeResponseHrefs, responseURLs

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

effectiveVersion, statusLine

Fields inherited from interface org.apache.webdav.lib.methods.DepthSupport

DEPTH_0, DEPTH_1, DEPTH_INFINITY

Constructor Summary

Constructors

Constructor and Description
VersionControlMethod() Method constructor.
VersionControlMethod(java.lang.String path) Method constructor.
VersionControlMethod(java.lang.String path, java.lang.String sTarget)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	generateRequestBody() DAV requests that contain a body must override this function to generate that body.
int	getDepth() Depth getter.
java.lang.String	getName()
void	parseResponse(java.io.InputStream input, org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn) Parse response.
void	setDepth(int depth) Depth setter.
void	setRequestHeader(java.lang.String headerName, java.lang.String headerValue)

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, addRequestHeaders, 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, processResponseHeaders, processStatusLine, readResponse, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setFollowRedirects, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, 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

Constructor Detail

VersionControlMethod

public VersionControlMethod()

Method constructor.

VersionControlMethod

public VersionControlMethod(java.lang.String path)

Method constructor.

VersionControlMethod

public VersionControlMethod(java.lang.String path,
                    java.lang.String sTarget)

Method Detail

getDepth

public int getDepth()

Description copied from interface: DepthSupport

Depth getter.

Specified by:

getDepth in interface DepthSupport

Returns:

int depth value

setDepth

public void setDepth(int depth)

Description copied from interface: DepthSupport

Depth setter.

Specified by:

setDepth in interface DepthSupport

Parameters:

depth - New depth value

setRequestHeader

public void setRequestHeader(java.lang.String headerName,
                    java.lang.String headerValue)

Specified by:

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

Overrides:

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

getName

public java.lang.String getName()

Specified by:

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

Specified by:

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

generateRequestBody

protected java.lang.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

parseResponse

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

Parse response.

Overrides:

parseResponse in class XMLResponseMethodBase

Parameters:

input - Input stream

Throws:

java.io.IOException

org.apache.commons.httpclient.HttpException