org.apache.jackrabbit.webdav.version.report
Class ExpandPropertyReport

java.lang.Object
  extended by org.apache.jackrabbit.webdav.version.report.ExpandPropertyReport
All Implemented Interfaces:
DeltaVConstants, Report, XmlSerializable

public class ExpandPropertyReport
extends Object
implements Report, DeltaVConstants

ExpandPropertyReport encapsulates the DAV:expand-property report, that provides a mechanism for retrieving in one request the properties from the resources identified by those DAV:href elements. It should be supported by all resources that support the REPORT method.

RFC 3253 specifies the following required format for the request body:

 <!ELEMENT expand-property (property*)>
 <!ELEMENT property (property*)>
 <!ATTLIST property name NMTOKEN #REQUIRED>
 name value: a property element type
 <!ATTLIST property namespace NMTOKEN "DAV:">
 namespace value: an XML namespace
 
NOTE: any DAV:property elements defined in the request body, that does not represent HrefProperty is treated as in a common PROPFIND request.

See Also:
DeltaVConstants.XML_EXPAND_PROPERTY, DeltaVConstants.XML_PROPERTY

Field Summary
 
Fields inherited from interface org.apache.jackrabbit.webdav.version.DeltaVConstants
ATTR_NAME, ATTR_NAMESPACE, COMMENT, CREATOR_DISPLAYNAME, HEADER_LABEL, HEADER_LOCATION, NAMESPACE, SUPPORTED_LIVE_PROPERTY_SET, SUPPORTED_METHOD_SET, SUPPORTED_REPORT_SET, VERSION_CONTROLLED_CONFIGURATION, WORKSPACE, XML_ACTIVITY, XML_ACTIVITY_COLLECTION_SET, XML_BASELINE, XML_CHECKOUT, XML_CHECKOUT_CHECKIN, XML_CHECKOUT_UNLOCK_CHECKIN, XML_EXPAND_PROPERTY, XML_LABEL, XML_LABEL_ADD, XML_LABEL_NAME, XML_LABEL_REMOVE, XML_LABEL_SET, XML_LOCATE_BY_HISTORY, XML_LOCKED_CHECKIN, XML_MERGE, XML_N0_AUTO_MERGE, XML_N0_CHECKOUT, XML_OPTIONS, XML_OPTIONS_RESPONSE, XML_PROPERTY, XML_REPORT, XML_SUPPORTED_METHOD, XML_SUPPORTED_REPORT, XML_UPDATE, XML_VERSION, XML_VERSION_HISTORY, XML_VERSION_HISTORY_SET, XML_VERSION_TREE, XML_VH_COLLECTION_SET, XML_WORKSPACE, XML_WSP_COLLECTION_SET
 
Constructor Summary
ExpandPropertyReport()
           
 
Method Summary
 ReportType getType()
          Returns ReportType.EXPAND_PROPERTY.
 void init(DavResource resource, ReportInfo info)
          Set the DeltaVResource for which this report was requested and the ReportInfo as specified by the REPORT request body, that defines the details for this report.
 boolean isMultiStatusReport()
          Always returns true.
 Element toXml(Document document)
          Run the report
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExpandPropertyReport

public ExpandPropertyReport()
Method Detail

getType

public ReportType getType()
Returns ReportType.EXPAND_PROPERTY.

Specified by:
getType in interface Report
Returns:
See Also:
Report.getType()

isMultiStatusReport

public boolean isMultiStatusReport()
Always returns true.

Specified by:
isMultiStatusReport in interface Report
Returns:
true
See Also:
Report.isMultiStatusReport()

init

public void init(DavResource resource,
                 ReportInfo info)
          throws DavException
Description copied from interface: Report
Set the DeltaVResource for which this report was requested and the ReportInfo as specified by the REPORT request body, that defines the details for this report.
Please note that this methods should perform basic validation checks in order to prevent exceptional situations during the xml serialization.

Specified by:
init in interface Report
Throws:
DavException
See Also:
Report.init(DavResource, ReportInfo)

toXml

public Element toXml(Document document)
Run the report

Specified by:
toXml in interface XmlSerializable
Parameters:
document -
Returns:
Xml Document as defined by RFC 2518
See Also:
XmlSerializable.toXml(Document)


Copyright © 2011-2013 Adobe Systems Incorporated. All Rights Reserved.