Package org.apache.webdav.lib.methods

Class AclReportMethod

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

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod, DepthSupport

public class AclReportMethod
extends XMLResponseMethodBase
implements DepthSupport

WebDAV Report method This class is used to send an report from the ACL specification. In this version only the principal-property-search is supported.

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
static final int	PRINCIPAL_PROPERTY_SEARCH

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	Description
AclReportMethod(String path, Collection propertyNames, int depth, int reportType)

Method Summary

Modifier and Type	Method	Description
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.
int	getDepth()	Depth getter.
String	getName()
void	setDepth(int depth)	Depth setter.
void	setRequestHeader(String headerName, String headerValue)	Set a header value, redirecting the special case of header "Depth" to setDepth(int) as appropriate.

Methods inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

convertElementToProperty, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponses, getResponseURLs, parseResponse, 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, 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

PRINCIPAL_PROPERTY_SEARCH

public static final int PRINCIPAL_PROPERTY_SEARCH

See Also:

• Constant Field Values

Constructor Details

AclReportMethod

public AclReportMethod(String path,
 Collection propertyNames,
 int depth,
 int reportType)

Parameters:

path -

propertyNames - requested properties

depth -

reportType - - one of the supported report types

Method Details

getName

public String getName()

Specified by:

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

Specified by:

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

See Also:

• HttpMethod.getName()

setDepth

public void setDepth(int depth)

Description copied from interface: DepthSupport

Depth setter.

Specified by:

setDepth in interface DepthSupport

Parameters:

depth - New depth value

See Also:

• DepthSupport.setDepth(int)

getDepth

public int getDepth()

Description copied from interface: DepthSupport

Depth getter.

Specified by:

getDepth in interface DepthSupport

Returns:

int depth value

See Also:

• DepthSupport.getDepth()

setRequestHeader

public void setRequestHeader(String headerName,
 String headerValue)

Set a header value, redirecting the special case of header "Depth" to setDepth(int) as appropriate.

Specified by:

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

Overrides:

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

Parameters:

headerName - Header name

headerValue - Header value

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 being used for the request.

Throws:

IOException

org.apache.commons.httpclient.HttpException

generateRequestBody

protected String generateRequestBody()

Description copied from class: XMLResponseMethodBase

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

See Also:

• XMLResponseMethodBase.generateRequestBody()