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 this
4    * work for additional information regarding copyright ownership. The ASF
5    * licenses this file to you under the Apache License, Version 2.0 (the
6    * "License"); you may not use this file except in compliance with the License.
7    * 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, WITHOUT
13   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14   * License for the specific language governing permissions and limitations under
15   * the License.
16   */
17  package org.apache.hadoop.hbase.io.crypto;
18  
19  import org.apache.hadoop.hbase.classification.InterfaceAudience;
20  import org.apache.hadoop.hbase.classification.InterfaceStability;
21  import org.apache.hadoop.conf.Configurable;
22  
23  /**
24   * An CipherProvider contributes support for various cryptographic
25   * Ciphers.
26   */
27  @InterfaceAudience.Public
28  @InterfaceStability.Evolving
29  public interface CipherProvider extends Configurable {
30  
31    /**
32     * Return the provider's name
33     */
34    public String getName();
35  
36    /**
37     * Return the set of Ciphers supported by this provider
38     */
39    public String[] getSupportedCiphers();
40  
41    /**
42     * Get an Cipher
43     * @param name Cipher name, e.g. "AES"
44     * @return the appropriate Cipher
45     */
46    public Cipher getCipher(String name);
47  
48  }