CredStash.java

/*
* Copyright 2015 herd contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.finra.herd.dao.credstash;

import java.util.Map;

/**
 * CredStash
 */
public interface CredStash
{
    /**
     * @param name Base name of the credential to retrieve
     * @param context key value map
     *
     * @return The plaintext contents of the credential (most recent version)
     * @throws Exception the runtime exception if the credential is not found
     */
    String getCredential(String name, Map<String, String> context) throws Exception;
}