org.apache.webdav.lib.methods
Class ReportMethod
- DepthSupport
public class ReportMethod
This class implements the WebDAV REPORT Method.
The REPORT method retrieves properties defined on the resource
identified by the Request-URI, if the resource does not have any internal
members, or on the resource identified by the Request-URI and potentially
its member resources, if the resource is a collection that has internal
member URIs.
A typical request looks like this:
ReportMethod() - Method constructor.
|
ReportMethod(String path) - Method constructor.
|
ReportMethod(String path, Enumeration propertyNames) - Method constructor.
|
ReportMethod(String path, int depth) - Method constructor.
|
ReportMethod(String path, int depth, Enumeration propertyNames) - Method constructor.
|
ReportMethod(String path, int depth, Enumeration propertyNames, Enumeration histUrl) - Method constructor.
|
ReportMethod(String path, int depth, String sBody)
|
convertElementToProperty , generateRequestBody , getDebug , getRequestContentLength , getResponseDocument , getResponseHashtable , getResponseURLs , getResponses , parseResponse , parseXMLResponse , readResponseBody , recycle , setDebug , setDecodeResponseHrefs , setDocument , setResponseHashtable , writeRequestBody |
ALL
public static final int ALL
Request of all properties name and value.
LOCATE_HISTORY
public static final int LOCATE_HISTORY
SUB_SET
public static final int SUB_SET
Request specified properties.
depth
protected int depth
Depth.
prefix
protected String prefix
The namespace abbreviation that prefixes DAV tags
propertyNames
protected PropertyName[] propertyNames
Property name list.
sVersionHistory
public String sVersionHistory
type
protected int type
Type of the Propfind.
ReportMethod
public ReportMethod()
Method constructor.
ReportMethod
public ReportMethod(String path)
Method constructor.
ReportMethod
public ReportMethod(String path,
Enumeration propertyNames)
Method constructor.
ReportMethod
public ReportMethod(String path,
int depth)
Method constructor.
ReportMethod
public ReportMethod(String path,
int depth,
Enumeration propertyNames)
Method constructor.
ReportMethod
public ReportMethod(String path,
int depth,
Enumeration propertyNames,
Enumeration histUrl)
Method constructor.
ReportMethod
public ReportMethod(String path,
int depth,
String sBody)
addRequestHeaders
public void addRequestHeaders(HttpState state,
HttpConnection conn)
throws IOException,
HttpException
Generate additional headers needed by the request.
state
- State tokenconn
- The connection being used to make the request.
generateRequestBody
protected String generateRequestBody()
DAV requests that contain a body must override this function to
generate that body.
The default behavior simply returns an empty body.
- generateRequestBody in interface XMLResponseMethodBase
getAllResponseURLs
public Enumeration getAllResponseURLs()
This method returns an enumeration of URL paths. If the ReportMethod
was sent to the URL of a collection, then there will be multiple URLs.
The URLs are picked out of the <D:href>
elements
of the response.
- an enumeration of URL paths as Strings
getName
public String getName()
getResponseProperties
public Enumeration getResponseProperties(String urlPath)
Returns an enumeration of Property
objects.
getType
public int getType()
Type getter.
setHistoryURLs
public void setHistoryURLs(Enumeration historyURLs)
sets History URL for locate by history Report
setPropertyNames
public void setPropertyNames(Enumeration propertyNames)
Property names setter.
The enumeration may contain strings with or without a namespace prefix
but the preferred way is to provide PropertyName objects.
propertyNames
- List of the property names
setRequestHeader
public void setRequestHeader(String headerName,
String headerValue)
Set a header value, redirecting attempts to set the "Depth" header to
a
setDepth(int)
call.
headerName
- Header nameheaderValue
- Header value
setType
public void setType(int type)
Type setter.