001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with this
004 * work for additional information regarding copyright ownership. The ASF
005 * licenses this file to you under the Apache License, Version 2.0 (the
006 * "License"); you may not use this file except in compliance with the License.
007 * 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, WITHOUT
013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 * License for the specific language governing permissions and limitations under
015 * the License.
016 */
017package org.apache.hadoop.hbase.io.crypto;
018
019import org.apache.hadoop.conf.Configurable;
020import org.apache.yetus.audience.InterfaceAudience;
021
022/**
023 * An CipherProvider contributes support for various cryptographic
024 * 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}