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 java.security.Key; 021import org.apache.yetus.audience.InterfaceAudience; 022 023/** 024 * KeyProvider is a interface to abstract the different methods of retrieving key material from key 025 * storage such as Java key store. 026 */ 027@InterfaceAudience.Public 028public interface KeyProvider { 029 030 public static final String PASSWORD = "password"; 031 public static final String PASSWORDFILE = "passwordfile"; 032 033 /** 034 * Initialize the key provider 035 */ 036 public void init(String params); 037 038 /** 039 * Retrieve the key for a given key aliase 040 * @return the keys corresponding to the supplied alias, or null if a key is not found 041 */ 042 public Key getKey(String alias); 043 044 /** 045 * Retrieve keys for a given set of key aliases 046 * @param aliases an array of aliases 047 * @return an array of keys corresponding to the supplied aliases, an entry will be null if a key 048 * is not found 049 */ 050 public Key[] getKeys(String[] aliases); 051 052}