You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by gi...@apache.org on 2018/10/29 14:55:15 UTC
[33/51] [partial] hbase-site git commit: Published site at
d5e4faacc354c1bc4d93efa71ca97ee3a056123e.
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b5e107c3/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html
----------------------------------------------------------------------
diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html
index 2658e1b..e9f426d 100644
--- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html
+++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html
@@ -337,768 +337,775 @@
<span class="sourceLineNo">329</span> * @see #holdLock(Object)<a name="line.329"></a>
<span class="sourceLineNo">330</span> * @return true if the procedure has the lock, false otherwise.<a name="line.330"></a>
<span class="sourceLineNo">331</span> */<a name="line.331"></a>
-<span class="sourceLineNo">332</span> @VisibleForTesting<a name="line.332"></a>
-<span class="sourceLineNo">333</span> public final boolean hasLock() {<a name="line.333"></a>
-<span class="sourceLineNo">334</span> return locked;<a name="line.334"></a>
-<span class="sourceLineNo">335</span> }<a name="line.335"></a>
-<span class="sourceLineNo">336</span><a name="line.336"></a>
-<span class="sourceLineNo">337</span> /**<a name="line.337"></a>
-<span class="sourceLineNo">338</span> * Called when the procedure is loaded for replay.<a name="line.338"></a>
-<span class="sourceLineNo">339</span> * The procedure implementor may use this method to perform some quick<a name="line.339"></a>
-<span class="sourceLineNo">340</span> * operation before replay.<a name="line.340"></a>
-<span class="sourceLineNo">341</span> * e.g. failing the procedure if the state on replay may be unknown.<a name="line.341"></a>
-<span class="sourceLineNo">342</span> */<a name="line.342"></a>
-<span class="sourceLineNo">343</span> protected void beforeReplay(TEnvironment env) {<a name="line.343"></a>
-<span class="sourceLineNo">344</span> // no-op<a name="line.344"></a>
-<span class="sourceLineNo">345</span> }<a name="line.345"></a>
-<span class="sourceLineNo">346</span><a name="line.346"></a>
-<span class="sourceLineNo">347</span> /**<a name="line.347"></a>
-<span class="sourceLineNo">348</span> * Called when the procedure is ready to be added to the queue after<a name="line.348"></a>
-<span class="sourceLineNo">349</span> * the loading/replay operation.<a name="line.349"></a>
-<span class="sourceLineNo">350</span> */<a name="line.350"></a>
-<span class="sourceLineNo">351</span> protected void afterReplay(TEnvironment env) {<a name="line.351"></a>
-<span class="sourceLineNo">352</span> // no-op<a name="line.352"></a>
-<span class="sourceLineNo">353</span> }<a name="line.353"></a>
-<span class="sourceLineNo">354</span><a name="line.354"></a>
-<span class="sourceLineNo">355</span> /**<a name="line.355"></a>
-<span class="sourceLineNo">356</span> * Called when the procedure is marked as completed (success or rollback).<a name="line.356"></a>
-<span class="sourceLineNo">357</span> * The procedure implementor may use this method to cleanup in-memory states.<a name="line.357"></a>
-<span class="sourceLineNo">358</span> * This operation will not be retried on failure. If a procedure took a lock,<a name="line.358"></a>
-<span class="sourceLineNo">359</span> * it will have been released when this method runs.<a name="line.359"></a>
-<span class="sourceLineNo">360</span> */<a name="line.360"></a>
-<span class="sourceLineNo">361</span> protected void completionCleanup(TEnvironment env) {<a name="line.361"></a>
-<span class="sourceLineNo">362</span> // no-op<a name="line.362"></a>
-<span class="sourceLineNo">363</span> }<a name="line.363"></a>
-<span class="sourceLineNo">364</span><a name="line.364"></a>
-<span class="sourceLineNo">365</span> /**<a name="line.365"></a>
-<span class="sourceLineNo">366</span> * By default, the procedure framework/executor will try to run procedures start to finish.<a name="line.366"></a>
-<span class="sourceLineNo">367</span> * Return true to make the executor yield between each execution step to<a name="line.367"></a>
-<span class="sourceLineNo">368</span> * give other procedures a chance to run.<a name="line.368"></a>
-<span class="sourceLineNo">369</span> * @param env the environment passed to the ProcedureExecutor<a name="line.369"></a>
-<span class="sourceLineNo">370</span> * @return Return true if the executor should yield on completion of an execution step.<a name="line.370"></a>
-<span class="sourceLineNo">371</span> * Defaults to return false.<a name="line.371"></a>
-<span class="sourceLineNo">372</span> */<a name="line.372"></a>
-<span class="sourceLineNo">373</span> protected boolean isYieldAfterExecutionStep(TEnvironment env) {<a name="line.373"></a>
-<span class="sourceLineNo">374</span> return false;<a name="line.374"></a>
-<span class="sourceLineNo">375</span> }<a name="line.375"></a>
-<span class="sourceLineNo">376</span><a name="line.376"></a>
-<span class="sourceLineNo">377</span> /**<a name="line.377"></a>
-<span class="sourceLineNo">378</span> * By default, the executor will keep the procedure result around util<a name="line.378"></a>
-<span class="sourceLineNo">379</span> * the eviction TTL is expired. The client can cut down the waiting time<a name="line.379"></a>
-<span class="sourceLineNo">380</span> * by requesting that the result is removed from the executor.<a name="line.380"></a>
-<span class="sourceLineNo">381</span> * In case of system started procedure, we can force the executor to auto-ack.<a name="line.381"></a>
-<span class="sourceLineNo">382</span> * @param env the environment passed to the ProcedureExecutor<a name="line.382"></a>
-<span class="sourceLineNo">383</span> * @return true if the executor should wait the client ack for the result.<a name="line.383"></a>
-<span class="sourceLineNo">384</span> * Defaults to return true.<a name="line.384"></a>
-<span class="sourceLineNo">385</span> */<a name="line.385"></a>
-<span class="sourceLineNo">386</span> protected boolean shouldWaitClientAck(TEnvironment env) {<a name="line.386"></a>
-<span class="sourceLineNo">387</span> return true;<a name="line.387"></a>
-<span class="sourceLineNo">388</span> }<a name="line.388"></a>
-<span class="sourceLineNo">389</span><a name="line.389"></a>
-<span class="sourceLineNo">390</span> /**<a name="line.390"></a>
-<span class="sourceLineNo">391</span> * Override this method to provide procedure specific counters for submitted count, failed<a name="line.391"></a>
-<span class="sourceLineNo">392</span> * count and time histogram.<a name="line.392"></a>
-<span class="sourceLineNo">393</span> * @param env The environment passed to the procedure executor<a name="line.393"></a>
-<span class="sourceLineNo">394</span> * @return Container object for procedure related metric<a name="line.394"></a>
-<span class="sourceLineNo">395</span> */<a name="line.395"></a>
-<span class="sourceLineNo">396</span> protected ProcedureMetrics getProcedureMetrics(TEnvironment env) {<a name="line.396"></a>
-<span class="sourceLineNo">397</span> return null;<a name="line.397"></a>
-<span class="sourceLineNo">398</span> }<a name="line.398"></a>
-<span class="sourceLineNo">399</span><a name="line.399"></a>
-<span class="sourceLineNo">400</span> /**<a name="line.400"></a>
-<span class="sourceLineNo">401</span> * This function will be called just when procedure is submitted for execution. Override this<a name="line.401"></a>
-<span class="sourceLineNo">402</span> * method to update the metrics at the beginning of the procedure. The default implementation<a name="line.402"></a>
-<span class="sourceLineNo">403</span> * updates submitted counter if {@link #getProcedureMetrics(Object)} returns non-null<a name="line.403"></a>
-<span class="sourceLineNo">404</span> * {@link ProcedureMetrics}.<a name="line.404"></a>
-<span class="sourceLineNo">405</span> */<a name="line.405"></a>
-<span class="sourceLineNo">406</span> protected void updateMetricsOnSubmit(TEnvironment env) {<a name="line.406"></a>
-<span class="sourceLineNo">407</span> ProcedureMetrics metrics = getProcedureMetrics(env);<a name="line.407"></a>
-<span class="sourceLineNo">408</span> if (metrics == null) {<a name="line.408"></a>
-<span class="sourceLineNo">409</span> return;<a name="line.409"></a>
-<span class="sourceLineNo">410</span> }<a name="line.410"></a>
-<span class="sourceLineNo">411</span><a name="line.411"></a>
-<span class="sourceLineNo">412</span> Counter submittedCounter = metrics.getSubmittedCounter();<a name="line.412"></a>
-<span class="sourceLineNo">413</span> if (submittedCounter != null) {<a name="line.413"></a>
-<span class="sourceLineNo">414</span> submittedCounter.increment();<a name="line.414"></a>
-<span class="sourceLineNo">415</span> }<a name="line.415"></a>
-<span class="sourceLineNo">416</span> }<a name="line.416"></a>
-<span class="sourceLineNo">417</span><a name="line.417"></a>
-<span class="sourceLineNo">418</span> /**<a name="line.418"></a>
-<span class="sourceLineNo">419</span> * This function will be called just after procedure execution is finished. Override this method<a name="line.419"></a>
-<span class="sourceLineNo">420</span> * to update metrics at the end of the procedure. If {@link #getProcedureMetrics(Object)} returns<a name="line.420"></a>
-<span class="sourceLineNo">421</span> * non-null {@link ProcedureMetrics}, the default implementation adds runtime of a procedure to a<a name="line.421"></a>
-<span class="sourceLineNo">422</span> * time histogram for successfully completed procedures. Increments failed counter for failed<a name="line.422"></a>
-<span class="sourceLineNo">423</span> * procedures.<a name="line.423"></a>
-<span class="sourceLineNo">424</span> * <p/><a name="line.424"></a>
-<span class="sourceLineNo">425</span> * TODO: As any of the sub-procedures on failure rolls back all procedures in the stack, including<a name="line.425"></a>
-<span class="sourceLineNo">426</span> * successfully finished siblings, this function may get called twice in certain cases for certain<a name="line.426"></a>
-<span class="sourceLineNo">427</span> * procedures. Explore further if this can be called once.<a name="line.427"></a>
-<span class="sourceLineNo">428</span> * @param env The environment passed to the procedure executor<a name="line.428"></a>
-<span class="sourceLineNo">429</span> * @param runtime Runtime of the procedure in milliseconds<a name="line.429"></a>
-<span class="sourceLineNo">430</span> * @param success true if procedure is completed successfully<a name="line.430"></a>
-<span class="sourceLineNo">431</span> */<a name="line.431"></a>
-<span class="sourceLineNo">432</span> protected void updateMetricsOnFinish(TEnvironment env, long runtime, boolean success) {<a name="line.432"></a>
-<span class="sourceLineNo">433</span> ProcedureMetrics metrics = getProcedureMetrics(env);<a name="line.433"></a>
-<span class="sourceLineNo">434</span> if (metrics == null) {<a name="line.434"></a>
-<span class="sourceLineNo">435</span> return;<a name="line.435"></a>
-<span class="sourceLineNo">436</span> }<a name="line.436"></a>
-<span class="sourceLineNo">437</span><a name="line.437"></a>
-<span class="sourceLineNo">438</span> if (success) {<a name="line.438"></a>
-<span class="sourceLineNo">439</span> Histogram timeHisto = metrics.getTimeHisto();<a name="line.439"></a>
-<span class="sourceLineNo">440</span> if (timeHisto != null) {<a name="line.440"></a>
-<span class="sourceLineNo">441</span> timeHisto.update(runtime);<a name="line.441"></a>
-<span class="sourceLineNo">442</span> }<a name="line.442"></a>
-<span class="sourceLineNo">443</span> } else {<a name="line.443"></a>
-<span class="sourceLineNo">444</span> Counter failedCounter = metrics.getFailedCounter();<a name="line.444"></a>
-<span class="sourceLineNo">445</span> if (failedCounter != null) {<a name="line.445"></a>
-<span class="sourceLineNo">446</span> failedCounter.increment();<a name="line.446"></a>
-<span class="sourceLineNo">447</span> }<a name="line.447"></a>
-<span class="sourceLineNo">448</span> }<a name="line.448"></a>
-<span class="sourceLineNo">449</span> }<a name="line.449"></a>
-<span class="sourceLineNo">450</span><a name="line.450"></a>
-<span class="sourceLineNo">451</span> @Override<a name="line.451"></a>
-<span class="sourceLineNo">452</span> public String toString() {<a name="line.452"></a>
-<span class="sourceLineNo">453</span> // Return the simple String presentation of the procedure.<a name="line.453"></a>
-<span class="sourceLineNo">454</span> return toStringSimpleSB().toString();<a name="line.454"></a>
-<span class="sourceLineNo">455</span> }<a name="line.455"></a>
-<span class="sourceLineNo">456</span><a name="line.456"></a>
-<span class="sourceLineNo">457</span> /**<a name="line.457"></a>
-<span class="sourceLineNo">458</span> * Build the StringBuilder for the simple form of procedure string.<a name="line.458"></a>
-<span class="sourceLineNo">459</span> * @return the StringBuilder<a name="line.459"></a>
-<span class="sourceLineNo">460</span> */<a name="line.460"></a>
-<span class="sourceLineNo">461</span> protected StringBuilder toStringSimpleSB() {<a name="line.461"></a>
-<span class="sourceLineNo">462</span> final StringBuilder sb = new StringBuilder();<a name="line.462"></a>
-<span class="sourceLineNo">463</span><a name="line.463"></a>
-<span class="sourceLineNo">464</span> sb.append("pid=");<a name="line.464"></a>
-<span class="sourceLineNo">465</span> sb.append(getProcId());<a name="line.465"></a>
-<span class="sourceLineNo">466</span><a name="line.466"></a>
-<span class="sourceLineNo">467</span> if (hasParent()) {<a name="line.467"></a>
-<span class="sourceLineNo">468</span> sb.append(", ppid=");<a name="line.468"></a>
-<span class="sourceLineNo">469</span> sb.append(getParentProcId());<a name="line.469"></a>
-<span class="sourceLineNo">470</span> }<a name="line.470"></a>
-<span class="sourceLineNo">471</span><a name="line.471"></a>
-<span class="sourceLineNo">472</span> /**<a name="line.472"></a>
-<span class="sourceLineNo">473</span> * TODO<a name="line.473"></a>
-<span class="sourceLineNo">474</span> * Enable later when this is being used.<a name="line.474"></a>
-<span class="sourceLineNo">475</span> * Currently owner not used.<a name="line.475"></a>
-<span class="sourceLineNo">476</span> if (hasOwner()) {<a name="line.476"></a>
-<span class="sourceLineNo">477</span> sb.append(", owner=");<a name="line.477"></a>
-<span class="sourceLineNo">478</span> sb.append(getOwner());<a name="line.478"></a>
-<span class="sourceLineNo">479</span> }*/<a name="line.479"></a>
-<span class="sourceLineNo">480</span><a name="line.480"></a>
-<span class="sourceLineNo">481</span> sb.append(", state="); // pState for Procedure State as opposed to any other kind.<a name="line.481"></a>
-<span class="sourceLineNo">482</span> toStringState(sb);<a name="line.482"></a>
-<span class="sourceLineNo">483</span><a name="line.483"></a>
-<span class="sourceLineNo">484</span> sb.append(", hasLock=").append(locked);<a name="line.484"></a>
-<span class="sourceLineNo">485</span><a name="line.485"></a>
-<span class="sourceLineNo">486</span> if (bypass) {<a name="line.486"></a>
-<span class="sourceLineNo">487</span> sb.append(", bypass=").append(bypass);<a name="line.487"></a>
-<span class="sourceLineNo">488</span> }<a name="line.488"></a>
-<span class="sourceLineNo">489</span><a name="line.489"></a>
-<span class="sourceLineNo">490</span> if (hasException()) {<a name="line.490"></a>
-<span class="sourceLineNo">491</span> sb.append(", exception=" + getException());<a name="line.491"></a>
-<span class="sourceLineNo">492</span> }<a name="line.492"></a>
-<span class="sourceLineNo">493</span><a name="line.493"></a>
-<span class="sourceLineNo">494</span> sb.append("; ");<a name="line.494"></a>
-<span class="sourceLineNo">495</span> toStringClassDetails(sb);<a name="line.495"></a>
-<span class="sourceLineNo">496</span><a name="line.496"></a>
-<span class="sourceLineNo">497</span> return sb;<a name="line.497"></a>
-<span class="sourceLineNo">498</span> }<a name="line.498"></a>
-<span class="sourceLineNo">499</span><a name="line.499"></a>
-<span class="sourceLineNo">500</span> /**<a name="line.500"></a>
-<span class="sourceLineNo">501</span> * Extend the toString() information with more procedure details<a name="line.501"></a>
-<span class="sourceLineNo">502</span> */<a name="line.502"></a>
-<span class="sourceLineNo">503</span> public String toStringDetails() {<a name="line.503"></a>
-<span class="sourceLineNo">504</span> final StringBuilder sb = toStringSimpleSB();<a name="line.504"></a>
-<span class="sourceLineNo">505</span><a name="line.505"></a>
-<span class="sourceLineNo">506</span> sb.append(" submittedTime=");<a name="line.506"></a>
-<span class="sourceLineNo">507</span> sb.append(getSubmittedTime());<a name="line.507"></a>
-<span class="sourceLineNo">508</span><a name="line.508"></a>
-<span class="sourceLineNo">509</span> sb.append(", lastUpdate=");<a name="line.509"></a>
-<span class="sourceLineNo">510</span> sb.append(getLastUpdate());<a name="line.510"></a>
-<span class="sourceLineNo">511</span><a name="line.511"></a>
-<span class="sourceLineNo">512</span> final int[] stackIndices = getStackIndexes();<a name="line.512"></a>
-<span class="sourceLineNo">513</span> if (stackIndices != null) {<a name="line.513"></a>
-<span class="sourceLineNo">514</span> sb.append("\n");<a name="line.514"></a>
-<span class="sourceLineNo">515</span> sb.append("stackIndexes=");<a name="line.515"></a>
-<span class="sourceLineNo">516</span> sb.append(Arrays.toString(stackIndices));<a name="line.516"></a>
-<span class="sourceLineNo">517</span> }<a name="line.517"></a>
-<span class="sourceLineNo">518</span><a name="line.518"></a>
-<span class="sourceLineNo">519</span> return sb.toString();<a name="line.519"></a>
-<span class="sourceLineNo">520</span> }<a name="line.520"></a>
-<span class="sourceLineNo">521</span><a name="line.521"></a>
-<span class="sourceLineNo">522</span> protected String toStringClass() {<a name="line.522"></a>
-<span class="sourceLineNo">523</span> StringBuilder sb = new StringBuilder();<a name="line.523"></a>
-<span class="sourceLineNo">524</span> toStringClassDetails(sb);<a name="line.524"></a>
-<span class="sourceLineNo">525</span> return sb.toString();<a name="line.525"></a>
-<span class="sourceLineNo">526</span> }<a name="line.526"></a>
-<span class="sourceLineNo">527</span><a name="line.527"></a>
-<span class="sourceLineNo">528</span> /**<a name="line.528"></a>
-<span class="sourceLineNo">529</span> * Called from {@link #toString()} when interpolating {@link Procedure} State. Allows decorating<a name="line.529"></a>
-<span class="sourceLineNo">530</span> * generic Procedure State with Procedure particulars.<a name="line.530"></a>
-<span class="sourceLineNo">531</span> * @param builder Append current {@link ProcedureState}<a name="line.531"></a>
-<span class="sourceLineNo">532</span> */<a name="line.532"></a>
-<span class="sourceLineNo">533</span> protected void toStringState(StringBuilder builder) {<a name="line.533"></a>
-<span class="sourceLineNo">534</span> builder.append(getState());<a name="line.534"></a>
-<span class="sourceLineNo">535</span> }<a name="line.535"></a>
-<span class="sourceLineNo">536</span><a name="line.536"></a>
-<span class="sourceLineNo">537</span> /**<a name="line.537"></a>
-<span class="sourceLineNo">538</span> * Extend the toString() information with the procedure details<a name="line.538"></a>
-<span class="sourceLineNo">539</span> * e.g. className and parameters<a name="line.539"></a>
-<span class="sourceLineNo">540</span> * @param builder the string builder to use to append the proc specific information<a name="line.540"></a>
-<span class="sourceLineNo">541</span> */<a name="line.541"></a>
-<span class="sourceLineNo">542</span> protected void toStringClassDetails(StringBuilder builder) {<a name="line.542"></a>
-<span class="sourceLineNo">543</span> builder.append(getClass().getName());<a name="line.543"></a>
-<span class="sourceLineNo">544</span> }<a name="line.544"></a>
-<span class="sourceLineNo">545</span><a name="line.545"></a>
-<span class="sourceLineNo">546</span> // ==========================================================================<a name="line.546"></a>
-<span class="sourceLineNo">547</span> // Those fields are unchanged after initialization.<a name="line.547"></a>
-<span class="sourceLineNo">548</span> //<a name="line.548"></a>
-<span class="sourceLineNo">549</span> // Each procedure will get created from the user or during<a name="line.549"></a>
-<span class="sourceLineNo">550</span> // ProcedureExecutor.start() during the load() phase and then submitted<a name="line.550"></a>
-<span class="sourceLineNo">551</span> // to the executor. these fields will never be changed after initialization<a name="line.551"></a>
-<span class="sourceLineNo">552</span> // ==========================================================================<a name="line.552"></a>
-<span class="sourceLineNo">553</span> public long getProcId() {<a name="line.553"></a>
-<span class="sourceLineNo">554</span> return procId;<a name="line.554"></a>
-<span class="sourceLineNo">555</span> }<a name="line.555"></a>
-<span class="sourceLineNo">556</span><a name="line.556"></a>
-<span class="sourceLineNo">557</span> public boolean hasParent() {<a name="line.557"></a>
-<span class="sourceLineNo">558</span> return parentProcId != NO_PROC_ID;<a name="line.558"></a>
-<span class="sourceLineNo">559</span> }<a name="line.559"></a>
-<span class="sourceLineNo">560</span><a name="line.560"></a>
-<span class="sourceLineNo">561</span> public long getParentProcId() {<a name="line.561"></a>
-<span class="sourceLineNo">562</span> return parentProcId;<a name="line.562"></a>
-<span class="sourceLineNo">563</span> }<a name="line.563"></a>
-<span class="sourceLineNo">564</span><a name="line.564"></a>
-<span class="sourceLineNo">565</span> public long getRootProcId() {<a name="line.565"></a>
-<span class="sourceLineNo">566</span> return rootProcId;<a name="line.566"></a>
-<span class="sourceLineNo">567</span> }<a name="line.567"></a>
-<span class="sourceLineNo">568</span><a name="line.568"></a>
-<span class="sourceLineNo">569</span> public String getProcName() {<a name="line.569"></a>
-<span class="sourceLineNo">570</span> return toStringClass();<a name="line.570"></a>
-<span class="sourceLineNo">571</span> }<a name="line.571"></a>
-<span class="sourceLineNo">572</span><a name="line.572"></a>
-<span class="sourceLineNo">573</span> public NonceKey getNonceKey() {<a name="line.573"></a>
-<span class="sourceLineNo">574</span> return nonceKey;<a name="line.574"></a>
-<span class="sourceLineNo">575</span> }<a name="line.575"></a>
-<span class="sourceLineNo">576</span><a name="line.576"></a>
-<span class="sourceLineNo">577</span> public long getSubmittedTime() {<a name="line.577"></a>
-<span class="sourceLineNo">578</span> return submittedTime;<a name="line.578"></a>
-<span class="sourceLineNo">579</span> }<a name="line.579"></a>
-<span class="sourceLineNo">580</span><a name="line.580"></a>
-<span class="sourceLineNo">581</span> public String getOwner() {<a name="line.581"></a>
-<span class="sourceLineNo">582</span> return owner;<a name="line.582"></a>
-<span class="sourceLineNo">583</span> }<a name="line.583"></a>
-<span class="sourceLineNo">584</span><a name="line.584"></a>
-<span class="sourceLineNo">585</span> public boolean hasOwner() {<a name="line.585"></a>
-<span class="sourceLineNo">586</span> return owner != null;<a name="line.586"></a>
-<span class="sourceLineNo">587</span> }<a name="line.587"></a>
-<span class="sourceLineNo">588</span><a name="line.588"></a>
-<span class="sourceLineNo">589</span> /**<a name="line.589"></a>
-<span class="sourceLineNo">590</span> * Called by the ProcedureExecutor to assign the ID to the newly created procedure.<a name="line.590"></a>
-<span class="sourceLineNo">591</span> */<a name="line.591"></a>
-<span class="sourceLineNo">592</span> @VisibleForTesting<a name="line.592"></a>
-<span class="sourceLineNo">593</span> protected void setProcId(long procId) {<a name="line.593"></a>
-<span class="sourceLineNo">594</span> this.procId = procId;<a name="line.594"></a>
-<span class="sourceLineNo">595</span> this.submittedTime = EnvironmentEdgeManager.currentTime();<a name="line.595"></a>
-<span class="sourceLineNo">596</span> setState(ProcedureState.RUNNABLE);<a name="line.596"></a>
-<span class="sourceLineNo">597</span> }<a name="line.597"></a>
-<span class="sourceLineNo">598</span><a name="line.598"></a>
-<span class="sourceLineNo">599</span> /**<a name="line.599"></a>
-<span class="sourceLineNo">600</span> * Called by the ProcedureExecutor to assign the parent to the newly created procedure.<a name="line.600"></a>
-<span class="sourceLineNo">601</span> */<a name="line.601"></a>
-<span class="sourceLineNo">602</span> protected void setParentProcId(long parentProcId) {<a name="line.602"></a>
-<span class="sourceLineNo">603</span> this.parentProcId = parentProcId;<a name="line.603"></a>
-<span class="sourceLineNo">604</span> }<a name="line.604"></a>
-<span class="sourceLineNo">605</span><a name="line.605"></a>
-<span class="sourceLineNo">606</span> protected void setRootProcId(long rootProcId) {<a name="line.606"></a>
-<span class="sourceLineNo">607</span> this.rootProcId = rootProcId;<a name="line.607"></a>
-<span class="sourceLineNo">608</span> }<a name="line.608"></a>
-<span class="sourceLineNo">609</span><a name="line.609"></a>
-<span class="sourceLineNo">610</span> /**<a name="line.610"></a>
-<span class="sourceLineNo">611</span> * Called by the ProcedureExecutor to set the value to the newly created procedure.<a name="line.611"></a>
-<span class="sourceLineNo">612</span> */<a name="line.612"></a>
-<span class="sourceLineNo">613</span> @VisibleForTesting<a name="line.613"></a>
-<span class="sourceLineNo">614</span> protected void setNonceKey(NonceKey nonceKey) {<a name="line.614"></a>
-<span class="sourceLineNo">615</span> this.nonceKey = nonceKey;<a name="line.615"></a>
-<span class="sourceLineNo">616</span> }<a name="line.616"></a>
-<span class="sourceLineNo">617</span><a name="line.617"></a>
-<span class="sourceLineNo">618</span> @VisibleForTesting<a name="line.618"></a>
-<span class="sourceLineNo">619</span> public void setOwner(String owner) {<a name="line.619"></a>
-<span class="sourceLineNo">620</span> this.owner = StringUtils.isEmpty(owner) ? null : owner;<a name="line.620"></a>
-<span class="sourceLineNo">621</span> }<a name="line.621"></a>
-<span class="sourceLineNo">622</span><a name="line.622"></a>
-<span class="sourceLineNo">623</span> public void setOwner(User owner) {<a name="line.623"></a>
-<span class="sourceLineNo">624</span> assert owner != null : "expected owner to be not null";<a name="line.624"></a>
-<span class="sourceLineNo">625</span> setOwner(owner.getShortName());<a name="line.625"></a>
-<span class="sourceLineNo">626</span> }<a name="line.626"></a>
-<span class="sourceLineNo">627</span><a name="line.627"></a>
-<span class="sourceLineNo">628</span> /**<a name="line.628"></a>
-<span class="sourceLineNo">629</span> * Called on store load to initialize the Procedure internals after<a name="line.629"></a>
-<span class="sourceLineNo">630</span> * the creation/deserialization.<a name="line.630"></a>
-<span class="sourceLineNo">631</span> */<a name="line.631"></a>
-<span class="sourceLineNo">632</span> protected void setSubmittedTime(long submittedTime) {<a name="line.632"></a>
-<span class="sourceLineNo">633</span> this.submittedTime = submittedTime;<a name="line.633"></a>
-<span class="sourceLineNo">634</span> }<a name="line.634"></a>
-<span class="sourceLineNo">635</span><a name="line.635"></a>
-<span class="sourceLineNo">636</span> // ==========================================================================<a name="line.636"></a>
-<span class="sourceLineNo">637</span> // runtime state - timeout related<a name="line.637"></a>
-<span class="sourceLineNo">638</span> // ==========================================================================<a name="line.638"></a>
-<span class="sourceLineNo">639</span> /**<a name="line.639"></a>
-<span class="sourceLineNo">640</span> * @param timeout timeout interval in msec<a name="line.640"></a>
-<span class="sourceLineNo">641</span> */<a name="line.641"></a>
-<span class="sourceLineNo">642</span> protected void setTimeout(int timeout) {<a name="line.642"></a>
-<span class="sourceLineNo">643</span> this.timeout = timeout;<a name="line.643"></a>
-<span class="sourceLineNo">644</span> }<a name="line.644"></a>
-<span class="sourceLineNo">645</span><a name="line.645"></a>
-<span class="sourceLineNo">646</span> public boolean hasTimeout() {<a name="line.646"></a>
-<span class="sourceLineNo">647</span> return timeout != NO_TIMEOUT;<a name="line.647"></a>
-<span class="sourceLineNo">648</span> }<a name="line.648"></a>
-<span class="sourceLineNo">649</span><a name="line.649"></a>
-<span class="sourceLineNo">650</span> /**<a name="line.650"></a>
-<span class="sourceLineNo">651</span> * @return the timeout in msec<a name="line.651"></a>
-<span class="sourceLineNo">652</span> */<a name="line.652"></a>
-<span class="sourceLineNo">653</span> public int getTimeout() {<a name="line.653"></a>
-<span class="sourceLineNo">654</span> return timeout;<a name="line.654"></a>
-<span class="sourceLineNo">655</span> }<a name="line.655"></a>
-<span class="sourceLineNo">656</span><a name="line.656"></a>
-<span class="sourceLineNo">657</span> /**<a name="line.657"></a>
-<span class="sourceLineNo">658</span> * Called on store load to initialize the Procedure internals after<a name="line.658"></a>
-<span class="sourceLineNo">659</span> * the creation/deserialization.<a name="line.659"></a>
-<span class="sourceLineNo">660</span> */<a name="line.660"></a>
-<span class="sourceLineNo">661</span> protected void setLastUpdate(long lastUpdate) {<a name="line.661"></a>
-<span class="sourceLineNo">662</span> this.lastUpdate = lastUpdate;<a name="line.662"></a>
-<span class="sourceLineNo">663</span> }<a name="line.663"></a>
-<span class="sourceLineNo">664</span><a name="line.664"></a>
-<span class="sourceLineNo">665</span> /**<a name="line.665"></a>
-<span class="sourceLineNo">666</span> * Called by ProcedureExecutor after each time a procedure step is executed.<a name="line.666"></a>
-<span class="sourceLineNo">667</span> */<a name="line.667"></a>
-<span class="sourceLineNo">668</span> protected void updateTimestamp() {<a name="line.668"></a>
-<span class="sourceLineNo">669</span> this.lastUpdate = EnvironmentEdgeManager.currentTime();<a name="line.669"></a>
-<span class="sourceLineNo">670</span> }<a name="line.670"></a>
-<span class="sourceLineNo">671</span><a name="line.671"></a>
-<span class="sourceLineNo">672</span> public long getLastUpdate() {<a name="line.672"></a>
-<span class="sourceLineNo">673</span> return lastUpdate;<a name="line.673"></a>
-<span class="sourceLineNo">674</span> }<a name="line.674"></a>
-<span class="sourceLineNo">675</span><a name="line.675"></a>
-<span class="sourceLineNo">676</span> /**<a name="line.676"></a>
-<span class="sourceLineNo">677</span> * Timeout of the next timeout.<a name="line.677"></a>
-<span class="sourceLineNo">678</span> * Called by the ProcedureExecutor if the procedure has timeout set and<a name="line.678"></a>
-<span class="sourceLineNo">679</span> * the procedure is in the waiting queue.<a name="line.679"></a>
-<span class="sourceLineNo">680</span> * @return the timestamp of the next timeout.<a name="line.680"></a>
-<span class="sourceLineNo">681</span> */<a name="line.681"></a>
-<span class="sourceLineNo">682</span> protected long getTimeoutTimestamp() {<a name="line.682"></a>
-<span class="sourceLineNo">683</span> return getLastUpdate() + getTimeout();<a name="line.683"></a>
-<span class="sourceLineNo">684</span> }<a name="line.684"></a>
-<span class="sourceLineNo">685</span><a name="line.685"></a>
-<span class="sourceLineNo">686</span> // ==========================================================================<a name="line.686"></a>
-<span class="sourceLineNo">687</span> // runtime state<a name="line.687"></a>
-<span class="sourceLineNo">688</span> // ==========================================================================<a name="line.688"></a>
-<span class="sourceLineNo">689</span> /**<a name="line.689"></a>
-<span class="sourceLineNo">690</span> * @return the time elapsed between the last update and the start time of the procedure.<a name="line.690"></a>
-<span class="sourceLineNo">691</span> */<a name="line.691"></a>
-<span class="sourceLineNo">692</span> public long elapsedTime() {<a name="line.692"></a>
-<span class="sourceLineNo">693</span> return getLastUpdate() - getSubmittedTime();<a name="line.693"></a>
-<span class="sourceLineNo">694</span> }<a name="line.694"></a>
-<span class="sourceLineNo">695</span><a name="line.695"></a>
-<span class="sourceLineNo">696</span> /**<a name="line.696"></a>
-<span class="sourceLineNo">697</span> * @return the serialized result if any, otherwise null<a name="line.697"></a>
-<span class="sourceLineNo">698</span> */<a name="line.698"></a>
-<span class="sourceLineNo">699</span> public byte[] getResult() {<a name="line.699"></a>
-<span class="sourceLineNo">700</span> return result;<a name="line.700"></a>
-<span class="sourceLineNo">701</span> }<a name="line.701"></a>
-<span class="sourceLineNo">702</span><a name="line.702"></a>
-<span class="sourceLineNo">703</span> /**<a name="line.703"></a>
-<span class="sourceLineNo">704</span> * The procedure may leave a "result" on completion.<a name="line.704"></a>
-<span class="sourceLineNo">705</span> * @param result the serialized result that will be passed to the client<a name="line.705"></a>
-<span class="sourceLineNo">706</span> */<a name="line.706"></a>
-<span class="sourceLineNo">707</span> protected void setResult(byte[] result) {<a name="line.707"></a>
-<span class="sourceLineNo">708</span> this.result = result;<a name="line.708"></a>
-<span class="sourceLineNo">709</span> }<a name="line.709"></a>
-<span class="sourceLineNo">710</span><a name="line.710"></a>
-<span class="sourceLineNo">711</span> /**<a name="line.711"></a>
-<span class="sourceLineNo">712</span> * Will only be called when loading procedures from procedure store, where we need to record<a name="line.712"></a>
-<span class="sourceLineNo">713</span> * whether the procedure has already held a lock. Later we will call<a name="line.713"></a>
-<span class="sourceLineNo">714</span> * {@link #doAcquireLock(Object, ProcedureStore)} to actually acquire the lock.<a name="line.714"></a>
-<span class="sourceLineNo">715</span> */<a name="line.715"></a>
-<span class="sourceLineNo">716</span> final void lockedWhenLoading() {<a name="line.716"></a>
-<span class="sourceLineNo">717</span> this.lockedWhenLoading = true;<a name="line.717"></a>
-<span class="sourceLineNo">718</span> }<a name="line.718"></a>
-<span class="sourceLineNo">719</span><a name="line.719"></a>
-<span class="sourceLineNo">720</span> public boolean isLockedWhenLoading() {<a name="line.720"></a>
-<span class="sourceLineNo">721</span> return lockedWhenLoading;<a name="line.721"></a>
-<span class="sourceLineNo">722</span> }<a name="line.722"></a>
-<span class="sourceLineNo">723</span><a name="line.723"></a>
-<span class="sourceLineNo">724</span> // ==============================================================================================<a name="line.724"></a>
-<span class="sourceLineNo">725</span> // Runtime state, updated every operation by the ProcedureExecutor<a name="line.725"></a>
-<span class="sourceLineNo">726</span> //<a name="line.726"></a>
-<span class="sourceLineNo">727</span> // There is always 1 thread at the time operating on the state of the procedure.<a name="line.727"></a>
-<span class="sourceLineNo">728</span> // The ProcedureExecutor may check and set states, or some Procecedure may<a name="line.728"></a>
-<span class="sourceLineNo">729</span> // update its own state. but no concurrent updates. we use synchronized here<a name="line.729"></a>
-<span class="sourceLineNo">730</span> // just because the procedure can get scheduled on different executor threads on each step.<a name="line.730"></a>
+<span class="sourceLineNo">332</span> public final boolean hasLock() {<a name="line.332"></a>
+<span class="sourceLineNo">333</span> return locked;<a name="line.333"></a>
+<span class="sourceLineNo">334</span> }<a name="line.334"></a>
+<span class="sourceLineNo">335</span><a name="line.335"></a>
+<span class="sourceLineNo">336</span> /**<a name="line.336"></a>
+<span class="sourceLineNo">337</span> * Called when the procedure is loaded for replay.<a name="line.337"></a>
+<span class="sourceLineNo">338</span> * The procedure implementor may use this method to perform some quick<a name="line.338"></a>
+<span class="sourceLineNo">339</span> * operation before replay.<a name="line.339"></a>
+<span class="sourceLineNo">340</span> * e.g. failing the procedure if the state on replay may be unknown.<a name="line.340"></a>
+<span class="sourceLineNo">341</span> */<a name="line.341"></a>
+<span class="sourceLineNo">342</span> protected void beforeReplay(TEnvironment env) {<a name="line.342"></a>
+<span class="sourceLineNo">343</span> // no-op<a name="line.343"></a>
+<span class="sourceLineNo">344</span> }<a name="line.344"></a>
+<span class="sourceLineNo">345</span><a name="line.345"></a>
+<span class="sourceLineNo">346</span> /**<a name="line.346"></a>
+<span class="sourceLineNo">347</span> * Called when the procedure is ready to be added to the queue after<a name="line.347"></a>
+<span class="sourceLineNo">348</span> * the loading/replay operation.<a name="line.348"></a>
+<span class="sourceLineNo">349</span> */<a name="line.349"></a>
+<span class="sourceLineNo">350</span> protected void afterReplay(TEnvironment env) {<a name="line.350"></a>
+<span class="sourceLineNo">351</span> // no-op<a name="line.351"></a>
+<span class="sourceLineNo">352</span> }<a name="line.352"></a>
+<span class="sourceLineNo">353</span><a name="line.353"></a>
+<span class="sourceLineNo">354</span> /**<a name="line.354"></a>
+<span class="sourceLineNo">355</span> * Called when the procedure is marked as completed (success or rollback).<a name="line.355"></a>
+<span class="sourceLineNo">356</span> * The procedure implementor may use this method to cleanup in-memory states.<a name="line.356"></a>
+<span class="sourceLineNo">357</span> * This operation will not be retried on failure. If a procedure took a lock,<a name="line.357"></a>
+<span class="sourceLineNo">358</span> * it will have been released when this method runs.<a name="line.358"></a>
+<span class="sourceLineNo">359</span> */<a name="line.359"></a>
+<span class="sourceLineNo">360</span> protected void completionCleanup(TEnvironment env) {<a name="line.360"></a>
+<span class="sourceLineNo">361</span> // no-op<a name="line.361"></a>
+<span class="sourceLineNo">362</span> }<a name="line.362"></a>
+<span class="sourceLineNo">363</span><a name="line.363"></a>
+<span class="sourceLineNo">364</span> /**<a name="line.364"></a>
+<span class="sourceLineNo">365</span> * By default, the procedure framework/executor will try to run procedures start to finish.<a name="line.365"></a>
+<span class="sourceLineNo">366</span> * Return true to make the executor yield between each execution step to<a name="line.366"></a>
+<span class="sourceLineNo">367</span> * give other procedures a chance to run.<a name="line.367"></a>
+<span class="sourceLineNo">368</span> * @param env the environment passed to the ProcedureExecutor<a name="line.368"></a>
+<span class="sourceLineNo">369</span> * @return Return true if the executor should yield on completion of an execution step.<a name="line.369"></a>
+<span class="sourceLineNo">370</span> * Defaults to return false.<a name="line.370"></a>
+<span class="sourceLineNo">371</span> */<a name="line.371"></a>
+<span class="sourceLineNo">372</span> protected boolean isYieldAfterExecutionStep(TEnvironment env) {<a name="line.372"></a>
+<span class="sourceLineNo">373</span> return false;<a name="line.373"></a>
+<span class="sourceLineNo">374</span> }<a name="line.374"></a>
+<span class="sourceLineNo">375</span><a name="line.375"></a>
+<span class="sourceLineNo">376</span> /**<a name="line.376"></a>
+<span class="sourceLineNo">377</span> * By default, the executor will keep the procedure result around util<a name="line.377"></a>
+<span class="sourceLineNo">378</span> * the eviction TTL is expired. The client can cut down the waiting time<a name="line.378"></a>
+<span class="sourceLineNo">379</span> * by requesting that the result is removed from the executor.<a name="line.379"></a>
+<span class="sourceLineNo">380</span> * In case of system started procedure, we can force the executor to auto-ack.<a name="line.380"></a>
+<span class="sourceLineNo">381</span> * @param env the environment passed to the ProcedureExecutor<a name="line.381"></a>
+<span class="sourceLineNo">382</span> * @return true if the executor should wait the client ack for the result.<a name="line.382"></a>
+<span class="sourceLineNo">383</span> * Defaults to return true.<a name="line.383"></a>
+<span class="sourceLineNo">384</span> */<a name="line.384"></a>
+<span class="sourceLineNo">385</span> protected boolean shouldWaitClientAck(TEnvironment env) {<a name="line.385"></a>
+<span class="sourceLineNo">386</span> return true;<a name="line.386"></a>
+<span class="sourceLineNo">387</span> }<a name="line.387"></a>
+<span class="sourceLineNo">388</span><a name="line.388"></a>
+<span class="sourceLineNo">389</span> /**<a name="line.389"></a>
+<span class="sourceLineNo">390</span> * Override this method to provide procedure specific counters for submitted count, failed<a name="line.390"></a>
+<span class="sourceLineNo">391</span> * count and time histogram.<a name="line.391"></a>
+<span class="sourceLineNo">392</span> * @param env The environment passed to the procedure executor<a name="line.392"></a>
+<span class="sourceLineNo">393</span> * @return Container object for procedure related metric<a name="line.393"></a>
+<span class="sourceLineNo">394</span> */<a name="line.394"></a>
+<span class="sourceLineNo">395</span> protected ProcedureMetrics getProcedureMetrics(TEnvironment env) {<a name="line.395"></a>
+<span class="sourceLineNo">396</span> return null;<a name="line.396"></a>
+<span class="sourceLineNo">397</span> }<a name="line.397"></a>
+<span class="sourceLineNo">398</span><a name="line.398"></a>
+<span class="sourceLineNo">399</span> /**<a name="line.399"></a>
+<span class="sourceLineNo">400</span> * This function will be called just when procedure is submitted for execution. Override this<a name="line.400"></a>
+<span class="sourceLineNo">401</span> * method to update the metrics at the beginning of the procedure. The default implementation<a name="line.401"></a>
+<span class="sourceLineNo">402</span> * updates submitted counter if {@link #getProcedureMetrics(Object)} returns non-null<a name="line.402"></a>
+<span class="sourceLineNo">403</span> * {@link ProcedureMetrics}.<a name="line.403"></a>
+<span class="sourceLineNo">404</span> */<a name="line.404"></a>
+<span class="sourceLineNo">405</span> protected void updateMetricsOnSubmit(TEnvironment env) {<a name="line.405"></a>
+<span class="sourceLineNo">406</span> ProcedureMetrics metrics = getProcedureMetrics(env);<a name="line.406"></a>
+<span class="sourceLineNo">407</span> if (metrics == null) {<a name="line.407"></a>
+<span class="sourceLineNo">408</span> return;<a name="line.408"></a>
+<span class="sourceLineNo">409</span> }<a name="line.409"></a>
+<span class="sourceLineNo">410</span><a name="line.410"></a>
+<span class="sourceLineNo">411</span> Counter submittedCounter = metrics.getSubmittedCounter();<a name="line.411"></a>
+<span class="sourceLineNo">412</span> if (submittedCounter != null) {<a name="line.412"></a>
+<span class="sourceLineNo">413</span> submittedCounter.increment();<a name="line.413"></a>
+<span class="sourceLineNo">414</span> }<a name="line.414"></a>
+<span class="sourceLineNo">415</span> }<a name="line.415"></a>
+<span class="sourceLineNo">416</span><a name="line.416"></a>
+<span class="sourceLineNo">417</span> /**<a name="line.417"></a>
+<span class="sourceLineNo">418</span> * This function will be called just after procedure execution is finished. Override this method<a name="line.418"></a>
+<span class="sourceLineNo">419</span> * to update metrics at the end of the procedure. If {@link #getProcedureMetrics(Object)} returns<a name="line.419"></a>
+<span class="sourceLineNo">420</span> * non-null {@link ProcedureMetrics}, the default implementation adds runtime of a procedure to a<a name="line.420"></a>
+<span class="sourceLineNo">421</span> * time histogram for successfully completed procedures. Increments failed counter for failed<a name="line.421"></a>
+<span class="sourceLineNo">422</span> * procedures.<a name="line.422"></a>
+<span class="sourceLineNo">423</span> * <p/><a name="line.423"></a>
+<span class="sourceLineNo">424</span> * TODO: As any of the sub-procedures on failure rolls back all procedures in the stack, including<a name="line.424"></a>
+<span class="sourceLineNo">425</span> * successfully finished siblings, this function may get called twice in certain cases for certain<a name="line.425"></a>
+<span class="sourceLineNo">426</span> * procedures. Explore further if this can be called once.<a name="line.426"></a>
+<span class="sourceLineNo">427</span> * @param env The environment passed to the procedure executor<a name="line.427"></a>
+<span class="sourceLineNo">428</span> * @param runtime Runtime of the procedure in milliseconds<a name="line.428"></a>
+<span class="sourceLineNo">429</span> * @param success true if procedure is completed successfully<a name="line.429"></a>
+<span class="sourceLineNo">430</span> */<a name="line.430"></a>
+<span class="sourceLineNo">431</span> protected void updateMetricsOnFinish(TEnvironment env, long runtime, boolean success) {<a name="line.431"></a>
+<span class="sourceLineNo">432</span> ProcedureMetrics metrics = getProcedureMetrics(env);<a name="line.432"></a>
+<span class="sourceLineNo">433</span> if (metrics == null) {<a name="line.433"></a>
+<span class="sourceLineNo">434</span> return;<a name="line.434"></a>
+<span class="sourceLineNo">435</span> }<a name="line.435"></a>
+<span class="sourceLineNo">436</span><a name="line.436"></a>
+<span class="sourceLineNo">437</span> if (success) {<a name="line.437"></a>
+<span class="sourceLineNo">438</span> Histogram timeHisto = metrics.getTimeHisto();<a name="line.438"></a>
+<span class="sourceLineNo">439</span> if (timeHisto != null) {<a name="line.439"></a>
+<span class="sourceLineNo">440</span> timeHisto.update(runtime);<a name="line.440"></a>
+<span class="sourceLineNo">441</span> }<a name="line.441"></a>
+<span class="sourceLineNo">442</span> } else {<a name="line.442"></a>
+<span class="sourceLineNo">443</span> Counter failedCounter = metrics.getFailedCounter();<a name="line.443"></a>
+<span class="sourceLineNo">444</span> if (failedCounter != null) {<a name="line.444"></a>
+<span class="sourceLineNo">445</span> failedCounter.increment();<a name="line.445"></a>
+<span class="sourceLineNo">446</span> }<a name="line.446"></a>
+<span class="sourceLineNo">447</span> }<a name="line.447"></a>
+<span class="sourceLineNo">448</span> }<a name="line.448"></a>
+<span class="sourceLineNo">449</span><a name="line.449"></a>
+<span class="sourceLineNo">450</span> @Override<a name="line.450"></a>
+<span class="sourceLineNo">451</span> public String toString() {<a name="line.451"></a>
+<span class="sourceLineNo">452</span> // Return the simple String presentation of the procedure.<a name="line.452"></a>
+<span class="sourceLineNo">453</span> return toStringSimpleSB().toString();<a name="line.453"></a>
+<span class="sourceLineNo">454</span> }<a name="line.454"></a>
+<span class="sourceLineNo">455</span><a name="line.455"></a>
+<span class="sourceLineNo">456</span> /**<a name="line.456"></a>
+<span class="sourceLineNo">457</span> * Build the StringBuilder for the simple form of procedure string.<a name="line.457"></a>
+<span class="sourceLineNo">458</span> * @return the StringBuilder<a name="line.458"></a>
+<span class="sourceLineNo">459</span> */<a name="line.459"></a>
+<span class="sourceLineNo">460</span> protected StringBuilder toStringSimpleSB() {<a name="line.460"></a>
+<span class="sourceLineNo">461</span> final StringBuilder sb = new StringBuilder();<a name="line.461"></a>
+<span class="sourceLineNo">462</span><a name="line.462"></a>
+<span class="sourceLineNo">463</span> sb.append("pid=");<a name="line.463"></a>
+<span class="sourceLineNo">464</span> sb.append(getProcId());<a name="line.464"></a>
+<span class="sourceLineNo">465</span><a name="line.465"></a>
+<span class="sourceLineNo">466</span> if (hasParent()) {<a name="line.466"></a>
+<span class="sourceLineNo">467</span> sb.append(", ppid=");<a name="line.467"></a>
+<span class="sourceLineNo">468</span> sb.append(getParentProcId());<a name="line.468"></a>
+<span class="sourceLineNo">469</span> }<a name="line.469"></a>
+<span class="sourceLineNo">470</span><a name="line.470"></a>
+<span class="sourceLineNo">471</span> /**<a name="line.471"></a>
+<span class="sourceLineNo">472</span> * TODO<a name="line.472"></a>
+<span class="sourceLineNo">473</span> * Enable later when this is being used.<a name="line.473"></a>
+<span class="sourceLineNo">474</span> * Currently owner not used.<a name="line.474"></a>
+<span class="sourceLineNo">475</span> if (hasOwner()) {<a name="line.475"></a>
+<span class="sourceLineNo">476</span> sb.append(", owner=");<a name="line.476"></a>
+<span class="sourceLineNo">477</span> sb.append(getOwner());<a name="line.477"></a>
+<span class="sourceLineNo">478</span> }*/<a name="line.478"></a>
+<span class="sourceLineNo">479</span><a name="line.479"></a>
+<span class="sourceLineNo">480</span> sb.append(", state="); // pState for Procedure State as opposed to any other kind.<a name="line.480"></a>
+<span class="sourceLineNo">481</span> toStringState(sb);<a name="line.481"></a>
+<span class="sourceLineNo">482</span><a name="line.482"></a>
+<span class="sourceLineNo">483</span> sb.append(", hasLock=").append(locked);<a name="line.483"></a>
+<span class="sourceLineNo">484</span><a name="line.484"></a>
+<span class="sourceLineNo">485</span> if (bypass) {<a name="line.485"></a>
+<span class="sourceLineNo">486</span> sb.append(", bypass=").append(bypass);<a name="line.486"></a>
+<span class="sourceLineNo">487</span> }<a name="line.487"></a>
+<span class="sourceLineNo">488</span><a name="line.488"></a>
+<span class="sourceLineNo">489</span> if (hasException()) {<a name="line.489"></a>
+<span class="sourceLineNo">490</span> sb.append(", exception=" + getException());<a name="line.490"></a>
+<span class="sourceLineNo">491</span> }<a name="line.491"></a>
+<span class="sourceLineNo">492</span><a name="line.492"></a>
+<span class="sourceLineNo">493</span> sb.append("; ");<a name="line.493"></a>
+<span class="sourceLineNo">494</span> toStringClassDetails(sb);<a name="line.494"></a>
+<span class="sourceLineNo">495</span><a name="line.495"></a>
+<span class="sourceLineNo">496</span> return sb;<a name="line.496"></a>
+<span class="sourceLineNo">497</span> }<a name="line.497"></a>
+<span class="sourceLineNo">498</span><a name="line.498"></a>
+<span class="sourceLineNo">499</span> /**<a name="line.499"></a>
+<span class="sourceLineNo">500</span> * Extend the toString() information with more procedure details<a name="line.500"></a>
+<span class="sourceLineNo">501</span> */<a name="line.501"></a>
+<span class="sourceLineNo">502</span> public String toStringDetails() {<a name="line.502"></a>
+<span class="sourceLineNo">503</span> final StringBuilder sb = toStringSimpleSB();<a name="line.503"></a>
+<span class="sourceLineNo">504</span><a name="line.504"></a>
+<span class="sourceLineNo">505</span> sb.append(" submittedTime=");<a name="line.505"></a>
+<span class="sourceLineNo">506</span> sb.append(getSubmittedTime());<a name="line.506"></a>
+<span class="sourceLineNo">507</span><a name="line.507"></a>
+<span class="sourceLineNo">508</span> sb.append(", lastUpdate=");<a name="line.508"></a>
+<span class="sourceLineNo">509</span> sb.append(getLastUpdate());<a name="line.509"></a>
+<span class="sourceLineNo">510</span><a name="line.510"></a>
+<span class="sourceLineNo">511</span> final int[] stackIndices = getStackIndexes();<a name="line.511"></a>
+<span class="sourceLineNo">512</span> if (stackIndices != null) {<a name="line.512"></a>
+<span class="sourceLineNo">513</span> sb.append("\n");<a name="line.513"></a>
+<span class="sourceLineNo">514</span> sb.append("stackIndexes=");<a name="line.514"></a>
+<span class="sourceLineNo">515</span> sb.append(Arrays.toString(stackIndices));<a name="line.515"></a>
+<span class="sourceLineNo">516</span> }<a name="line.516"></a>
+<span class="sourceLineNo">517</span><a name="line.517"></a>
+<span class="sourceLineNo">518</span> return sb.toString();<a name="line.518"></a>
+<span class="sourceLineNo">519</span> }<a name="line.519"></a>
+<span class="sourceLineNo">520</span><a name="line.520"></a>
+<span class="sourceLineNo">521</span> protected String toStringClass() {<a name="line.521"></a>
+<span class="sourceLineNo">522</span> StringBuilder sb = new StringBuilder();<a name="line.522"></a>
+<span class="sourceLineNo">523</span> toStringClassDetails(sb);<a name="line.523"></a>
+<span class="sourceLineNo">524</span> return sb.toString();<a name="line.524"></a>
+<span class="sourceLineNo">525</span> }<a name="line.525"></a>
+<span class="sourceLineNo">526</span><a name="line.526"></a>
+<span class="sourceLineNo">527</span> /**<a name="line.527"></a>
+<span class="sourceLineNo">528</span> * Called from {@link #toString()} when interpolating {@link Procedure} State. Allows decorating<a name="line.528"></a>
+<span class="sourceLineNo">529</span> * generic Procedure State with Procedure particulars.<a name="line.529"></a>
+<span class="sourceLineNo">530</span> * @param builder Append current {@link ProcedureState}<a name="line.530"></a>
+<span class="sourceLineNo">531</span> */<a name="line.531"></a>
+<span class="sourceLineNo">532</span> protected void toStringState(StringBuilder builder) {<a name="line.532"></a>
+<span class="sourceLineNo">533</span> builder.append(getState());<a name="line.533"></a>
+<span class="sourceLineNo">534</span> }<a name="line.534"></a>
+<span class="sourceLineNo">535</span><a name="line.535"></a>
+<span class="sourceLineNo">536</span> /**<a name="line.536"></a>
+<span class="sourceLineNo">537</span> * Extend the toString() information with the procedure details<a name="line.537"></a>
+<span class="sourceLineNo">538</span> * e.g. className and parameters<a name="line.538"></a>
+<span class="sourceLineNo">539</span> * @param builder the string builder to use to append the proc specific information<a name="line.539"></a>
+<span class="sourceLineNo">540</span> */<a name="line.540"></a>
+<span class="sourceLineNo">541</span> protected void toStringClassDetails(StringBuilder builder) {<a name="line.541"></a>
+<span class="sourceLineNo">542</span> builder.append(getClass().getName());<a name="line.542"></a>
+<span class="sourceLineNo">543</span> }<a name="line.543"></a>
+<span class="sourceLineNo">544</span><a name="line.544"></a>
+<span class="sourceLineNo">545</span> // ==========================================================================<a name="line.545"></a>
+<span class="sourceLineNo">546</span> // Those fields are unchanged after initialization.<a name="line.546"></a>
+<span class="sourceLineNo">547</span> //<a name="line.547"></a>
+<span class="sourceLineNo">548</span> // Each procedure will get created from the user or during<a name="line.548"></a>
+<span class="sourceLineNo">549</span> // ProcedureExecutor.start() during the load() phase and then submitted<a name="line.549"></a>
+<span class="sourceLineNo">550</span> // to the executor. these fields will never be changed after initialization<a name="line.550"></a>
+<span class="sourceLineNo">551</span> // ==========================================================================<a name="line.551"></a>
+<span class="sourceLineNo">552</span> public long getProcId() {<a name="line.552"></a>
+<span class="sourceLineNo">553</span> return procId;<a name="line.553"></a>
+<span class="sourceLineNo">554</span> }<a name="line.554"></a>
+<span class="sourceLineNo">555</span><a name="line.555"></a>
+<span class="sourceLineNo">556</span> public boolean hasParent() {<a name="line.556"></a>
+<span class="sourceLineNo">557</span> return parentProcId != NO_PROC_ID;<a name="line.557"></a>
+<span class="sourceLineNo">558</span> }<a name="line.558"></a>
+<span class="sourceLineNo">559</span><a name="line.559"></a>
+<span class="sourceLineNo">560</span> public long getParentProcId() {<a name="line.560"></a>
+<span class="sourceLineNo">561</span> return parentProcId;<a name="line.561"></a>
+<span class="sourceLineNo">562</span> }<a name="line.562"></a>
+<span class="sourceLineNo">563</span><a name="line.563"></a>
+<span class="sourceLineNo">564</span> public long getRootProcId() {<a name="line.564"></a>
+<span class="sourceLineNo">565</span> return rootProcId;<a name="line.565"></a>
+<span class="sourceLineNo">566</span> }<a name="line.566"></a>
+<span class="sourceLineNo">567</span><a name="line.567"></a>
+<span class="sourceLineNo">568</span> public String getProcName() {<a name="line.568"></a>
+<span class="sourceLineNo">569</span> return toStringClass();<a name="line.569"></a>
+<span class="sourceLineNo">570</span> }<a name="line.570"></a>
+<span class="sourceLineNo">571</span><a name="line.571"></a>
+<span class="sourceLineNo">572</span> public NonceKey getNonceKey() {<a name="line.572"></a>
+<span class="sourceLineNo">573</span> return nonceKey;<a name="line.573"></a>
+<span class="sourceLineNo">574</span> }<a name="line.574"></a>
+<span class="sourceLineNo">575</span><a name="line.575"></a>
+<span class="sourceLineNo">576</span> public long getSubmittedTime() {<a name="line.576"></a>
+<span class="sourceLineNo">577</span> return submittedTime;<a name="line.577"></a>
+<span class="sourceLineNo">578</span> }<a name="line.578"></a>
+<span class="sourceLineNo">579</span><a name="line.579"></a>
+<span class="sourceLineNo">580</span> public String getOwner() {<a name="line.580"></a>
+<span class="sourceLineNo">581</span> return owner;<a name="line.581"></a>
+<span class="sourceLineNo">582</span> }<a name="line.582"></a>
+<span class="sourceLineNo">583</span><a name="line.583"></a>
+<span class="sourceLineNo">584</span> public boolean hasOwner() {<a name="line.584"></a>
+<span class="sourceLineNo">585</span> return owner != null;<a name="line.585"></a>
+<span class="sourceLineNo">586</span> }<a name="line.586"></a>
+<span class="sourceLineNo">587</span><a name="line.587"></a>
+<span class="sourceLineNo">588</span> /**<a name="line.588"></a>
+<span class="sourceLineNo">589</span> * Called by the ProcedureExecutor to assign the ID to the newly created procedure.<a name="line.589"></a>
+<span class="sourceLineNo">590</span> */<a name="line.590"></a>
+<span class="sourceLineNo">591</span> @VisibleForTesting<a name="line.591"></a>
+<span class="sourceLineNo">592</span> protected void setProcId(long procId) {<a name="line.592"></a>
+<span class="sourceLineNo">593</span> this.procId = procId;<a name="line.593"></a>
+<span class="sourceLineNo">594</span> this.submittedTime = EnvironmentEdgeManager.currentTime();<a name="line.594"></a>
+<span class="sourceLineNo">595</span> setState(ProcedureState.RUNNABLE);<a name="line.595"></a>
+<span class="sourceLineNo">596</span> }<a name="line.596"></a>
+<span class="sourceLineNo">597</span><a name="line.597"></a>
+<span class="sourceLineNo">598</span> /**<a name="line.598"></a>
+<span class="sourceLineNo">599</span> * Called by the ProcedureExecutor to assign the parent to the newly created procedure.<a name="line.599"></a>
+<span class="sourceLineNo">600</span> */<a name="line.600"></a>
+<span class="sourceLineNo">601</span> protected void setParentProcId(long parentProcId) {<a name="line.601"></a>
+<span class="sourceLineNo">602</span> this.parentProcId = parentProcId;<a name="line.602"></a>
+<span class="sourceLineNo">603</span> }<a name="line.603"></a>
+<span class="sourceLineNo">604</span><a name="line.604"></a>
+<span class="sourceLineNo">605</span> protected void setRootProcId(long rootProcId) {<a name="line.605"></a>
+<span class="sourceLineNo">606</span> this.rootProcId = rootProcId;<a name="line.606"></a>
+<span class="sourceLineNo">607</span> }<a name="line.607"></a>
+<span class="sourceLineNo">608</span><a name="line.608"></a>
+<span class="sourceLineNo">609</span> /**<a name="line.609"></a>
+<span class="sourceLineNo">610</span> * Called by the ProcedureExecutor to set the value to the newly created procedure.<a name="line.610"></a>
+<span class="sourceLineNo">611</span> */<a name="line.611"></a>
+<span class="sourceLineNo">612</span> @VisibleForTesting<a name="line.612"></a>
+<span class="sourceLineNo">613</span> protected void setNonceKey(NonceKey nonceKey) {<a name="line.613"></a>
+<span class="sourceLineNo">614</span> this.nonceKey = nonceKey;<a name="line.614"></a>
+<span class="sourceLineNo">615</span> }<a name="line.615"></a>
+<span class="sourceLineNo">616</span><a name="line.616"></a>
+<span class="sourceLineNo">617</span> @VisibleForTesting<a name="line.617"></a>
+<span class="sourceLineNo">618</span> public void setOwner(String owner) {<a name="line.618"></a>
+<span class="sourceLineNo">619</span> this.owner = StringUtils.isEmpty(owner) ? null : owner;<a name="line.619"></a>
+<span class="sourceLineNo">620</span> }<a name="line.620"></a>
+<span class="sourceLineNo">621</span><a name="line.621"></a>
+<span class="sourceLineNo">622</span> public void setOwner(User owner) {<a name="line.622"></a>
+<span class="sourceLineNo">623</span> assert owner != null : "expected owner to be not null";<a name="line.623"></a>
+<span class="sourceLineNo">624</span> setOwner(owner.getShortName());<a name="line.624"></a>
+<span class="sourceLineNo">625</span> }<a name="line.625"></a>
+<span class="sourceLineNo">626</span><a name="line.626"></a>
+<span class="sourceLineNo">627</span> /**<a name="line.627"></a>
+<span class="sourceLineNo">628</span> * Called on store load to initialize the Procedure internals after<a name="line.628"></a>
+<span class="sourceLineNo">629</span> * the creation/deserialization.<a name="line.629"></a>
+<span class="sourceLineNo">630</span> */<a name="line.630"></a>
+<span class="sourceLineNo">631</span> protected void setSubmittedTime(long submittedTime) {<a name="line.631"></a>
+<span class="sourceLineNo">632</span> this.submittedTime = submittedTime;<a name="line.632"></a>
+<span class="sourceLineNo">633</span> }<a name="line.633"></a>
+<span class="sourceLineNo">634</span><a name="line.634"></a>
+<span class="sourceLineNo">635</span> // ==========================================================================<a name="line.635"></a>
+<span class="sourceLineNo">636</span> // runtime state - timeout related<a name="line.636"></a>
+<span class="sourceLineNo">637</span> // ==========================================================================<a name="line.637"></a>
+<span class="sourceLineNo">638</span> /**<a name="line.638"></a>
+<span class="sourceLineNo">639</span> * @param timeout timeout interval in msec<a name="line.639"></a>
+<span class="sourceLineNo">640</span> */<a name="line.640"></a>
+<span class="sourceLineNo">641</span> protected void setTimeout(int timeout) {<a name="line.641"></a>
+<span class="sourceLineNo">642</span> this.timeout = timeout;<a name="line.642"></a>
+<span class="sourceLineNo">643</span> }<a name="line.643"></a>
+<span class="sourceLineNo">644</span><a name="line.644"></a>
+<span class="sourceLineNo">645</span> public boolean hasTimeout() {<a name="line.645"></a>
+<span class="sourceLineNo">646</span> return timeout != NO_TIMEOUT;<a name="line.646"></a>
+<span class="sourceLineNo">647</span> }<a name="line.647"></a>
+<span class="sourceLineNo">648</span><a name="line.648"></a>
+<span class="sourceLineNo">649</span> /**<a name="line.649"></a>
+<span class="sourceLineNo">650</span> * @return the timeout in msec<a name="line.650"></a>
+<span class="sourceLineNo">651</span> */<a name="line.651"></a>
+<span class="sourceLineNo">652</span> public int getTimeout() {<a name="line.652"></a>
+<span class="sourceLineNo">653</span> return timeout;<a name="line.653"></a>
+<span class="sourceLineNo">654</span> }<a name="line.654"></a>
+<span class="sourceLineNo">655</span><a name="line.655"></a>
+<span class="sourceLineNo">656</span> /**<a name="line.656"></a>
+<span class="sourceLineNo">657</span> * Called on store load to initialize the Procedure internals after<a name="line.657"></a>
+<span class="sourceLineNo">658</span> * the creation/deserialization.<a name="line.658"></a>
+<span class="sourceLineNo">659</span> */<a name="line.659"></a>
+<span class="sourceLineNo">660</span> protected void setLastUpdate(long lastUpdate) {<a name="line.660"></a>
+<span class="sourceLineNo">661</span> this.lastUpdate = lastUpdate;<a name="line.661"></a>
+<span class="sourceLineNo">662</span> }<a name="line.662"></a>
+<span class="sourceLineNo">663</span><a name="line.663"></a>
+<span class="sourceLineNo">664</span> /**<a name="line.664"></a>
+<span class="sourceLineNo">665</span> * Called by ProcedureExecutor after each time a procedure step is executed.<a name="line.665"></a>
+<span class="sourceLineNo">666</span> */<a name="line.666"></a>
+<span class="sourceLineNo">667</span> protected void updateTimestamp() {<a name="line.667"></a>
+<span class="sourceLineNo">668</span> this.lastUpdate = EnvironmentEdgeManager.currentTime();<a name="line.668"></a>
+<span class="sourceLineNo">669</span> }<a name="line.669"></a>
+<span class="sourceLineNo">670</span><a name="line.670"></a>
+<span class="sourceLineNo">671</span> public long getLastUpdate() {<a name="line.671"></a>
+<span class="sourceLineNo">672</span> return lastUpdate;<a name="line.672"></a>
+<span class="sourceLineNo">673</span> }<a name="line.673"></a>
+<span class="sourceLineNo">674</span><a name="line.674"></a>
+<span class="sourceLineNo">675</span> /**<a name="line.675"></a>
+<span class="sourceLineNo">676</span> * Timeout of the next timeout.<a name="line.676"></a>
+<span class="sourceLineNo">677</span> * Called by the ProcedureExecutor if the procedure has timeout set and<a name="line.677"></a>
+<span class="sourceLineNo">678</span> * the procedure is in the waiting queue.<a name="line.678"></a>
+<span class="sourceLineNo">679</span> * @return the timestamp of the next timeout.<a name="line.679"></a>
+<span class="sourceLineNo">680</span> */<a name="line.680"></a>
+<span class="sourceLineNo">681</span> protected long getTimeoutTimestamp() {<a name="line.681"></a>
+<span class="sourceLineNo">682</span> return getLastUpdate() + getTimeout();<a name="line.682"></a>
+<span class="sourceLineNo">683</span> }<a name="line.683"></a>
+<span class="sourceLineNo">684</span><a name="line.684"></a>
+<span class="sourceLineNo">685</span> // ==========================================================================<a name="line.685"></a>
+<span class="sourceLineNo">686</span> // runtime state<a name="line.686"></a>
+<span class="sourceLineNo">687</span> // ==========================================================================<a name="line.687"></a>
+<span class="sourceLineNo">688</span> /**<a name="line.688"></a>
+<span class="sourceLineNo">689</span> * @return the time elapsed between the last update and the start time of the procedure.<a name="line.689"></a>
+<span class="sourceLineNo">690</span> */<a name="line.690"></a>
+<span class="sourceLineNo">691</span> public long elapsedTime() {<a name="line.691"></a>
+<span class="sourceLineNo">692</span> return getLastUpdate() - getSubmittedTime();<a name="line.692"></a>
+<span class="sourceLineNo">693</span> }<a name="line.693"></a>
+<span class="sourceLineNo">694</span><a name="line.694"></a>
+<span class="sourceLineNo">695</span> /**<a name="line.695"></a>
+<span class="sourceLineNo">696</span> * @return the serialized result if any, otherwise null<a name="line.696"></a>
+<span class="sourceLineNo">697</span> */<a name="line.697"></a>
+<span class="sourceLineNo">698</span> public byte[] getResult() {<a name="line.698"></a>
+<span class="sourceLineNo">699</span> return result;<a name="line.699"></a>
+<span class="sourceLineNo">700</span> }<a name="line.700"></a>
+<span class="sourceLineNo">701</span><a name="line.701"></a>
+<span class="sourceLineNo">702</span> /**<a name="line.702"></a>
+<span class="sourceLineNo">703</span> * The procedure may leave a "result" on completion.<a name="line.703"></a>
+<span class="sourceLineNo">704</span> * @param result the serialized result that will be passed to the client<a name="line.704"></a>
+<span class="sourceLineNo">705</span> */<a name="line.705"></a>
+<span class="sourceLineNo">706</span> protected void setResult(byte[] result) {<a name="line.706"></a>
+<span class="sourceLineNo">707</span> this.result = result;<a name="line.707"></a>
+<span class="sourceLineNo">708</span> }<a name="line.708"></a>
+<span class="sourceLineNo">709</span><a name="line.709"></a>
+<span class="sourceLineNo">710</span> /**<a name="line.710"></a>
+<span class="sourceLineNo">711</span> * Will only be called when loading procedures from procedure store, where we need to record<a name="line.711"></a>
+<span class="sourceLineNo">712</span> * whether the procedure has already held a lock. Later we will call<a name="line.712"></a>
+<span class="sourceLineNo">713</span> * {@link #restoreLock(Object, ProcedureStore)} to actually acquire the lock.<a name="line.713"></a>
+<span class="sourceLineNo">714</span> */<a name="line.714"></a>
+<span class="sourceLineNo">715</span> final void lockedWhenLoading() {<a name="line.715"></a>
+<span class="sourceLineNo">716</span> this.lockedWhenLoading = true;<a name="line.716"></a>
+<span class="sourceLineNo">717</span> }<a name="line.717"></a>
+<span class="sourceLineNo">718</span><a name="line.718"></a>
+<span class="sourceLineNo">719</span> /**<a name="line.719"></a>
+<span class="sourceLineNo">720</span> * Can only be called when restarting, before the procedure actually being executed, as after we<a name="line.720"></a>
+<span class="sourceLineNo">721</span> * actually call the {@link #doAcquireLock(Object, ProcedureStore)} method, we will reset<a name="line.721"></a>
+<span class="sourceLineNo">722</span> * {@link #lockedWhenLoading} to false.<a name="line.722"></a>
+<span class="sourceLineNo">723</span> * <p/><a name="line.723"></a>
+<span class="sourceLineNo">724</span> * Now it is only used in the ProcedureScheduler to determine whether we should put a Procedure in<a name="line.724"></a>
+<span class="sourceLineNo">725</span> * front of a queue.<a name="line.725"></a>
+<span class="sourceLineNo">726</span> */<a name="line.726"></a>
+<span class="sourceLineNo">727</span> public boolean isLockedWhenLoading() {<a name="line.727"></a>
+<span class="sourceLineNo">728</span> return lockedWhenLoading;<a name="line.728"></a>
+<span class="sourceLineNo">729</span> }<a name="line.729"></a>
+<span class="sourceLineNo">730</span><a name="line.730"></a>
<span class="sourceLineNo">731</span> // ==============================================================================================<a name="line.731"></a>
-<span class="sourceLineNo">732</span><a name="line.732"></a>
-<span class="sourceLineNo">733</span> /**<a name="line.733"></a>
-<span class="sourceLineNo">734</span> * @return true if the procedure is in a RUNNABLE state.<a name="line.734"></a>
-<span class="sourceLineNo">735</span> */<a name="line.735"></a>
-<span class="sourceLineNo">736</span> public synchronized boolean isRunnable() {<a name="line.736"></a>
-<span class="sourceLineNo">737</span> return state == ProcedureState.RUNNABLE;<a name="line.737"></a>
-<span class="sourceLineNo">738</span> }<a name="line.738"></a>
+<span class="sourceLineNo">732</span> // Runtime state, updated every operation by the ProcedureExecutor<a name="line.732"></a>
+<span class="sourceLineNo">733</span> //<a name="line.733"></a>
+<span class="sourceLineNo">734</span> // There is always 1 thread at the time operating on the state of the procedure.<a name="line.734"></a>
+<span class="sourceLineNo">735</span> // The ProcedureExecutor may check and set states, or some Procecedure may<a name="line.735"></a>
+<span class="sourceLineNo">736</span> // update its own state. but no concurrent updates. we use synchronized here<a name="line.736"></a>
+<span class="sourceLineNo">737</span> // just because the procedure can get scheduled on different executor threads on each step.<a name="line.737"></a>
+<span class="sourceLineNo">738</span> // ==============================================================================================<a name="line.738"></a>
<span class="sourceLineNo">739</span><a name="line.739"></a>
-<span class="sourceLineNo">740</span> public synchronized boolean isInitializing() {<a name="line.740"></a>
-<span class="sourceLineNo">741</span> return state == ProcedureState.INITIALIZING;<a name="line.741"></a>
-<span class="sourceLineNo">742</span> }<a name="line.742"></a>
-<span class="sourceLineNo">743</span><a name="line.743"></a>
-<span class="sourceLineNo">744</span> /**<a name="line.744"></a>
-<span class="sourceLineNo">745</span> * @return true if the procedure has failed. It may or may not have rolled back.<a name="line.745"></a>
-<span class="sourceLineNo">746</span> */<a name="line.746"></a>
-<span class="sourceLineNo">747</span> public synchronized boolean isFailed() {<a name="line.747"></a>
-<span class="sourceLineNo">748</span> return state == ProcedureState.FAILED || state == ProcedureState.ROLLEDBACK;<a name="line.748"></a>
+<span class="sourceLineNo">740</span> /**<a name="line.740"></a>
+<span class="sourceLineNo">741</span> * @return true if the procedure is in a RUNNABLE state.<a name="line.741"></a>
+<span class="sourceLineNo">742</span> */<a name="line.742"></a>
+<span class="sourceLineNo">743</span> public synchronized boolean isRunnable() {<a name="line.743"></a>
+<span class="sourceLineNo">744</span> return state == ProcedureState.RUNNABLE;<a name="line.744"></a>
+<span class="sourceLineNo">745</span> }<a name="line.745"></a>
+<span class="sourceLineNo">746</span><a name="line.746"></a>
+<span class="sourceLineNo">747</span> public synchronized boolean isInitializing() {<a name="line.747"></a>
+<span class="sourceLineNo">748</span> return state == ProcedureState.INITIALIZING;<a name="line.748"></a>
<span class="sourceLineNo">749</span> }<a name="line.749"></a>
<span class="sourceLineNo">750</span><a name="line.750"></a>
<span class="sourceLineNo">751</span> /**<a name="line.751"></a>
-<span class="sourceLineNo">752</span> * @return true if the procedure is finished successfully.<a name="line.752"></a>
+<span class="sourceLineNo">752</span> * @return true if the procedure has failed. It may or may not have rolled back.<a name="line.752"></a>
<span class="sourceLineNo">753</span> */<a name="line.753"></a>
-<span class="sourceLineNo">754</span> public synchronized boolean isSuccess() {<a name="line.754"></a>
-<span class="sourceLineNo">755</span> return state == ProcedureState.SUCCESS && !hasException();<a name="line.755"></a>
+<span class="sourceLineNo">754</span> public synchronized boolean isFailed() {<a name="line.754"></a>
+<span class="sourceLineNo">755</span> return state == ProcedureState.FAILED || state == ProcedureState.ROLLEDBACK;<a name="line.755"></a>
<span class="sourceLineNo">756</span> }<a name="line.756"></a>
<span class="sourceLineNo">757</span><a name="line.757"></a>
<span class="sourceLineNo">758</span> /**<a name="line.758"></a>
-<span class="sourceLineNo">759</span> * @return true if the procedure is finished. The Procedure may be completed successfully or<a name="line.759"></a>
-<span class="sourceLineNo">760</span> * rolledback.<a name="line.760"></a>
-<span class="sourceLineNo">761</span> */<a name="line.761"></a>
-<span class="sourceLineNo">762</span> public synchronized boolean isFinished() {<a name="line.762"></a>
-<span class="sourceLineNo">763</span> return isSuccess() || state == ProcedureState.ROLLEDBACK;<a name="line.763"></a>
-<span class="sourceLineNo">764</span> }<a name="line.764"></a>
-<span class="sourceLineNo">765</span><a name="line.765"></a>
-<span class="sourceLineNo">766</span> /**<a name="line.766"></a>
-<span class="sourceLineNo">767</span> * @return true if the procedure is waiting for a child to finish or for an external event.<a name="line.767"></a>
+<span class="sourceLineNo">759</span> * @return true if the procedure is finished successfully.<a name="line.759"></a>
+<span class="sourceLineNo">760</span> */<a name="line.760"></a>
+<span class="sourceLineNo">761</span> public synchronized boolean isSuccess() {<a name="line.761"></a>
+<span class="sourceLineNo">762</span> return state == ProcedureState.SUCCESS && !hasException();<a name="line.762"></a>
+<span class="sourceLineNo">763</span> }<a name="line.763"></a>
+<span class="sourceLineNo">764</span><a name="line.764"></a>
+<span class="sourceLineNo">765</span> /**<a name="line.765"></a>
+<span class="sourceLineNo">766</span> * @return true if the procedure is finished. The Procedure may be completed successfully or<a name="line.766"></a>
+<span class="sourceLineNo">767</span> * rolledback.<a name="line.767"></a>
<span class="sourceLineNo">768</span> */<a name="line.768"></a>
-<span class="sourceLineNo">769</span> public synchronized boolean isWaiting() {<a name="line.769"></a>
-<span class="sourceLineNo">770</span> switch (state) {<a name="line.770"></a>
-<span class="sourceLineNo">771</span> case WAITING:<a name="line.771"></a>
-<span class="sourceLineNo">772</span> case WAITING_TIMEOUT:<a name="line.772"></a>
-<span class="sourceLineNo">773</span> return true;<a name="line.773"></a>
-<span class="sourceLineNo">774</span> default:<a name="line.774"></a>
-<span class="sourceLineNo">775</span> break;<a name="line.775"></a>
-<span class="sourceLineNo">776</span> }<a name="line.776"></a>
-<span class="sourceLineNo">777</span> return false;<a name="line.777"></a>
-<span class="sourceLineNo">778</span> }<a name="line.778"></a>
-<span class="sourceLineNo">779</span><a name="line.779"></a>
-<span class="sourceLineNo">780</span> @VisibleForTesting<a name="line.780"></a>
-<span class="sourceLineNo">781</span> protected synchronized void setState(final ProcedureState state) {<a name="line.781"></a>
-<span class="sourceLineNo">782</span> this.state = state;<a name="line.782"></a>
-<span class="sourceLineNo">783</span> updateTimestamp();<a name="line.783"></a>
-<span class="sourceLineNo">784</span> }<a name="line.784"></a>
-<span class="sourceLineNo">785</span><a name="line.785"></a>
-<span class="sourceLineNo">786</span> public synchronized ProcedureState getState() {<a name="line.786"></a>
-<span class="sourceLineNo">787</span> return state;<a name="line.787"></a>
-<span class="sourceLineNo">788</span> }<a name="line.788"></a>
-<span class="sourceLineNo">789</span><a name="line.789"></a>
-<span class="sourceLineNo">790</span> protected void setFailure(final String source, final Throwable cause) {<a name="line.790"></a>
-<span class="sourceLineNo">791</span> setFailure(new RemoteProcedureException(source, cause));<a name="line.791"></a>
-<span class="sourceLineNo">792</span> }<a name="line.792"></a>
-<span class="sourceLineNo">793</span><a name="line.793"></a>
-<span class="sourceLineNo">794</span> protected synchronized void setFailure(final RemoteProcedureException exception) {<a name="line.794"></a>
-<span class="sourceLineNo">795</span> this.exception = exception;<a name="line.795"></a>
-<span class="sourceLineNo">796</span> if (!isFinished()) {<a name="line.796"></a>
-<span class="sourceLineNo">797</span> setState(ProcedureState.FAILED);<a name="line.797"></a>
-<span class="sourceLineNo">798</span> }<a name="line.798"></a>
+<span class="sourceLineNo">769</span> public synchronized boolean isFinished() {<a name="line.769"></a>
+<span class="sourceLineNo">770</span> return isSuccess() || state == ProcedureState.ROLLEDBACK;<a name="line.770"></a>
+<span class="sourceLineNo">771</span> }<a name="line.771"></a>
+<span class="sourceLineNo">772</span><a name="line.772"></a>
+<span class="sourceLineNo">773</span> /**<a name="line.773"></a>
+<span class="sourceLineNo">774</span> * @return true if the procedure is waiting for a child to finish or for an external event.<a name="line.774"></a>
+<span class="sourceLineNo">775</span> */<a name="line.775"></a>
+<span class="sourceLineNo">776</span> public synchronized boolean isWaiting() {<a name="line.776"></a>
+<span class="sourceLineNo">777</span> switch (state) {<a name="line.777"></a>
+<span class="sourceLineNo">778</span> case WAITING:<a name="line.778"></a>
+<span class="sourceLineNo">779</span> case WAITING_TIMEOUT:<a name="line.779"></a>
+<span class="sourceLineNo">780</span> return true;<a name="line.780"></a>
+<span class="sourceLineNo">781</span> default:<a name="line.781"></a>
+<span class="sourceLineNo">782</span> break;<a name="line.782"></a>
+<span class="sourceLineNo">783</span> }<a name="line.783"></a>
+<span class="sourceLineNo">784</span> return false;<a name="line.784"></a>
+<span class="sourceLineNo">785</span> }<a name="line.785"></a>
+<span class="sourceLineNo">786</span><a name="line.786"></a>
+<span class="sourceLineNo">787</span> @VisibleForTesting<a name="line.787"></a>
+<span class="sourceLineNo">788</span> protected synchronized void setState(final ProcedureState state) {<a name="line.788"></a>
+<span class="sourceLineNo">789</span> this.state = state;<a name="line.789"></a>
+<span class="sourceLineNo">790</span> updateTimestamp();<a name="line.790"></a>
+<span class="sourceLineNo">791</span> }<a name="line.791"></a>
+<span class="sourceLineNo">792</span><a name="line.792"></a>
+<span class="sourceLineNo">793</span> public synchronized ProcedureState getState() {<a name="line.793"></a>
+<span class="sourceLineNo">794</span> return state;<a name="line.794"></a>
+<span class="sourceLineNo">795</span> }<a name="line.795"></a>
+<span class="sourceLineNo">796</span><a name="line.796"></a>
+<span class="sourceLineNo">797</span> protected void setFailure(final String source, final Throwable cause) {<a name="line.797"></a>
+<span class="sourceLineNo">798</span> setFailure(new RemoteProcedureException(source, cause));<a name="line.798"></a>
<span class="sourceLineNo">799</span> }<a name="line.799"></a>
<span class="sourceLineNo">800</span><a name="line.800"></a>
-<span class="sourceLineNo">801</span> protected void setAbortFailure(final String source, final String msg) {<a name="line.801"></a>
-<span class="sourceLineNo">802</span> setFailure(source, new ProcedureAbortedException(msg));<a name="line.802"></a>
-<span class="sourceLineNo">803</span> }<a name="line.803"></a>
-<span class="sourceLineNo">804</span><a name="line.804"></a>
-<span class="sourceLineNo">805</span> /**<a name="line.805"></a>
-<span class="sourceLineNo">806</span> * Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.<a name="line.806"></a>
-<span class="sourceLineNo">807</span> * <p/><a name="line.807"></a>
-<span class="sourceLineNo">808</span> * Another usage for this method is to implement retrying. A procedure can set the state to<a name="line.808"></a>
-<span class="sourceLineNo">809</span> * {@code WAITING_TIMEOUT} by calling {@code setState} method, and throw a<a name="line.809"></a>
-<span class="sourceLineNo">810</span> * {@link ProcedureSuspendedException} to halt the execution of the procedure, and do not forget a<a name="line.810"></a>
-<span class="sourceLineNo">811</span> * call {@link #setTimeout(int)} method to set the timeout. And you should also override this<a name="line.811"></a>
-<span class="sourceLineNo">812</span> * method to wake up the procedure, and also return false to tell the ProcedureExecutor that the<a name="line.812"></a>
-<span class="sourceLineNo">813</span> * timeout event has been handled.<a name="line.813"></a>
-<span class="sourceLineNo">814</span> * @return true to let the framework handle the timeout as abort, false in case the procedure<a name="line.814"></a>
-<span class="sourceLineNo">815</span> * handled the timeout itself.<a name="line.815"></a>
-<span class="sourceLineNo">816</span> */<a name="line.816"></a>
-<span class="sourceLineNo">817</span> protected synchronized boolean setTimeoutFailure(TEnvironment env) {<a name="line.817"></a>
-<span class="sourceLineNo">818</span> if (state == ProcedureState.WAITING_TIMEOUT) {<a name="line.818"></a>
-<span class="sourceLineNo">819</span> long timeDiff = EnvironmentEdgeManager.currentTime() - lastUpdate;<a name="line.819"></a>
-<span class="sourceLineNo">820</span> setFailure("ProcedureExecutor",<a name="line.820"></a>
-<span class="sourceLineNo">821</span> new TimeoutIOException("Operation timed out after " + StringUtils.humanTimeDiff(timeDiff)));<a name="line.821"></a>
-<span class="sourceLineNo">822</span> return true;<a name="line.822"></a>
-<span class="sourceLineNo">823</span> }<a name="line.823"></a>
-<span class="sourceLineNo">824</span> return false;<a name="line.824"></a>
-<span class="sourceLineNo">825</span> }<a name="line.825"></a>
-<span class="sourceLineNo">826</span><a name="line.826"></a>
-<span class="sourceLineNo">827</span> public synchronized boolean hasException() {<a name="line.827"></a>
-<span class="sourceLineNo">828</span> return exception != null;<a name="line.828"></a>
-<span class="sourceLineNo">829</span> }<a name="line.829"></a>
-<span class="sourceLineNo">830</span><a name="line.830"></a>
-<span class="sourceLineNo">831</span> public synchronized RemoteProcedureException getException() {<a name="line.831"></a>
-<span class="sourceLineNo">832</span> return exception;<a name="line.832"></a>
-<span class="sourceLineNo">833</span> }<a name="line.833"></a>
-<span class="sourceLineNo">834</span><a name="line.834"></a>
-<span class="sourceLineNo">835</span> /**<a name="line.835"></a>
-<span class="sourceLineNo">836</span> * Called by the ProcedureExecutor on procedure-load to restore the latch state<a name="line.836"></a>
-<span class="sourceLineNo">837</span> */<a name="line.837"></a>
-<span class="sourceLineNo">838</span> protected synchronized void setChildrenLatch(int numChildren) {<a name="line.838"></a>
-<span class="sourceLineNo">839</span> this.childrenLatch = numChildren;<a name="line.839"></a>
-<span class="sourceLineNo">840</span> if (LOG.isTraceEnabled()) {<a name="line.840"></a>
-<span class="sourceLineNo">841</span> LOG.trace("CHILD LATCH INCREMENT SET " +<a name="line.841"></a>
-<span class="sourceLineNo">842</span> this.childrenLatch, new Throwable(this.toString()));<a name="line.842"></a>
-<span class="sourceLineNo">843</span> }<a name="line.843"></a>
-<span class="sourceLineNo">844</span> }<a name="line.844"></a>
-<span class="sourceLineNo">845</span><a name="line.845"></a>
-<
<TRUNCATED>