Constructor Detail

• UserProvider

  public UserProvider()

Method Detail

• setConf

  public void setConf(org.apache.hadoop.conf.Configuration conf)

  Specified by:

  setConf in interface org.apache.hadoop.conf.Configurable

  Overrides:

  setConf in class BaseConfigurable

• instantiate

  public static UserProvider instantiate(org.apache.hadoop.conf.Configuration conf)

  Instantiate the UserProvider specified in the configuration and set the passed configuration via setConf(Configuration)

  Parameters:

  conf - to read and set on the created UserProvider

  Returns:

  a UserProvider ready for use.

• setUserProviderForTesting

  public static void setUserProviderForTesting(org.apache.hadoop.conf.Configuration conf,
                               Class<? extends UserProvider> provider)

  Set the UserProvider in the given configuration that should be instantiated

  Parameters:

  conf - to update

  provider - class of the provider to set

• getCurrentUserName

  public String getCurrentUserName()
                            throws IOException

  Returns:

  the userName for the current logged-in user.

  Throws:

  IOException - if the underlying user cannot be obtained

• isHBaseSecurityEnabled

  public boolean isHBaseSecurityEnabled()

  Returns:

  true if security is enabled, false otherwise

• isHadoopSecurityEnabled

  public boolean isHadoopSecurityEnabled()

  Returns:

  whether or not Kerberos authentication is configured for Hadoop. For non-secure Hadoop, this always returns false. For secure Hadoop, it will return the value from UserGroupInformation.isSecurityEnabled().

• getCurrent

  public User getCurrent()
                  throws IOException

  Returns:

  the current user within the current execution context

  Throws:

  IOException - if the user cannot be loaded

• create

  public User create(org.apache.hadoop.security.UserGroupInformation ugi)

  Wraps an underlying UserGroupInformation instance.

  Parameters:

  ugi - The base Hadoop user

  Returns:

  User

• login

  public void login(String fileConfKey,
           String principalConfKey,
           String localhost)
             throws IOException

  Log in the current process using the given configuration keys for the credential file and login principal.

  This is only applicable when running on secure Hadoop -- see org.apache.hadoop.security.SecurityUtil#login(Configuration,String,String,String). On regular Hadoop (without security features), this will safely be ignored.

  Parameters:

  fileConfKey - Property key used to configure path to the credential file

  principalConfKey - Property key used to configure login principal

  localhost - Current hostname to use in any credentials

  Throws:

  IOException - underlying exception from SecurityUtil.login() call