io.milton.http.webdav

Class DefaultPropFindPropertyBuilder

java.lang.Object

io.milton.http.webdav.DefaultPropFindPropertyBuilder

All Implemented Interfaces:

PropFindPropertyBuilder

public class DefaultPropFindPropertyBuilder
extends Object
implements PropFindPropertyBuilder

This class performs the main part of PROPFIND processing, which is given a field request (either named fields or an allprop request) and a target resource, iterate over that resource and its children (depending on the depth header) and list a list of PropFindResponse objects. These PropFindResponse objects contain typed values for all of the known fields, and a set of unknown fields. These will be used to build the xml which is ultimately sent back to the client. This class uses a list of PropertySource's, where each PropertySource represents some mechanism to read properties from a resource.

Author:

brad

Constructor Summary

Constructors

Constructor and Description
DefaultPropFindPropertyBuilder(List<PropertySource> propertySources)

Method Summary

Modifier and Type	Method and Description
List<PropFindResponse>	buildProperties(PropFindableResource pfr, int depth, PropertiesRequest parseResult, String url) Construct a list of PropFindResponse for the given resource, using the PropertySource's injected into this class.
Set<QName>	findAllProps(PropFindableResource resource)
static String	fixUrlForWindows(String url) Requested URL *should* never contain an ampersand because its a reserved character.
ValueAndType	getProperty(QName field, Resource resource)
void	processResource(List<PropFindResponse> responses, PropFindableResource resource, PropertiesRequest parseResult, String href, int requestedDepth, int currentDepth, String collectionHref)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPropFindPropertyBuilder

public DefaultPropFindPropertyBuilder(List<PropertySource> propertySources)

Parameters:

propertySources - - the list of property sources used to read properties from resources

Method Detail

buildProperties

public List<PropFindResponse> buildProperties(PropFindableResource pfr,
                                              int depth,
                                              PropertiesRequest parseResult,
                                              String url)
                                       throws URISyntaxException,
                                              NotAuthorizedException,
                                              BadRequestException

Construct a list of PropFindResponse for the given resource, using the PropertySource's injected into this class.

Specified by:

buildProperties in interface PropFindPropertyBuilder

Parameters:

pfr - - the resource to interrogate

depth - - the depth header. 0 means only look at the given resource. 1 is to include children

parseResult - - contains the list of fields, or a true boolean indicating all properties

url - - the URL of the given resource - MUST be correctly encoded

Returns:

Throws:

URISyntaxException

NotAuthorizedException

BadRequestException

getProperty

public ValueAndType getProperty(QName field,
                                Resource resource)
                         throws NotAuthorizedException,
                                BadRequestException

Specified by:

getProperty in interface PropFindPropertyBuilder

Throws:

NotAuthorizedException

BadRequestException

processResource

public void processResource(List<PropFindResponse> responses,
                            PropFindableResource resource,
                            PropertiesRequest parseResult,
                            String href,
                            int requestedDepth,
                            int currentDepth,
                            String collectionHref)
                     throws NotAuthorizedException,
                            BadRequestException

Specified by:

processResource in interface PropFindPropertyBuilder

Throws:

NotAuthorizedException

BadRequestException

findAllProps

public Set<QName> findAllProps(PropFindableResource resource)
                        throws NotAuthorizedException,
                               BadRequestException

Specified by:

findAllProps in interface PropFindPropertyBuilder

Throws:

NotAuthorizedException

BadRequestException

fixUrlForWindows

public static String fixUrlForWindows(String url)

Requested URL *should* never contain an ampersand because its a reserved character. However windows 7 does send unencoded ampersands in requests, but expects them to be encoded in responses.

Parameters:

url -

Returns: