org.apache.webdav.lib.methods
Class AclReportMethod

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.AclReportMethod
All Implemented Interfaces:
DepthSupport, HttpMethod

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 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, responseURLs
 
Fields inherited from class org.apache.commons.httpclient.HttpMethodBase
USER_AGENT
 
Fields inherited from interface org.apache.webdav.lib.methods.DepthSupport
DEPTH_0, DEPTH_1, DEPTH_INFINITY
 
Constructor Summary
AclReportMethod(java.lang.String path, java.util.Collection propertyNames, int depth, int reportType)
           
 
Method Summary
 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.
 int getDepth()
          Depth getter.
 java.lang.String getName()
           
 void setDepth(int depth)
          Depth setter.
 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.
 
Methods inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
convertElementToProperty, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponses, getResponseURLs, parseResponse, 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, 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

PRINCIPAL_PROPERTY_SEARCH

public static final int PRINCIPAL_PROPERTY_SEARCH
See Also:
Constant Field Values
Constructor Detail

AclReportMethod

public AclReportMethod(java.lang.String path,
                       java.util.Collection propertyNames,
                       int depth,
                       int reportType)
Parameters:
path -
propertyNames - requested properties
depth -
reportType - - one of the supported report types
Method Detail

getName

public java.lang.String getName()
Specified by:
getName in interface HttpMethod
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
Parameters:
headerName - Header name
headerValue - Header value

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 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()