io.milton.http.acl

Class PrincipalPropertySearchReport

java.lang.Object

io.milton.http.acl.PrincipalPropertySearchReport

All Implemented Interfaces:

Report

public class PrincipalPropertySearchReport
extends Object
implements Report

The report can be used to search principals for matching properties and return specified properties for the matching principal resources. To search for an address book owned by a user named "Laurie", the REPORT request body would look like this:

<?xml version="1.0" encoding="utf-8" ?>
<D:principal-property-search xmlns:D="DAV:">
<D:property-search>
<D:prop>
<D:displayname/>
</D:prop>
<D:match>Laurie</D:match>
</D:property-search>
<D:prop>
<C:addressbook-home-set xmlns:C="urn:ietf:params:xml:ns:carddav"/>
<D:displayname/>
</D:prop>
</D:principal-property-search>
 

The server performs a case-sensitive or caseless search for a matching string subset of "Laurie" within the DAV:displayname property. Thus, the server might return "Laurie Dusseault", "Laurier Desruisseaux", or "Wilfrid Laurier" all as matching DAV:displayname values, and the address books for each of these.

Author:

nabil.shams

Constructor Summary

Constructors

Constructor and Description
PrincipalPropertySearchReport(PropFindPropertyBuilder propertyBuilder, PropFindXmlGenerator xmlGenerator, io.milton.principal.PrincipalSearchService principalSearchService)

Method Summary

Modifier and Type	Method and Description
String	getName()
String	process(String host, String path, io.milton.resource.Resource r, org.jdom2.Document doc)

Methods inherited from class java.lang.Object

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

Constructor Detail

PrincipalPropertySearchReport

public PrincipalPropertySearchReport(PropFindPropertyBuilder propertyBuilder,
                                     PropFindXmlGenerator xmlGenerator,
                                     io.milton.principal.PrincipalSearchService principalSearchService)

Method Detail

getName

public String getName()

Specified by:

getName in interface Report

process

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

Specified by:

process in interface Report

Throws:

io.milton.http.exceptions.BadRequestException

io.milton.http.exceptions.NotAuthorizedException