| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Constraint (Apache HBase 4.0.0-alpha-1-SNAPSHOT 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.hadoop.hbase.constraint, interface: Constraint"> |
| <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/Constraint.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.constraint</a></div> |
| <h1 title="Interface Constraint" class="title">Interface Constraint</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>org.apache.hadoop.conf.Configurable</code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BaseConstraint.html" title="class in org.apache.hadoop.hbase.constraint">BaseConstraint</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/constraint/Constraint.html#line-61">Constraint</a></span><span class="extends-implements"> |
| extends org.apache.hadoop.conf.Configurable</span></div> |
| <div class="block">Apply a <a href="Constraint.html" title="interface in org.apache.hadoop.hbase.constraint"><code>Constraint</code></a> (in traditional database terminology) to a Table. Any number of |
| <a href="Constraint.html" title="interface in org.apache.hadoop.hbase.constraint"><code>Constraints</code></a> can be added to the table, in any order. |
| <p/> |
| A <a href="Constraint.html" title="interface in org.apache.hadoop.hbase.constraint"><code>Constraint</code></a> must be added to a table before the table is loaded via |
| <a href="Constraints.html#add(org.apache.hadoop.hbase.client.TableDescriptorBuilder,java.lang.Class...)"><code>Constraints.add(org.apache.hadoop.hbase.client.TableDescriptorBuilder, Class...)</code></a> or |
| <a href="Constraints.html#add(org.apache.hadoop.hbase.client.TableDescriptorBuilder,org.apache.hadoop.hbase.util.Pair...)"><code>Constraints.add(org.apache.hadoop.hbase.client.TableDescriptorBuilder, org.apache.hadoop.hbase.util.Pair...)</code></a> |
| (if you want to add a configuration with the <a href="Constraint.html" title="interface in org.apache.hadoop.hbase.constraint"><code>Constraint</code></a>). Constraints will be run in the |
| order that they are added. Further, a Constraint will be configured before it is run (on load). |
| <p/> |
| See |
| <a href="Constraints.html#enableConstraint(org.apache.hadoop.hbase.client.TableDescriptorBuilder,java.lang.Class)"><code>Constraints.enableConstraint(org.apache.hadoop.hbase.client.TableDescriptorBuilder, Class)</code></a> |
| and |
| <a href="Constraints.html#disableConstraint(org.apache.hadoop.hbase.client.TableDescriptorBuilder,java.lang.Class)"><code>Constraints.disableConstraint(org.apache.hadoop.hbase.client.TableDescriptorBuilder, Class)</code></a> |
| for enabling/disabling of a given <a href="Constraint.html" title="interface in org.apache.hadoop.hbase.constraint"><code>Constraint</code></a> after it has been added. |
| <p/> |
| If a <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> is invalid, the Constraint should throw some sort of |
| <a href="ConstraintException.html" title="class in org.apache.hadoop.hbase.constraint"><code>ConstraintException</code></a>, indicating that the <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> |
| has failed. When this exception is thrown, not further retries of the <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> are attempted |
| nor are any other <a href="Constraint.html" title="interface in org.apache.hadoop.hbase.constraint"><code>Constraints</code></a> attempted (the <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> is clearly not |
| valid). Therefore, there are performance implications in the order in which <a href="BaseConstraint.html" title="class in org.apache.hadoop.hbase.constraint"><code>Constraints</code></a> are specified. |
| <p/> |
| If a <a href="Constraint.html" title="interface in org.apache.hadoop.hbase.constraint"><code>Constraint</code></a> fails to fail the <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> via a |
| <a href="ConstraintException.html" title="class in org.apache.hadoop.hbase.constraint"><code>ConstraintException</code></a>, but instead throws a |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link"><code>RuntimeException</code></a>, the entire constraint processing mechanism |
| (<a href="ConstraintProcessor.html" title="class in org.apache.hadoop.hbase.constraint"><code>ConstraintProcessor</code></a>) will be unloaded from the table. This ensures that the region |
| server is still functional, but no more <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Puts</code></a> will be checked via <a href="Constraint.html" title="interface in org.apache.hadoop.hbase.constraint"><code>Constraints</code></a>. |
| <p/> |
| Further, <a href="Constraint.html" title="interface in org.apache.hadoop.hbase.constraint"><code>Constraints</code></a> should probably not be used to enforce cross-table |
| references as it will cause tremendous write slowdowns, but it is possible. |
| <p/> |
| NOTE: Implementing classes must have a nullary (no-args) constructor</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="BaseConstraint.html" title="class in org.apache.hadoop.hbase.constraint"><code>BaseConstraint</code></a></li> |
| <li><a href="Constraints.html" title="class in org.apache.hadoop.hbase.constraint"><code>Constraints</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#check(org.apache.hadoop.hbase.client.Put)" class="member-name-link">check</a><wbr>(<a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a> p)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Check a <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> to ensure it is valid for the table.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.conf.Configurable">Methods inherited from interface org.apache.hadoop.conf.Configurable</h3> |
| <code>getConf, setConf</code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="check(org.apache.hadoop.hbase.client.Put)"> |
| <h3>check</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/constraint/Constraint.html#line-73">check</a></span><wbr><span class="parameters">(<a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a> p)</span> |
| throws <span class="exceptions"><a href="ConstraintException.html" title="class in org.apache.hadoop.hbase.constraint">ConstraintException</a></span></div> |
| <div class="block">Check a <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> to ensure it is valid for the table. If the <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> is valid, then just |
| return from the method. Otherwise, throw an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link"><code>Exception</code></a> specifying what happened. This |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link"><code>Exception</code></a> is propagated back to the client so you can see what caused the <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> |
| to fail.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>p</code> - <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> to check</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="ConstraintException.html" title="class in org.apache.hadoop.hbase.constraint">ConstraintException</a></code> - when the <a href="../client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> does not |
| match the constraint.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
