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

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

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, 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 setInfo(ReportInfo info)
          Set the ReportInfo.
 void setResource(DeltaVResource resource)
          Set the target resource.
 org.jdom.Document toXml()
          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()

setResource

public void setResource(DeltaVResource resource)
                 throws IllegalArgumentException
Set the target resource.

Specified by:
setResource in interface Report
Parameters:
resource -
Throws:
IllegalArgumentException - if the specified resource is null
See Also:
Report.setResource(org.apache.jackrabbit.webdav.version.DeltaVResource)

setInfo

public void setInfo(ReportInfo info)
             throws IllegalArgumentException
Set the ReportInfo.

Specified by:
setInfo in interface Report
Parameters:
info -
Throws:
IllegalArgumentException - if the given ReportInfo does not contain a DAV:expand-property element.
See Also:
Report.setInfo(ReportInfo)

toXml

public org.jdom.Document toXml()
                        throws DavException
Run the report

Specified by:
toXml in interface Report
Returns:
Xml Document as defined by RFC 2518
Throws:
DavException
See Also:
Report.toXml()


Copyright © 2005 . All Rights Reserved.