io.milton.http.webdav

Class WebDavProtocol

java.lang.Object

io.milton.http.webdav.WebDavProtocol

All Implemented Interfaces:

HttpExtension, PropertySource

public class WebDavProtocol
extends Object
implements HttpExtension, PropertySource

Defines the methods and properties that make up the webdav protocol. We've been a little pragmatic about what the webdav protocol actually is. It generally doesnt include things defined in subsequent protocols (RFC's), but where something is frequently used by other protocols (like REPORT) or is very tightly couple with normal webdav operations (like quota checking) you'll find it here

Author:

brad

Nested Class Summary

Nested classes/interfaces inherited from interface io.milton.property.PropertySource

PropertySource.PropertyAccessibility, PropertySource.PropertyMetaData, PropertySource.PropertySetException

Field Summary

Fields

Modifier and Type	Field and Description
static String	DAV_PREFIX
static String	DAV_URI
static NameSpace	NS_DAV

Constructor Summary

Constructors

Constructor and Description

WebDavProtocol(HandlerHelper handlerHelper, ResourceTypeHelper resourceTypeHelper, WebDavResponseHandler responseHandler, List<PropertySource> propertySources, QuotaDataAccessor quotaDataAccessor, PropPatchSetter patchSetter, PropertyAuthoriser propertyAuthoriser, ETagGenerator eTagGenerator, UrlAdapter urlAdapter, ResourceHandlerHelper resourceHandlerHelper, UserAgentHelper userAgentHelper, PropFindRequestFieldParser requestFieldParser, PropFindPropertyBuilder propertyBuilder, DisplayNameFormatter displayNameFormatter, boolean enableTextContentProperty)

Method Summary

Modifier and Type	Method and Description
void	addPropertySource(PropertySource ps)
void	addReport(Report report)
void	clearProperty(QName name, Resource r)
List<QName>	getAllPropertyNames(Resource r)
List<CustomPostHandler>	getCustomPostHandlers()
DisplayNameFormatter	getDisplayNameFormatter() Generates the displayname element text.
ETagGenerator	geteTagGenerator()
HandlerHelper	getHandlerHelper()
Set<Handler>	getHandlers()
MkColHandler	getMkColHandler()
Object	getProperty(QName name, Resource r)
PropertyMap	getPropertyMap()
PropertySource.PropertyMetaData	getPropertyMetaData(QName name, Resource r)
List<PropertySource>	getPropertySources()
PropPatchHandler	getPropPatchHandler()
QuotaDataAccessor	getQuotaDataAccessor()
Map<String,Report>	getReports()
ResourceTypeHelper	getResourceTypeHelper()
protected void	sendStringProp(XmlWriter writer, String name, String value)
void	setCustomPostHandlers(List<CustomPostHandler> customPostHandlers)
void	setProperty(QName name, Object value, Resource r)

Methods inherited from class java.lang.Object

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

Field Detail

DAV_URI

public static final String DAV_URI

See Also:

Constant Field Values

DAV_PREFIX

public static final String DAV_PREFIX

See Also:

Constant Field Values

NS_DAV

public static final NameSpace NS_DAV

Constructor Detail

WebDavProtocol

public WebDavProtocol(HandlerHelper handlerHelper,
                      ResourceTypeHelper resourceTypeHelper,
                      WebDavResponseHandler responseHandler,
                      List<PropertySource> propertySources,
                      QuotaDataAccessor quotaDataAccessor,
                      PropPatchSetter patchSetter,
                      PropertyAuthoriser propertyAuthoriser,
                      ETagGenerator eTagGenerator,
                      UrlAdapter urlAdapter,
                      ResourceHandlerHelper resourceHandlerHelper,
                      UserAgentHelper userAgentHelper,
                      PropFindRequestFieldParser requestFieldParser,
                      PropFindPropertyBuilder propertyBuilder,
                      DisplayNameFormatter displayNameFormatter,
                      boolean enableTextContentProperty)

Method Detail

getCustomPostHandlers

public List<CustomPostHandler> getCustomPostHandlers()

Specified by:

getCustomPostHandlers in interface HttpExtension

setCustomPostHandlers

public void setCustomPostHandlers(List<CustomPostHandler> customPostHandlers)

getPropertySources

public List<PropertySource> getPropertySources()

addPropertySource

public void addPropertySource(PropertySource ps)

addReport

public void addReport(Report report)

getHandlers

public Set<Handler> getHandlers()

Specified by:

getHandlers in interface HttpExtension

Returns:

- all method handlers that this extension supports.

getProperty

public Object getProperty(QName name,
                          Resource r)

Specified by:

getProperty in interface PropertySource

setProperty

public void setProperty(QName name,
                        Object value,
                        Resource r)

Specified by:

setProperty in interface PropertySource

getPropertyMetaData

public PropertySource.PropertyMetaData getPropertyMetaData(QName name,
                                                           Resource r)

Specified by:

getPropertyMetaData in interface PropertySource

clearProperty

public void clearProperty(QName name,
                          Resource r)

Specified by:

clearProperty in interface PropertySource

getAllPropertyNames

public List<QName> getAllPropertyNames(Resource r)

Specified by:

getAllPropertyNames in interface PropertySource

getDisplayNameFormatter

public DisplayNameFormatter getDisplayNameFormatter()

Generates the displayname element text. By default is a CdataDisplayNameFormatter wrapping a DefaultDisplayNameFormatter so that extended character sets are supported

Returns:

sendStringProp

protected void sendStringProp(XmlWriter writer,
                              String name,
                              String value)

getHandlerHelper

public HandlerHelper getHandlerHelper()

getQuotaDataAccessor

public QuotaDataAccessor getQuotaDataAccessor()

getReports

public Map<String,Report> getReports()

getResourceTypeHelper

public ResourceTypeHelper getResourceTypeHelper()

geteTagGenerator

public ETagGenerator geteTagGenerator()

getPropertyMap

public PropertyMap getPropertyMap()

getMkColHandler

public MkColHandler getMkColHandler()

getPropPatchHandler

public PropPatchHandler getPropPatchHandler()