001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to you under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.hadoop.hbase.quotas.policies;
018
019import java.io.IOException;
020import org.apache.hadoop.hbase.client.Mutation;
021import org.apache.hadoop.hbase.quotas.SpaceLimitingException;
022import org.apache.hadoop.hbase.quotas.SpaceViolationPolicy;
023import org.apache.hadoop.hbase.quotas.SpaceViolationPolicyEnforcement;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * A {@link SpaceViolationPolicyEnforcement} which disables the table. The enforcement counterpart
028 * to {@link SpaceViolationPolicy#DISABLE}. This violation policy is different from others as it
029 * doesn't take action (i.e. enable/disable table) local to the RegionServer, like the other
030 * ViolationPolicies do. In case of violation, the appropriate action is initiated by the master.
031 */
032@InterfaceAudience.Private
033public class DisableTableViolationPolicyEnforcement extends DefaultViolationPolicyEnforcement {
034
035  @Override
036  public void enable() throws IOException {
037    // do nothing
038  }
039
040  @Override
041  public void disable() throws IOException {
042    // do nothing
043  }
044
045  @Override
046  public void check(Mutation m) throws SpaceLimitingException {
047    // If this policy is enacted, then the table is (or should be) disabled.
048    throw new SpaceLimitingException(
049        getPolicyName(), "This table is disabled due to violating a space quota.");
050  }
051
052  @Override
053  public String getPolicyName() {
054    return SpaceViolationPolicy.DISABLE.name();
055  }
056}