org.apache.ignite.hadoop.fs

Class KerberosHadoopFileSystemFactory

java.lang.Object

org.apache.ignite.hadoop.fs.BasicHadoopFileSystemFactory

org.apache.ignite.hadoop.fs.KerberosHadoopFileSystemFactory

All Implemented Interfaces:

Externalizable, Serializable, HadoopFileSystemFactory

public class KerberosHadoopFileSystemFactory
extends BasicHadoopFileSystemFactory

Secure Hadoop file system factory that can work with underlying file system protected with Kerberos. It uses "impersonation" mechanism, to be able to work on behalf of arbitrary client user. Please see https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Superusers.html for details. The principal and the key tab name to be used for Kerberos authentication are set explicitly in the factory configuration.

This factory does not cache any file system instances. If "fs.[prefix].impl.disable.cache" is set to true, file system instances will be cached by Hadoop.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	DFLT_RELOGIN_INTERVAL The default interval used to re-login from the key tab, in milliseconds.

Constructor Summary

Constructors

Constructor and Description
KerberosHadoopFileSystemFactory() Constructor.

Method Summary

Modifier and Type	Method and Description
@Nullable String	getKeyTab() Gets the key tab full file name (e.g.
@Nullable String	getKeyTabPrincipal() Gets the key tab principal short name (e.g.
long	getReloginInterval() The interval used to re-login from the key tab, in milliseconds.
void	readExternal(ObjectInput in)
void	setKeyTab(@Nullable String keyTab) Sets the key tab file name.
void	setKeyTabPrincipal(@Nullable String keyTabPrincipal) Set the key tab principal name.
void	setReloginInterval(long reloginInterval) Sets the relogin interval in milliseconds.
void	writeExternal(ObjectOutput out)

Methods inherited from class org.apache.ignite.hadoop.fs.BasicHadoopFileSystemFactory

get, getConfigPaths, getUri, getUserNameMapper, setConfigPaths, setUri, setUserNameMapper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DFLT_RELOGIN_INTERVAL

public static final long DFLT_RELOGIN_INTERVAL

The default interval used to re-login from the key tab, in milliseconds.

See Also:

Constant Field Values

Constructor Detail

KerberosHadoopFileSystemFactory

public KerberosHadoopFileSystemFactory()

Constructor.

Method Detail

getKeyTabPrincipal

@Nullable
public @Nullable String getKeyTabPrincipal()

Gets the key tab principal short name (e.g. "hdfs").

Returns:

The key tab principal.

setKeyTabPrincipal

public void setKeyTabPrincipal(@Nullable
                               @Nullable String keyTabPrincipal)

Set the key tab principal name. See getKeyTabPrincipal() for more information.

Parameters:

keyTabPrincipal - The key tab principal name.

getKeyTab

@Nullable
public @Nullable String getKeyTab()

Gets the key tab full file name (e.g. "/etc/security/keytabs/hdfs.headless.keytab" or "/etc/krb5.keytab").

Returns:

The key tab file name.

setKeyTab

public void setKeyTab(@Nullable
                      @Nullable String keyTab)

Sets the key tab file name. See getKeyTab() for more information.

Parameters:

keyTab - The key tab file name.

getReloginInterval

public long getReloginInterval()

The interval used to re-login from the key tab, in milliseconds. Important that the value should not be larger than the Kerberos ticket life time multiplied by 0.2. This is because the ticket renew window starts from 0.8 * ticket life time. Default ticket life time is 1 day (24 hours), so the default re-login interval (10 min) is obeys this rule well.

Zero value means that re-login should be attempted on each file system operation. Negative values are not allowed.

Note, however, that it does not make sense to make this value small, because Hadoop does not allow to login if less than org.apache.hadoop.security.UserGroupInformation.MIN_TIME_BEFORE_RELOGIN milliseconds have passed since the time of the previous login.

Returns:

The re-login interval, in milliseconds.

setReloginInterval

public void setReloginInterval(long reloginInterval)

Sets the relogin interval in milliseconds. See getReloginInterval() for more information.

Parameters:

reloginInterval - The re-login interval, in milliseconds.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class BasicHadoopFileSystemFactory

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class BasicHadoopFileSystemFactory

Throws:

IOException

ClassNotFoundException