001    package 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    
022    import java.util.List;
023    
024    import org.apache.maven.settings.Proxy;
025    import org.apache.maven.settings.Server;
026    
027    /**
028     * Collects parameters that control the decryption of settings.
029     * 
030     * @author Benjamin Bentmann
031     */
032    public interface SettingsDecryptionRequest
033    {
034    
035        /**
036         * Gets the servers whose passwords should be decrypted.
037         * 
038         * @return The servers to decrypt, never {@code null}.
039         */
040        List<Server> getServers();
041    
042        /**
043         * Sets the servers whose passwords should be decrypted.
044         * 
045         * @param servers The servers to decrypt, may be {@code null}.
046         * @return This request, never {@code null}.
047         */
048        SettingsDecryptionRequest setServers( List<Server> servers );
049    
050        /**
051         * Gets the proxies whose passwords should be decrypted.
052         * 
053         * @return The proxies to decrypt, never {@code null}.
054         */
055        List<Proxy> getProxies();
056    
057        /**
058         * Sets the proxies whose passwords should be decrypted.
059         * 
060         * @param proxies The proxies to decrypt, may be {@code null}.
061         * @return This request, never {@code null}.
062         */
063        SettingsDecryptionRequest setProxies( List<Proxy> proxies );
064    
065    }