<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InMemoryKeystore (ORC Core 1.9.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="InMemoryKeystore (ORC Core 1.9.0 API)";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/InMemoryKeystore.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/orc/FileMetadata.html" title="interface in org.apache.orc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/orc/IntegerColumnStatistics.html" title="interface in org.apache.orc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/orc/InMemoryKeystore.html" target="_top">Frames</a></li>
<li><a href="InMemoryKeystore.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.orc</div>
<h2 title="Class InMemoryKeystore" class="title">Class InMemoryKeystore</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.orc.InMemoryKeystore</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl">KeyProvider</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">InMemoryKeystore</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl">KeyProvider</a></pre>
<div class="block">This is an in-memory implementation of <a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl"><code>KeyProvider</code></a>.
 <p>
 The primary use of this class is for when the user doesn't have a
 Hadoop KMS running and wishes to use encryption. It is also useful for
 testing.
 <p>
 The local keys for this class are encrypted/decrypted using the cipher
 in CBC/NoPadding mode and a constant IV. Since the key is random, the
 constant IV is not a problem.
 <p>
 This class is not thread safe.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.orc.impl.KeyProvider">
<!--   -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.orc.impl.<a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl">KeyProvider</a></h3>
<code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.Factory.html?is-external=true" title="class or interface in org.apache.orc.impl">KeyProvider.Factory</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#SUPPORTS_AES_256">SUPPORTS_AES_256</a></span></code>
<div class="block">Support AES 256 ?</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#InMemoryKeystore--">InMemoryKeystore</a></span>()</code>
<div class="block">Create a new InMemoryKeystore.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#InMemoryKeystore-java.util.Random-">InMemoryKeystore</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Random.html?is-external=true" title="class or interface in java.util">Random</a>&nbsp;random)</code>
<div class="block">Create an InMemoryKeystore with the given random generator.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/orc/InMemoryKeystore.html" title="class in org.apache.orc">InMemoryKeystore</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#addKey-java.lang.String-org.apache.orc.EncryptionAlgorithm-byte:A-">addKey</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyName,
      <a href="https://orc.apache.org/api/orc-core/org/apache/orc/EncryptionAlgorithm.html?is-external=true" title="class or interface in org.apache.orc">EncryptionAlgorithm</a>&nbsp;algorithm,
      byte[]&nbsp;masterKey)</code>
<div class="block">Function that takes care of adding a new key.<br>
 A new key can be added only if:
 
 This is a new key and no prior key version exist.
 If the key exists (has versions), then the new version to be added should be greater than
 the version that already exists.
 </div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/orc/InMemoryKeystore.html" title="class in org.apache.orc">InMemoryKeystore</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#addKey-java.lang.String-int-org.apache.orc.EncryptionAlgorithm-byte:A-">addKey</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyName,
      int&nbsp;version,
      <a href="https://orc.apache.org/api/orc-core/org/apache/orc/EncryptionAlgorithm.html?is-external=true" title="class or interface in org.apache.orc">EncryptionAlgorithm</a>&nbsp;algorithm,
      byte[]&nbsp;masterKey)</code>
<div class="block">Function that takes care of adding a new key.<br>
 A new key can be added only if:
 
 This is a new key and no prior key version exist.
 If the key exists (has versions), then the new version to be added should be greater than
 the version that already exists.
 </div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/LocalKey.html?is-external=true" title="class or interface in org.apache.orc.impl">LocalKey</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#createLocalKey-org.apache.orc.impl.HadoopShims.KeyMetadata-">createLocalKey</a></span>(<a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/HadoopShims.KeyMetadata.html?is-external=true" title="class or interface in org.apache.orc.impl">HadoopShims.KeyMetadata</a>&nbsp;key)</code>
<div class="block">Create a local key for the given key version.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/security/Key.html?is-external=true" title="class or interface in java.security">Key</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#decryptLocalKey-org.apache.orc.impl.HadoopShims.KeyMetadata-byte:A-">decryptLocalKey</a></span>(<a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/HadoopShims.KeyMetadata.html?is-external=true" title="class or interface in org.apache.orc.impl">HadoopShims.KeyMetadata</a>&nbsp;key,
               byte[]&nbsp;encryptedKey)</code>
<div class="block">Create a local key for the given key version and initialization vector.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/HadoopShims.KeyMetadata.html?is-external=true" title="class or interface in org.apache.orc.impl">HadoopShims.KeyMetadata</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#getCurrentKeyVersion-java.lang.String-">getCurrentKeyVersion</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyName)</code>
<div class="block">Get the current metadata for a given key.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#getKeyNames--">getKeyNames</a></span>()</code>
<div class="block">Get the list of key names from the key provider.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/HadoopShims.KeyProviderKind.html?is-external=true" title="class or interface in org.apache.orc.impl">HadoopShims.KeyProviderKind</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/InMemoryKeystore.html#getKind--">getKind</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="SUPPORTS_AES_256">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SUPPORTS_AES_256</h4>
<pre>public static final&nbsp;boolean SUPPORTS_AES_256</pre>
<div class="block">Support AES 256 ?</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="InMemoryKeystore--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>InMemoryKeystore</h4>
<pre>public&nbsp;InMemoryKeystore()</pre>
<div class="block">Create a new InMemoryKeystore.</div>
</li>
</ul>
<a name="InMemoryKeystore-java.util.Random-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>InMemoryKeystore</h4>
<pre>public&nbsp;InMemoryKeystore(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Random.html?is-external=true" title="class or interface in java.util">Random</a>&nbsp;random)</pre>
<div class="block">Create an InMemoryKeystore with the given random generator.
 Except for testing, this must be a SecureRandom.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getKeyNames--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyNames</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getKeyNames()</pre>
<div class="block">Get the list of key names from the key provider.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true#getKeyNames--" title="class or interface in org.apache.orc.impl">getKeyNames</a></code>&nbsp;in interface&nbsp;<code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl">KeyProvider</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of key names</dd>
</dl>
</li>
</ul>
<a name="getCurrentKeyVersion-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentKeyVersion</h4>
<pre>public&nbsp;<a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/HadoopShims.KeyMetadata.html?is-external=true" title="class or interface in org.apache.orc.impl">HadoopShims.KeyMetadata</a>&nbsp;getCurrentKeyVersion(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyName)</pre>
<div class="block">Get the current metadata for a given key. This is used when encrypting
 new data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true#getCurrentKeyVersion-java.lang.String-" title="class or interface in org.apache.orc.impl">getCurrentKeyVersion</a></code>&nbsp;in interface&nbsp;<code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl">KeyProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyName</code> - the name of a key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>metadata for the current version of the key</dd>
</dl>
</li>
</ul>
<a name="createLocalKey-org.apache.orc.impl.HadoopShims.KeyMetadata-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createLocalKey</h4>
<pre>public&nbsp;<a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/LocalKey.html?is-external=true" title="class or interface in org.apache.orc.impl">LocalKey</a>&nbsp;createLocalKey(<a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/HadoopShims.KeyMetadata.html?is-external=true" title="class or interface in org.apache.orc.impl">HadoopShims.KeyMetadata</a>&nbsp;key)</pre>
<div class="block">Create a local key for the given key version.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true#createLocalKey-org.apache.orc.impl.HadoopShims.KeyMetadata-" title="class or interface in org.apache.orc.impl">createLocalKey</a></code>&nbsp;in interface&nbsp;<code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl">KeyProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the master key version</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the local key's material</dd>
</dl>
</li>
</ul>
<a name="decryptLocalKey-org.apache.orc.impl.HadoopShims.KeyMetadata-byte:A-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decryptLocalKey</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/security/Key.html?is-external=true" title="class or interface in java.security">Key</a>&nbsp;decryptLocalKey(<a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/HadoopShims.KeyMetadata.html?is-external=true" title="class or interface in org.apache.orc.impl">HadoopShims.KeyMetadata</a>&nbsp;key,
                           byte[]&nbsp;encryptedKey)</pre>
<div class="block">Create a local key for the given key version and initialization vector.
 Given a probabilistically unique iv, it will generate a unique key
 with the master key at the specified version. This allows the encryption
 to use this local key for the encryption and decryption without ever
 having access to the master key.
 <p>
 This uses KeyProviderCryptoExtension.decryptEncryptedKey with a fixed key
 of the appropriate length.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true#decryptLocalKey-org.apache.orc.impl.HadoopShims.KeyMetadata-byte:A-" title="class or interface in org.apache.orc.impl">decryptLocalKey</a></code>&nbsp;in interface&nbsp;<code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl">KeyProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the master key version</dd>
<dd><code>encryptedKey</code> - the unique initialization vector</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the local key's material</dd>
</dl>
</li>
</ul>
<a name="getKind--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKind</h4>
<pre>public&nbsp;<a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/HadoopShims.KeyProviderKind.html?is-external=true" title="class or interface in org.apache.orc.impl">HadoopShims.KeyProviderKind</a>&nbsp;getKind()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true#getKind--" title="class or interface in org.apache.orc.impl">getKind</a></code>&nbsp;in interface&nbsp;<code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl">KeyProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="addKey-java.lang.String-org.apache.orc.EncryptionAlgorithm-byte:A-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addKey</h4>
<pre>public&nbsp;<a href="../../../org/apache/orc/InMemoryKeystore.html" title="class in org.apache.orc">InMemoryKeystore</a>&nbsp;addKey(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyName,
                               <a href="https://orc.apache.org/api/orc-core/org/apache/orc/EncryptionAlgorithm.html?is-external=true" title="class or interface in org.apache.orc">EncryptionAlgorithm</a>&nbsp;algorithm,
                               byte[]&nbsp;masterKey)
                        throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Function that takes care of adding a new key.<br>
 A new key can be added only if:
 <ul>
 <li>This is a new key and no prior key version exist.</li>
 <li>If the key exists (has versions), then the new version to be added should be greater than
 the version that already exists.</li>
 </ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyName</code> - Name of the key to be added</dd>
<dd><code>algorithm</code> - Algorithm used</dd>
<dd><code>masterKey</code> - Master key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="addKey-java.lang.String-int-org.apache.orc.EncryptionAlgorithm-byte:A-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addKey</h4>
<pre>public&nbsp;<a href="../../../org/apache/orc/InMemoryKeystore.html" title="class in org.apache.orc">InMemoryKeystore</a>&nbsp;addKey(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyName,
                               int&nbsp;version,
                               <a href="https://orc.apache.org/api/orc-core/org/apache/orc/EncryptionAlgorithm.html?is-external=true" title="class or interface in org.apache.orc">EncryptionAlgorithm</a>&nbsp;algorithm,
                               byte[]&nbsp;masterKey)
                        throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Function that takes care of adding a new key.<br>
 A new key can be added only if:
 <ul>
 <li>This is a new key and no prior key version exist.</li>
 <li>If the key exists (has versions), then the new version to be added should be greater than
 the version that already exists.</li>
 </ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyName</code> - Name of the key to be added</dd>
<dd><code>version</code> - Key Version</dd>
<dd><code>algorithm</code> - Algorithm used</dd>
<dd><code>masterKey</code> - Master key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/InMemoryKeystore.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/orc/FileMetadata.html" title="interface in org.apache.orc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/orc/IntegerColumnStatistics.html" title="interface in org.apache.orc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/orc/InMemoryKeystore.html" target="_top">Frames</a></li>
<li><a href="InMemoryKeystore.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013&#x2013;2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
