WebDAV Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class ipworksssl.WebDAV

Remarks

The WebDAV Class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL related settings are also supported via the config method.

The class allows remote management of resource properties and properties, including creation, deletion, listing, copying, and moving. Resource locking is also supported.

The list_directory and find_properties methods will list the properties of a resource properties or resource, and a on_dir_list or on_resource_properties event will be fired 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 a HTTP 403 Forbidden response.

A number of operations can be performed on resources by using the various methods of the class. Please refer to the individual methods for more information.

WebDAV allows non-standard properties to be specified through XML namespaces.

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

Property List

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

Method List

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

Event List

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

Config Settings

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

accept Property

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

Syntax

def get_accept() -> str: ...
def set_accept(value: str) -> None: ...

accept = property(get_accept, 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

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

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, 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 class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The auth_scheme 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]".

auth_scheme Property

The authentication scheme to use when server authentication is required.

Syntax

def get_auth_scheme() -> int: ...
def set_auth_scheme(value: int) -> None: ...

auth_scheme = property(get_auth_scheme, set_auth_scheme)

Default Value

0

Remarks

This property will tell the class 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 class will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

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

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

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

For security, changing the value of this property will cause the class to clear the values of user, password, and Authorization.

connected Property

This shows whether the class is connected.

Syntax

def get_connected() -> bool: ...
def set_connected(value: bool) -> None: ...

connected = property(get_connected, set_connected)

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the connect or disconnect method instead of setting this property.

cookie_count Property

The number of records in the Cookie arrays.

Syntax

def get_cookie_count() -> int: ...
def set_cookie_count(value: int) -> None: ...

cookie_count = property(get_cookie_count, set_cookie_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• cookie_domain
• cookie_expiration
• cookie_name
• cookie_path
• cookie_secure
• cookie_value

The array indices start at 0 and end at cookie_count - 1.

cookie_domain Property

This is the domain of a received cookie.

Syntax

def get_cookie_domain(cookie_index: int) -> str: ...

Default Value

""

Remarks

This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_expiration Property

This property contains an expiration time for the cookie (if provided by the server).

Syntax

def get_cookie_expiration(cookie_index: int) -> str: ...

Default Value

""

Remarks

This property 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, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_name Property

This property, contains the name of the cookie.

Syntax

def get_cookie_name(cookie_index: int) -> str: ...
def set_cookie_name(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property, contains the name of the cookie.

This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

cookie_path Property

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

def get_cookie_path(cookie_index: int) -> str: ...

Default Value

""

Remarks

This property 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 property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_secure Property

This property contains the security flag of the received cookie.

Syntax

def get_cookie_secure(cookie_index: int) -> bool: ...

Default Value

FALSE

Remarks

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_value Property

This property contains the value of the cookie.

Syntax

def get_cookie_value(cookie_index: int) -> str: ...
def set_cookie_value(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.

The on_set_cookie event provides the cookies set by the server.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

depth Property

The depth associated with the current operation.

Syntax

def get_depth() -> int: ...
def set_depth(value: int) -> None: ...

depth = property(get_depth, set_depth)

Default Value

0

Remarks

When performing certain operations on resource collections, the class will use depth to instruct the server on 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: lock_resource, move_resource copy_resource, find_properties, patch_properties, and list_directory.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

follow_redirects Property

This property determines what happens when the server issues a redirect.

Syntax

def get_follow_redirects() -> int: ...
def set_follow_redirects(value: int) -> None: ...

follow_redirects = property(get_follow_redirects, set_follow_redirects)

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class 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 url_scheme is the same; otherwise, the class fails with an error.

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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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 class fails with an error instead.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

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

This property is read-only.

local_file Property

The path to a local file used for DAV operations.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

After a get_resource operation, local_file will contain the contents of the resource.

For a put_resource operation, local_file contains the data that will be uploaded to the server.

If local_file is empty then the received data is provided through the on_transfer event.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host 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 multi-homed hosts (machines with more than one IP interface).

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

lock_owner Property

The principle that owns the current resource lock.

Syntax

def get_lock_owner() -> str: ...
def set_lock_owner(value: str) -> None: ...

lock_owner = property(get_lock_owner, set_lock_owner)

Default Value

""

Remarks

Before a call to the lock_resource method, lock_owner 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 lock_resource operation, the class will set the lock_owner property to the correct value returned in the server's response.

lock_scope Property

The scope of the current resource lock.

Syntax

def get_lock_scope() -> str: ...
def set_lock_scope(value: str) -> None: ...

lock_scope = property(get_lock_scope, set_lock_scope)

Default Value

""

Remarks

Before a call to the lock_resource method, lock_scope may be set to the type of scope needed for the lock. Currently the class will only allow two types of scopes to be requested:

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

lock_timeout Property

The time to live for the current resource lock.

Syntax

def get_lock_timeout() -> int: ...
def set_lock_timeout(value: int) -> None: ...

lock_timeout = property(get_lock_timeout, set_lock_timeout)

Default Value

0

Remarks

Before a call to the lock_resource method, lock_timeout 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 lock_resource operation, the class will set the lock_timeout property to the correct value returned in the server's response.

lock_tokens Property

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

Syntax

def get_lock_tokens() -> str: ...
def set_lock_tokens(value: str) -> None: ...

lock_tokens = property(get_lock_tokens, set_lock_tokens)

Default Value

""

Remarks

Before a call to the lock_resource method, lock_tokens may be set to the tokens 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 lock_timeout. If the lock request is not a lock refresh, lock_tokens must be empty, and will be parsed out of the server response after a successful call to the lock_resource method.

lock_type Property

The type of the current resource lock.

Syntax

def get_lock_type() -> str: ...
def set_lock_type(value: str) -> None: ...

lock_type = property(get_lock_type, set_lock_type)

Default Value

"write"

Remarks

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

namespace_count Property

The number of records in the Namespace arrays.

Syntax

def get_namespace_count() -> int: ...
def set_namespace_count(value: int) -> None: ...

namespace_count = property(get_namespace_count, set_namespace_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• namespace_prefix
• namespace_uri

The array indices start at 0 and end at namespace_count - 1.

namespace_prefix Property

The Prefix for the Namespace .

Syntax

def get_namespace_prefix(namespace_index: int) -> str: ...
def set_namespace_prefix(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

The namespace_prefix for the namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

namespace_uri Property

Namespace URI associated with the corresponding Prefix .

Syntax

def get_namespace_uri(namespace_index: int) -> str: ...
def set_namespace_uri(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

Namespace URI associated with the corresponding namespace_prefix. This is usually a URL pointing to the XML schema for the namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

other_headers Property

This property includes other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

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 content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

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 class beyond what is provided.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

password Property

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

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used. If auth_scheme 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 auth_scheme 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 auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM and user and password are empty, the class will attempt to authenticate using the current user's credentials.

property_count Property

The number of records in the Property arrays.

Syntax

def get_property_count() -> int: ...
def set_property_count(value: int) -> None: ...

property_count = property(get_property_count, set_property_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• property_attr
• property_name
• property_namespace_uri
• property_operation
• property_status
• property_value

The array indices start at 0 and end at property_count - 1.

property_attr Property

This property shows the attribute string for the specified DAV property.

Syntax

def get_property_attr(property_index: int) -> str: ...
def set_property_attr(property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property shows the attribute string for the specified DAV property.

The property_index parameter specifies the index of the item in the array. The size of the array is controlled by the property_count property.

property_name Property

This property shows the name of the DAV property sent to or received from the server.

Syntax

def get_property_name(property_index: int) -> str: ...
def set_property_name(property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property shows the name of the DAV property sent to or received from the server.

The property_index parameter specifies the index of the item in the array. The size of the array is controlled by the property_count property.

property_namespace_uri Property

This property shows the DAV property namespace.

Syntax

def get_property_namespace_uri(property_index: int) -> str: ...
def set_property_namespace_uri(property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property shows the DAV property namespace. The default URI is "DAV:". This value may be changed if a desired namespace is different from the default namespace.

The property_index parameter specifies the index of the item in the array. The size of the array is controlled by the property_count property.

property_operation Property

This property shows the operation to perform on a property when calling PatchProperties .

Syntax

def get_property_operation(property_index: int) -> int: ...
def set_property_operation(property_index: int, value: int) -> None: ...

Default Value

0

Remarks

This property shows the operation to perform on a property when calling patch_properties.

This is used when the class sends a property patch request to the server. When a call is made to patch_properties, the class will use the property_operation to tell the server what to do under the following scheme:

The property_index parameter specifies the index of the item in the array. The size of the array is controlled by the property_count property.

property_status Property

This property shows the status of the retrieved DAV property.

Syntax

def get_property_status(property_index: int) -> str: ...

Default Value

""

Remarks

This property shows the status of the retrieved DAV property. If the property is successfully retrieved, property_status contains the string "OK". Otherwise, it contains the HTTP status and description provided by the server.

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

The property_index parameter specifies the index of the item in the array. The size of the array is controlled by the property_count property.

This property is read-only.

property_value Property

This property shows the value of the DAV property.

Syntax

def get_property_value(property_index: int) -> str: ...
def set_property_value(property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property shows the value of the DAV property.

The property_index parameter specifies the index of the item in the array. The size of the array is controlled by the property_count property.

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

This property contains a user name, if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

referer Property

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

Syntax

def get_referer() -> str: ...
def set_referer(value: str) -> None: ...

referer = property(get_referer, 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.

resource_count Property

The number of records in the Resource arrays.

Syntax

def get_resource_count() -> int: ...

resource_count = property(get_resource_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• resource_content_language
• resource_content_length
• resource_content_type
• resource_display_name
• resource_last_modified
• resource_uri

The array indices start at 0 and end at resource_count - 1.

This property is read-only.

resource_content_language Property

This property shows the language of the resource being returned.

Syntax

def get_resource_content_language(resource_index: int) -> str: ...

Default Value

""

Remarks

This property shows the language of the resource being returned.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_content_length Property

This property shows the length of the resource returned.

Syntax

def get_resource_content_length(resource_index: int) -> str: ...

Default Value

""

Remarks

This property shows the length of the resource returned.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_content_type Property

This property shows the type of the resource being returned.

Syntax

def get_resource_content_type(resource_index: int) -> str: ...

Default Value

""

Remarks

This property shows the type of the resource being returned.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_display_name Property

This property shows the name of the resource being listed.

Syntax

def get_resource_display_name(resource_index: int) -> str: ...

Default Value

""

Remarks

This property shows the name of the resource being listed.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_last_modified Property

This property shows the date/time stamp of the last time the resource was modified.

Syntax

def get_resource_last_modified(resource_index: int) -> str: ...

Default Value

""

Remarks

This property shows the date/time stamp of the last time the resource was modified.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_uri Property

This property shows the URI of the resource being returned.

Syntax

def get_resource_uri(resource_index: int) -> str: ...

Default Value

""

Remarks

This property shows the URI of the resource being returned.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

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 class 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:

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

status_line Property

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

Syntax

def get_status_line() -> str: ...

status_line = property(get_status_line, None)

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 class, the error string is the same as the status_line property.

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, 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 class will wait for the operation to complete before returning control.

The class will use do_events 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 class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

transferred_data Property

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

Syntax

def get_transferred_data() -> bytes: ...

transferred_data = property(get_transferred_data, None)

Default Value

""

Remarks

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

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

This property is read-only.

transferred_data_limit Property

This property specifies the the maximum amount of data to be transferred.

Syntax

def get_transferred_data_limit() -> int: ...
def set_transferred_data_limit(value: int) -> None: ...

transferred_data_limit = property(get_transferred_data_limit, set_transferred_data_limit)

Default Value

0

Remarks

This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the transferred_data property.

transferred_headers Property

This property includes the full set of headers as received from the server.

Syntax

def get_transferred_headers() -> str: ...

transferred_headers = property(get_transferred_headers, None)

Default Value

""

Remarks

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

The on_header event shows the individual headers as parsed by the class.

This property is read-only.

user Property

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

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, set_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If auth_scheme 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 auth_scheme 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 auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM, and user and password are empty, the class will attempt to authenticate using the current user's credentials.

add_cookie Method

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

def add_cookie(cookie_name: str, cookie_value: str) -> None: ...

Remarks

This property 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.

add_namespace Method

Adds a namespace to the Namespaces properties.

Syntax

def add_namespace(prefix: str, namespace_uri: str) -> None: ...

Remarks

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

copy_resource Method

Copy a resource to a new location.

Syntax

def copy_resource(source_resource_uri: str, destination_resource_uri: str) -> None: ...

Remarks

The copy_resource method will copy 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 class will copy only SourceResourceURI. If depth is set to "infinity", the class will copy SourceResourceURI and its entire subtree to locations relative to it.

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

delete_resource Method

Delete a resource.

Syntax

def delete_resource(resource_uri: str) -> None: ...

Remarks

The resource or collection specified by ResourceURI is deleted. The delete_resource method behaves independently of the depth property. If ResourceURI denotes a non-collection resource, it is first removed from any collection which contains, then is removed from the server. If ResourceURI denotes a collection, the server behaves as if the command were issued with an infinite depth (ie, all internal member URIs denoting single resources or collections are deleted).

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

find_properties Method

Get resource property values from the server.

Syntax

def find_properties(resource_uri: str) -> None: ...

Remarks

find_properties will request the values for the names at each item provided in the properties properties. The matching URIs and property values will be returned through one or more on_resource_properties events (one for each matching resource).

If there are no properties set, then the server will be asked for all the properties of the resource. The properties will be returned via one or more on_resource_properties events.

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 a HTTP 403 Forbidden response.

find_property_names Method

Get resource property names from the server.

Syntax

def find_property_names(resource_uri: str) -> None: ...

Remarks

find_property_names will request names of all the properties of ResourceURI. The matching URIs will be returned through one or more on_resource_properties 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 a HTTP 403 Forbidden response.

get_property Method

Get the value for a particular property.

Syntax

def get_property(property_name: str) -> str: ...

Remarks

The class 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 is useful for reading values of composite properties.

get_resource Method

Get a resource using the WebDAV GET method.

Syntax

def get_resource(resource_uri: str) -> None: ...

Remarks

Fetch the resource using the WebDAV GET method. The resource contents are delivered through the on_transfer event, and the HTTP response headers through the on_header event.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_directory Method

List the files and subdirectories of the ResourceURI .

Syntax

def list_directory(resource_uri: str) -> None: ...

Remarks

This method will return a list of resources from the specified URI. The results will be returned through one or more on_dir_list 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 a HTTP 403 Forbidden response.

lock_resource Method

Obtain a lock for a specified resource.

Syntax

def lock_resource(resource_uri: str) -> None: ...

Remarks

The lock_resource 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 class will lock only ResourceURI and its properties. If depth is set to "infinity", the class will lock ResourceURI and its entire subtree.

If move_resource or copy_resource 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 non-lock owners from adding resources to that collection.

make_directory Method

Make a new directory.

Syntax

def make_directory(resource_uri: str) -> None: ...

Remarks

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

move_resource Method

Moves one resource to a new location.

Syntax

def move_resource(source_resource_uri: str, destination_resource_uri: str) -> None: ...

Remarks

The move_resource 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 class will move only SourceResourceURI. If depth is set to "infinity", the class will move SourceResourceURI and its entire subtree to locations relative to it.

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

patch_properties Method

Update the current set of properties on the server.

Syntax

def patch_properties(resource_uri: str) -> None: ...

Remarks

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

post_to_resource Method

Posts data to a resource using the WebDAV POST method.

Syntax

def post_to_resource(resource_uri: str, post_data: bytes) -> None: ...

Remarks

Posts data to the resource ResourceURI using the WebDAV POST method. The posted data is taken from PostData. The server response text is received through the on_transfer event, and the HTTP response headers through the on_header event. If local_file is not empty the data (not the headers) is written there as well.

put_resource Method

Send data to the server using the PUT method.

Syntax

def put_resource(resource_uri: str) -> None: ...

Remarks

The data is taken from local_file. The server will normally require authentication for this operation, so user and password must have valid values before the request is made.

reset Method

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

set_property Method

Set the value of a property.

Syntax

def set_property(property_name: str, property_value: str) -> None: ...

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 patch_properties on one property where the operation is opSet.

Example

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

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

un_lock_resource Method

Unlocks a resource.

Syntax

def un_lock_resource(resource_uri: str) -> None: ...

Remarks

Before calling un_lock_resource on a particular resource, the lock_tokens property must be set to the lock tokens for ResourceURI. The method will remove the lock, allowing other users or non-privileged users to access and operate on the file.

on_connected Event

This event is fired immediately after a connection completes (or fails).

Syntax

class WebDAVConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class WebDAV:
@property
def on_connected() -> Callable[[WebDAVConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[WebDAVConnectedEventParams], None]) -> None: ...

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.

on_connection_status Event

This event is fired to indicate changes in the connection state.

Syntax

class WebDAVConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class WebDAV:
@property
def on_connection_status() -> Callable[[WebDAVConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[WebDAVConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status 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:

on_dir_list Event

Fires for each entry returned in a directory listing.

Syntax

class WebDAVDirListEventParams(object):
  @property
  def resource_uri() -> str: ...

  @property
  def display_name() -> str: ...

  @property
  def content_language() -> str: ...

  @property
  def content_length() -> str: ...

  @property
  def content_type() -> str: ...

  @property
  def last_modified() -> str: ...

# In class WebDAV:
@property
def on_dir_list() -> Callable[[WebDAVDirListEventParams], None]: ...
@on_dir_list.setter
def on_dir_list(event_hook: Callable[[WebDAVDirListEventParams], None]) -> None: ...

Remarks

The on_dir_list event is fired when a directory listing is received as a response to list_directory.

The on_start_transfer and on_end_transfer events mark the beginning and end of the event stream.

on_disconnected Event

This event is fired when a connection is closed.

Syntax

class WebDAVDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class WebDAV:
@property
def on_disconnected() -> Callable[[WebDAVDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[WebDAVDisconnectedEventParams], None]) -> None: ...

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.

on_end_transfer Event

Fired when a document finishes transferring.

Syntax

class WebDAVEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class WebDAV:
@property
def on_end_transfer() -> Callable[[WebDAVEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[WebDAVEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer 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.

on_error Event

Information about errors during data delivery.

Syntax

class WebDAVErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class WebDAV:
@property
def on_error() -> Callable[[WebDAVErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[WebDAVErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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.

on_header Event

This event is fired every time a header line comes in.

Syntax

class WebDAVHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class WebDAV:
@property
def on_header() -> Callable[[WebDAVHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[WebDAVHeaderEventParams], None]) -> None: ...

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).

on_log Event

This event fires once for each log message.

Syntax

class WebDAVLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class WebDAV:
@property
def on_log() -> Callable[[WebDAVLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[WebDAVLogEventParams], None]) -> None: ...

Remarks

This event fires once for each log message generated by the class. 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"

on_redirect Event

This event is fired when a redirection is received from the server.

Syntax

class WebDAVRedirectEventParams(object):
  @property
  def location() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class WebDAV:
@property
def on_redirect() -> Callable[[WebDAVRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[WebDAVRedirectEventParams], None]) -> None: ...

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 class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_resource_properties Event

Fires for each entry returned through a property search.

Syntax

class WebDAVResourcePropertiesEventParams(object):
  @property
  def resource_uri() -> str: ...

  @property
  def resource_properties() -> str: ...

# In class WebDAV:
@property
def on_resource_properties() -> Callable[[WebDAVResourcePropertiesEventParams], None]: ...
@on_resource_properties.setter
def on_resource_properties(event_hook: Callable[[WebDAVResourcePropertiesEventParams], None]) -> None: ...

Remarks

The on_resource_properties event is fired when resource properties are received as a response to find_properties.

The on_start_transfer and on_end_transfer 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.

on_set_cookie Event

This event is fired for every cookie set by the server.

Syntax

class WebDAVSetCookieEventParams(object):
  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

  @property
  def expires() -> str: ...

  @property
  def domain() -> str: ...

  @property
  def path() -> str: ...

  @property
  def secure() -> bool: ...

# In class WebDAV:
@property
def on_set_cookie() -> Callable[[WebDAVSetCookieEventParams], None]: ...
@on_set_cookie.setter
def on_set_cookie(event_hook: Callable[[WebDAVSetCookieEventParams], None]) -> None: ...

Remarks

The on_set_cookie 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 (url_server) 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 (url_path) 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.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class WebDAVSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class WebDAV:
@property
def on_ssl_server_authentication() -> Callable[[WebDAVSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[WebDAVSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class WebDAVSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class WebDAV:
@property
def on_ssl_status() -> Callable[[WebDAVSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[WebDAVSSLStatusEventParams], None]) -> None: ...

Remarks

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

on_start_transfer Event

Fired when a document starts transferring (after the headers).

Syntax

class WebDAVStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class WebDAV:
@property
def on_start_transfer() -> Callable[[WebDAVStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[WebDAVStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer 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.

on_status Event

This event is fired when the HTTP status line is received from the server.

Syntax

class WebDAVStatusEventParams(object):
  @property
  def http_version() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class WebDAV:
@property
def on_status() -> Callable[[WebDAVStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[WebDAVStatusEventParams], None]) -> None: ...

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").

on_transfer Event

This event is fired while a document transfers (delivers document).

Syntax

class WebDAVTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class WebDAV:
@property
def on_transfer() -> Callable[[WebDAVTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[WebDAVTransferEventParams], None]) -> None: ...

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.

WebDAV Config Settings

WebDAV Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

WebDAV Errors

WebDAV Errors

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

HTTP Errors

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

SSLClient Errors

SSL Errors

TCP/IP Errors