public class MultiStatusResponse extends Object implements XmlSerializable, DavConstants
MultiStatusResponse
represents the DAV:multistatus element defined
by RFC 2518:
<!ELEMENT response (href, ((href*, status)|(propstat+)), responsedescription?) > <!ELEMENT status (#PCDATA) > <!ELEMENT propstat (prop, status, responsedescription?) > <!ELEMENT responsedescription (#PCDATA) > <!ELEMENT prop ANY >
creationDateFormat, DEPTH_0, DEPTH_1, DEPTH_INFINITY, DEPTH_INFINITY_S, HEADER_AUTHORIZATION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_DAV, HEADER_DEPTH, HEADER_DESTINATION, HEADER_ETAG, HEADER_IF, HEADER_LAST_MODIFIED, HEADER_LOCK_TOKEN, HEADER_OVERWRITE, HEADER_TIMEOUT, INFINITE_TIMEOUT, modificationDateFormat, NAMESPACE, OPAQUE_LOCK_TOKEN_PREFIX, PROPERTY_CREATIONDATE, PROPERTY_DISPLAYNAME, PROPERTY_GETCONTENTLANGUAGE, PROPERTY_GETCONTENTLENGTH, PROPERTY_GETCONTENTTYPE, PROPERTY_GETETAG, PROPERTY_GETLASTMODIFIED, PROPERTY_LOCKDISCOVERY, PROPERTY_RESOURCETYPE, PROPERTY_SOURCE, PROPERTY_SUPPORTEDLOCK, PROPFIND_ALL_PROP, PROPFIND_ALL_PROP_INCLUDE, PROPFIND_BY_PROPERTY, PROPFIND_PROPERTY_NAMES, TIMEOUT_INFINITE, UNDEFINED_TIME, UNDEFINED_TIMEOUT, XML_ACTIVELOCK, XML_ALLPROP, XML_COLLECTION, XML_DEPTH, XML_DST, XML_EXCLUSIVE, XML_HREF, XML_INCLUDE, XML_KEEPALIVE, XML_LINK, XML_LOCKENTRY, XML_LOCKINFO, XML_LOCKROOT, XML_LOCKSCOPE, XML_LOCKTOKEN, XML_LOCKTYPE, XML_MULTISTATUS, XML_OMIT, XML_OWNER, XML_PROP, XML_PROPERTYBEHAVIOR, XML_PROPERTYUPDATE, XML_PROPFIND, XML_PROPNAME, XML_PROPSTAT, XML_REMOVE, XML_RESPONSE, XML_RESPONSEDESCRIPTION, XML_SET, XML_SHARED, XML_SOURCE, XML_STATUS, XML_TIMEOUT, XML_WRITE
Constructor and Description |
---|
MultiStatusResponse(DavResource resource,
DavPropertyNameSet propNameSet)
Constructs a WebDAV multistatus response and retrieves the resource
properties according to the given
DavPropertyNameSet . |
MultiStatusResponse(DavResource resource,
DavPropertyNameSet propNameSet,
int propFindType)
Constructs a WebDAV multistatus response and retrieves the resource
properties according to the given
DavPropertyNameSet . |
MultiStatusResponse(String href,
int statusCode)
Constructs an WebDAV multistatus response for a given resource.
|
MultiStatusResponse(String href,
int statusCode,
String responseDescription)
Constructs an WebDAV multistatus response for a given resource.
|
MultiStatusResponse(String href,
Status status,
String responseDescription)
Constructs an WebDAV multistatus response
|
MultiStatusResponse(String href,
String responseDescription)
Constructs an empty WebDAV multistatus response of type 'PropStat'
|
Modifier and Type | Method and Description |
---|---|
void |
add(DavProperty<?> property)
Adds a property to this response '200' propstat set.
|
void |
add(DavProperty<?> property,
int status)
Adds a property to this response
|
void |
add(DavPropertyName propertyName)
Adds a property name to this response '200' propstat set.
|
void |
add(DavPropertyName propertyName,
int status)
Adds a property name to this response
|
static MultiStatusResponse |
createFromXml(Element responseElement)
Build a new response object from the given xml element.
|
String |
getHref()
Returns the href
|
DavPropertySet |
getProperties(int status)
Get properties present in this response for the given status code.
|
DavPropertyNameSet |
getPropertyNames(int status)
Get property names present in this response for the given status code.
|
String |
getResponseDescription() |
Status[] |
getStatus()
Return an array listing all 'status' available is this response object.
|
boolean |
isPropStat() |
Element |
toXml(Document document)
Returns the xml representation of the implementing object as
Element . |
public MultiStatusResponse(String href, Status status, String responseDescription)
href
- status
- responseDescription
- public MultiStatusResponse(String href, int statusCode)
null
.href
- statusCode
- public MultiStatusResponse(String href, int statusCode, String responseDescription)
href
- statusCode
- responseDescription
- public MultiStatusResponse(String href, String responseDescription)
public MultiStatusResponse(DavResource resource, DavPropertyNameSet propNameSet)
DavPropertyNameSet
.resource
- propNameSet
- public MultiStatusResponse(DavResource resource, DavPropertyNameSet propNameSet, int propFindType)
DavPropertyNameSet
. It
adds all known property to the '200' set, while unknown properties are
added to the '404' set.
Note, that the set of property names is ignored in case of a DavConstants.PROPFIND_ALL_PROP
and DavConstants.PROPFIND_PROPERTY_NAMES
propFindType.
resource
- The resource to retrieve the property frompropNameSet
- The property name set as obtained from the request
body.propFindType
- any of the following values: DavConstants.PROPFIND_ALL_PROP
, DavConstants.PROPFIND_BY_PROPERTY
, DavConstants.PROPFIND_PROPERTY_NAMES
, DavConstants.PROPFIND_ALL_PROP_INCLUDE
public String getResponseDescription()
getResponseDescription()
public Status[] getStatus()
MultiStatusResponse
defines an response consisting of
href and status elements.public boolean isPropStat()
true
if the response is of type "propstat" (containing information about individual properties)public Element toXml(Document document)
XmlSerializable
Element
. The given Document
is used
as factory and represents the owner document
of the returned DOM element.toXml
in interface XmlSerializable
document
- XmlSerializable.toXml(org.w3c.dom.Document)
public void add(DavProperty<?> property)
property
- the property to addpublic void add(DavPropertyName propertyName)
propertyName
- the property name to addpublic void add(DavProperty<?> property, int status)
property
- the property to addstatus
- the status of the response set to selectpublic void add(DavPropertyName propertyName, int status)
propertyName
- the property name to addstatus
- the status of the response set to selectpublic DavPropertySet getProperties(int status)
DavPropertySet
will be returned.status
- public DavPropertyNameSet getPropertyNames(int status)
DavPropertyNameSet
will be returned.status
- public static MultiStatusResponse createFromXml(Element responseElement)
responseElement
- MultiStatusResponse
instanceIllegalArgumentException
- if the specified element is
null
or not a DAV:response element or if the mandatory
DAV:href child is missing.Copyright © 2004–2021 The Apache Software Foundation. All rights reserved.