org.apache.hadoop.hbase.security.access.NamespacePermission Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hbase-client Show documentation
Client of HBase
There is a newer version: 3.0.0-beta-1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.security.access;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.util.Objects;
import org.apache.hadoop.hbase.NamespaceDescriptor;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.yetus.audience.InterfaceAudience;

/**
 * Represents an authorization for access for the given namespace.
 */
@InterfaceAudience.Public
public class NamespacePermission extends Permission {

  private String namespace = NamespaceDescriptor.DEFAULT_NAMESPACE_NAME_STR;

  /**
   * Construct a namespace permission.
   * @param namespace namespace's name
   * @param assigned  assigned actions
   */
  NamespacePermission(String namespace, Action... assigned) {
    super(assigned);
    this.namespace = namespace;
    this.scope = Scope.NAMESPACE;
  }

  public String getNamespace() {
    return namespace;
  }

  /**
   * check if given action is granted in given namespace.
   * @param namespace namespace's name
   * @param action    action to be checked
   * @return true if granted, false otherwise
   */
  public boolean implies(String namespace, Action action) {
    return namespace.equals(this.namespace) && implies(action);
  }

  @Override
  public boolean equalsExceptActions(Object obj) {
    if (!(obj instanceof NamespacePermission)) {
      return false;
    }
    NamespacePermission gp = (NamespacePermission) obj;
    return namespace.equals(gp.namespace);
  }

  @Override
  public int hashCode() {
    return Objects.hash(namespace) + super.hashCode();
  }

  @Override
  public boolean equals(Object obj) {
    return equalsExceptActions(obj) && super.equals(obj);
  }

  @Override
  public String toString() {
    return "[NamespacePermission: " + rawExpression() + "]";
  }

  @Override
  protected String rawExpression() {
    StringBuilder raw = new StringBuilder("namespace=").append(namespace).append(", ");
    return raw.toString() + super.rawExpression();
  }

  @Override
  public void readFields(DataInput in) throws IOException {
    super.readFields(in);
    namespace = Bytes.toString(Bytes.readByteArray(in));
  }

  @Override
  public void write(DataOutput out) throws IOException {
    super.write(out);
    Bytes.writeByteArray(out, Bytes.toBytes(namespace));
  }
}