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