Class WebDavDispatcherClass2

The default WebDAV class 2 implementation

Inheritance

Object

WebDavDispatcherClass2

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace:FubarDev.WebDavServer.Dispatchers

Assembly:FubarDev.WebDavServer.dll

Syntax

public class WebDavDispatcherClass2 : IWebDavClass2, IWebDavClass

Constructors

| Improve this Doc View Source

WebDavDispatcherClass2(IEnumerable<IClass2Handler>, IWebDavContext)

Initializes a new instance of the WebDavDispatcherClass2 class.

Declaration

public WebDavDispatcherClass2([NotNull, ItemNotNull] IEnumerable<IClass2Handler> handlers, [NotNull] IWebDavContext context)

Parameters

Type	Name	Description
IEnumerable<IClass2Handler>	handlers	The WebDAV class 2 handlers
IWebDavContext	context	The WebDAV context

Properties

| Improve this Doc View Source

DefaultResponseHeaders

Gets the headers to be sent for any response

Declaration

public IReadOnlyDictionary<string, IEnumerable<string>> DefaultResponseHeaders { get; }

Property Value

Type	Description
IReadOnlyDictionary<String, IEnumerable<String>>

Implements

IWebDavClass.DefaultResponseHeaders

| Improve this Doc View Source

HttpMethods

Gets the HTTP methods supported by this WebDAV class.

Declaration

public IEnumerable<string> HttpMethods { get; }

Property Value

Type	Description
IEnumerable<String>

Implements

IWebDavClass.HttpMethods

| Improve this Doc View Source

OptionsResponseHeaders

Gets the headers to be sent for a response of an OPTIONS request

Declaration

public IReadOnlyDictionary<string, IEnumerable<string>> OptionsResponseHeaders { get; }

Property Value

Type	Description
IReadOnlyDictionary<String, IEnumerable<String>>

Implements

IWebDavClass.OptionsResponseHeaders

| Improve this Doc View Source

WebDavContext

Gets the context for a request

Declaration

public IWebDavContext WebDavContext { get; }

Property Value

Type	Description
IWebDavContext

Implements

IWebDavClass.WebDavContext

Methods

| Improve this Doc View Source

GetProperties(IEntry)

Gets the properties for an entry that are supported by this WebDAV class

Declaration

public IEnumerable<IUntypedReadableProperty> GetProperties(IEntry entry)

Parameters

Type	Name	Description
IEntry	entry	The entry to create the properties for

Returns

Type	Description
IEnumerable<IUntypedReadableProperty>	The properties that are to be used for the given entry

Implements

IWebDavClass.GetProperties(IEntry)

| Improve this Doc View Source

LockAsync(String, lockinfo, CancellationToken)

Creates a lock for the given path using the information in info.

Declaration

public Task<IWebDavResult> LockAsync(string path, lockinfo info, CancellationToken cancellationToken)

Parameters

Type	Name	Description
String	path	The path to create the lock for
lockinfo	info	The additional information used to create the lock
CancellationToken	cancellationToken	The cancellcation token

Returns

Type	Description
Task<IWebDavResult>	The result of the operation

Implements

IWebDavClass2.LockAsync(String, lockinfo, CancellationToken)

| Improve this Doc View Source

RefreshLockAsync(String, IfHeader, TimeoutHeader, CancellationToken)

Refreshes a lock for the given path using the lock identified by the ifHeader.

Declaration

public Task<IWebDavResult> RefreshLockAsync(string path, IfHeader ifHeader, TimeoutHeader timeoutHeader, CancellationToken cancellationToken)

Parameters

Type	Name	Description
String	path	The path to create the lock for
IfHeader	ifHeader	The `If` header used to identify the lock
TimeoutHeader	timeoutHeader	The new timeout values
CancellationToken	cancellationToken	The cancellcation token

Returns

Type	Description
Task<IWebDavResult>	The result of the operation

Implements

IWebDavClass2.RefreshLockAsync(String, IfHeader, TimeoutHeader, CancellationToken)

| Improve this Doc View Source

TryCreateDeadProperty(IPropertyStore, IEntry, XName, out IDeadProperty)

Tries to create a well known dead property required/used by this WebDAV class implementation

Declaration

public bool TryCreateDeadProperty(IPropertyStore store, IEntry entry, XName name, out IDeadProperty deadProperty)

Parameters

Type	Name	Description
IPropertyStore	store	The property store to store this property
IEntry	entry	The entry to instantiate this property for
XName	name	The name of the dead property to create
IDeadProperty	deadProperty	The created dead property if this function returned true.

Returns

Type	Description
Boolean	true when this function could handle the creation of the well known dead property with the given name

Implements

IWebDavClass.TryCreateDeadProperty(IPropertyStore, IEntry, XName, out IDeadProperty)

| Improve this Doc View Source

UnlockAsync(String, LockTokenHeader, CancellationToken)

Removes a LOCK with the given stateToken from the given path

Declaration

public Task<IWebDavResult> UnlockAsync(string path, LockTokenHeader stateToken, CancellationToken cancellationToken)

Parameters

Type	Name	Description
String	path	The path to remove the lock for
LockTokenHeader	stateToken	The state token of the lock to remove
CancellationToken	cancellationToken	The cancellcation token

Returns

Type	Description
Task<IWebDavResult>	The result of the operation

Implements

IWebDavClass2.UnlockAsync(String, LockTokenHeader, CancellationToken)