org.apache.webdav.lib.methods

Class AclReportMethod

Implemented Interfaces:
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

static int
PRINCIPAL_PROPERTY_SEARCH

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

builder, decodeResponseHrefs, responseURLs

Fields inherited from interface org.apache.webdav.lib.methods.DepthSupport

DEPTH_0, DEPTH_1, DEPTH_INFINITY

Constructor Summary

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

Method Summary

void
addRequestHeaders(HttpState state, HttpConnection conn)
Generate additional headers needed by the request.
protected String
generateRequestBody()
int
getDepth()
String
getName()
void
setDepth(int depth)
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, generateRequestBody, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponseURLs, getResponses, parseResponse, parseXMLResponse, readResponseBody, recycle, setDebug, setDecodeResponseHrefs, setDocument, setResponseHashtable, writeRequestBody

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

getRequestContentLength, isRequestContentAlreadySet, readContinueCode, recycle, setRequestBody, setRequestBody, setRequestBody, setRequestBody, setRequestBody, writeRequestBody

Field Details

PRINCIPAL_PROPERTY_SEARCH

public static final int PRINCIPAL_PROPERTY_SEARCH
Field Value:
1

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

addRequestHeaders

public void addRequestHeaders(HttpState state,
                              HttpConnection conn)
            throws IOException,
                   HttpException
Generate additional headers needed by the request.
Parameters:
state - State token
conn - The connection being used for the request.

generateRequestBody

protected String generateRequestBody()
Overrides:
generateRequestBody in interface XMLResponseMethodBase

getDepth

public int getDepth()
Specified by:
getDepth in interface DepthSupport

getName

public String getName()

setDepth

public void setDepth(int depth)
Specified by:
setDepth in interface DepthSupport

setRequestHeader

public void setRequestHeader(String headerName,
                             String headerValue)
Parameters:
headerName - Header name
headerValue - Header value