001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.quotas.policies;
019
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;
027import org.apache.yetus.audience.InterfaceAudience;
028
029/**
030 * A {@link SpaceViolationPolicyEnforcement} which disallows any inserts to the table. The
031 * enforcement counterpart to {@link SpaceViolationPolicy#NO_INSERTS}.
032 */
033@InterfaceAudience.Private
034public class NoInsertsViolationPolicyEnforcement extends DefaultViolationPolicyEnforcement {
035
036  @Override
037  public void enable() {
038  }
039
040  @Override
041  public void disable() {
042  }
043
044  @Override
045  public void check(Mutation m) throws SpaceLimitingException {
046    // Disallow all "new" data flowing into HBase, but allow Deletes (even though we know they will
047    // temporarily increase utilization).
048    if (m instanceof Append || m instanceof Increment || m instanceof Put) {
049      throw new SpaceLimitingException(getPolicyName(),
050        m.getClass().getSimpleName() + "s are disallowed due to a space quota.");
051    }
052  }
053
054  @Override
055  public String getPolicyName() {
056    return SpaceViolationPolicy.NO_INSERTS.name();
057  }
058}