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:
- 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.
Constructor Summary |
AclReportMethod(java.lang.String path,
java.util.Collection propertyNames,
int depth,
int reportType)
|
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.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, getResponseBodyAsStream, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isConnectionCloseForced, isHttp11, isRequestSent, isStrictMode, 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 |
PRINCIPAL_PROPERTY_SEARCH
public static final int PRINCIPAL_PROPERTY_SEARCH
- See Also:
- Constant Field Values
AclReportMethod
public AclReportMethod(java.lang.String path,
java.util.Collection propertyNames,
int depth,
int reportType)
- Parameters:
path
- propertyNames
- requested propertiesdepth
- reportType
- - one of the supported report types
getName
public java.lang.String getName()
- Specified by:
getName
in interface HttpMethod
- Specified by:
getName
in class 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(java.lang.String headerName,
java.lang.String headerValue)
- Set a header value, redirecting the special case of header "Depth" to
setDepth(int)
as appropriate.
- Specified by:
setRequestHeader
in interface HttpMethod
- Overrides:
setRequestHeader
in class HttpMethodBase
- Parameters:
headerName
- Header nameheaderValue
- Header value
addRequestHeaders
public void addRequestHeaders(HttpState state,
HttpConnection conn)
throws java.io.IOException,
HttpException
- Generate additional headers needed by the request.
- Overrides:
addRequestHeaders
in class HttpMethodBase
- Parameters:
state
- State tokenconn
- The connection being used for the request.
- Throws:
java.io.IOException
HttpException
generateRequestBody
protected java.lang.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()