Package org.apache.jackrabbit.webdav.version.report

Interface Report

All Superinterfaces:
XmlSerializable
All Known Implementing Classes:
AbstractReport, AbstractSecurityReport, AclPrincipalReport, CompareBaselineReport, ExpandPropertyReport, LatestActivityVersionReport, LocateByHistoryReport, PrincipalMatchReport, PrincipalSearchReport, SearchablePropertyReport, VersionTreeReport
public interface Report extends XmlSerializable
The Report interface defines METHODS needed in order to respond to a REPORT request. The REPORT method is a required feature to all DeltaV resources.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    ReportType
    getType()
    Returns the registered type of this report.
    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.
    Please note that this methods should perform basic validation checks in order to prevent exceptional situations during the xml serialization.
    boolean
    isMultiStatusReport()
    Returns true if this Report will send a MultiStatus response.
    Please note that RFC 3253 that the the response must be a 207 Multi-Status, if a Depth request header is present.

    Methods inherited from interface org.apache.jackrabbit.webdav.xml.XmlSerializable

    toXml

  • Method Details

    • getType

      ReportType getType()
      Returns the registered type of this report.
      Returns:
      the type of this report.

    • isMultiStatusReport

      boolean isMultiStatusReport()
      Returns true if this Report will send a MultiStatus response.
      Please note that RFC 3253 that the the response must be a 207 Multi-Status, if a Depth request header is present.
      Returns:

    • init

      void init(DavResource resource, ReportInfo info) throws DavException
      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.
      Parameters:
      resource -
      info -
      Throws:
      DavException