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