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 */
018
019package org.apache.hadoop.security.authorize;
020
021import org.apache.hadoop.classification.InterfaceAudience;
022import org.apache.hadoop.classification.InterfaceStability;
023import org.apache.hadoop.conf.Configurable;
024import org.apache.hadoop.security.UserGroupInformation;
025
026@InterfaceStability.Unstable
027@InterfaceAudience.Public
028public interface ImpersonationProvider  extends Configurable {
029
030
031  /**
032   * Specifies the configuration prefix for the proxy user properties and
033   * initializes the provider.
034   *
035   * @param configurationPrefix the configuration prefix for the proxy user
036   * properties
037   */
038  public void init(String configurationPrefix);
039
040  /**
041   * Authorize the superuser which is doing doAs
042   * 
043   * @param user ugi of the effective or proxy user which contains a real user
044   * @param remoteAddress the ip address of client
045   * @throws AuthorizationException
046   */
047  public void authorize(UserGroupInformation user, String remoteAddress)
048      throws AuthorizationException;
049}