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.vfs.provider.http;
18  
19  import org.apache.commons.httpclient.HttpClient;
20  import org.apache.commons.vfs.FileName;
21  import org.apache.commons.vfs.FileObject;
22  import org.apache.commons.vfs.FileSystem;
23  import org.apache.commons.vfs.FileSystemOptions;
24  import org.apache.commons.vfs.provider.AbstractFileSystem;
25  import org.apache.commons.vfs.provider.GenericFileName;
26  
27  import java.util.Collection;
28  
29  /***
30   * An HTTP file system.
31   *
32   * @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
33   * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
34   */
35  public class HttpFileSystem
36      extends AbstractFileSystem
37      implements FileSystem
38  {
39      private final HttpClient client;
40  
41      protected HttpFileSystem(final GenericFileName rootName, final HttpClient client, final FileSystemOptions fileSystemOptions)
42      {
43          super(rootName, null, fileSystemOptions);
44          this.client = client;
45      }
46  
47      /***
48       * Adds the capabilities of this file system.
49       */
50      protected void addCapabilities(final Collection caps)
51      {
52          caps.addAll(HttpFileProvider.capabilities);
53      }
54  
55      protected HttpClient getClient()
56      {
57          return client;
58      }
59  
60      /***
61       * Creates a file object.  This method is called only if the requested
62       * file is not cached.
63       */
64      protected FileObject createFile(final FileName name)
65          throws Exception
66      {
67          return new HttpFileObject(name, this);
68      }
69  }