Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> webdav >> lib >> [ methods overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

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:

DepthSupport, org.apache.commons.httpclient.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
private  int	depth
static int	PRINCIPAL_PROPERTY_SEARCH
private  PropertyBodyHelper	propertyBodyHelper
private  int	reportType

 

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

builder, decodeResponseHrefs, responseURLs

 

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

 

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

 

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(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)           Generate additional headers needed by the request.
private  void	generatePrincipalPropertySearchBody(org.apache.webdav.lib.util.XMLPrinter printer)           Generate the body for a principal-property-search report.
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()           Obtains the name of the HTTP method as used in the HTTP request line, for example "GET" or "POST".
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) 55 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, 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

 

Field Detail

PRINCIPAL_PROPERTY_SEARCH

public static final int PRINCIPAL_PROPERTY_SEARCH

See Also:

Constant Field Values

---

propertyBodyHelper

private PropertyBodyHelper propertyBodyHelper

---

depth

private int depth

---

reportType

private int reportType

Constructor Detail

AclReportMethod

public AclReportMethod(java.lang.String path,
                       java.util.Collection propertyNames,
                       int depth,
                       int reportType)

Method Detail

getName

public java.lang.String getName()

Description copied from class: org.apache.commons.httpclient.HttpMethodBase

Obtains the name of the HTTP method as used in the HTTP request line, for example "GET" or "POST".

Specified by:

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

---

setDepth

public void setDepth(int depth)

Description copied from interface: DepthSupport

Depth setter.

Specified by:

setDepth in interface DepthSupport

---

getDepth

public int getDepth()

Description copied from interface: DepthSupport

Depth getter.

Specified by:

getDepth in interface DepthSupport

---

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) 55 as appropriate.

Specified by:

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

---

addRequestHeaders

public void addRequestHeaders(org.apache.commons.httpclient.HttpState state,
                              org.apache.commons.httpclient.HttpConnection conn)
                       throws java.io.IOException,
                              org.apache.commons.httpclient.HttpException

Generate additional headers needed by the request.

---

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

---

generatePrincipalPropertySearchBody

private void generatePrincipalPropertySearchBody(org.apache.webdav.lib.util.XMLPrinter printer)

Generate the body for a principal-property-search report. Currently the section is constant.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> webdav >> lib >> [ methods overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---