001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.util;
018
019/**
020 * Encrypts and decrypts Strings.
021 *
022 * @since 2.0
023 */
024public interface Cryptor {
025
026    /**
027     * Decrypts the password.
028     *
029     * @param encryptedKey the encrypted password.
030     * @return The plain text password.
031     * @throws Exception If an error occurs.
032     */
033    String decrypt(String encryptedKey) throws Exception;
034
035    /**
036     * Encrypt the plain text password.
037     *
038     * @param plainKey The password.
039     * @return The encrypted password String.
040     * @throws Exception If an error occurs.
041     */
042    String encrypt(String plainKey) throws Exception;
043}