1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.vfs2.provider.webdav;
18
19 import java.net.URLStreamHandler;
20 import java.util.Collection;
21
22 import org.apache.commons.httpclient.HttpClient;
23 import org.apache.commons.vfs2.Capability;
24 import org.apache.commons.vfs2.FileObject;
25 import org.apache.commons.vfs2.FileSystemOptions;
26 import org.apache.commons.vfs2.provider.AbstractFileName;
27 import org.apache.commons.vfs2.provider.DefaultURLStreamHandler;
28 import org.apache.commons.vfs2.provider.GenericFileName;
29 import org.apache.commons.vfs2.provider.http.HttpFileSystem;
30
31 /**
32 * A WebDAV file system.
33 *
34 * @since 2.0
35 */
36 public class WebdavFileSystem extends HttpFileSystem {
37
38 /**
39 * Constructs a new instance.
40 *
41 * @param rootName root base name
42 * @param httpClient {@link HttpClient} instance
43 * @param fileSystemOptions Options to build this file system.
44 */
45 protected WebdavFileSystem(final GenericFileName rootName, final HttpClient httpClient,
46 final FileSystemOptions fileSystemOptions) {
47 super(rootName, httpClient, fileSystemOptions);
48 }
49
50 /**
51 * Returns the capabilities of this file system.
52 *
53 * @param caps The Capabilities to add.
54 */
55 @Override
56 protected void addCapabilities(final Collection<Capability> caps) {
57 caps.addAll(WebdavFileProvider.capabilities);
58 }
59
60 /**
61 * Creates a file object. This method is called only if the requested file is not cached.
62 *
63 * @param name the FileName.
64 * @return The created FileObject.
65 */
66 @Override
67 protected FileObject createFile(final AbstractFileName name) {
68
69 return new WebdavFileObject(name, this);
70 }
71
72 @Override
73 protected HttpClient getClient() {
74 // make accessible
75 return super.getClient();
76 }
77
78 /**
79 * Gets a URLStreamHandler.
80 *
81 * @return The URLStreamHandler.
82 */
83 public URLStreamHandler getURLStreamHandler() {
84 return new DefaultURLStreamHandler(getContext(), getFileSystemOptions());
85 }
86 }