001package org.apache.maven.settings.crypto;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.util.List;
023
024import org.apache.maven.settings.Proxy;
025import org.apache.maven.settings.Server;
026import org.apache.maven.settings.building.SettingsProblem;
027
028/**
029 * Collects the output of the settings decrypter.
030 *
031 * @author Benjamin Bentmann
032 */
033public interface SettingsDecryptionResult
034{
035
036    /**
037     * Gets the decrypted server. This is a convenience method to retrieve the first element from {@link #getServers()}.
038     *
039     * @return The decrypted server or {@code null}.
040     */
041    Server getServer();
042
043    /**
044     * Gets the decrypted servers.
045     *
046     * @return The decrypted server, can be empty but never {@code null}.
047     */
048    List<Server> getServers();
049
050    /**
051     * Gets the decrypted proxy. This is a convenience method to retrieve the first element from {@link #getProxies()}.
052     *
053     * @return The decrypted proxy or {@code null}.
054     */
055    Proxy getProxy();
056
057    /**
058     * Gets the decrypted proxies.
059     *
060     * @return The decrypted proxy, can be empty but never {@code null}.
061     */
062    List<Proxy> getProxies();
063
064    /**
065     * Gets the problems that were encountered during the settings decryption.
066     *
067     * @return The problems that were encountered during the decryption, can be empty but never {@code null}.
068     */
069    List<SettingsProblem> getProblems();
070
071}