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.webdav;
18  
19  import java.util.Arrays;
20  import java.util.Collection;
21  import java.util.Collections;
22  
23  import org.apache.commons.httpclient.HttpClient;
24  import org.apache.commons.vfs2.Capability;
25  import org.apache.commons.vfs2.FileName;
26  import org.apache.commons.vfs2.FileObject;
27  import org.apache.commons.vfs2.FileSystem;
28  import org.apache.commons.vfs2.FileSystemConfigBuilder;
29  import org.apache.commons.vfs2.FileSystemException;
30  import org.apache.commons.vfs2.FileSystemOptions;
31  import org.apache.commons.vfs2.UserAuthenticationData;
32  import org.apache.commons.vfs2.provider.GenericFileName;
33  import org.apache.commons.vfs2.provider.http.HttpClientFactory;
34  import org.apache.commons.vfs2.provider.http.HttpFileProvider;
35  import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
36  
37  /**
38   * A provider for WebDAV.
39   *
40   * @since 2.0
41   */
42  public class WebdavFileProvider extends HttpFileProvider {
43  
44      /**
45       * The authenticator types used by the WebDAV provider.
46       *
47       * @deprecated Might be removed in the next major version.
48       */
49      @Deprecated
50      public static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES = new UserAuthenticationData.Type[] {
51              UserAuthenticationData.USERNAME, UserAuthenticationData.PASSWORD };
52  
53      /** The capabilities of the WebDAV provider */
54      protected static final Collection<Capability> capabilities = Collections
55              .unmodifiableCollection(Arrays.asList(Capability.CREATE, Capability.DELETE, Capability.RENAME, Capability.GET_TYPE,
56                      Capability.LIST_CHILDREN, Capability.READ_CONTENT, Capability.URI, Capability.WRITE_CONTENT,
57                      Capability.GET_LAST_MODIFIED, Capability.ATTRIBUTES, Capability.RANDOM_ACCESS_READ,
58                      Capability.DIRECTORY_READ_CONTENT));
59  
60      public WebdavFileProvider() {
61          setFileNameParser(WebdavFileNameParser.getInstance());
62      }
63  
64      /**
65       * Creates a {@link FileSystem}.
66       * <p>
67       * If you're looking at this method and wondering how to get a FileSystemOptions object bearing the proxy host and
68       * credentials configuration through to this method so it's used for resolving a
69       * {@link org.apache.commons.vfs2.FileObject FileObject} in the FileSystem, then be sure to use correct signature of
70       * the {@link org.apache.commons.vfs2.FileSystemManager FileSystemManager} resolveFile method.
71       * </p>
72       *
73       * @see org.apache.commons.vfs2.impl.DefaultFileSystemManager#resolveFile(FileObject, String, FileSystemOptions)
74       */
75      @Override
76      protected FileSystem doCreateFileSystem(final FileName name, final FileSystemOptions fileSystemOptions)
77              throws FileSystemException {
78          // Create the file system
79          final GenericFileName rootName = (GenericFileName) name;
80          final FileSystemOptions fsOpts = fileSystemOptions == null ? new FileSystemOptions() : fileSystemOptions;
81  
82          UserAuthenticationData authData = null;
83          HttpClient httpClient;
84          try {
85              authData = UserAuthenticatorUtils.authenticate(fsOpts, AUTHENTICATOR_TYPES);
86  
87              httpClient = HttpClientFactory.createConnection(WebdavFileSystemConfigBuilder.getInstance(), "http",
88                      rootName.getHostName(), rootName.getPort(),
89                      UserAuthenticatorUtils.toString(UserAuthenticatorUtils.getData(authData,
90                              UserAuthenticationData.USERNAME, UserAuthenticatorUtils.toChar(rootName.getUserName()))),
91                      UserAuthenticatorUtils.toString(UserAuthenticatorUtils.getData(authData,
92                              UserAuthenticationData.PASSWORD, UserAuthenticatorUtils.toChar(rootName.getPassword()))),
93                      fsOpts);
94          } finally {
95              UserAuthenticatorUtils.cleanup(authData);
96          }
97  
98          return new WebdavFileSystem(rootName, httpClient, fsOpts);
99      }
100 
101     @Override
102     public FileSystemConfigBuilder getConfigBuilder() {
103         return WebdavFileSystemConfigBuilder.getInstance();
104     }
105 
106     @Override
107     public Collection<Capability> getCapabilities() {
108         return capabilities;
109     }
110 }