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;
18  
19  /**
20   * The user authenticator is used to query credentials from the user. Since a UserAuthenticator is provided with the
21   * {@link FileSystemOptions} to a {@link FileSystem} it should also implement reasonable equals and hashCode functions
22   * if the FileSystem should be shared.
23   */
24  public interface UserAuthenticator {
25  
26      /**
27       * Queries the given type from the user.
28       *
29       * @param types An array containing the user's credentials
30       * @return The UserAuthenticationData.
31       */
32      UserAuthenticationData requestAuthentication(UserAuthenticationData.Type[] types);
33  }