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 org.apache.yetus.audience.InterfaceAudience;
020import org.apache.hadoop.hbase.client.Append;
021import org.apache.hadoop.hbase.client.Increment;
022import org.apache.hadoop.hbase.client.Mutation;
023import org.apache.hadoop.hbase.client.Put;
024import org.apache.hadoop.hbase.quotas.SpaceLimitingException;
025import org.apache.hadoop.hbase.quotas.SpaceViolationPolicy;
026import org.apache.hadoop.hbase.quotas.SpaceViolationPolicyEnforcement;
027
028/**
029 * A {@link SpaceViolationPolicyEnforcement} which disallows any inserts to the table. The
030 * enforcement counterpart to {@link SpaceViolationPolicy#NO_INSERTS}.
031 */
032@InterfaceAudience.Private
033public class NoInsertsViolationPolicyEnforcement extends DefaultViolationPolicyEnforcement {
034
035  @Override
036  public void enable() {}
037
038  @Override
039  public void disable() {}
040
041  @Override
042  public void check(Mutation m) throws SpaceLimitingException {
043    // Disallow all "new" data flowing into HBase, but allow Deletes (even though we know they will
044    // temporarily increase utilization).
045    if (m instanceof Append  || m instanceof Increment || m instanceof Put) {
046      throw new SpaceLimitingException(getPolicyName(),
047          m.getClass().getSimpleName() + "s are disallowed due to a space quota.");
048    }
049  }
050
051  @Override
052  public String getPolicyName() {
053    return SpaceViolationPolicy.NO_INSERTS.name();
054  }
055}