public class SearchablePropertyReport extends Object implements Report
SearchablePropertyReport
identifies those properties that may be
searched using the DAV:principal-property-search REPORT
.
This report must be supported on all collections identified in the value of
a DAV:principal-collection-set property.
The request body MUST be an empty DAV:principal-search-property-set element.
The response body MUST be a DAV:principal-search-property-set XML element with the following structure:
<!ELEMENT principal-search-property-set (principal-search-property*) > <!ELEMENT principal-search-property (prop, description) > prop: see RFC 2518, Section 12.11 <!ELEMENT description #PCDATA > Human readable description. Note, that the language of the description must be indicated by the xml:lang attribute.Note that a DAV:principal-search-property XML element is required for each property that may be searched with the DAV:principal-property-search REPORT.
Modifier and Type | Field and Description |
---|---|
static String |
REPORT_NAME
The report name
|
static ReportType |
REPORT_TYPE
The report type
|
static String |
XML_PRINCIPAL_SEARCH_PROPERTY_SET
Constant used for the DAV:principal-search-property-set response element.
|
Constructor and Description |
---|
SearchablePropertyReport() |
Modifier and Type | Method and Description |
---|---|
void |
addPrincipalSearchProperty(DavPropertyName propName,
String description,
String language)
Add a property name that should be listed in the DAV:principal-search-property-set.
|
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. |
Element |
toXml(Document document)
Returns the xml representation of the implementing object as
Element . |
public static final String REPORT_NAME
public static final ReportType REPORT_TYPE
public static final String XML_PRINCIPAL_SEARCH_PROPERTY_SET
public ReportType getType()
Report
getType
in interface Report
Report.getType()
public boolean isMultiStatusReport()
Report
Report
will send a MultiStatus
response.isMultiStatusReport
in interface Report
200 (ok)
.Report.isMultiStatusReport()
public void init(DavResource resource, ReportInfo info) throws DavException
Report
DeltaVResource
for which this report was requested
and the ReportInfo
as specified by the REPORT request body,
that defines the details for this report.init
in interface Report
DavException
Report.init(DavResource, ReportInfo)
public Element toXml(Document document)
XmlSerializable
Element
. The given Document
is used
as factory and represents the owner document
of the returned DOM element.toXml
in interface XmlSerializable
document
- to be used as factory.XmlSerializable.toXml(Document)
public void addPrincipalSearchProperty(DavPropertyName propName, String description, String language)
propName
- a property name that may be searched in the PrincipalSearchReport
.description
- Human readable description of the searchable property.language
- defines in which language the description is written.IllegalArgumentException
- if propName is null
.Copyright © 2004-2020 The Apache Software Foundation. All Rights Reserved.