WebDAV Component

Properties   Methods   Events   Config Settings   Errors  

The WebDAV Component implements an easy-to-use interface to the Web Distributed Authoring and Versioning (WebDAV) protocol.

Syntax

TipwWebDAV

Remarks

The WebDAV Component is designed to interact with the Web Distributed Authoring and Versioning (WebDAV) protocol. This component offers robust support for both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

Remote Resource Management

The WebDAV Component enables remote management of resource properties and collections, offering a comprehensive set of operations including creation, deletion, listing, copying, moving, and resource locking.

Listing Directories

The ListDirectory method is used to list the resources from a specific URI. Depending on the Depth property (see below) the scope of the list changes. For each resource found, the component fires the DirList once and also populates the Resources properties.

Downloading Resources

The GetResource method is used to retrieve the data of a resource from a WebDAV server. The data is stored in the stream specified using SetDownloadStream, the file from the LocalFile property, or the TransferredData property respectively.

Uploading Resources

The PutResource method is used to send data to the WebDAV server using the PUT method to the specified resource URI. The data is taken from the the stream specified using SetUploadStream or the file from the LocalFile property.

Finding Properties

The FindProperties method is used to find the properties of a specific resource (or multiple resource depending on the Depth property). This search can be filtered by adding items to the Properties properties, one item for each property. This method will populate then populate the Properties properties (clearing the collection) and fire the ResourceProperties event once for each found property.

Depth

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return the response HTTP 403 Forbidden.

Namespaces

The namespaces are provided in the Namespaces properties, which is filled automatically when retrieving DAV responses, but must be filled manually when requesting nonstandard properties.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Accept Property (WebDAV Component)

This property includes a list of acceptable MIME types for the request.

Syntax

property Accept: String read get_Accept write set_Accept;

Default Value

''

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

Authorization Property (WebDAV Component)

This property includes the Authorization string to be sent to the server.

Syntax

property Authorization: String read get_Authorization write set_Authorization;

Default Value

''

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form 'Basic [encoded-user-password]'.

AuthScheme Property (WebDAV Component)

This property specifies the authentication scheme to use when server authentication is required.

Syntax

property AuthScheme: TipwTHTTPAuthSchemes read get_AuthScheme write set_AuthScheme;

TipwTHTTPAuthSchemes = (
  authBasic,
  authDigest,
  authProprietary,
  authNone,
  authNtlm,
  authNegotiate,
  authOAuth
);

Default Value

authBasic

Remarks

This property will tell the component which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the component will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the component.

For security, changing the value of this property will cause the component to clear the values of User, Password, and Authorization.

Connected Property (WebDAV Component)

Whether the component is connected.

Syntax

property Connected: Boolean read get_Connected;

Default Value

false

Remarks

This property is used to determine whether or not the component is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Cookies Property (WebDAV Component)

A collection of cookies.

Syntax

property Cookies: TipwHTTPCookieList read get_Cookies write set_Cookies;

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This property is not available at design time.

Depth Property (WebDAV Component)

This property specifies the depth associated with the current operation.

Syntax

property Depth: TipwTDepths read get_Depth write set_Depth;

TipwTDepths = (
  dpUnspecified,
  dpResourceOnly,
  dpImmediateChildren,
  dpInfinity
);

Default Value

dpUnspecified

Remarks

When performing certain operations on resource collections, the component will use Depth to instruct the server about how deep to operate within the collection. Depth is an enumerated type with the following possible values:

Depth is used when performing the following operations: LockResource, MoveResource CopyResource, FindProperties, PatchProperties, and ListDirectory.

Firewall Property (WebDAV Component)

A set of properties related to firewall access.

Syntax

property Firewall: TipwFirewall read get_Firewall write set_Firewall;

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

FollowRedirects Property (WebDAV Component)

Determines what happens when the server issues a redirect.

Syntax

property FollowRedirects: TipwTFollowRedirects read get_FollowRedirects write set_FollowRedirects;

TipwTFollowRedirects = (
  frNever,
  frAlways,
  frSameScheme
);

Default Value

frNever

Remarks

This property determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the component raises an exception.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the component raises an exception instead.

Idle Property (WebDAV Component)

The current status of the component.

Syntax

property Idle: Boolean read get_Idle;

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

LocalFile Property (WebDAV Component)

This property includes the path to a local file used for DAV operations.

Syntax

property LocalFile: String read get_LocalFile write set_LocalFile;

Default Value

''

Remarks

After a GetResource operation, LocalFile will contain the contents of the resource.

For a PutResource operation, LocalFile contains the data that will be uploaded to the server.

If LocalFile is empty, then the received data are provided through the Transfer event.

LocalHost Property (WebDAV Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

property LocalHost: String read get_LocalHost write set_LocalHost;

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

LockOwner Property (WebDAV Component)

This property specifies the principle that owns the current resource lock.

Syntax

property LockOwner: String read get_LockOwner write set_LockOwner;

Default Value

''

Remarks

Before making a call to the LockResource method, LockOwner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockResource operation, the component will set the LockOwner property to the correct value returned in the server's response.

LockScope Property (WebDAV Component)

This property specifies the scope of the current resource lock.

Syntax

property LockScope: String read get_LockScope write set_LockScope;

Default Value

''

Remarks

Before making a call to the LockResource method, LockScope may be set to the type of scope needed for the lock. Currently, the component will allow only two types of scopes to be requested:

If no scope is specified, the protocol default scope, exclusive, will be requested. After a successful LockResource operation, the component will set the LockScope property to the correct value returned in the server's response.

LockTimeout Property (WebDAV Component)

This property includes the time to live for the current resource lock.

Syntax

property LockTimeout: Integer read get_LockTimeout write set_LockTimeout;

Default Value

0

Remarks

Before a call to the LockResource method, LockTimeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If Timeout of 0 is specified, the server will use a default timeout. After a successful LockResource operation, the component will set the LockTimeout property to the correct value returned in the server's response.

LockToken Property (WebDAV Component)

The lock string to be used when submitting operations on a locked resource.

Syntax

property LockToken: String read get_LockToken write set_LockToken;

Default Value

''

Remarks

Before a call to the LockResource method, LockToken may be set to the token returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in LockTimeout. If the lock request is not a lock refresh, LockToken must be empty, and they will be parsed out of the server response after a successful call to the LockResource method.

LockType Property (WebDAV Component)

This property specifies the type of the current resource lock.

Syntax

property LockType: String read get_LockType write set_LockType;

Default Value

'write'

Remarks

Before making a call to the LockResource method, LockType may be set to the type of lock being requested. Currently, the component supports only requesting locks of type write, although the protocol defines an optional read lock. After a successful LockResource operation, the component will set the LockType property to the correct value returned in the server's response.

Namespaces Property (WebDAV Component)

This property includes the collection of namespaces in the current stack.

Syntax

property Namespaces: TipwXMLNamespaceList read get_Namespaces write set_Namespaces;

Remarks

WebDAV allows nonstandard properties to be specified through XML namespaces.

The collection is filled automatically when retrieving DAV responses, but it must be filled manually when requesting nonstandard properties.

If the DAV URI is not found in the namespaces collection, it will be added as the default namespace when generating a request. The DAV namespace URI is DAV:.

This property is not available at design time.

OtherHeaders Property (WebDAV Component)

Other headers as determined by the user (optional).

Syntax

property OtherHeaders: String read get_OtherHeaders write set_OtherHeaders;

Default Value

''

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ('#13#10') .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the component beyond what is provided.

This property is not available at design time.

ParsedHeaders Property (WebDAV Component)

This property includes a collection of headers returned from the last request.

Syntax

property ParsedHeaders: TipwHeaderList read get_ParsedHeaders;

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This property is read-only and not available at design time.

Password Property (WebDAV Component)

This property includes a password if authentication is to be used.

Syntax

property Password: String read get_Password write set_Password;

Default Value

''

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form 'Basic [encoded-user-password]'.

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

Properties Property (WebDAV Component)

This property includes a collection of WebDAV properties.

Syntax

property Properties: TipwDAVPropertyList read get_Properties write set_Properties;

Remarks

The property names provided in the Properties collection are used by the FindProperties and PatchProperties methods.

After a call to FindProperties, the Properties properties will contain the name, value, and status of the DAV property returned by the server. The contents of the properties change for every matching resource (ResourceProperties event). After the call completes, the properties will contain the values of the last matching resource.

When a call is made to PatchProperties, the component will use the operations provided in the Properties collection to tell the server what to do with the properties under the following scheme:

Proxy Property (WebDAV Component)

A set of properties related to proxy access.

Syntax

property Proxy: TipwProxy read get_Proxy write set_Proxy;

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

Referer Property (WebDAV Component)

This property includes the referer URL/document (optional).

Syntax

property Referer: String read get_Referer write set_Referer;

Default Value

''

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

This property is not available at design time.

ResourceData Property (WebDAV Component)

Specifies the data to be uploaded to the webDAV server.

Syntax

property ResourceData: String read get_ResourceData write set_ResourceData;
property ResourceDataB: TBytes read get_ResourceDataB write set_ResourceDataB;

Default Value

''

Remarks

This property specifies the data to be uploaded to the webDAV server. If neither the SetUploadStream nor LocalFile are specified, the data specified in this property will be uploaded to the designated resource when the PutResource method is called.

This property is not available at design time.

Resources Property (WebDAV Component)

This property includes a collection of resources resulting from the last directory listing.

Syntax

property Resources: TipwDAVResourceList read get_Resources;

Remarks

This property contains a list of resources listed by the server after a call to the ListDirectory method. To retrieve properties of a particular resource, please refer to the FindProperties method.

MaxResources can be used to control the number of resource listings saved.

This property is read-only.

SSLAcceptServerCert Property (WebDAV Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

property SSLAcceptServerCert: TipwCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert;

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (WebDAV Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

property SSLCert: TipwCertificate read get_SSLCert write set_SSLCert;

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (WebDAV Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

property SSLProvider: TipwTSSLProviders read get_SSLProvider write set_SSLProvider;

TipwTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

SSLServerCert Property (WebDAV Component)

The server certificate for the last established connection.

Syntax

property SSLServerCert: TipwCertificate read get_SSLServerCert;

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

StatusLine Property (WebDAV Component)

This property is the first line of the last server response.

Syntax

property StatusLine: String read get_StatusLine;

Default Value

''

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the component, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].

This property is read-only and not available at design time.

Timeout Property (WebDAV Component)

The timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TransferredData Property (WebDAV Component)

This property includes the contents of the last response from the server.

Syntax

property TransferredData: String read get_TransferredData;
property TransferredDataB: TBytes read get_TransferredDataB;

Default Value

''

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

This property is read-only and not available at design time.

TransferredHeaders Property (WebDAV Component)

The full set of headers as received from the server.

Syntax

property TransferredHeaders: String read get_TransferredHeaders;

Default Value

''

Remarks

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the component.

This property is read-only and not available at design time.

User Property (WebDAV Component)

This property includes a user name if authentication is to be used.

Syntax

property User: String read get_User write set_User;

Default Value

''

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form 'Basic [encoded-user-password]'.

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

AddCookie Method (WebDAV Component)

Adds a cookie and the corresponding value to the outgoing request headers.

Syntax

procedure AddCookie(CookieName: String; CookieValue: String);

Remarks

This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

AddNamespace Method (WebDAV Component)

This method adds a namespace to the Namespaces properties.

Syntax

procedure AddNamespace(Prefix: String; NamespaceURI: String);

Remarks

Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

CheckFileExists Method (WebDAV Component)

Checks if a file exists in the specified URI.

Syntax

function CheckFileExists(ResourceURI: String): Boolean;

Remarks

This method returns True if the file exists on the specific endpoint provided by the ResourceURI parameter. It returns False if the file does not exist.

Config Method (WebDAV Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CopyResource Method (WebDAV Component)

This method copies a resource to a new location.

Syntax

procedure CopyResource(SourceResourceURI: String; DestinationResourceURI: String);

Remarks

The CopyResource method will copy the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI using the WebDAV COPY method.

This method is associated with the Depth property. If Depth is set to 0, the component will copy only SourceResourceURI. If Depth is set to infinity, the component will copy SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a LockResource of infinite depth on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

DeleteResource Method (WebDAV Component)

This method deletes a resource.

Syntax

procedure DeleteResource(ResourceURI: String);

Remarks

The resource or collection specified by ResourceURIis deleted using the WebDAV DELETE method. The DeleteResource method behaves independently of the Depth property. If ResourceURI denotes a collection, the server behaves as if the command were issued with an infinite depth (i.e., all internal member URIs denoting single resources or collections are deleted). If ResourceURI denotes a non-collection resource, it is first removed from any collection that it contains, and then the resource is removed from the server.

DoEvents Method (WebDAV Component)

This method processes events from the internal message queue.

Syntax

procedure DoEvents();

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

FindProperties Method (WebDAV Component)

This method is used to get resource property values from the server.

Syntax

procedure FindProperties(ResourceURI: String);

Remarks

This method retrieves the properties for the resources using the WebDAV PROPFIND method. If there are properties (with names) set in the Properties properties then the values for only those properties will be requested. If no properties are set in the Properties properties, then the all the properties for the specified resource will be requested.

The response will populate the Properties properties and will fire the ResourceProperties event once for each property returned.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return the response HTTP 403 Forbidden.

FindPropertyNames Method (WebDAV Component)

This method is used to get resource property names from the server.

Syntax

procedure FindPropertyNames(ResourceURI: String);

Remarks

FindPropertyNames will request names of all the properties of ResourceURI. The matching URIs will be returned through one or more ResourceProperties events (one for each matching resource), and the property names will be provided through the Properties properties.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return the response HTTP 403 Forbidden.

GetProperty Method (WebDAV Component)

This method is used to get the value for a particular property.

Syntax

function GetProperty(PropertyName: String): String;

Remarks

The component will search through its internal Properties properties for the property identified by PropertyName and will return the value associated with it.

PropertyName may also be a partial XPath expression to the retrieved resource XML. This method is useful for reading values of composite properties.

Note: This method does not make a request to the WebDAV server for a list of properties. The FindProperties method must be called first to issue the WebDAV PROPFIND request and populate the Properties properties.

GetResource Method (WebDAV Component)

This method uses a WebDAV GET method to get a resource.

Syntax

procedure GetResource(ResourceURI: String);

Remarks

This method requests a resource using the WebDAV GET method. When the DAV server responds, the resource contents are delivered through the Transfer event, and the HTTP response headers are delivered through the Header event. Additionally, the resource contents are saved to the stream specified using SetDownloadStream, the specified LocalFile, or the TransferredData property respectively.

Interrupt Method (WebDAV Component)

This method interrupts the current method.

Syntax

procedure Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListDirectory Method (WebDAV Component)

This method lists the files and subdirectories of the ResourceURI .

Syntax

procedure ListDirectory(ResourceURI: String);

Remarks

This method will return a list of resources from the specified URI. The results will be returned through one or more DirList events (one for each matching resource).

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return the response HTTP 403 Forbidden.

LockResource Method (WebDAV Component)

This method is used to obtain a lock for a specified resource.

Syntax

procedure LockResource(ResourceURI: String);

Remarks

The LockResource method will request a new lock to be placed on ResourceURI in the user's name so that only the user can operate on it. The method is linked to a number of properties that it uses to generate the lock request:

This method is associated with the Depth property. If Depth is set to 0, the component will lock only ResourceURI and its properties. If Depth is set to infinity, the component will lock ResourceURI and its entire subtree.

If MoveResource or CopyResource are used to place a resource or collection in a location under a resource locked with infinity, the new resource or collection will be added to the lock. Any lock on a collection will prevent nonlock owners from adding resources to that collection.

MakeDirectory Method (WebDAV Component)

This method can be used to make a new directory.

Syntax

procedure MakeDirectory(ResourceURI: String);

Remarks

A new resource collection is created at the location specified by ResourceURI.

MoveResource Method (WebDAV Component)

This method moves one resource to a new location.

Syntax

procedure MoveResource(SourceResourceURI: String; DestinationResourceURI: String);

Remarks

The MoveResource method will move the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

This method is associated with the Depth property. If Depth is set to 0, the component will move only SourceResourceURI. If Depth is set to infinity, the component will move SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a LockResource of infinite depth on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

PatchProperties Method (WebDAV Component)

This method updates the current set of properties on the server.

Syntax

procedure PatchProperties(ResourceURI: String);

Remarks

When the user calls PatchProperties, the component will send a request to the server to update the existing property list. The method is linked to the Properties property: the component will use the Operation field to tell the server what to do with the properties.

PostToResource Method (WebDAV Component)

This method posts data to a resource using the WebDAV POST method.

Syntax

procedure PostToResource(ResourceURI: String);

Remarks

This method posts data to the resource ResourceURI using the WebDAV POST method. The posted data are taken from ResourceData. The server response text is received through the Transfer event, and the HTTP response headers are received through the Header event. If LocalFile property is not empty, the data (not the headers) are written there as well.

PutResource Method (WebDAV Component)

This method sends data to the server using the PUT method.

Syntax

procedure PutResource(ResourceURI: String);

Remarks

The data are taken from LocalFile. The server will normally require authentication for this operation, so User and Password must have valid values before the request is made.

Reset Method (WebDAV Component)

This method will reset the component.

Syntax

procedure Reset();

Remarks

This method will reset the component's properties to their default values.

SendCustomRequest Method (WebDAV Component)

This method sends a custom request to the WebDAV server.

Syntax

procedure SendCustomRequest(HttpMethod: String; Url: String; RequestBody: String);

Remarks

This method can be used to send arbitrary requests to a WebDAV server.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• PROPFIND
• PROPPATCH
• MKCOL
• COPY
• MOVE
• LOCK
• UNLOCK

The value passed for URL is used as the location the request is made to. The RequestBody parameter is used to provide the component with the request body for the request. If no request body is needed for the request, the RequestBody parameter should also then be set to an empty string. If preferred, the request body can be provided via the LocalFile property instead. When doing so, the RequestBody parameter must be set to an empty string.

Note, the LocalFile property is not cleared after the request is made and should be cleared by either calling Reset or be setting it to an empty string.

When the server responds, the component stores the response headers in the ParsedHeaders properties and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or the TransferredData property (using the same logic as GetResource). If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

SetDownloadStream Method (WebDAV Component)

This method sets the stream to which the downloaded data from the server will be written.

Syntax

procedure SetDownloadStream(DownloadStream: TStream);

Remarks

If a download stream is set before the GetResource method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

The component will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetDownloadStream again before calling GetResource again.

The downloaded content will be written starting at the current position in the stream.

SetProperty Method (WebDAV Component)

This method sets the value of a property.

Syntax

procedure SetProperty(PropertyName: String; PropertyValue: String);

Remarks

This method is used to set a single property to a certain value. The name and new value of the property must be supplied in the parameters for this method.

Note: This is the same as calling the PatchProperties on one property when the operation is opSet.

Example. Set Property:

Control.SetProperty("MyProperty", "MyValue")

is equivalent to: Control.PropertyCount = 1 Control.PropertyName(0) = "MyProperty" Control.PropertyValue(0) = "MyValue" Control.PropertyOperation(0) = opSet Control.PatchProperties()

SetUploadStream Method (WebDAV Component)

This method sets the stream to be uploaded to the server.

Syntax

procedure SetUploadStream(UploadStream: TStream);

Remarks

If an upload stream is set before data are to be uploaded to the server, the content of the stream will be read by the component and uploaded to the server. The stream should be open and normally set to position 0.

The component will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetUploadStream again before calling the PutResource/PostToResource again.

The content of the stream will be read from the current position all the way to the end and no bytes will be skipped.

UnLockResource Method (WebDAV Component)

This method unlocks a resource.

Syntax

procedure UnLockResource(ResourceURI: String);

Remarks

Before calling UnLockResource on a particular resource, the LockToken property must be set to the lock token for ResourceURI. The method will remove the lock, allowing other users or nonprivileged users to access and operate on the file.

Connected Event (WebDAV Component)

Fired immediately after a connection completes (or fails).

Syntax

type TConnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnConnected: TConnectedEvent read FOnConnected write FOnConnected;

Remarks

If the connection is made normally, StatusCode is 0 and Description is 'OK'.

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (WebDAV Component)

Fired to indicate changes in the connection state.

Syntax

type TConnectionStatusEvent = procedure (
  Sender: TObject;
  const ConnectionEvent: String;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnConnectionStatus: TConnectionStatusEvent read FOnConnectionStatus write FOnConnectionStatus;

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

DirList Event (WebDAV Component)

This event fires for each entry returned in a directory listing.

Syntax

type TDirListEvent = procedure (
  Sender: TObject;
  const ResourceURI: String;
  const DisplayName: String;
  const ContentLanguage: String;
  ContentLength: Int64;
  const ContentType: String;
  const LastModified: String
) of Object;

property OnDirList: TDirListEvent read FOnDirList write FOnDirList;

Remarks

The DirList event is fired when a directory listing is received as a response to ListDirectory.

The StartTransfer and EndTransfer events mark the beginning and the end of the event stream.

Disconnected Event (WebDAV Component)

Fired when a connection is closed.

Syntax

type TDisconnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected;

Remarks

If the connection is broken normally, StatusCode is 0 and Description is 'OK'.

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (WebDAV Component)

This event is fired when a document finishes transferring.

Syntax

type TEndTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer
) of Object;

property OnEndTransfer: TEndTransferEvent read FOnEndTransfer write FOnEndTransfer;

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (WebDAV Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (WebDAV Component)

Fired every time a header line comes in.

Syntax

type THeaderEvent = procedure (
  Sender: TObject;
  const Field: String;
  const Value: String
) of Object;

property OnHeader: THeaderEvent read FOnHeader write FOnHeader;

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains '' (empty string).

Log Event (WebDAV Component)

Fired once for each log message.

Syntax

type TLogEvent = procedure (
  Sender: TObject;
  LogLevel: Integer;
  const Message: String;
  const LogType: String
) of Object;

property OnLog: TLogEvent read FOnLog write FOnLog;

Remarks

This event is fired once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Redirect Event (WebDAV Component)

Fired when a redirection is received from the server.

Syntax

type TRedirectEvent = procedure (
  Sender: TObject;
  const Location: String;
  var Accept: Boolean
) of Object;

property OnRedirect: TRedirectEvent read FOnRedirect write FOnRedirect;

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the component raises an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

ResourceProperties Event (WebDAV Component)

This event fires for each entry returned through a property search.

Syntax

type TResourcePropertiesEvent = procedure (
  Sender: TObject;
  const ResourceURI: String;
  const ResourceProperties: String
) of Object;

property OnResourceProperties: TResourcePropertiesEvent read FOnResourceProperties write FOnResourceProperties;

Remarks

The ResourceProperties event is fired when resource properties are received as a response to FindProperties.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The ResourceProperties contains the full XML containing the properties of the resource.

ResourceURI contains the name of the resource.

The parsed property names, values, and status are contained within the Properties properties.

SetCookie Event (WebDAV Component)

Fired for every cookie set by the server.

Syntax

type TSetCookieEvent = procedure (
  Sender: TObject;
  const Name: String;
  const Value: String;
  const Expires: String;
  const Domain: String;
  const Path: String;
  Secure: Boolean
) of Object;

property OnSetCookie: TSetCookieEvent read FOnSetCookie write FOnSetCookie;

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (WebDAV Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  const CertEncoded: String;
  const CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (WebDAV Component)

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (WebDAV Component)

This event is fired when a document starts transferring (after the headers).

Syntax

type TStartTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer
) of Object;

property OnStartTransfer: TStartTransferEvent read FOnStartTransfer write FOnStartTransfer;

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (WebDAV Component)

Fired when the HTTP status line is received from the server.

Syntax

type TStatusEvent = procedure (
  Sender: TObject;
  const HTTPVersion: String;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnStatus: TStatusEvent read FOnStatus write FOnStatus;

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (WebDAV Component)

Fired while a document transfers (delivers document).

Syntax

type TTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer;
  BytesTransferred: Int64;
  PercentDone: Integer;
  const Text: String;
  const TextB: TBytes
) of Object;

property OnTransfer: TTransferEvent read FOnTransfer write FOnTransfer;

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

>

constructor Create();

constructor Create(valEncoded: TBytes);

constructor Create(valStoreType: TipwCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);

constructor Create(valStoreType: TipwCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);

DAVProperty Type

A property that is either sent to or received from the server.

Remarks

This type defines a property that is used when the component sends a property find or patch request to the server. When FindProperties is used, this property will be populated with the properties returned from the server. When a call is made to PatchProperties, the component will use the information provided by this type to tell the server what to do with the property being specified.

Fields

Constructors

constructor Create();

constructor Create(valName: String);

DAVResource Type

A resource as returned in a directory listing from the WebDAV component.

Remarks

This type describes a resource that has been returned by the server during a response to a ListDirectory request. The DAVResource type contains fields which describe each listing as returned from the server.

Fields

Constructors

constructor Create();

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

constructor Create();

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

constructor Create();

constructor Create(valField: String; valValue: String);

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the Name and Value fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

constructor Create();

constructor Create(valName: String; valValue: String);

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

constructor Create();

constructor Create(valServer: String; valPort: Integer);

constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);

XMLNamespace Type

This type describes an XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.

The default namespace exists at index 0. The Prefix field at index 0 is xmlns, and the Name field contains the default namespace.

Fields

Constructors

constructor Create();

constructor Create(valURI: String; valPrefix: String);

Config Settings (WebDAV Component)

WebDAV Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (WebDAV Component)

WebDAV Errors

The component may also return one of the following error codes, which are inherited from other components.

HTTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

SSL Errors

TCP/IP Errors