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