io.milton.http.caldav

Class ExpandPropertyReport

java.lang.Object

io.milton.http.caldav.ExpandPropertyReport

All Implemented Interfaces:

Report

public class ExpandPropertyReport
extends Object
implements Report

http://tools.ietf.org/html/rfc3253#section-3.8 Many property values are defined as a DAV:href, or a set of DAV:href elements. The DAV:expand-property report provides a mechanism for retrieving in one request the properties from the resources identified by those DAV:href elements. This report not only decreases the number of requests required, but also allows the server to minimize the number of separate read transactions required on the underlying versioning store. The DAV:expand-property report SHOULD be supported by all resources that support the REPORT method. Marshalling: The request body MUST be a DAV:expand-property XML element. name value: a property element type namespace value: an XML namespace The response body for a successful request MUST be a DAV:multistatus XML element. multistatus: see RFC 2518, Section 12.9 The properties reported in the DAV:prop elements of the DAV:multistatus element MUST be those identified by the DAV:property elements in the DAV:expand-property element. If there are DAV:property elements nested within a DAV:property element, then every DAV:href in the value of the corresponding property is replaced by a DAV:response element whose DAV:prop elements report the values of the properties identified by the nested DAV:property elements. The nested DAV:property elements can in turn contain DAV:property elements, so that multiple levels of DAV:href expansion can be requested. Note that a validating parser MUST be aware that the DAV:expand- property report effectively modifies the DTD of every property by replacing every occurrence of "href" in the DTD with "href | response". REPORT /foo.html HTTP/1.1 Host: www.webdav.org Content-Type: text/xml; charset="utf-8" Content-Length: xxxx >>RESPONSE HTTP/1.1 207 Multi-Status Content-Type: text/xml; charset="utf-8" Content-Length: xxxx http://www.webdav.org/foo.html http://repo.webdav.org/his/23 http://repo.webdav.org/his/23/ver/1 Fred http://www.webdav.org/ws/dev/sally HTTP/1.1 200 OK http://repo.webdav.org/his/23/ver/2 Sally http://repo.webdav.org/act/add-refresh-cmd HTTP/1.1 200 OK HTTP/1.1 200 OK HTTP/1.1 200 OK In this example, the DAV:creator-displayname and DAV:activity-set properties of the versions in the DAV:version-set of the DAV:version-history of http://www.webdav.org/foo.html are reported.

Author:

bradm

Constructor Summary

Constructors

Constructor and Description
ExpandPropertyReport(ResourceFactory resourceFactory, PropFindPropertyBuilder propertyBuilder, PropFindXmlGenerator xmlGenerator)

Method Summary

Modifier and Type	Method and Description
String	getName()
PropertiesRequest	parse(org.jdom2.Element elProp)
String	process(String host, String path, io.milton.resource.Resource calendar, org.jdom2.Document doc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpandPropertyReport

public ExpandPropertyReport(ResourceFactory resourceFactory,
                            PropFindPropertyBuilder propertyBuilder,
                            PropFindXmlGenerator xmlGenerator)

Method Detail

process

public String process(String host,
                      String path,
                      io.milton.resource.Resource calendar,
                      org.jdom2.Document doc)
               throws io.milton.http.exceptions.NotAuthorizedException,
                      io.milton.http.exceptions.BadRequestException

Specified by:

process in interface Report

Throws:

io.milton.http.exceptions.NotAuthorizedException

io.milton.http.exceptions.BadRequestException

parse

public PropertiesRequest parse(org.jdom2.Element elProp)

getName

public String getName()

Specified by:

getName in interface Report