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.impl;
18  
19  import org.apache.commons.vfs2.FileSystem;
20  import org.apache.commons.vfs2.FileSystemConfigBuilder;
21  import org.apache.commons.vfs2.FileSystemOptions;
22  import org.apache.commons.vfs2.UserAuthenticator;
23  
24  /**
25   * Default options usable for all file systems.
26   */
27  public class DefaultFileSystemConfigBuilder extends FileSystemConfigBuilder {
28      /** The default FileSystemConfigBuilder */
29      private static final DefaultFileSystemConfigBuilderigBuilder.html#DefaultFileSystemConfigBuilder">DefaultFileSystemConfigBuilder BUILDER = new DefaultFileSystemConfigBuilder();
30  
31      /**
32       * Gets the singleton builder.
33       *
34       * @return the singleton builder.
35       */
36      public static DefaultFileSystemConfigBuilder getInstance() {
37          return BUILDER;
38      }
39  
40      /**
41       * Sets the user authenticator to get authentication informations.
42       *
43       * @param opts The FileSystemOptions.
44       * @param userAuthenticator The UserAuthenticator.
45       */
46      public void setUserAuthenticator(final FileSystemOptions opts, final UserAuthenticator userAuthenticator) {
47          setParam(opts, "userAuthenticator", userAuthenticator);
48      }
49  
50      /**
51       * @see #setUserAuthenticator
52       * @param opts The FileSystemOptions.
53       * @return The UserAuthenticator.
54       */
55      public UserAuthenticator getUserAuthenticator(final FileSystemOptions opts) {
56          return getParam(opts, "userAuthenticator");
57      }
58  
59      /**
60       * Dummy class that implements FileSystem.
61       */
62      abstract static class DefaultFileSystem implements FileSystem {
63      }
64  
65      @Override
66      protected Class<? extends FileSystem> getConfigClass() {
67          return DefaultFileSystem.class;
68      }
69  }