001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.security;
029
030import org.opencms.configuration.I_CmsConfigurationParameterHandler;
031import org.opencms.file.CmsObject;
032
033/**
034 * Interface for a system-wide secret store, which can be used to access (string-valued) credentials like
035 * passwords or API keys for external services.
036 */
037public interface I_CmsSecretStore extends I_CmsConfigurationParameterHandler {
038
039    /**
040     * Gets the secret for the given key.
041     *
042     *  <p>If no secret is found, null will be returned.
043     *  <p>Note: this <em>may</em> be called before the initialize() method, and in that case, it should not throw any exceptions
044     *  (whether it can actually return something meaningful depends on the implementation).
045     *
046     * @param key the key for a secret
047     * @return the secret
048     */
049    String getSecret(String key);
050
051    /**
052     * The Admin CmsObject to use for Vfs operations, etc.
053     *
054     * @param cmsObject the admin CmsObject
055     */
056    void initialize(CmsObject cmsObject);
057
058}