001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://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: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://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.crypto;
029
030import org.opencms.configuration.I_CmsConfigurationParameterHandler;
031import org.opencms.file.CmsObject;
032
033/**
034 * Interfaces for classes that encrypt text as text.
035 */
036public interface I_CmsTextEncryption extends I_CmsConfigurationParameterHandler {
037
038    /**
039     * Decrypts encrypted data.
040     *
041     * @param input the encrypted data
042     * @return the decrypted data
043     * @throws CmsEncryptionException if the data couldn't be decrypted
044     */
045    public String decrypt(String input) throws CmsEncryptionException;
046
047    /**
048     * Encrypts data.
049     *
050     * @param input the data to encrypt
051     * @return the encrypted data
052     * @throws CmsEncryptionException if the data couldn't be encrypted
053     */
054    public String encrypt(String input) throws CmsEncryptionException;
055
056    /**
057     * Gets the name of the encryption handler.
058     *
059     * @return the name
060     */
061    String getName();
062
063    /**
064     * Initializes the encryption handler.
065     *
066     * @param cms an Admin CMS context
067     */
068    void initialize(CmsObject cms);
069
070    /**
071     * Sets the name of the encryption handler.
072     *
073     * @param name the name that should be set
074     */
075    void setName(String name);
076
077}