org.apache.webdav.lib.methods
Class PropPatchMethod

java.lang.Object
  |
  +--org.apache.commons.httpclient.HttpMethodBase
        |
        +--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.

Author:
Remy Maucherat, B.C. Holmes, Robert Owen, Dirk Verbeeck

Inner classes inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
XMLResponseMethodBase.Response, XMLResponseMethodBase.ResponseWithinMultistatus, XMLResponseMethodBase.SingleResponse
 
Field Summary
protected  java.util.Hashtable toRemove
          Hashtable of the properties to remove.
protected  java.util.Hashtable toSet
          Hashtable of the properties to set.
 
Fields inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
builder
 
Fields inherited from class org.apache.commons.httpclient.HttpMethodBase
debug, followRedirects, name, parameters, path, query, queryString, requestHeaders, responseHeaders, state, statusCode, statusText
 
Fields inherited from interface org.apache.commons.httpclient.HttpMethod
PROTOCOL
 
Constructor Summary
PropPatchMethod()
          Method constructor.
PropPatchMethod(java.lang.String path)
          Method constructor.
 
Method Summary
 void addPropertyToRemove(java.lang.String name)
          Add property to remove.
 void addPropertyToRemove(java.lang.String name, java.lang.String namespace, java.lang.String namespaceInfo)
          Add property to remove.
 void addPropertyToSet(java.lang.String name, java.lang.String value)
          Add a new property to set.
 void addPropertyToSet(java.lang.String name, java.lang.String value, java.lang.String namespace, java.lang.String namespaceInfo)
          Add a new property to set.
 void generateHeaders(java.lang.String host, org.apache.commons.httpclient.State state)
          Generate additional headers needed by the request.
 java.lang.String generateQuery()
          Generate the query body.
 
Methods inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
convertElementToProperty, getResponseDocument, getResponseHashtable, getResponses, getState, parseResponse, parseXMLResponse, recycle
 
Methods inherited from class org.apache.commons.httpclient.HttpMethodBase
checkNotUsed, checkUsed, followRedirects, generateHeaders, generateRequestLine, generateRequestLine, getHeader, getHeaders, getHeadersHashtable, getName, getPath, getStatusCode, getStatusText, hasBeenUsed, hasResponseBody, isStreamedQuery, needContentLength, needExpectation, processResponseHeaders, removeHeader, setDebug, setFollowRedirects, setHeader, setParameter, setPath, setQuery, setQueryString, setState, setStatusCode, setStatusText, setUsed, streamQuery, validate
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

toSet

protected java.util.Hashtable toSet
Hashtable of the properties to set.

toRemove

protected java.util.Hashtable toRemove
Hashtable of the properties to remove.
Constructor Detail

PropPatchMethod

public PropPatchMethod()
Method constructor.

PropPatchMethod

public PropPatchMethod(java.lang.String path)
Method constructor.
Method Detail

addPropertyToSet

public void addPropertyToSet(java.lang.String name,
                             java.lang.String value)
Add a new property to set.
Parameters:
name - Property name
value - Property value

addPropertyToSet

public void addPropertyToSet(java.lang.String name,
                             java.lang.String value,
                             java.lang.String namespace,
                             java.lang.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(java.lang.String name)
Add property to remove.
Parameters:
name - Property name

addPropertyToRemove

public void addPropertyToRemove(java.lang.String name,
                                java.lang.String namespace,
                                java.lang.String namespaceInfo)
Add property to remove.
Parameters:
name - Property name
namespace - Namespace abbreviation
namespaceInfo - Namespace information

generateHeaders

public void generateHeaders(java.lang.String host,
                            org.apache.commons.httpclient.State state)
Generate additional headers needed by the request.
Overrides:
generateHeaders in class org.apache.commons.httpclient.HttpMethodBase
Parameters:
host - the host
state - State token

generateQuery

public java.lang.String generateQuery()
Generate the query body.
Overrides:
generateQuery in class org.apache.commons.httpclient.HttpMethodBase
Returns:
String query