|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.webdav.lib.methods.WebdavMethodBase | +--org.apache.webdav.lib.methods.XMLResponseMethodBase | +--org.apache.webdav.lib.methods.PropFindMethod
This class implements the WebDAV PROPFIND Method.
The PROPFIND 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:
PROPFIND /file HTTP/1.1 Host: www.foo.bar Content-type: text/xml; charset="utf-8" Content-Length: xxxx <?xml version="1.0" encoding="utf-8" ?> <D:propfind xmlns:D="DAV:"> <D:prop xmlns:R="http://www.foo.bar/boxschema/"> <R:bigbox/> <R:author/> <R:DingALing/> <R:Random/> </D:prop> </D:propfind>
Inner classes inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase |
XMLResponseMethodBase.GetLastModifiedPropertyImpl, XMLResponseMethodBase.PropertyImpl, XMLResponseMethodBase.ResourceTypePropertyImpl, XMLResponseMethodBase.Response, XMLResponseMethodBase.ResponseWithinMultistatus, XMLResponseMethodBase.SingleResponse |
Field Summary | |
static int |
ALL
Request of all properties name and value. |
static int |
BY_NAME
Request of named properties. |
static int |
NAMES
Request of all properties name. |
Fields inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase |
builder |
Fields inherited from class org.apache.webdav.lib.methods.WebdavMethodBase |
debug, headers, name, path, query, state, statusCode, statusText |
Fields inherited from interface org.apache.webdav.lib.methods.DepthSupport |
DEPTH_0, DEPTH_1, DEPTH_INFINITY |
Fields inherited from interface org.apache.webdav.lib.methods.WebdavMethod |
PROTOCOL |
Constructor Summary | |
PropFindMethod()
Method constructor. |
|
PropFindMethod(java.lang.String path)
Method constructor. |
|
PropFindMethod(java.lang.String path,
java.util.Enumeration propertyNames)
Method constructor. |
|
PropFindMethod(java.lang.String path,
int depth)
Method constructor. |
|
PropFindMethod(java.lang.String path,
int depth,
int type)
Method constructor. |
Method Summary | |
void |
generateHeaders(java.lang.String host,
State state)
Generate additional headers needed by the request. |
java.lang.String |
generateQuery()
Generate the query body. |
java.util.Enumeration |
getAllResponseURLs()
This method returns an enumeration of URL paths. |
int |
getDepth()
Depth getter. |
java.util.Enumeration |
getResponseProperties(java.lang.String urlPath)
Returns an enumeration of Property objects. |
int |
getType()
Type getter. |
void |
recycle()
Reset the State of the class to its initial state, so that it can be used again. |
void |
setDepth(int depth)
Depth setter. |
void |
setPropertyNames(java.util.Enumeration propertyNames)
Property names setter. |
void |
setType(int type)
Type setter. |
Methods inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase |
convertElementToProperty, getResponseDocument, getResponseHashtable, getResponses, parseResponse, parseXMLResponse |
Methods inherited from class org.apache.webdav.lib.methods.WebdavMethodBase |
checkNotUsed, checkUsed, followRedirects, generateHeaders, generateRequestLine, getHeader, getHeaders, getName, getPath, getStatusCode, getStatusText, hasBeenUsed, isStreamedQuery, processResponseHeaders, removeHeader, setDebug, setHeader, setPath, setQuery, setStatusCode, setStatusText, setUsed, streamQuery, validate |
Methods inherited from class java.lang.Object |
|
Field Detail |
public static final int BY_NAME
public static final int ALL
public static final int NAMES
Constructor Detail |
public PropFindMethod()
public PropFindMethod(java.lang.String path)
public PropFindMethod(java.lang.String path, int depth)
public PropFindMethod(java.lang.String path, int depth, int type)
public PropFindMethod(java.lang.String path, java.util.Enumeration propertyNames)
Method Detail |
public void setType(int type)
type
- New type valuepublic int getType()
public void setDepth(int depth)
setDepth
in interface DepthSupport
depth
- New depth valuepublic int getDepth()
getDepth
in interface DepthSupport
public void setPropertyNames(java.util.Enumeration propertyNames)
propertyNames
- List of the property namespublic void recycle()
XMLResponseMethodBase
recycle
in class XMLResponseMethodBase
public void generateHeaders(java.lang.String host, State state)
generateHeaders
in class WebdavMethodBase
host
- the hoststate
- State tokenpublic java.lang.String generateQuery()
generateQuery
in class WebdavMethodBase
public java.util.Enumeration getAllResponseURLs()
<D:href>
elements
of the response.public java.util.Enumeration getResponseProperties(java.lang.String urlPath)
Property
objects.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |