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.apache.maven.settings.crypto;
20  
21  import java.util.List;
22  
23  import org.apache.maven.settings.Proxy;
24  import org.apache.maven.settings.Server;
25  
26  /**
27   * Collects parameters that control the decryption of settings.
28   *
29   * @author Benjamin Bentmann
30   */
31  public interface SettingsDecryptionRequest {
32  
33      /**
34       * Gets the servers whose passwords should be decrypted.
35       *
36       * @return The servers to decrypt, never {@code null}.
37       */
38      List<Server> getServers();
39  
40      /**
41       * Sets the servers whose passwords should be decrypted.
42       *
43       * @param servers The servers to decrypt, may be {@code null}.
44       * @return This request, never {@code null}.
45       */
46      SettingsDecryptionRequest setServers(List<Server> servers);
47  
48      /**
49       * Gets the proxies whose passwords should be decrypted.
50       *
51       * @return The proxies to decrypt, never {@code null}.
52       */
53      List<Proxy> getProxies();
54  
55      /**
56       * Sets the proxies whose passwords should be decrypted.
57       *
58       * @param proxies The proxies to decrypt, may be {@code null}.
59       * @return This request, never {@code null}.
60       */
61      SettingsDecryptionRequest setProxies(List<Proxy> proxies);
62  }