View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    * http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.hadoop.hbase.quotas.policies;
18  
19  import org.apache.hadoop.hbase.classification.InterfaceAudience;
20  import org.apache.hadoop.hbase.client.Append;
21  import org.apache.hadoop.hbase.client.Delete;
22  import org.apache.hadoop.hbase.client.Increment;
23  import org.apache.hadoop.hbase.client.Mutation;
24  import org.apache.hadoop.hbase.client.Put;
25  import org.apache.hadoop.hbase.quotas.SpaceLimitingException;
26  import org.apache.hadoop.hbase.quotas.SpaceViolationPolicy;
27  import org.apache.hadoop.hbase.quotas.SpaceViolationPolicyEnforcement;
28  
29  /**
30   * A {@link SpaceViolationPolicyEnforcement} implementation which disables all writes flowing
31   * into HBase. The enforcement counterpart to {@link SpaceViolationPolicy#NO_WRITES}.
32   */
33  @InterfaceAudience.Private
34  public class NoWritesViolationPolicyEnforcement extends DefaultViolationPolicyEnforcement {
35  
36    @Override
37    public void enable() {}
38  
39    @Override
40    public void disable() {}
41  
42    @Override
43    public void check(Mutation m) throws SpaceLimitingException {
44      if (m instanceof Append || m instanceof Delete || m instanceof Increment || m instanceof Put) {
45        throw new SpaceLimitingException(getPolicyName(),
46            m.getClass().getSimpleName() + "s are disallowed due to a space quota.");
47      }
48    }
49  
50    @Override
51    public String getPolicyName() {
52      return SpaceViolationPolicy.NO_WRITES.name();
53    }
54  }