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.http;
18  
19  import java.util.Collection;
20  
21  import org.apache.commons.httpclient.HttpClient;
22  import org.apache.commons.httpclient.HttpConnectionManager;
23  import org.apache.commons.httpclient.MultiThreadedHttpConnectionManager;
24  import org.apache.commons.vfs2.Capability;
25  import org.apache.commons.vfs2.FileObject;
26  import org.apache.commons.vfs2.FileSystemOptions;
27  import org.apache.commons.vfs2.provider.AbstractFileName;
28  import org.apache.commons.vfs2.provider.AbstractFileSystem;
29  import org.apache.commons.vfs2.provider.GenericFileName;
30  
31  /**
32   * An HTTP file system.
33   */
34  public class HttpFileSystem extends AbstractFileSystem {
35  
36      private final HttpClient client;
37  
38      protected HttpFileSystem(final GenericFileName rootName, final HttpClient client,
39              final FileSystemOptions fileSystemOptions) {
40          super(rootName, null, fileSystemOptions);
41          this.client = client;
42      }
43  
44      /**
45       * Adds the capabilities of this file system.
46       */
47      @Override
48      protected void addCapabilities(final Collection<Capability> caps) {
49          caps.addAll(HttpFileProvider.capabilities);
50      }
51  
52      protected HttpClient getClient() {
53          return client;
54      }
55  
56      /** @since 2.0 */
57      @Override
58      public void closeCommunicationLink() {
59          if (getClient() != null) {
60              final HttpConnectionManager mgr = getClient().getHttpConnectionManager();
61              if (mgr instanceof MultiThreadedHttpConnectionManager) {
62                  ((MultiThreadedHttpConnectionManager) mgr).shutdown();
63              }
64          }
65      }
66  
67      /**
68       * Creates a file object. This method is called only if the requested file is not cached.
69       */
70      @Override
71      protected FileObject createFile(final AbstractFileName name) throws Exception {
72          return new HttpFileObject<>(name, this);
73      }
74  }