| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ITransportPlugin (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="declaration: package: org.apache.storm.security.auth, interface: ITransportPlugin"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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 class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ITransportPlugin.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.security.auth</a></div> |
| <h1 title="Interface ITransportPlugin" class="title">Interface ITransportPlugin</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="digest/DigestSaslTransportPlugin.html" title="class in org.apache.storm.security.auth.digest">DigestSaslTransportPlugin</a></code>, <code><a href="kerberos/KerberosSaslTransportPlugin.html" title="class in org.apache.storm.security.auth.kerberos">KerberosSaslTransportPlugin</a></code>, <code><a href="plain/PlainSaslTransportPlugin.html" title="class in org.apache.storm.security.auth.plain">PlainSaslTransportPlugin</a></code>, <code><a href="sasl/SaslTransportPlugin.html" title="class in org.apache.storm.security.auth.sasl">SaslTransportPlugin</a></code>, <code><a href="SimpleTransportPlugin.html" title="class in org.apache.storm.security.auth">SimpleTransportPlugin</a></code>, <code><a href="../../testing/SingleUserSimpleTransport.html" title="class in org.apache.storm.testing">SingleUserSimpleTransport</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ITransportPlugin</span></div> |
| <div class="block">Interface for Thrift Transport plugin.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#areWorkerTokensSupported()" class="member-name-link">areWorkerTokensSupported</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Check if worker tokens are supported by this transport.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.storm.thrift.transport.TTransport</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#connect(org.apache.storm.thrift.transport.TTransport,java.lang.String,java.lang.String)" class="member-name-link">connect</a><wbr>(org.apache.storm.thrift.transport.TTransport transport, |
| <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> serverHost, |
| <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> asUser)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Connect to the specified server via framed transport.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPort()" class="member-name-link">getPort</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get port.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.storm.thrift.server.TServer</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServer(org.apache.storm.thrift.TProcessor)" class="member-name-link">getServer</a><wbr>(org.apache.storm.thrift.TProcessor processor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a server associated with a given port, service handler, and purpose.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#prepare(org.apache.storm.security.auth.ThriftConnectionType,java.util.Map)" class="member-name-link">prepare</a><wbr>(<a href="ThriftConnectionType.html" title="enum in org.apache.storm.security.auth">ThriftConnectionType</a> type, |
| <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><<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>> topoConf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Invoked once immediately after construction.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="prepare(org.apache.storm.security.auth.ThriftConnectionType,java.util.Map)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">prepare</span><wbr><span class="parameters">(<a href="ThriftConnectionType.html" title="enum in org.apache.storm.security.auth">ThriftConnectionType</a> type, |
| <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><<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>> topoConf)</span></div> |
| <div class="block">Invoked once immediately after construction.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - the type of connection this will process.</dd> |
| <dd><code>topoConf</code> - Storm configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServer(org.apache.storm.thrift.TProcessor)"> |
| <h3>getServer</h3> |
| <div class="member-signature"><span class="return-type">org.apache.storm.thrift.server.TServer</span> <span class="element-name">getServer</span><wbr><span class="parameters">(org.apache.storm.thrift.TProcessor processor)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| org.apache.storm.thrift.transport.TTransportException</span></div> |
| <div class="block">Create a server associated with a given port, service handler, and purpose.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>processor</code> - service handler</dd> |
| <dt>Returns:</dt> |
| <dd>server</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| <dd><code>org.apache.storm.thrift.transport.TTransportException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connect(org.apache.storm.thrift.transport.TTransport,java.lang.String,java.lang.String)"> |
| <h3>connect</h3> |
| <div class="member-signature"><span class="return-type">org.apache.storm.thrift.transport.TTransport</span> <span class="element-name">connect</span><wbr><span class="parameters">(org.apache.storm.thrift.transport.TTransport transport, |
| <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> serverHost, |
| <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> asUser)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| org.apache.storm.thrift.transport.TTransportException</span></div> |
| <div class="block">Connect to the specified server via framed transport.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>transport</code> - The underlying Thrift transport.</dd> |
| <dd><code>serverHost</code> - server host</dd> |
| <dd><code>asUser</code> - the user as which the connection should be established, and all the subsequent actions should be executed. Only |
| applicable when using secure storm cluster. A null/blank value here will just indicate to use the logged in user.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| <dd><code>org.apache.storm.thrift.transport.TTransportException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPort()"> |
| <h3>getPort</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getPort</span>()</div> |
| <div class="block">Get port.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The port this transport is using. This is not known until |
| <a href="#getServer(org.apache.storm.thrift.TProcessor)"><code>getServer(org.apache.storm.thrift.TProcessor)</code></a> has been called</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="areWorkerTokensSupported()"> |
| <h3>areWorkerTokensSupported</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">areWorkerTokensSupported</span>()</div> |
| <div class="block">Check if worker tokens are supported by this transport.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if they are else false.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
