001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2;
018
019/**
020 * The user authenticator is used to query credentials from the user. Since a UserAuthenticator
021 * is provided with the {@link FileSystemOptions} to a {@link FileSystem} it should also implement
022 * reasonable equals and hashCode functions if the FileSystem should be shared.
023 */
024public interface UserAuthenticator
025{
026    /**
027     * Queries the given type from the user.
028     * @param types An array containing the user's credentials
029     * @return The UserAuthenticationData.
030     */
031    UserAuthenticationData requestAuthentication(UserAuthenticationData.Type[] types);
032}