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.webdav4;
18
19 import java.net.URLStreamHandler;
20 import java.util.Collection;
21
22 import org.apache.commons.vfs2.Capability;
23 import org.apache.commons.vfs2.FileName;
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.http4.Http4FileSystem;
29 import org.apache.http.client.HttpClient;
30 import org.apache.http.client.protocol.HttpClientContext;
31
32 /**
33 * A WebDAV file system based on HTTP4.
34 *
35 * @since 2.5.0
36 */
37 public class Webdav4FileSystem extends Http4FileSystem {
38
39 /**
40 * Constructs a new instance.
41 *
42 * @param rootName root base name
43 * @param fileSystemOptions file system options
44 * @param httpClient {@link HttpClient} instance
45 * @param httpClientContext {@link HttpClientContext} instance
46 */
47 protected Webdav4FileSystem(final FileName rootName, final FileSystemOptions fileSystemOptions,
48 final HttpClient httpClient, final HttpClientContext httpClientContext) {
49 super(rootName, fileSystemOptions, httpClient, httpClientContext);
50 }
51
52 /**
53 * Returns the capabilities of this file system.
54 *
55 * @param caps The Capabilities to add.
56 */
57 @Override
58 protected void addCapabilities(final Collection<Capability> caps) {
59 caps.addAll(Webdav4FileProvider.capabilities);
60 }
61
62 /**
63 * Creates a file object. This method is called only if the requested file is not cached.
64 *
65 * @param name the FileName.
66 * @return The created FileObject.
67 */
68 @Override
69 protected FileObject createFile(final AbstractFileName name) throws Exception {
70 return new Webdav4FileObject(name, this);
71 }
72
73 /**
74 * Gets a URLStreamHandler.
75 *
76 * @return The URLStreamHandler.
77 */
78 public URLStreamHandler getURLStreamHandler() {
79 return new DefaultURLStreamHandler(getContext(), getFileSystemOptions());
80 }
81 }