View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.vfs2.util;
18  
19  /**
20   * Encrypts and decrypts Strings.
21   *
22   * @since 2.0
23   */
24  public interface Cryptor {
25  
26      /**
27       * Decrypts the password.
28       *
29       * @param encryptedKey the encrypted password.
30       * @return The plain text password.
31       * @throws Exception If an error occurs.
32       */
33      String decrypt(String encryptedKey) throws Exception;
34  
35      /**
36       * Encrypt the plain text password.
37       *
38       * @param plainKey The password.
39       * @return The encrypted password String.
40       * @throws Exception If an error occurs.
41       */
42      String encrypt(String plainKey) throws Exception;
43  }