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