ranger-elasticsearch-plugin-shim/src/main/java/org/apache/ranger/authorization/elasticsearch/authorizer/RangerElasticsearchAccessControl.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.ranger.authorization.elasticsearch.authorizer;

import java.util.List;

public interface RangerElasticsearchAccessControl {

	/**
	 * Check permission for user do action on the elasticsearch index.
	 *
	 * @param user The user do the request.
	 * @param groups The groups of the user.
	 * @param index The elasticsearch index.
	 * @param action The operation type.
	 * @param clientIPAddress The clent IP address.
	 * @return Check permission result.
	 */
	boolean checkPermission(String user, List<String> groups, String index, String action, String clientIPAddress);
}