blob: 6589b097bf13aded54e76cfbc9bda552e15cd5f5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>PersistentWindowedBoltExecutor (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.topology, class: PersistentWindowedBoltExecutor">
<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/PersistentWindowedBoltExecutor.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.storm.topology</a></div>
<h1 title="Class PersistentWindowedBoltExecutor" class="title">Class PersistentWindowedBoltExecutor&lt;T extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</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="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">org.apache.storm.topology.WindowedBoltExecutor</a>
<div class="inheritance">org.apache.storm.topology.PersistentWindowedBoltExecutor&lt;T&gt;</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/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../task/IBolt.html" title="interface in org.apache.storm.task">IBolt</a></code>, <code><a href="IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="IRichBolt.html" title="interface in org.apache.storm.topology">IRichBolt</a></code>, <code><a href="IStatefulBolt.html" title="interface in org.apache.storm.topology">IStatefulBolt</a>&lt;T&gt;</code>, <code><a href="IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a>&lt;T&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PersistentWindowedBoltExecutor&lt;T extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</span>
<span class="extends-implements">extends <a href="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a>
implements <a href="IStatefulBolt.html" title="interface in org.apache.storm.topology">IStatefulBolt</a>&lt;T&gt;</span></div>
<div class="block">Wraps a <a href="IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology"><code>IStatefulWindowedBolt</code></a> and handles the execution. Uses state and the underlying checkpointing mechanisms to save the
tuples in window to state. The tuples are also kept in-memory by transparently caching the window partitions and checkpointing them as
needed.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../serialized-form.html#org.apache.storm.topology.PersistentWindowedBoltExecutor">Serialized Form</a></li>
</ul>
</dd>
</dl>
</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.topology.WindowedBoltExecutor">Fields inherited from class&nbsp;org.apache.storm.topology.<a href="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a></h3>
<code><a href="WindowedBoltExecutor.html#LATE_TUPLE_FIELD">LATE_TUPLE_FIELD</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(org.apache.storm.topology.IStatefulWindowedBolt)" class="member-name-link">PersistentWindowedBoltExecutor</a><wbr>(<a href="IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology">IStatefulWindowedBolt</a>&lt;<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a>&gt;&nbsp;bolt)</code></div>
<div class="col-last even-row-color">&nbsp;</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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(org.apache.storm.tuple.Tuple)" class="member-name-link">execute</a><wbr>(<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>&nbsp;input)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Process a single tuple of input.</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="#initState(T)" class="member-name-link">initState</a><wbr>(<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a>&nbsp;state)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method is invoked by the framework with the previously saved state of the component.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a>&lt;<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newWindowLifecycleListener()" class="member-name-link">newWindowLifecycleListener</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#preCommit(long)" class="member-name-link">preCommit</a><wbr>(long&nbsp;txid)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This is a hook for the component to perform some actions just before the framework commits its state.</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="#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)" 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>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;topoConf,
<a href="../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
<a href="../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a>&nbsp;collector)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Called when a task for this component is initialized within a worker on the cluster.</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="#prePrepare(long)" class="member-name-link">prePrepare</a><wbr>(long&nbsp;txid)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This is a hook for the component to perform some actions just before the framework prepares its state.</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="#preRollback()" class="member-name-link">preRollback</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This is a hook for the component to perform some actions just before the framework rolls back the prepared state.</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="#start()" class="member-name-link">start</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 trigger policy and waterMarkEventGenerator if set.</div>
</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="#validate(java.util.Map,org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">validate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;topoConf,
<a href="base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;windowLengthCount,
<a href="base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;windowLengthDuration,
<a href="base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;slidingIntervalCount,
<a href="base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;slidingIntervalDuration)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.topology.WindowedBoltExecutor">Methods inherited from class&nbsp;org.apache.storm.topology.<a href="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a></h3>
<code><a href="WindowedBoltExecutor.html#boltExecute(java.util.function.Supplier,java.util.function.Supplier,java.util.function.Supplier,java.lang.Long)">boltExecute</a>, <a href="WindowedBoltExecutor.html#boltExecute(java.util.List,java.util.List,java.util.List,java.lang.Long)">boltExecute</a>, <a href="WindowedBoltExecutor.html#cleanup()">cleanup</a>, <a href="WindowedBoltExecutor.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a>, <a href="WindowedBoltExecutor.html#doPrepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector,java.util.Collection,boolean)">doPrepare</a>, <a href="WindowedBoltExecutor.html#getComponentConfiguration()">getComponentConfiguration</a>, <a href="WindowedBoltExecutor.html#getState()">getState</a>, <a href="WindowedBoltExecutor.html#getTopologyTimeoutMillis(java.util.Map)">getTopologyTimeoutMillis</a>, <a href="WindowedBoltExecutor.html#restoreState(java.util.Map)">restoreState</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.topology.IComponent">Methods inherited from interface&nbsp;org.apache.storm.topology.<a href="IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></h3>
<code><a href="IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a>, <a href="IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.topology.IStatefulBolt">Methods inherited from interface&nbsp;org.apache.storm.topology.<a href="IStatefulBolt.html" title="interface in org.apache.storm.topology">IStatefulBolt</a></h3>
<code><a href="IStatefulBolt.html#cleanup()">cleanup</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.storm.topology.IStatefulWindowedBolt)">
<h3>PersistentWindowedBoltExecutor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PersistentWindowedBoltExecutor</span><wbr><span class="parameters">(<a href="IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology">IStatefulWindowedBolt</a>&lt;<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a>&gt;&nbsp;bolt)</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,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">
<h3>prepare</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<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>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;topoConf,
<a href="../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
<a href="../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a>&nbsp;collector)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../task/IBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">IBolt</a></code></span></div>
<div class="block">Called when a task for this component is initialized within a worker on the cluster. It provides the bolt with the environment in
which the bolt executes.
<p>This includes the:</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../task/IBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="../task/IBolt.html" title="interface in org.apache.storm.task">IBolt</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="IStatefulBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="IStatefulBolt.html" title="interface in org.apache.storm.topology">IStatefulBolt</a>&lt;<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a> extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="WindowedBoltExecutor.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">prepare</a></code>&nbsp;in class&nbsp;<code><a href="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a></code></dd>
<dt>Parameters:</dt>
<dd><code>topoConf</code> - The Storm configuration for this bolt. This is the configuration provided to the topology merged in with cluster
configuration on this machine.</dd>
<dd><code>context</code> - This object can be used to get information about this task's place within the topology, including the task id and
component id of this task, input and output information, etc.</dd>
<dd><code>collector</code> - The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and
cleanup methods. The collector is thread-safe and should be saved as an instance variable of this bolt object.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../task/IBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)"><code>IBolt.prepare(Map, TopologyContext, OutputCollector)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="validate(java.util.Map,org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)">
<h3>validate</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">validate</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>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;topoConf,
<a href="base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;windowLengthCount,
<a href="base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;windowLengthDuration,
<a href="base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;slidingIntervalCount,
<a href="base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;slidingIntervalDuration)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="WindowedBoltExecutor.html#validate(java.util.Map,org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)">validate</a></code>&nbsp;in class&nbsp;<code><a href="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="start()">
<h3>start</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">start</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="WindowedBoltExecutor.html#start()">WindowedBoltExecutor</a></code></span></div>
<div class="block">Start the trigger policy and waterMarkEventGenerator if set.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="WindowedBoltExecutor.html#start()">start</a></code>&nbsp;in class&nbsp;<code><a href="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execute(org.apache.storm.tuple.Tuple)">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">execute</span><wbr><span class="parameters">(<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>&nbsp;input)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../task/IBolt.html#execute(org.apache.storm.tuple.Tuple)">IBolt</a></code></span></div>
<div class="block">Process a single tuple of input. The Tuple object contains metadata on it about which component/stream/task it came from. The values
of the Tuple can be accessed using Tuple#getValue. The IBolt does not have to process the Tuple immediately. It is perfectly fine to
hang onto a tuple and process it later (for instance, to do an aggregation or join).
<p>Tuples should be emitted using the OutputCollector provided through the prepare method. It is required that all input tuples are
acked or failed at some point using the OutputCollector. Otherwise, Storm will be unable to determine when tuples coming off the
spouts have been completed.
<p>For the common case of acking an input tuple at the end of the execute method, see IBasicBolt which automates this.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../task/IBolt.html#execute(org.apache.storm.tuple.Tuple)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="../task/IBolt.html" title="interface in org.apache.storm.task">IBolt</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="IStatefulBolt.html#execute(org.apache.storm.tuple.Tuple)">execute</a></code>&nbsp;in interface&nbsp;<code><a href="IStatefulBolt.html" title="interface in org.apache.storm.topology">IStatefulBolt</a>&lt;<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a> extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="WindowedBoltExecutor.html#execute(org.apache.storm.tuple.Tuple)">execute</a></code>&nbsp;in class&nbsp;<code><a href="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a></code></dd>
<dt>Parameters:</dt>
<dd><code>input</code> - The input tuple to be processed.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../task/IBolt.html#execute(org.apache.storm.tuple.Tuple)"><code>IBolt.execute(Tuple)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="initState(T)">
<h3 id="initState(org.apache.storm.state.State)">initState</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">initState</span><wbr><span class="parameters">(<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a>&nbsp;state)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="IStatefulComponent.html#initState(T)">IStatefulComponent</a></code></span></div>
<div class="block">This method is invoked by the framework with the previously saved state of the component. This is invoked after prepare but before
the component starts processing tuples.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IStatefulComponent.html#initState(T)">initState</a></code>&nbsp;in interface&nbsp;<code><a href="IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a>&lt;<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a> extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</code></dd>
<dt>Parameters:</dt>
<dd><code>state</code> - the previously saved state of the component.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="prePrepare(long)">
<h3>prePrepare</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">prePrepare</span><wbr><span class="parameters">(long&nbsp;txid)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="IStatefulComponent.html#prePrepare(long)">IStatefulComponent</a></code></span></div>
<div class="block">This is a hook for the component to perform some actions just before the framework prepares its state.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IStatefulComponent.html#prePrepare(long)">prePrepare</a></code>&nbsp;in interface&nbsp;<code><a href="IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a>&lt;<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a> extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="preCommit(long)">
<h3>preCommit</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">preCommit</span><wbr><span class="parameters">(long&nbsp;txid)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="IStatefulComponent.html#preCommit(long)">IStatefulComponent</a></code></span></div>
<div class="block">This is a hook for the component to perform some actions just before the framework commits its state.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IStatefulComponent.html#preCommit(long)">preCommit</a></code>&nbsp;in interface&nbsp;<code><a href="IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a>&lt;<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a> extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="preRollback()">
<h3>preRollback</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">preRollback</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="IStatefulComponent.html#preRollback()">IStatefulComponent</a></code></span></div>
<div class="block">This is a hook for the component to perform some actions just before the framework rolls back the prepared state.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="IStatefulComponent.html#preRollback()">preRollback</a></code>&nbsp;in interface&nbsp;<code><a href="IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a>&lt;<a href="PersistentWindowedBoltExecutor.html" title="type parameter in PersistentWindowedBoltExecutor">T</a> extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="newWindowLifecycleListener()">
<h3>newWindowLifecycleListener</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a>&lt;<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>&gt;</span>&nbsp;<span class="element-name">newWindowLifecycleListener</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="WindowedBoltExecutor.html#newWindowLifecycleListener()">newWindowLifecycleListener</a></code>&nbsp;in class&nbsp;<code><a href="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</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 &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>