org.apache.jackrabbit.webdav.client.methods

Class PropPatchMethod

java.lang.Object

org.apache.commons.httpclient.HttpMethodBase

org.apache.commons.httpclient.methods.ExpectContinueMethod

org.apache.commons.httpclient.methods.EntityEnclosingMethod

org.apache.jackrabbit.webdav.client.methods.DavMethodBase

org.apache.jackrabbit.webdav.client.methods.PropPatchMethod

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod, DavMethod, DavConstants

public class PropPatchMethod
extends DavMethodBase
implements DavConstants

PropPatchMethod...

Field Summary

Fields inherited from class org.apache.commons.httpclient.methods.EntityEnclosingMethod

CONTENT_LENGTH_AUTO, CONTENT_LENGTH_CHUNKED

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

effectiveVersion, statusLine

Fields inherited from interface org.apache.jackrabbit.webdav.DavConstants

creationDateFormat, DEPTH_0, DEPTH_1, DEPTH_INFINITY, DEPTH_INFINITY_S, HEADER_AUTHORIZATION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_DAV, HEADER_DEPTH, HEADER_DESTINATION, HEADER_ETAG, HEADER_IF, HEADER_LAST_MODIFIED, HEADER_LOCK_TOKEN, HEADER_OVERWRITE, HEADER_TIMEOUT, INFINITE_TIMEOUT, modificationDateFormat, NAMESPACE, OPAQUE_LOCK_TOKEN_PREFIX, PROPERTY_CREATIONDATE, PROPERTY_DISPLAYNAME, PROPERTY_GETCONTENTLANGUAGE, PROPERTY_GETCONTENTLENGTH, PROPERTY_GETCONTENTTYPE, PROPERTY_GETETAG, PROPERTY_GETLASTMODIFIED, PROPERTY_LOCKDISCOVERY, PROPERTY_RESOURCETYPE, PROPERTY_SOURCE, PROPERTY_SUPPORTEDLOCK, PROPFIND_ALL_PROP, PROPFIND_ALL_PROP_INCLUDE, PROPFIND_BY_PROPERTY, PROPFIND_PROPERTY_NAMES, TIMEOUT_INFINITE, UNDEFINED_TIME, UNDEFINED_TIMEOUT, XML_ACTIVELOCK, XML_ALLPROP, XML_COLLECTION, XML_DEPTH, XML_DST, XML_EXCLUSIVE, XML_HREF, XML_INCLUDE, XML_KEEPALIVE, XML_LINK, XML_LOCKENTRY, XML_LOCKINFO, XML_LOCKROOT, XML_LOCKSCOPE, XML_LOCKTOKEN, XML_LOCKTYPE, XML_MULTISTATUS, XML_OMIT, XML_OWNER, XML_PROP, XML_PROPERTYBEHAVIOR, XML_PROPERTYUPDATE, XML_PROPFIND, XML_PROPNAME, XML_PROPSTAT, XML_REMOVE, XML_RESPONSE, XML_RESPONSEDESCRIPTION, XML_SET, XML_SHARED, XML_SOURCE, XML_STATUS, XML_TIMEOUT, XML_WRITE

Constructor Summary

Constructors

Constructor and Description
PropPatchMethod(String uri, DavPropertySet setProperties, DavPropertyNameSet removeProperties)
PropPatchMethod(String uri, List<? extends PropEntry> changeList)

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Reset method to 'abstract' in order to force subclasses to change the name (inherited value is GetMethod.getName()).
DavException	getResponseException() Builds a DavException for the status line and the DAV:error element that may be present in the response body.
protected boolean	isSuccess(int statusCode)
protected void	processMultiStatusBody(MultiStatus multiStatus, org.apache.commons.httpclient.HttpState httpState, org.apache.commons.httpclient.HttpConnection httpConnection) This method is invoked during the DavMethodBase.processResponseBody(HttpState, HttpConnection), which in this implementation parses the response body into a MultiStatus object if the status code indicates 207 (MultiStatus). Subclasses may want to override this method in order to apply specific validation of the multi-status.

Methods inherited from class org.apache.jackrabbit.webdav.client.methods.DavMethodBase

addRequestHeader, checkSuccess, getResponseBodyAsDocument, getResponseBodyAsMultiStatus, getSuccess, processResponseBody, processStatusLine, setRequestBody, setRequestBody, setRequestHeader, setSuccess, succeeded

Methods inherited from class org.apache.commons.httpclient.methods.EntityEnclosingMethod

addContentLengthRequestHeader, addRequestHeaders, clearRequestBody, generateRequestBody, generateRequestEntity, getFollowRedirects, getRequestCharSet, getRequestContentLength, getRequestEntity, hasRequestContent, recycle, setContentChunked, setFollowRedirects, setRequestBody, setRequestBody, setRequestContentLength, setRequestContentLength, setRequestEntity, writeRequestBody

Methods inherited from class org.apache.commons.httpclient.methods.ExpectContinueMethod

getUseExpectHeader, setUseExpectHeader

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, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getParams, getPath, getProxyAuthenticationRealm, getProxyAuthState, getQueryString, getRecoverableExceptionCount, 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, processResponseHeaders, readResponse, readResponseBody, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, 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

Methods inherited from interface org.apache.commons.httpclient.HttpMethod

abort, addRequestHeader, addRequestHeader, addResponseFooter, execute, getDoAuthentication, getFollowRedirects, getHostAuthState, getHostConfiguration, getParams, getPath, getProxyAuthState, getQueryString, getRequestHeader, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaders, getResponseHeaders, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isRequestSent, isStrictMode, recycle, releaseConnection, removeRequestHeader, removeRequestHeader, setDoAuthentication, setFollowRedirects, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setStrictMode, setURI, validate

Constructor Detail

PropPatchMethod

public PropPatchMethod(String uri,
               List<? extends PropEntry> changeList)
                throws IOException

Parameters:

uri -

changeList - list of DavProperty (for 'set') and DavPropertyName (for 'remove') entries.

Throws:

IOException

PropPatchMethod

public PropPatchMethod(String uri,
               DavPropertySet setProperties,
               DavPropertyNameSet removeProperties)
                throws IOException

Throws:

IOException

Method Detail

getName

public String getName()

Description copied from class: DavMethodBase

Reset method to 'abstract' in order to force subclasses to change the name (inherited value is GetMethod.getName()).

Specified by:

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

Specified by:

getName in class DavMethodBase

Returns:

Name of the method.

See Also:

HttpMethod.getName()

isSuccess

protected boolean isSuccess(int statusCode)

Specified by:

isSuccess in class DavMethodBase

Parameters:

statusCode -

Returns:

true if status code is 207 (Multi-Status). For compliance reason 200 (OK) is interpreted as successful response as well.

processMultiStatusBody

protected void processMultiStatusBody(MultiStatus multiStatus,
                          org.apache.commons.httpclient.HttpState httpState,
                          org.apache.commons.httpclient.HttpConnection httpConnection)

Description copied from class: DavMethodBase

This method is invoked during the DavMethodBase.processResponseBody(HttpState, HttpConnection), which in this implementation parses the response body into a MultiStatus object if the status code indicates 207 (MultiStatus).
Subclasses may want to override this method in order to apply specific validation of the multi-status.

This implementation does nothing.

Overrides:

processMultiStatusBody in class DavMethodBase

Parameters:

multiStatus -

httpState -

httpConnection -

See Also:

DavMethodBase.processResponseBody(HttpState, HttpConnection)

getResponseException

public DavException getResponseException()
                                  throws IOException

Description copied from interface: DavMethod

Builds a DavException for the status line and the DAV:error element that may be present in the response body. If the response does not indicate an error, null will be returned.

Specified by:

getResponseException in interface DavMethod

Overrides:

getResponseException in class DavMethodBase

Returns:

Throws:

IOException

See Also:

DavMethod.getResponseException()