Package org.apache.webdav.lib.methods

Class PropPatchMethod

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

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod

public class PropPatchMethod
extends XMLResponseMethodBase

PROPPATCH 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
protected Hashtable	toRemove	Hashtable of the properties to remove.
protected Hashtable	toSet	Hashtable of the properties to set.

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
PropPatchMethod()	Method constructor.
PropPatchMethod(String path)	Method constructor.

Method Summary

Modifier and Type	Method	Description
void	addPropertyToRemove(String name)	Add property to remove.
void	addPropertyToRemove(String name, String namespace, String namespaceInfo)	Add property to remove.
void	addPropertyToSet(String name, String value)	Add a new property to set.
void	addPropertyToSet(String name, String value, String namespace, String namespaceInfo)	Add a new property to set.
void	addRequestHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)	Generate additional headers needed by the request.
protected String	generateRequestBody()	DAV requests that contain a body must override this function to generate that body.
String	getName()
void	parseResponse(InputStream input, org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)	Parse response.

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, processResponseHeaders, 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

toSet

protected Hashtable toSet

Hashtable of the properties to set.

toRemove

protected Hashtable toRemove

Hashtable of the properties to remove.

Constructor Details

PropPatchMethod

public PropPatchMethod()

Method constructor.

PropPatchMethod

public PropPatchMethod(String path)

Method constructor.

Method Details

addPropertyToSet

public void addPropertyToSet(String name,
 String value)

Add a new property to set.

Parameters:

name - Property name

value - Property value

addPropertyToSet

public void addPropertyToSet(String name,
 String value,
 String namespace,
 String namespaceInfo)

Add a new property to set.

Parameters:

name - Property name

value - Property value

namespace - Namespace abbreviation

namespaceInfo - Namespace information

addPropertyToRemove

public void addPropertyToRemove(String name)

Add property to remove.

Parameters:

name - Property name

addPropertyToRemove

public void addPropertyToRemove(String name,
 String namespace,
 String namespaceInfo)

Add property to remove.

Parameters:

name - Property name

namespace - Namespace abbreviation

namespaceInfo - Namespace information

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

Generate additional headers needed by the request.

Overrides:

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

Parameters:

state - State token

conn - the connection

Throws:

IOException

org.apache.commons.httpclient.HttpException

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

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