access-binding/access-binding-hive/src/main/java/org/apache/access/binding/hive/AccessOnFailureHookContext.java

/*
 * 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.access.binding.hive;

import org.apache.access.core.AccessURI;
import org.apache.access.core.Database;
import org.apache.access.core.Table;
import org.apache.hadoop.hive.ql.exec.Task;
import org.apache.hadoop.hive.ql.hooks.ReadEntity;
import org.apache.hadoop.hive.ql.hooks.WriteEntity;
import org.apache.hadoop.hive.ql.metadata.AuthorizationException;

import java.io.Serializable;
import java.util.List;
import java.util.Set;

/**
 * Context information provided by Access to implementations
 * of AccessOnFailureHook
 */
public interface AccessOnFailureHookContext  {

  /**
   * @return the command attempted by user
   */
  public String getCommand();

  /**
    * @return the set of read entities
    */
  public Set<ReadEntity> getInputs();

  /**
   * @return the set of write entities
   */
  public Set<WriteEntity> getOutputs();

  /**
   * @return the user name
   */
  public String getUserName();

  /**
   * @return the ip address
   */
  public String getIpAddress();

  /**
   * @return the database object
   */
  public Database getDatabase();

  /**
   * @return the table object
   */
  public Table getTable();

  /**
   * @return the udf URI
   */
  public AccessURI getUdfURI();

  /**
   * @return the partition URI
   */
  public AccessURI getPartitionURI();

  /**
   * @return the authorization failure exception
   */
  public AuthorizationException getException();

}