| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.constraint, interface: Constraint"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.constraint;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import org.apache.hadoop.conf.Configurable;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.client.Put;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">/**</span> |
| <span class="source-line-no">025</span><span id="line-25"> * Apply a {@link Constraint} (in traditional database terminology) to a Table. Any number of</span> |
| <span class="source-line-no">026</span><span id="line-26"> * {@link Constraint Constraints} can be added to the table, in any order.</span> |
| <span class="source-line-no">027</span><span id="line-27"> * <p/></span> |
| <span class="source-line-no">028</span><span id="line-28"> * A {@link Constraint} must be added to a table before the table is loaded via</span> |
| <span class="source-line-no">029</span><span id="line-29"> * {@link Constraints#add(org.apache.hadoop.hbase.client.TableDescriptorBuilder, Class...)} or</span> |
| <span class="source-line-no">030</span><span id="line-30"> * {@link Constraints#add(org.apache.hadoop.hbase.client.TableDescriptorBuilder, org.apache.hadoop.hbase.util.Pair...)}</span> |
| <span class="source-line-no">031</span><span id="line-31"> * (if you want to add a configuration with the {@link Constraint}). Constraints will be run in the</span> |
| <span class="source-line-no">032</span><span id="line-32"> * order that they are added. Further, a Constraint will be configured before it is run (on load).</span> |
| <span class="source-line-no">033</span><span id="line-33"> * <p/></span> |
| <span class="source-line-no">034</span><span id="line-34"> * See</span> |
| <span class="source-line-no">035</span><span id="line-35"> * {@link Constraints#enableConstraint(org.apache.hadoop.hbase.client.TableDescriptorBuilder, Class)}</span> |
| <span class="source-line-no">036</span><span id="line-36"> * and</span> |
| <span class="source-line-no">037</span><span id="line-37"> * {@link Constraints#disableConstraint(org.apache.hadoop.hbase.client.TableDescriptorBuilder, Class)}</span> |
| <span class="source-line-no">038</span><span id="line-38"> * for enabling/disabling of a given {@link Constraint} after it has been added.</span> |
| <span class="source-line-no">039</span><span id="line-39"> * <p/></span> |
| <span class="source-line-no">040</span><span id="line-40"> * If a {@link Put} is invalid, the Constraint should throw some sort of</span> |
| <span class="source-line-no">041</span><span id="line-41"> * {@link org.apache.hadoop.hbase.constraint.ConstraintException}, indicating that the {@link Put}</span> |
| <span class="source-line-no">042</span><span id="line-42"> * has failed. When this exception is thrown, not further retries of the {@link Put} are attempted</span> |
| <span class="source-line-no">043</span><span id="line-43"> * nor are any other {@link Constraint Constraints} attempted (the {@link Put} is clearly not</span> |
| <span class="source-line-no">044</span><span id="line-44"> * valid). Therefore, there are performance implications in the order in which {@link BaseConstraint</span> |
| <span class="source-line-no">045</span><span id="line-45"> * Constraints} are specified.</span> |
| <span class="source-line-no">046</span><span id="line-46"> * <p/></span> |
| <span class="source-line-no">047</span><span id="line-47"> * If a {@link Constraint} fails to fail the {@link Put} via a</span> |
| <span class="source-line-no">048</span><span id="line-48"> * {@link org.apache.hadoop.hbase.constraint.ConstraintException}, but instead throws a</span> |
| <span class="source-line-no">049</span><span id="line-49"> * {@link RuntimeException}, the entire constraint processing mechanism</span> |
| <span class="source-line-no">050</span><span id="line-50"> * ({@link ConstraintProcessor}) will be unloaded from the table. This ensures that the region</span> |
| <span class="source-line-no">051</span><span id="line-51"> * server is still functional, but no more {@link Put Puts} will be checked via {@link Constraint</span> |
| <span class="source-line-no">052</span><span id="line-52"> * Constraints}.</span> |
| <span class="source-line-no">053</span><span id="line-53"> * <p/></span> |
| <span class="source-line-no">054</span><span id="line-54"> * Further, {@link Constraint Constraints} should probably not be used to enforce cross-table</span> |
| <span class="source-line-no">055</span><span id="line-55"> * references as it will cause tremendous write slowdowns, but it is possible.</span> |
| <span class="source-line-no">056</span><span id="line-56"> * <p/></span> |
| <span class="source-line-no">057</span><span id="line-57"> * NOTE: Implementing classes must have a nullary (no-args) constructor</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @see BaseConstraint</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @see Constraints</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61">@InterfaceAudience.Private</span> |
| <span class="source-line-no">062</span><span id="line-62">public interface Constraint extends Configurable {</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> /**</span> |
| <span class="source-line-no">065</span><span id="line-65"> * Check a {@link Put} to ensure it is valid for the table. If the {@link Put} is valid, then just</span> |
| <span class="source-line-no">066</span><span id="line-66"> * return from the method. Otherwise, throw an {@link Exception} specifying what happened. This</span> |
| <span class="source-line-no">067</span><span id="line-67"> * {@link Exception} is propagated back to the client so you can see what caused the {@link Put}</span> |
| <span class="source-line-no">068</span><span id="line-68"> * to fail.</span> |
| <span class="source-line-no">069</span><span id="line-69"> * @param p {@link Put} to check</span> |
| <span class="source-line-no">070</span><span id="line-70"> * @throws org.apache.hadoop.hbase.constraint.ConstraintException when the {@link Put} does not</span> |
| <span class="source-line-no">071</span><span id="line-71"> * match the constraint.</span> |
| <span class="source-line-no">072</span><span id="line-72"> */</span> |
| <span class="source-line-no">073</span><span id="line-73"> void check(Put p) throws ConstraintException;</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
