1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27 package org.apache.hc.client5.http.auth;
28
29 /**
30 * Abstract store of authentication credentials.
31 * <p>
32 * Implementations of this interface must be thread-safe. Access to shared
33 * data must be synchronized as methods of this interface may be executed
34 * from multiple threads.
35 * </p>
36 *
37 * @since 4.0
38 */
39 public interface CredentialsStore extends CredentialsProvider {
40
41 /**
42 * Sets the {@link Credentials credentials} for the given authentication
43 * scope. Any previous credentials for the given scope will be overwritten.
44 *
45 * @param authScope the {@link AuthScope authentication scope}
46 * @param credentials the authentication {@link Credentials credentials}
47 * for the given scope.
48 *
49 * @see #getCredentials(AuthScope, org.apache.hc.core5.http.protocol.HttpContext)
50 */
51 void setCredentials(AuthScope authScope, Credentials credentials);
52
53 /**
54 * Clears all credentials.
55 */
56 void clear();
57
58 }