| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>LocalFsBlobStore (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.blobstore, class: LocalFsBlobStore"> |
| <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/LocalFsBlobStore.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><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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.blobstore</a></div> |
| <h1 title="Class LocalFsBlobStore" class="title">Class LocalFsBlobStore</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a> |
| <div class="inheritance"><a href="BlobStore.html" title="class in org.apache.storm.blobstore">org.apache.storm.blobstore.BlobStore</a> |
| <div class="inheritance">org.apache.storm.blobstore.LocalFsBlobStore</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../daemon/Shutdownable.html" title="interface in org.apache.storm.daemon">Shutdownable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LocalFsBlobStore</span> |
| <span class="extends-implements">extends <a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></span></div> |
| <div class="block">Provides a local file system backed blob store implementation for Nimbus. |
| |
| <p>For a local blob store the user and the supervisor use NimbusBlobStore Client API in order to talk to nimbus through thrift. |
| The authentication and authorization here is based on the subject. |
| We currently have NIMBUS_ADMINS and SUPERVISOR_ADMINS configuration. NIMBUS_ADMINS are given READ, WRITE and ADMIN |
| access whereas the SUPERVISOR_ADMINS are given READ access in order to read and download the blobs form the nimbus. |
| |
| <p>The ACLs for the blob store are validated against whether the subject is a NIMBUS_ADMIN, SUPERVISOR_ADMIN or USER |
| who has read, write or admin privileges in order to perform respective operations on the blob. |
| |
| <p>For local blob store |
| 1. The USER interacts with nimbus to upload and access blobs through NimbusBlobStore Client API. |
| 2. The USER sets the ACLs, and the blob access is validated against these ACLs. |
| 3. The SUPERVISOR interacts with nimbus through the NimbusBlobStore Client API to download the blobs. |
| The supervisors principal should match the set of users configured into SUPERVISOR_ADMINS. |
| Here, the PrincipalToLocalPlugin takes care of mapping the principal to user name before the ACL validation.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.storm.blobstore.BlobStore">Nested classes/interfaces inherited from class org.apache.storm.blobstore.<a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></h2> |
| <code><a href="BlobStore.BlobStoreFileInputStream.html" title="class in org.apache.storm.blobstore">BlobStore.BlobStoreFileInputStream</a>, <a href="BlobStore.BlobStoreFileOutputStream.html" title="class in org.apache.storm.blobstore">BlobStore.BlobStoreFileOutputStream</a>, <a href="BlobStore.KeyTranslationIterator.html" title="class in org.apache.storm.blobstore">BlobStore.KeyTranslationIterator</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</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">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="BlobStoreAclHandler.html" title="class in org.apache.storm.blobstore">BlobStoreAclHandler</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#aclHandler" class="member-name-link">aclHandler</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final org.slf4j.Logger</code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.blobstore.BlobStore">Fields inherited from class org.apache.storm.blobstore.<a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></h3> |
| <code><a href="BlobStore.html#BASE_BLOBS_DIR_NAME">BASE_BLOBS_DIR_NAME</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">LocalFsBlobStore</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkForBlobOrDownload(java.lang.String)" class="member-name-link">checkForBlobOrDownload</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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkForBlobUpdate(java.lang.String)" class="member-name-link">checkForBlobUpdate</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> key)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AtomicOutputStream.html" title="class in org.apache.storm.blobstore">AtomicOutputStream</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createBlob(java.lang.String,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)" class="member-name-link">createBlob</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> key, |
| <a href="../generated/SettableBlobMeta.html" title="class in org.apache.storm.generated">SettableBlobMeta</a> meta, |
| <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> who)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates the blob.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteBlob(java.lang.String,javax.security.auth.Subject)" class="member-name-link">deleteBlob</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> key, |
| <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> who)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deletes the blob data and metadata.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fullCleanup(long)" class="member-name-link">fullCleanup</a><wbr>(long age)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InputStreamWithMeta.html" title="class in org.apache.storm.blobstore">InputStreamWithMeta</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlob(java.lang.String,javax.security.auth.Subject)" class="member-name-link">getBlob</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> key, |
| <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> who)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the InputStream to read the blob details.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../generated/ReadableBlobMeta.html" title="class in org.apache.storm.generated">ReadableBlobMeta</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlobMeta(java.lang.String,javax.security.auth.Subject)" class="member-name-link">getBlobMeta</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> key, |
| <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> who)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the current version of metadata for a blob to be viewed by the user or downloaded by the supervisor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlobReplication(java.lang.String,javax.security.auth.Subject)" class="member-name-link">getBlobReplication</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> key, |
| <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> who)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the replication factor of the blob.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listKeys()" class="member-name-link">listKeys</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an iterator with all the list of keys currently available on the blob store.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prepare(java.util.Map,java.lang.String,org.apache.storm.nimbus.NimbusInfo,org.apache.storm.nimbus.ILeaderElector)" class="member-name-link">prepare</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><<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>> conf, |
| <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> overrideBase, |
| <a href="../nimbus/NimbusInfo.html" title="class in org.apache.storm.nimbus">NimbusInfo</a> nimbusInfo, |
| <a href="../nimbus/ILeaderElector.html" title="interface in org.apache.storm.nimbus">ILeaderElector</a> leaderElector)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Allows us to initialize the blob store.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBlobMeta(java.lang.String,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)" class="member-name-link">setBlobMeta</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> key, |
| <a href="../generated/SettableBlobMeta.html" title="class in org.apache.storm.generated">SettableBlobMeta</a> meta, |
| <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> who)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the metadata with renewed acls for the blob.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLeaderElector(org.apache.storm.nimbus.ILeaderElector)" class="member-name-link">setLeaderElector</a><wbr>(<a href="../nimbus/ILeaderElector.html" title="interface in org.apache.storm.nimbus">ILeaderElector</a> leaderElector)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets leader elector (only used by LocalFsBlobStore to help sync blobs between Nimbi.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shutdown()" class="member-name-link">shutdown</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startSyncBlobs()" class="member-name-link">startSyncBlobs</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Start the syncing blobs between the local running instance of the BlobStore and others.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AtomicOutputStream.html" title="class in org.apache.storm.blobstore">AtomicOutputStream</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateBlob(java.lang.String,javax.security.auth.Subject)" class="member-name-link">updateBlob</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> key, |
| <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> who)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Updates the blob data.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateBlobReplication(java.lang.String,int,javax.security.auth.Subject)" class="member-name-link">updateBlobReplication</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> key, |
| int replication, |
| <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> who)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Modifies the replication factor of the blob.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.blobstore.BlobStore">Methods inherited from class org.apache.storm.blobstore.<a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></h3> |
| <code><a href="BlobStore.html#close()">close</a>, <a href="BlobStore.html#createBlob(java.lang.String,byte%5B%5D,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)">createBlob</a>, <a href="BlobStore.html#createBlob(java.lang.String,java.io.InputStream,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)">createBlob</a>, <a href="BlobStore.html#filterAndListKeys(org.apache.storm.blobstore.KeyFilter)">filterAndListKeys</a>, <a href="BlobStore.html#readBlob(java.lang.String,javax.security.auth.Subject)">readBlob</a>, <a href="BlobStore.html#readBlobTo(java.lang.String,java.io.OutputStream,javax.security.auth.Subject)">readBlobTo</a>, <a href="BlobStore.html#storedTopoIds()">storedTopoIds</a>, <a href="BlobStore.html#updateBlob(java.lang.String,byte%5B%5D,javax.security.auth.Subject)">updateBlob</a>, <a href="BlobStore.html#updateLastBlobUpdateTime()">updateLastBlobUpdateTime</a>, <a href="BlobStore.html#validateBlobUpdateTime()">validateBlobUpdateTime</a>, <a href="BlobStore.html#validateKey(java.lang.String)">validateKey</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name">LOG</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="aclHandler"> |
| <h3>aclHandler</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="BlobStoreAclHandler.html" title="class in org.apache.storm.blobstore">BlobStoreAclHandler</a></span> <span class="element-name">aclHandler</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>LocalFsBlobStore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LocalFsBlobStore</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="prepare(java.util.Map,java.lang.String,org.apache.storm.nimbus.NimbusInfo,org.apache.storm.nimbus.ILeaderElector)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">prepare</span><wbr><span class="parameters">(<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>> conf, |
| <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> overrideBase, |
| <a href="../nimbus/NimbusInfo.html" title="class in org.apache.storm.nimbus">NimbusInfo</a> nimbusInfo, |
| <a href="../nimbus/ILeaderElector.html" title="interface in org.apache.storm.nimbus">ILeaderElector</a> leaderElector)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#prepare(java.util.Map,java.lang.String,org.apache.storm.nimbus.NimbusInfo,org.apache.storm.nimbus.ILeaderElector)">BlobStore</a></code></span></div> |
| <div class="block">Allows us to initialize the blob store.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#prepare(java.util.Map,java.lang.String,org.apache.storm.nimbus.NimbusInfo,org.apache.storm.nimbus.ILeaderElector)">prepare</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - The storm configuration</dd> |
| <dd><code>overrideBase</code> - The directory path to store the blobs</dd> |
| <dd><code>nimbusInfo</code> - Contains the nimbus host, port and leadership information</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startSyncBlobs()"> |
| <h3>startSyncBlobs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">startSyncBlobs</span>() |
| throws <span class="exceptions"><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a>, |
| <a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#startSyncBlobs()">BlobStore</a></code></span></div> |
| <div class="block">Start the syncing blobs between the local running instance of the BlobStore and others. |
| A no-op for the HdfsBlobStore where HDFS itself does the syncing |
| but for the LocalFsBlobStore ZK state updates are run periodically here.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="BlobStore.html#startSyncBlobs()">startSyncBlobs</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></code></dd> |
| <dd><code><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createBlob(java.lang.String,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)"> |
| <h3>createBlob</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="AtomicOutputStream.html" title="class in org.apache.storm.blobstore">AtomicOutputStream</a></span> <span class="element-name">createBlob</span><wbr><span class="parameters">(<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> key, |
| <a href="../generated/SettableBlobMeta.html" title="class in org.apache.storm.generated">SettableBlobMeta</a> meta, |
| <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> who)</span> |
| throws <span class="exceptions"><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a>, |
| <a href="../generated/KeyAlreadyExistsException.html" title="class in org.apache.storm.generated">KeyAlreadyExistsException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#createBlob(java.lang.String,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)">BlobStore</a></code></span></div> |
| <div class="block">Creates the blob.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#createBlob(java.lang.String,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)">createBlob</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - Key for the blob</dd> |
| <dd><code>meta</code> - Metadata which contains the acls information</dd> |
| <dd><code>who</code> - Is the subject creating the blob</dd> |
| <dt>Returns:</dt> |
| <dd>AtomicOutputStream returns a stream into which the data can be written</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a></code></dd> |
| <dd><code><a href="../generated/KeyAlreadyExistsException.html" title="class in org.apache.storm.generated">KeyAlreadyExistsException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateBlob(java.lang.String,javax.security.auth.Subject)"> |
| <h3>updateBlob</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="AtomicOutputStream.html" title="class in org.apache.storm.blobstore">AtomicOutputStream</a></span> <span class="element-name">updateBlob</span><wbr><span class="parameters">(<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> key, |
| <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> who)</span> |
| throws <span class="exceptions"><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a>, |
| <a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#updateBlob(java.lang.String,javax.security.auth.Subject)">BlobStore</a></code></span></div> |
| <div class="block">Updates the blob data.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#updateBlob(java.lang.String,javax.security.auth.Subject)">updateBlob</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - Key for the blob</dd> |
| <dd><code>who</code> - Is the subject having the write privilege for the blob</dd> |
| <dt>Returns:</dt> |
| <dd>AtomicOutputStream returns a stream into which the data can be written</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a></code></dd> |
| <dd><code><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBlobMeta(java.lang.String,javax.security.auth.Subject)"> |
| <h3>getBlobMeta</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../generated/ReadableBlobMeta.html" title="class in org.apache.storm.generated">ReadableBlobMeta</a></span> <span class="element-name">getBlobMeta</span><wbr><span class="parameters">(<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> key, |
| <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> who)</span> |
| throws <span class="exceptions"><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a>, |
| <a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#getBlobMeta(java.lang.String,javax.security.auth.Subject)">BlobStore</a></code></span></div> |
| <div class="block">Gets the current version of metadata for a blob to be viewed by the user or downloaded by the supervisor.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#getBlobMeta(java.lang.String,javax.security.auth.Subject)">getBlobMeta</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - Key for the blob</dd> |
| <dd><code>who</code> - Is the subject having the read privilege for the blob</dd> |
| <dt>Returns:</dt> |
| <dd>AtomicOutputStream returns a stream into which the data can be written</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a></code></dd> |
| <dd><code><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLeaderElector(org.apache.storm.nimbus.ILeaderElector)"> |
| <h3>setLeaderElector</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLeaderElector</span><wbr><span class="parameters">(<a href="../nimbus/ILeaderElector.html" title="interface in org.apache.storm.nimbus">ILeaderElector</a> leaderElector)</span></div> |
| <div class="block">Sets leader elector (only used by LocalFsBlobStore to help sync blobs between Nimbi.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#setLeaderElector(org.apache.storm.nimbus.ILeaderElector)">setLeaderElector</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBlobMeta(java.lang.String,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)"> |
| <h3>setBlobMeta</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setBlobMeta</span><wbr><span class="parameters">(<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> key, |
| <a href="../generated/SettableBlobMeta.html" title="class in org.apache.storm.generated">SettableBlobMeta</a> meta, |
| <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> who)</span> |
| throws <span class="exceptions"><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a>, |
| <a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#setBlobMeta(java.lang.String,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)">BlobStore</a></code></span></div> |
| <div class="block">Sets the metadata with renewed acls for the blob.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#setBlobMeta(java.lang.String,org.apache.storm.generated.SettableBlobMeta,javax.security.auth.Subject)">setBlobMeta</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - Key for the blob</dd> |
| <dd><code>meta</code> - Metadata which contains the updated acls information</dd> |
| <dd><code>who</code> - Is the subject having the write privilege for the blob</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a></code></dd> |
| <dd><code><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deleteBlob(java.lang.String,javax.security.auth.Subject)"> |
| <h3>deleteBlob</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">deleteBlob</span><wbr><span class="parameters">(<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> key, |
| <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> who)</span> |
| throws <span class="exceptions"><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a>, |
| <a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#deleteBlob(java.lang.String,javax.security.auth.Subject)">BlobStore</a></code></span></div> |
| <div class="block">Deletes the blob data and metadata.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#deleteBlob(java.lang.String,javax.security.auth.Subject)">deleteBlob</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - Key for the blob</dd> |
| <dd><code>who</code> - Is the subject having write privilege for the blob</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a></code></dd> |
| <dd><code><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBlob(java.lang.String,javax.security.auth.Subject)"> |
| <h3>getBlob</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="InputStreamWithMeta.html" title="class in org.apache.storm.blobstore">InputStreamWithMeta</a></span> <span class="element-name">getBlob</span><wbr><span class="parameters">(<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> key, |
| <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> who)</span> |
| throws <span class="exceptions"><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a>, |
| <a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#getBlob(java.lang.String,javax.security.auth.Subject)">BlobStore</a></code></span></div> |
| <div class="block">Gets the InputStream to read the blob details.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#getBlob(java.lang.String,javax.security.auth.Subject)">getBlob</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - Key for the blob</dd> |
| <dd><code>who</code> - Is the subject having the read privilege for the blob</dd> |
| <dt>Returns:</dt> |
| <dd>InputStreamWithMeta has the additional file length and version information</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a></code></dd> |
| <dd><code><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="listKeys()"> |
| <h3>listKeys</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</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>></span> <span class="element-name">listKeys</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#listKeys()">BlobStore</a></code></span></div> |
| <div class="block">Returns an iterator with all the list of keys currently available on the blob store.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#listKeys()">listKeys</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Returns:</dt> |
| <dd><code>Iterator<String></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdown()"> |
| <h3>shutdown</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">shutdown</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBlobReplication(java.lang.String,javax.security.auth.Subject)"> |
| <h3>getBlobReplication</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getBlobReplication</span><wbr><span class="parameters">(<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> key, |
| <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> who)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#getBlobReplication(java.lang.String,javax.security.auth.Subject)">BlobStore</a></code></span></div> |
| <div class="block">Gets the replication factor of the blob.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#getBlobReplication(java.lang.String,javax.security.auth.Subject)">getBlobReplication</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - Key for the blob</dd> |
| <dd><code>who</code> - Is the subject having the read privilege for the blob</dd> |
| <dt>Returns:</dt> |
| <dd>BlobReplication object containing the replication factor for the blob</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateBlobReplication(java.lang.String,int,javax.security.auth.Subject)"> |
| <h3>updateBlobReplication</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">updateBlobReplication</span><wbr><span class="parameters">(<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> key, |
| int replication, |
| <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> who)</span> |
| throws <span class="exceptions"><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a>, |
| <a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BlobStore.html#updateBlobReplication(java.lang.String,int,javax.security.auth.Subject)">BlobStore</a></code></span></div> |
| <div class="block">Modifies the replication factor of the blob.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="BlobStore.html#updateBlobReplication(java.lang.String,int,javax.security.auth.Subject)">updateBlobReplication</a></code> in class <code><a href="BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - Key for the blob</dd> |
| <dd><code>replication</code> - The replication factor the blob has to be set</dd> |
| <dd><code>who</code> - Is the subject having the update privilege for the blob</dd> |
| <dt>Returns:</dt> |
| <dd>BlobReplication object containing the updated replication factor for the blob</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../generated/AuthorizationException.html" title="class in org.apache.storm.generated">AuthorizationException</a></code></dd> |
| <dd><code><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkForBlobOrDownload(java.lang.String)"> |
| <h3>checkForBlobOrDownload</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">checkForBlobOrDownload</span><wbr><span class="parameters">(<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> key)</span> |
| throws <span class="exceptions"><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="../generated/KeyNotFoundException.html" title="class in org.apache.storm.generated">KeyNotFoundException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkForBlobUpdate(java.lang.String)"> |
| <h3>checkForBlobUpdate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">checkForBlobUpdate</span><wbr><span class="parameters">(<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> key)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fullCleanup(long)"> |
| <h3>fullCleanup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">fullCleanup</span><wbr><span class="parameters">(long age)</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></span></div> |
| <dl class="notes"> |
| <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> |
| </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> |
