blob: e5a444b5f0157b1ecdf3805fa6b5a07d7277e4b2 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Interface org.apache.storm.security.auth.IAutoCredentials (Storm 2.6.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="use: package: org.apache.storm.security.auth, interface: IAutoCredentials">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Interface org.apache.storm.security.auth.IAutoCredentials" class="title">Uses of Interface<br>org.apache.storm.security.auth.IAutoCredentials</h1>
</div>
<div class="caption"><span>Packages that use <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.storm.common">org.apache.storm.common</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.storm.daemon.worker">org.apache.storm.daemon.worker</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="#org.apache.storm.hbase.security">org.apache.storm.hbase.security</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.storm.hdfs.security">org.apache.storm.hdfs.security</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="#org.apache.storm.hive.security">org.apache.storm.hive.security</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.storm.security.auth">org.apache.storm.security.auth</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="#org.apache.storm.security.auth.kerberos">org.apache.storm.security.auth.kerberos</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.storm.common">
<h2>Uses of <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a> in <a href="../../../common/package-summary.html">org.apache.storm.common</a></h2>
<div class="caption"><span>Classes in <a href="../../../common/package-summary.html">org.apache.storm.common</a> that implement <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../../../common/AbstractHadoopAutoCreds.html" class="type-name-link" title="class in org.apache.storm.common">AbstractHadoopAutoCreds</a></code></div>
<div class="col-last even-row-color">
<div class="block">The base class that for auto credential plugins that abstracts out some of the common functionality.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.daemon.worker">
<h2>Uses of <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a> in <a href="../../../daemon/worker/package-summary.html">org.apache.storm.daemon.worker</a></h2>
<div class="caption"><span>Methods in <a href="../../../daemon/worker/package-summary.html">org.apache.storm.daemon.worker</a> that return types with arguments of type <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">WorkerState.</span><code><a href="../../../daemon/worker/WorkerState.html#getAutoCredentials()" class="member-name-link">getAutoCredentials</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Constructor parameters in <a href="../../../daemon/worker/package-summary.html">org.apache.storm.daemon.worker</a> with type arguments of type <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../../../daemon/worker/WorkerState.html#%3Cinit%3E(java.util.Map,org.apache.storm.messaging.IContext,java.lang.String,java.lang.String,java.util.function.Supplier,int,java.lang.String,java.util.Map,org.apache.storm.cluster.IStateStorage,org.apache.storm.cluster.IStormClusterState,java.util.Collection,org.apache.storm.metrics2.StormMetricRegistry,org.apache.storm.generated.Credentials)" class="member-name-link">WorkerState</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
<a href="../../../messaging/IContext.html" title="interface in org.apache.storm.messaging">IContext</a>&nbsp;mqContext,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyId,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;assignmentId,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="../../../utils/SupervisorIfaceFactory.html" title="interface in org.apache.storm.utils">SupervisorIfaceFactory</a>&gt;&nbsp;supervisorIfaceSupplier,
int&nbsp;port,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;workerId,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;topologyConf,
<a href="../../../cluster/IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a>&nbsp;stateStorage,
<a href="../../../cluster/IStormClusterState.html" title="interface in org.apache.storm.cluster">IStormClusterState</a>&nbsp;stormClusterState,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a>&gt;&nbsp;autoCredentials,
<a href="../../../metrics2/StormMetricRegistry.html" title="class in org.apache.storm.metrics2">StormMetricRegistry</a>&nbsp;metricRegistry,
<a href="../../../generated/Credentials.html" title="class in org.apache.storm.generated">Credentials</a>&nbsp;initialCredentials)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.hbase.security">
<h2>Uses of <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a> in <a href="../../../hbase/security/package-summary.html">org.apache.storm.hbase.security</a></h2>
<div class="caption"><span>Classes in <a href="../../../hbase/security/package-summary.html">org.apache.storm.hbase.security</a> that implement <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../../../hbase/security/AutoHBase.html" class="type-name-link" title="class in org.apache.storm.hbase.security">AutoHBase</a></code></div>
<div class="col-last even-row-color">
<div class="block">Auto credentials plugin for HBase implementation.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.hdfs.security">
<h2>Uses of <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a> in <a href="../../../hdfs/security/package-summary.html">org.apache.storm.hdfs.security</a></h2>
<div class="caption"><span>Classes in <a href="../../../hdfs/security/package-summary.html">org.apache.storm.hdfs.security</a> that implement <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../../../hdfs/security/AutoHDFS.html" class="type-name-link" title="class in org.apache.storm.hdfs.security">AutoHDFS</a></code></div>
<div class="col-last even-row-color">
<div class="block">Auto credentials plugin for HDFS implementation.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.hive.security">
<h2>Uses of <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a> in <a href="../../../hive/security/package-summary.html">org.apache.storm.hive.security</a></h2>
<div class="caption"><span>Classes in <a href="../../../hive/security/package-summary.html">org.apache.storm.hive.security</a> that implement <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../../../hive/security/AutoHive.html" class="type-name-link" title="class in org.apache.storm.hive.security">AutoHive</a></code></div>
<div class="col-last even-row-color">
<div class="block">Auto credentials plugin for Hive implementation.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.security.auth">
<h2>Uses of <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a> in <a href="../package-summary.html">org.apache.storm.security.auth</a></h2>
<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.storm.security.auth</a> that implement <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../AutoSSL.html" class="type-name-link" title="class in org.apache.storm.security.auth">AutoSSL</a></code></div>
<div class="col-last even-row-color">
<div class="block">This plugin is intended to be used for user topologies to send SSL keystore/truststore files to the remote workers.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.storm.security.auth</a> that return types with arguments of type <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientAuthUtils.</span><code><a href="../ClientAuthUtils.html#getAutoCredentials(java.util.Map)" class="member-name-link">getAutoCredentials</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;topoConf)</code></div>
<div class="col-last even-row-color">
<div class="block">Get all of the configured AutoCredential Plugins.</div>
</div>
</div>
<div class="caption"><span>Method parameters in <a href="../package-summary.html">org.apache.storm.security.auth</a> with type arguments of type <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/security/auth/Subject.html" title="class or interface in javax.security.auth" class="external-link">Subject</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientAuthUtils.</span><code><a href="../ClientAuthUtils.html#populateSubject(javax.security.auth.Subject,java.util.Collection,java.util.Map)" class="member-name-link">populateSubject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/security/auth/Subject.html" title="class or interface in javax.security.auth" class="external-link">Subject</a>&nbsp;subject,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a>&gt;&nbsp;autos,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;credentials)</code></div>
<div class="col-last even-row-color">
<div class="block">Populate a subject from credentials using the IAutoCredentials.</div>
</div>
<div class="col-first odd-row-color"><code>static void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientAuthUtils.</span><code><a href="../ClientAuthUtils.html#updateSubject(javax.security.auth.Subject,java.util.Collection,java.util.Map)" class="member-name-link">updateSubject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/security/auth/Subject.html" title="class or interface in javax.security.auth" class="external-link">Subject</a>&nbsp;subject,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a>&gt;&nbsp;autos,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;credentials)</code></div>
<div class="col-last odd-row-color">
<div class="block">Update a subject from credentials using the IAutoCredentials.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.security.auth.kerberos">
<h2>Uses of <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a> in <a href="../kerberos/package-summary.html">org.apache.storm.security.auth.kerberos</a></h2>
<div class="caption"><span>Classes in <a href="../kerberos/package-summary.html">org.apache.storm.security.auth.kerberos</a> that implement <a href="../IAutoCredentials.html" title="interface in org.apache.storm.security.auth">IAutoCredentials</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../kerberos/AutoTGT.html" class="type-name-link" title="class in org.apache.storm.security.auth.kerberos">AutoTGT</a></code></div>
<div class="col-last even-row-color">
<div class="block">Automatically take a user's TGT, and push it, and renew it in Nimbus.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>