View Javadoc
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      protected Webdav4FileSystem(final FileName rootName, final FileSystemOptions fileSystemOptions,
40              final HttpClient httpClient, final HttpClientContext httpClientContext) {
41          super(rootName, fileSystemOptions, httpClient, httpClientContext);
42      }
43  
44      /**
45       * Returns the capabilities of this file system.
46       *
47       * @param caps The Capabilities to add.
48       */
49      @Override
50      protected void addCapabilities(final Collection<Capability> caps) {
51          caps.addAll(Webdav4FileProvider.capabilities);
52      }
53  
54      /**
55       * Creates a file object. This method is called only if the requested file is not cached.
56       *
57       * @param name the FileName.
58       * @return The created FileObject.
59       */
60      @Override
61      protected FileObject createFile(final AbstractFileName name) throws Exception {
62          return new Webdav4FileObject(name, this);
63      }
64  
65      /**
66       * Return a URLStreamHandler.
67       *
68       * @return The URLStreamHandler.
69       */
70      public URLStreamHandler getURLStreamHandler() {
71          return new DefaultURLStreamHandler(getContext(), getFileSystemOptions());
72      }
73  }