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