org.apache.webdav.lib.methods
Class PropPatchMethod

java.lang.Object
  extended byorg.apache.commons.httpclient.HttpMethodBase
      extended byorg.apache.webdav.lib.methods.HttpRequestBodyMethodBase
          extended byorg.apache.webdav.lib.methods.XMLResponseMethodBase
              extended byorg.apache.webdav.lib.methods.PropPatchMethod
All Implemented Interfaces:
HttpMethod

public class PropPatchMethod
extends XMLResponseMethodBase

PROPPATCH Method.


Nested Class Summary
 
Nested classes inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
XMLResponseMethodBase.OptionsResponse, 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, responseURLs
 
Fields inherited from class org.apache.commons.httpclient.HttpMethodBase
USER_AGENT
 
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 addRequestHeaders(HttpState state, HttpConnection conn)
          Generate additional headers needed by the request.
protected  java.lang.String generateRequestBody()
          DAV requests that contain a body must override this function to generate that body.
 java.lang.String getName()
           
 void parseResponse(java.io.InputStream input, HttpState state, 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, 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
addAuthorizationRequestHeader, addContentLengthRequestHeader, addCookieRequestHeader, addHostRequestHeader, addProxyAuthorizationRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, execute, fakeResponse, generateRequestLine, getAuthenticationRealm, getContentCharSet, getDoAuthentication, getFollowRedirects, getHostConfiguration, getMethodRetryHandler, getPath, getProxyAuthenticationRealm, getQueryString, getRecoverableExceptionCount, getRequestCharSet, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isConnectionCloseForced, isHttp11, isStrictMode, processResponseBody, processResponseHeaders, processStatusLine, readResponse, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setFollowRedirects, setHostConfiguration, setHttp11, setMethodRetryHandler, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setResponseStream, setStrictMode, shouldCloseConnection, validate, writeRequest, writeRequestHeaders, writeRequestLine
 
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

getName

public java.lang.String getName()

addRequestHeaders

public void addRequestHeaders(HttpState state,
                              HttpConnection conn)
                       throws java.io.IOException,
                              HttpException
Generate additional headers needed by the request.

Parameters:
state - State token
conn - the connection
Throws:
java.io.IOException
HttpException

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,
                          HttpState state,
                          HttpConnection conn)
                   throws java.io.IOException,
                          HttpException
Parse response.

Overrides:
parseResponse in class XMLResponseMethodBase
Parameters:
input - Input stream
Throws:
java.io.IOException
HttpException