MultiStatus (Apache Maven Wagon 2.4 API)

java.lang.Object
- org.apache.jackrabbit.webdav.MultiStatus

All Implemented Interfaces:

org.apache.jackrabbit.webdav.DavConstants, org.apache.jackrabbit.webdav.xml.XmlSerializable
```
public class MultiStatus
extends Object
implements org.apache.jackrabbit.webdav.DavConstants, org.apache.jackrabbit.webdav.xml.XmlSerializable
```
MultiStatus representing the content of a multistatus response body and allows to retrieve the Xml representation.

Field Summary
- Fields inherited from interface org.apache.jackrabbit.webdav.DavConstants
  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 Summary

Constructors
Constructor and Description

MultiStatus()

Constructors
Constructor and Description
`MultiStatus()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addResourceProperties(org.apache.jackrabbit.webdav.DavResource resource, org.apache.jackrabbit.webdav.property.DavPropertyNameSet propNameSet, int depth)` Add response(s) to this multistatus, in order to build a multistatus e.g.
`void`	`addResourceProperties(org.apache.jackrabbit.webdav.DavResource resource, org.apache.jackrabbit.webdav.property.DavPropertyNameSet propNameSet, int propFindType, int depth)` Add response(s) to this multistatus, in order to build a multistatus for responding to a PROPFIND request.
`void`	`addResourceStatus(org.apache.jackrabbit.webdav.DavResource resource, int status, int depth)` Add response(s) to this multistatus, in order to build a multistatus as returned for COPY, MOVE, LOCK or DELETE requests resulting in an error with a resource other than the resource identified in the Request-URI.
`void`	`addResponse(org.apache.jackrabbit.webdav.MultiStatusResponse response)` Add a `MultiStatusResponse` element to this `MultiStatus`
`static MultiStatus`	`createFromXml(Element multistatusElement)` Build a `MultiStatus` from the specified xml element.
`String`	`getResponseDescription()` Returns the response description.
`org.apache.jackrabbit.webdav.MultiStatusResponse[]`	`getResponses()` Returns the multistatus responses present as array.
`void`	`setResponseDescription(String responseDescription)` Set the response description.
`Element`	`toXml(Document document)` Return the Xml representation of this `MultiStatus`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MultiStatus
```
public MultiStatus()
```
- Method Detail
  - addResourceProperties
```
public void addResourceProperties(org.apache.jackrabbit.webdav.DavResource resource,
                         org.apache.jackrabbit.webdav.property.DavPropertyNameSet propNameSet,
                         int propFindType,
                         int depth)
```
    Add response(s) to this multistatus, in order to build a multistatus for responding to a PROPFIND request.
    
    Parameters:
    resource - The resource to add property from
    propNameSet - The requested property names of the PROPFIND request
    propFindType -
    depth -
  - addResourceProperties
```
public void addResourceProperties(org.apache.jackrabbit.webdav.DavResource resource,
                         org.apache.jackrabbit.webdav.property.DavPropertyNameSet propNameSet,
                         int depth)
```
    Add response(s) to this multistatus, in order to build a multistatus e.g. in order to respond to a PROPFIND request. Please note, that in terms of PROPFIND, this method would correspond to a DavConstants.PROPFIND_BY_PROPERTY propfind type.
    
    Parameters:
    resource - The resource to add property from
    propNameSet - The requested property names of the PROPFIND request
    depth -
    See Also:
    for the corresponding method that allows to specify the type explicitly.
  - addResourceStatus
```
public void addResourceStatus(org.apache.jackrabbit.webdav.DavResource resource,
                     int status,
                     int depth)
```
    Add response(s) to this multistatus, in order to build a multistatus as returned for COPY, MOVE, LOCK or DELETE requests resulting in an error with a resource other than the resource identified in the Request-URI.
    
    Parameters:
    resource -
    status -
    depth -
  - addResponse
```
public void addResponse(org.apache.jackrabbit.webdav.MultiStatusResponse response)
```
    Add a MultiStatusResponse element to this MultiStatus
    
    Parameters:
    response -
  - getResponses
```
public org.apache.jackrabbit.webdav.MultiStatusResponse[] getResponses()
```
    Returns the multistatus responses present as array.
    
    Returns:
    array of all responses present in this multistatus.
  - setResponseDescription
```
public void setResponseDescription(String responseDescription)
```
    Set the response description.
    
    Parameters:
    responseDescription -
  - getResponseDescription
```
public String getResponseDescription()
```
    Returns the response description.
    
    Returns:
    responseDescription
  - toXml
```
public Element toXml(Document document)
```
    Return the Xml representation of this MultiStatus.
    
    Specified by:
    
    toXml in interface org.apache.jackrabbit.webdav.xml.XmlSerializable
    
    Parameters:
    document -
    
    Returns:
    Xml document
  - createFromXml
```
public static MultiStatus createFromXml(Element multistatusElement)
```
    Build a MultiStatus from the specified xml element.
    
    Parameters:
    multistatusElement -
    
    Returns:
    new MultiStatus instance.
    
    Throws:
    
    IllegalArgumentException - if the given document is null or does not provide the required element.

Class MultiStatus

Field Summary

Fields inherited from interface org.apache.jackrabbit.webdav.DavConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MultiStatus

Method Detail

addResourceProperties

addResourceProperties

addResourceStatus

addResponse

getResponses

setResponseDescription

getResponseDescription

toXml

createFromXml