| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>LocalizedResource (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.localizer, class: LocalizedResource"> |
| <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/LocalizedResource.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><a href="#field-summary">Field</a> | </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.localizer</a></div> |
| <h1 title="Class LocalizedResource" class="title">Class LocalizedResource</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="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">org.apache.storm.localizer.LocallyCachedBlob</a> |
| <div class="inheritance">org.apache.storm.localizer.LocalizedResource</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LocalizedResource</span> |
| <span class="extends-implements">extends <a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></span></div> |
| <div class="block">Represents a resource that is localized on the supervisor. A localized resource has a .current symlink to the current version file which |
| is named filename.{current version}. There is also a filename.version which contains the latest version.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.localizer.LocallyCachedBlob">Fields inherited from class org.apache.storm.localizer.<a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></h3> |
| <code><a href="LocallyCachedBlob.html#localUpdateTime">localUpdateTime</a>, <a href="LocallyCachedBlob.html#NOT_DOWNLOADED_VERSION">NOT_DOWNLOADED_VERSION</a></code></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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#cleanupOrphanedData()" class="member-name-link">cleanupOrphanedData</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clean up any temporary files.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#commitNewVersion(long)" class="member-name-link">commitNewVersion</a><wbr>(long version)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Commit the new version and make it available for the end user.</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="#completelyRemove()" class="member-name-link">completelyRemove</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Completely remove anything that is cached locally for this blob and all tracking files also stored for it.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</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> other)</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>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fetchUnzipToTemp(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">fetchUnzipToTemp</a><wbr>(<a href="../blobstore/ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> store)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Download the latest version to a temp location.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocalVersion()" class="member-name-link">getLocalVersion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the version of the blob cached locally.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRemoteVersion(org.apache.storm.blobstore.ClientBlobStore)" class="member-name-link">getRemoteVersion</a><wbr>(<a href="../blobstore/ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> store)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the version of the blob in the blob store.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSizeOnDisk()" class="member-name-link">getSizeOnDisk</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the amount of disk space that is used by this blob.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</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>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFullyDownloaded()" class="member-name-link">isFullyDownloaded</a>()</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>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSize(long)" class="member-name-link">setSize</a><wbr>(long size)</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="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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.localizer.LocallyCachedBlob">Methods inherited from class org.apache.storm.localizer.<a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></h3> |
| <code><a href="LocallyCachedBlob.html#addReference(org.apache.storm.localizer.PortAndAssignment,org.apache.storm.localizer.BlobChangingCallback)">addReference</a>, <a href="LocallyCachedBlob.html#fetch(org.apache.storm.blobstore.ClientBlobStore,java.lang.String,org.apache.storm.localizer.IOFunction,org.apache.storm.localizer.IOFunction)">fetch</a>, <a href="LocallyCachedBlob.html#getDependencies()">getDependencies</a>, <a href="LocallyCachedBlob.html#getKey()">getKey</a>, <a href="LocallyCachedBlob.html#getLastUsed()">getLastUsed</a>, <a href="LocallyCachedBlob.html#getSizeOnDisk(java.nio.file.Path)">getSizeOnDisk</a>, <a href="LocallyCachedBlob.html#informReferencesAndCommitNewVersion(long)">informReferencesAndCommitNewVersion</a>, <a href="LocallyCachedBlob.html#isUsed()">isUsed</a>, <a href="LocallyCachedBlob.html#removeReference(org.apache.storm.localizer.PortAndAssignment)">removeReference</a>, <a href="LocallyCachedBlob.html#touch()">touch</a>, <a href="LocallyCachedBlob.html#update(org.apache.storm.blobstore.ClientBlobStore,long)">update</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#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#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#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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setSize(long)"> |
| <h3>setSize</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">setSize</span><wbr><span class="parameters">(long size)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLocalVersion()"> |
| <h3>getLocalVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getLocalVersion</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="LocallyCachedBlob.html#getLocalVersion()">LocallyCachedBlob</a></code></span></div> |
| <div class="block">Get the version of the blob cached locally. If the version is unknown or it has not been downloaded NOT_DOWNLOADED_VERSION should be |
| returned. PRECONDITION: this can only be called with a lock on this instance held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="LocallyCachedBlob.html#getLocalVersion()">getLocalVersion</a></code> in class <code><a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteVersion(org.apache.storm.blobstore.ClientBlobStore)"> |
| <h3>getRemoteVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getRemoteVersion</span><wbr><span class="parameters">(<a href="../blobstore/ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> store)</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="LocallyCachedBlob.html#getRemoteVersion(org.apache.storm.blobstore.ClientBlobStore)">LocallyCachedBlob</a></code></span></div> |
| <div class="block">Get the version of the blob in the blob store. PRECONDITION: this can only be called with a lock on this instance held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="LocallyCachedBlob.html#getRemoteVersion(org.apache.storm.blobstore.ClientBlobStore)">getRemoteVersion</a></code> in class <code><a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</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="fetchUnzipToTemp(org.apache.storm.blobstore.ClientBlobStore)"> |
| <h3>fetchUnzipToTemp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">fetchUnzipToTemp</span><wbr><span class="parameters">(<a href="../blobstore/ClientBlobStore.html" title="class in org.apache.storm.blobstore">ClientBlobStore</a> store)</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>, |
| <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="LocallyCachedBlob.html#fetchUnzipToTemp(org.apache.storm.blobstore.ClientBlobStore)">LocallyCachedBlob</a></code></span></div> |
| <div class="block">Download the latest version to a temp location. This may also include unzipping some or all of the data to a temp location. |
| PRECONDITION: this can only be called with a lock on this instance held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="LocallyCachedBlob.html#fetchUnzipToTemp(org.apache.storm.blobstore.ClientBlobStore)">fetchUnzipToTemp</a></code> in class <code><a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>store</code> - the store to us to download the data.</dd> |
| <dt>Returns:</dt> |
| <dd>the version that was downloaded.</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><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="commitNewVersion(long)"> |
| <h3>commitNewVersion</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">commitNewVersion</span><wbr><span class="parameters">(long version)</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> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="LocallyCachedBlob.html#commitNewVersion(long)">LocallyCachedBlob</a></code></span></div> |
| <div class="block">Commit the new version and make it available for the end user. |
| PRECONDITION: uncompressToTempLocationIfNeeded will have been called. |
| PRECONDITION: this can only be called with a lock on this instance held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="LocallyCachedBlob.html#commitNewVersion(long)">commitNewVersion</a></code> in class <code><a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>version</code> - the version of the blob to commit.</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> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanupOrphanedData()"> |
| <h3>cleanupOrphanedData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">cleanupOrphanedData</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> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="LocallyCachedBlob.html#cleanupOrphanedData()">LocallyCachedBlob</a></code></span></div> |
| <div class="block">Clean up any temporary files. This will be called after updating a blob, either successfully or if an error has occured. |
| The goal is to find any files that may be left over and remove them so space is not leaked. |
| PRECONDITION: this can only be called with a lock on this instance held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="LocallyCachedBlob.html#cleanupOrphanedData()">cleanupOrphanedData</a></code> in class <code><a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></code></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> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="completelyRemove()"> |
| <h3>completelyRemove</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">completelyRemove</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> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="LocallyCachedBlob.html#completelyRemove()">LocallyCachedBlob</a></code></span></div> |
| <div class="block">Completely remove anything that is cached locally for this blob and all tracking files also stored for it. |
| This will be called after the blob was determined to no longer be needed in the cache. |
| PRECONDITION: this can only be called with a lock on this instance held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="LocallyCachedBlob.html#completelyRemove()">completelyRemove</a></code> in class <code><a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></code></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> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSizeOnDisk()"> |
| <h3>getSizeOnDisk</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getSizeOnDisk</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="LocallyCachedBlob.html#getSizeOnDisk()">LocallyCachedBlob</a></code></span></div> |
| <div class="block">Get the amount of disk space that is used by this blob. If the blob is uncompressed it should be the sum of the space used by all |
| of the uncompressed files. In general this will not be called with any locks held so it is a good idea to cache it and updated it |
| when committing a new version.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="LocallyCachedBlob.html#getSizeOnDisk()">getSizeOnDisk</a></code> in class <code><a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isFullyDownloaded()"> |
| <h3>isFullyDownloaded</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFullyDownloaded</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="LocallyCachedBlob.html#isFullyDownloaded()">isFullyDownloaded</a></code> in class <code><a href="LocallyCachedBlob.html" title="class in org.apache.storm.localizer">LocallyCachedBlob</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<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> other)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></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> |
