org.codehaus.plexus.components.secdispatcher.MasterSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plexus-sec-dispatcher Show documentation

The newest version!

/*
 * Copyright (c) 2008 Sonatype, Inc. All rights reserved.
 *
 * This program is licensed to you under the Apache License Version 2.0,
 * and you may not use this file except in compliance with the Apache License Version 2.0.
 * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the Apache License Version 2.0 is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
 */

package org.codehaus.plexus.components.secdispatcher;

/**
 * Source of master password.
 */
public interface MasterSource {
    /**
     * Handles the config to get master password. Implementation may do one of the following things:
     * 
     *     if the config cannot be handled by given source, return {@code null}
     *     otherwise, if master password retrieval based on config was attempted but failed, throw {@link SecDispatcherException}
     *     happy path: return the master password.
     * 
     *
     * @param config the source of master password, and opaque string.
     * @return the master password, or {@code null} if implementation does not handle this config
     * @throws SecDispatcherException If implementation does handle this masterSource, but cannot obtain master password
     */
    String handle(String config) throws SecDispatcherException;

    /**
     * Validates master source configuration.
     * 
     *     if the config cannot be handled by given source, return {@code null}
     *     otherwise, implementation performs validation and returns non-{@code null} validation response
     * 
     */
    SecDispatcher.ValidationResponse validateConfiguration(String config);
}