View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.repository;
20  
21  import java.util.Map;
22  
23  /**
24   * The authentication to use for accessing a protected resource. This acts basically as an extensible callback mechanism
25   * from which network operations can request authentication data like username and password when needed.
26   */
27  public interface Authentication {
28  
29      /**
30       * Fills the given authentication context with the data from this authentication callback. To do so, implementors
31       * have to call {@link AuthenticationContext#put(String, Object)}. <br>
32       * <br>
33       * The {@code key} parameter supplied to this method acts merely as a hint for interactive callbacks that want to
34       * prompt the user for only that authentication data which is required. Implementations are free to ignore this
35       * parameter and put all the data they have into the authentication context at once.
36       *
37       * @param context The authentication context to populate, must not be {@code null}.
38       * @param key The key denoting a specific piece of authentication data that is being requested for a network
39       *            operation, may be {@code null}.
40       * @param data Any (read-only) extra data in form of key value pairs that might be useful when getting the
41       *            authentication data, may be {@code null}.
42       */
43      void fill(AuthenticationContext context, String key, Map<String, String> data);
44  
45      /**
46       * Updates the given digest with data from this authentication callback. To do so, implementors have to call the
47       * {@code update()} methods in {@link AuthenticationDigest}.
48       *
49       * @param digest The digest to update, must not be {@code null}.
50       */
51      void digest(AuthenticationDigest digest);
52  }