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   * @since 2.0
21   */
22  public interface Cryptor {
23  
24      /**
25       * Encrypt the plain text password.
26       *
27       * @param plainKey The password.
28       * @return The encrypted password String.
29       * @throws Exception If an error occurs.
30       */
31      String encrypt(String plainKey) throws Exception;
32  
33      /**
34       * Decrypts the password.
35       *
36       * @param encryptedKey the encrypted password.
37       * @return The plain text password.
38       * @throws Exception If an error occurs.
39       */
40      String decrypt(String encryptedKey) throws Exception;
41  }