Please check the Parameter Reference Documentation for an overview of the available YADE parameters.
Issues
WebDAV support is subject to the following issues:
YADE-172 - Getting issue details... STATUS
Example: transfer from WebDAV server to local file system
First we create some global profiles for file transfer from a WebDAV host to a localhost:
[local_target_host] target_protocol = local target_dir = /tmp/test/jade/in [webdav_source_host] source_protocol = webdav source_host = http://homer.sos/jade source_port = 80 source_user = test source_password = 12345 source_ssh_auth_method = url [copy_webdav2local] include = webdav_source_host,local_target_host operation = copy
The profile copy_webdav2local will be included in further profiles.
Example with file_path
In the file_path option you can add a list of source file names.
If the option source_dir is empty then these file names have to be specified with absolute paths from the viewpoint of the WebDAV server (e.g. DocumentRoot setting in Apache).
- If the option source_dir is not empty then these file names have to be specified with relative paths to the source_dir directory. The source_dir directory has to be specified with an absolute path from the viewpoint of the WebDAV server (e.g. DocumentRoot setting in Apache).
In this example there are two files with the same name in different source directories: /jade/out/1.txt and /jade/out2/1.txt
After the transfer there is only one file /tmp/test/jade/in/1.txt in the target directory.
This is a special situation and a good example to discuss the difference in behaviour depending on the options overwrite_files (default: true) and append_files (default: false).
Here we have three profiles:
[filepath_append] include = copy_webdav2local file_path = /jade/out/1.txt;/jade/out2/1.txt append_files = true [filepath_no_overwrite] include = copy_webdav2local file_path = /jade/out/1.txt;/jade/out2/1.txt overwrite_files = false [filepath_overwrite] include = copy_webdav2local file_path = /jade/out/1.txt;/jade/out2/1.txt
- In the first example filepath_append the target file has the content of both source files.
The second transfer of /jade/out2/1.txt appends the already existing target file /tmp/test/jade/in/1.txt which was created after the first transfer of /jade/out/1.txt. - In the second example filepath_no_overwrite the target file has the content of the first source files (/jade/out/1.txt).
The second transfer of /jade/out2/1.txt is skipped because /tmp/test/jade/in/1.txt already exists after the first transfer of /jade/out/1.txt. - In the third example filepath_overwrite the target file has the content of the second source files (/jade/out2/1.txt).
The second transfer of /jade/out2/1.txt overwrites the target file /tmp/test/jade/in/1.txt from the first transfer of /jade/out/1.txt.
You can also use
file_path = 1.txt;../out2/1.txt source_dir = /jade/out/
or
file_path = out/1.txt;out2/1.txt source_dir = /jade/
instead of the above setting
file_path = /jade/out/1.txt;/jade/out2/1.txt
Example with file_spec
The file_spec option expects a regular expression to select files from the directory that is specified by the source_dir option.
- By the following first profile filespec all files with names ending in .txt. will be transferred from the directory /jade/out to /tmp/test/jade/in
- By the second profile recursive the recursive option (default:
false) is used to transfer all files with names ending in .txt from subdirectories of source_dir
[filespec] include = copy_webdav2local source_dir = /jade/out file_spec = \.txt$ [recursive] include = copy_webdav2local source_dir = /jade/out file_spec = \.txt$ recursive = true
Example with file_spec behind a proxy
First we create a global profile for the proxy parameter:
[webdav_source_proxy] source_proxy_host = proxy.sos source_proxy_port = 3128 #source_proxy_user = #source_proxy_password =
The profile webdav_source_proxy will be included in above file_spec profile:
[filespec_with_proxy] include = copy_webdav2local,webdav_source_proxy source_dir = /jade/out file_spec = \.txt$
and so you receive the above example with file_spec with proxy support.
Example: transfer from local file system to WebDAV server
First we create some global profiles for file transfer from the localhost to a WebDAV server:
[local_source_host] source_protocol = local [webdav_target_host] target_protocol = webdav target_host = http://homer.sos/jade target_port = 80 target_user = test target_password = 12345 target_ssh_auth_method = url target_dir = /jade/in [copy_local2webdav] include = webdav_target_host,local_source_host operation = copy
The profile copy_local2webdav will be included in further profiles.
Please note that the target_dir has to be specified as absolute path from the viewpoint of the WebDAV server (e.g. DocumentRoot setting in Apache).
The target_dir is not relative to the location in which WebDAV is operated.
Example with file_path
This example is similar to the above example with file_path for transfer from WebDAV host to localhost, however, the direction has changed.
[filepath] include = copy_local2webdav file_path = /tmp/test/jade/in/1.txt
The append_files parameter is reported not to have worked for some releases. Using this parameter prevents /tmp/test/jade/out2/1.txt from overwriting /tmp/test/jade/out/1.txt as by the following profile:
[filepath_append] include = copy_local2webdav file_path = /tmp/test/jade/out/1.txt;/tmp/test/jade/out2/1.txt append_files = true
Example with file_spec
These examples are similar to the above example with file_spec, however, directions have changed.
- By the first profile filespec transfers are effected for files with names ending in .txt from /tmp/test/jade/out to /jade/in
- By the second profile recursive the recursive option (default:
false) is used to transfer files with names ending in .txt from subdirectories of source_dir
[filespec] include = copy_local2webdav source_dir = /tmp/test/jade/out file_spec = \.txt$ [recursive] include = copy_local2webdav source_dir = /tmp/test/jade/out file_spec = \.txt$ recursive = true
Example with file_spec behind a proxy
First we create a global profile for the proxy parameter:
[webdav_target_proxy] target_proxy_host = proxy.sos target_proxy_port = 3128 #target_proxy_user = #target_proxy_password =
The profile webdav_target_proxy will be included in above file_spec profile:
[filespec_with_proxy] include = copy_local2webdav,webdav_target_proxy source_dir = /tmp/test/jade/out file_spec = \.txt$
as a result you receive the above example with file_spec with proxy support.