001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.io.crypto;
019
020import org.apache.hadoop.conf.Configurable;
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * An CipherProvider contributes support for various cryptographic Ciphers.
025 */
026@InterfaceAudience.Public
027public interface CipherProvider extends Configurable {
028
029  /**
030   * Return the provider's name
031   */
032  public String getName();
033
034  /**
035   * Return the set of Ciphers supported by this provider
036   */
037  public String[] getSupportedCiphers();
038
039  /**
040   * Get an Cipher
041   * @param name Cipher name, e.g. "AES"
042   * @return the appropriate Cipher
043   */
044  public Cipher getCipher(String name);
045
046}