blob: 1885beea189b202efcd9776d6ae48895bd99e415 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.storm.blobstore.ClientBlobStore (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.blobstore, class: ClientBlobStore">
<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="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">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 Class org.apache.storm.blobstore.ClientBlobStore" class="title">Uses of Class<br>org.apache.storm.blobstore.ClientBlobStore</h1>
</div>
<div class="caption"><span>Packages that use <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</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.blobstore">org.apache.storm.blobstore</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.storm.hdfs.blobstore">org.apache.storm.hdfs.blobstore</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="#org.apache.storm.localizer">org.apache.storm.localizer</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.storm.utils">org.apache.storm.utils</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.storm.blobstore">
<h2>Uses of <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> in <a href="../package-summary.html">org.apache.storm.blobstore</a></h2>
<div class="caption"><span>Subclasses of <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> in <a href="../package-summary.html">org.apache.storm.blobstore</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="../LocalModeClientBlobStore.html" class="type-name-link" title="class in org.apache.storm.blobstore">LocalModeClientBlobStore</a></code></div>
<div class="col-last even-row-color">
<div class="block">A Client blob store for LocalMode.</div>
</div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../NimbusBlobStore.html" class="type-name-link" title="class in org.apache.storm.blobstore">NimbusBlobStore</a></code></div>
<div class="col-last odd-row-color">
<div class="block">NimbusBlobStore is a USER facing client API to perform basic operations such as create, update, delete and read for local and hdfs blob
store.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.storm.blobstore</a> with parameters of type <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</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>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientBlobStore.WithBlobstore.</span><code><a href="../ClientBlobStore.WithBlobstore.html#run(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">run</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;blobStore)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.hdfs.blobstore">
<h2>Uses of <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> in <a href="../../hdfs/blobstore/package-summary.html">org.apache.storm.hdfs.blobstore</a></h2>
<div class="caption"><span>Subclasses of <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> in <a href="../../hdfs/blobstore/package-summary.html">org.apache.storm.hdfs.blobstore</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/blobstore/HdfsClientBlobStore.html" class="type-name-link" title="class in org.apache.storm.hdfs.blobstore">HdfsClientBlobStore</a></code></div>
<div class="col-last even-row-color">
<div class="block">Client to access the HDFS blobStore.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.localizer">
<h2>Uses of <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> in <a href="../../localizer/package-summary.html">org.apache.storm.localizer</a></h2>
<div class="caption"><span>Methods in <a href="../../localizer/package-summary.html">org.apache.storm.localizer</a> that return <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</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>protected <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">AsyncLocalizer.</span><code><a href="../../localizer/AsyncLocalizer.html#getClientBlobStore()" class="member-name-link">getClientBlobStore</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../../localizer/package-summary.html">org.apache.storm.localizer</a> with parameters of type <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</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/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../../localizer/LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">LocalizedResourceRetentionSet.</span><code><a href="../../localizer/LocalizedResourceRetentionSet.html#cleanup(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">cleanup</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;store)</code></div>
<div class="col-last even-row-color">
<div class="block">Actually cleanup the blobs to try and get below the target cache size.</div>
</div>
<div class="col-first odd-row-color"><code>protected org.apache.storm.localizer.LocallyCachedBlob.DownloadMeta</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LocallyCachedBlob.</span><code><a href="../../localizer/LocallyCachedBlob.html#fetch(org.apache.storm.blobstore.ClientBlobStore,java.lang.String,org.apache.storm.localizer.IOFunction,org.apache.storm.localizer.IOFunction)" class="member-name-link">fetch</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;store,
<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;key,
<a href="../../localizer/IOFunction.html" title="interface in org.apache.storm.localizer">IOFunction</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a>&gt;&nbsp;pathSupplier,
<a href="../../localizer/IOFunction.html" title="interface in org.apache.storm.localizer">IOFunction</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&gt;&nbsp;outStreamSupplier)</code></div>
<div class="col-last odd-row-color">
<div class="block">Helper function to download blob from blob store.</div>
</div>
<div class="col-first even-row-color"><code>long</code></div>
<div class="col-second even-row-color"><span class="type-name-label">LocalizedResource.</span><code><a href="../../localizer/LocalizedResource.html#fetchUnzipToTemp(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">fetchUnzipToTemp</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;store)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>abstract long</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LocallyCachedBlob.</span><code><a href="../../localizer/LocallyCachedBlob.html#fetchUnzipToTemp(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">fetchUnzipToTemp</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;store)</code></div>
<div class="col-last odd-row-color">
<div class="block">Download the latest version to a temp location.</div>
</div>
<div class="col-first even-row-color"><code>long</code></div>
<div class="col-second even-row-color"><span class="type-name-label">LocallyCachedTopologyBlob.</span><code><a href="../../localizer/LocallyCachedTopologyBlob.html#fetchUnzipToTemp(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">fetchUnzipToTemp</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;store)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>long</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LocalizedResource.</span><code><a href="../../localizer/LocalizedResource.html#getRemoteVersion(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">getRemoteVersion</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;store)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>abstract long</code></div>
<div class="col-second even-row-color"><span class="type-name-label">LocallyCachedBlob.</span><code><a href="../../localizer/LocallyCachedBlob.html#getRemoteVersion(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">getRemoteVersion</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;store)</code></div>
<div class="col-last even-row-color">
<div class="block">Get the version of the blob in the blob store.</div>
</div>
<div class="col-first odd-row-color"><code>long</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LocallyCachedTopologyBlob.</span><code><a href="../../localizer/LocallyCachedTopologyBlob.html#getRemoteVersion(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">getRemoteVersion</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;store)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">LocallyCachedBlob.</span><code><a href="../../localizer/LocallyCachedBlob.html#update(org.apache.storm.blobstore.ClientBlobStore,long)" class="member-name-link">update</a><wbr>(<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;blobStore,
long&nbsp;remoteBlobstoreUpdateTime)</code></div>
<div class="col-last even-row-color">
<div class="block">Checks and downloads a blob locally as necessary.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.utils">
<h2>Uses of <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> in <a href="../../utils/package-summary.html">org.apache.storm.utils</a></h2>
<div class="caption"><span>Methods in <a href="../../utils/package-summary.html">org.apache.storm.utils</a> that return <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</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="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Utils.</span><code><a href="../../utils/Utils.html#getClientBlobStore(java.util.Map)" class="member-name-link">getClientBlobStore</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)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ServerUtils.</span><code><a href="../../utils/ServerUtils.html#getClientBlobStoreForSupervisor(java.util.Map)" class="member-name-link">getClientBlobStoreForSupervisor</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)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../../utils/package-summary.html">org.apache.storm.utils</a> with parameters of type <a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</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 long</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ServerUtils.</span><code><a href="../../utils/ServerUtils.html#nimbusVersionOfBlob(java.lang.String,org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">nimbusVersionOfBlob</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>&nbsp;key,
<a href="../ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a>&nbsp;cb)</code></div>
<div class="col-last even-row-color">&nbsp;</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>