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  import org.apache.maven.settings.building.SettingsProblem;
26  
27  /**
28   * Collects the output of the settings decrypter.
29   *
30   */
31  public interface SettingsDecryptionResult {
32  
33      /**
34       * Gets the decrypted server. This is a convenience method to retrieve the first element from {@link #getServers()}.
35       *
36       * @return The decrypted server or {@code null}.
37       */
38      Server getServer();
39  
40      /**
41       * Gets the decrypted servers.
42       *
43       * @return The decrypted server, can be empty but never {@code null}.
44       */
45      List<Server> getServers();
46  
47      /**
48       * Gets the decrypted proxy. This is a convenience method to retrieve the first element from {@link #getProxies()}.
49       *
50       * @return The decrypted proxy or {@code null}.
51       */
52      Proxy getProxy();
53  
54      /**
55       * Gets the decrypted proxies.
56       *
57       * @return The decrypted proxy, can be empty but never {@code null}.
58       */
59      List<Proxy> getProxies();
60  
61      /**
62       * Gets the problems that were encountered during the settings decryption.
63       *
64       * @return The problems that were encountered during the decryption, can be empty but never {@code null}.
65       */
66      List<SettingsProblem> getProblems();
67  }