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
29 /**
30 * Dummy class that implements FileSystem.
31 */
32 abstract static class DefaultFileSystem implements FileSystem {
33 }
34
35 /** The default FileSystemConfigBuilder */
36 private static final DefaultFileSystemConfigBuilder BUILDER = new DefaultFileSystemConfigBuilder();
37
38 /**
39 * Gets the singleton builder.
40 *
41 * @return the singleton builder.
42 */
43 public static DefaultFileSystemConfigBuilder getInstance() {
44 return BUILDER;
45 }
46
47 /**
48 * Constructs a new instance.
49 */
50 public DefaultFileSystemConfigBuilder() {
51 // empty
52 }
53
54 @Override
55 protected Class<? extends FileSystem> getConfigClass() {
56 return DefaultFileSystem.class;
57 }
58
59 /**
60 * Gets the UserAuthenticator parameter.
61 *
62 * @see #setUserAuthenticator
63 * @param opts The FileSystemOptions.
64 * @return The UserAuthenticator parameter..
65 */
66 public UserAuthenticator getUserAuthenticator(final FileSystemOptions opts) {
67 return getParam(opts, "userAuthenticator");
68 }
69
70 /**
71 * Sets the user authenticator to get authentication information.
72 *
73 * @param opts The FileSystemOptions.
74 * @param userAuthenticator The UserAuthenticator.
75 */
76 public void setUserAuthenticator(final FileSystemOptions opts, final UserAuthenticator userAuthenticator) {
77 setParam(opts, "userAuthenticator", userAuthenticator);
78 }
79 }