001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.repository;
020
021import java.util.Map;
022
023/**
024 * The authentication to use for accessing a protected resource. This acts basically as an extensible callback mechanism
025 * from which network operations can request authentication data like username and password when needed.
026 */
027public interface Authentication {
028
029    /**
030     * Fills the given authentication context with the data from this authentication callback. To do so, implementors
031     * have to call {@link AuthenticationContext#put(String, Object)}. <br>
032     * <br>
033     * The {@code key} parameter supplied to this method acts merely as a hint for interactive callbacks that want to
034     * prompt the user for only that authentication data which is required. Implementations are free to ignore this
035     * parameter and put all the data they have into the authentication context at once.
036     *
037     * @param context The authentication context to populate, must not be {@code null}.
038     * @param key The key denoting a specific piece of authentication data that is being requested for a network
039     *            operation, may be {@code null}.
040     * @param data Any (read-only) extra data in form of key value pairs that might be useful when getting the
041     *            authentication data, may be {@code null}.
042     */
043    void fill(AuthenticationContext context, String key, Map<String, String> data);
044
045    /**
046     * Updates the given digest with data from this authentication callback. To do so, implementors have to call the
047     * {@code update()} methods in {@link AuthenticationDigest}.
048     *
049     * @param digest The digest to update, must not be {@code null}.
050     */
051    void digest(AuthenticationDigest digest);
052}