org.apache.storm.hdfs.security

Class AutoHDFS

java.lang.Object

org.apache.storm.common.AbstractAutoCreds

org.apache.storm.hdfs.security.AutoHDFS

All Implemented Interfaces:

Shutdownable, IAutoCredentials, ICredentialsRenewer, INimbusCredentialPlugin

public class AutoHDFS
extends AbstractAutoCreds

Automatically get HDFS delegation tokens and push it to user’s topology. The class assumes that HDFS configuration files are in your class path.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HDFS_CREDENTIALS
static String	TOPOLOGY_HDFS_URI

Fields inherited from class org.apache.storm.common.AbstractAutoCreds

CONFIG_KEY_RESOURCES

Constructor Summary

Constructors

Constructor and Description
AutoHDFS()

Method Summary

Modifier and Type	Method and Description
void	doPrepare(Map conf) Prepare the plugin
void	doRenew(Map<String,String> credentials, Map<String,Object> topologyConf, String ownerPrincipal)
protected String	getConfigKeyString() The lookup key for the config key string
protected String	getCredentialKey(String configKey) The key with which the credentials are stored in the credentials map
protected byte[]	getHadoopCredentials(Map<String,Object> conf, String topologyOwnerPrincipal)
protected byte[]	getHadoopCredentials(Map<String,Object> conf, String configKey, String topologyOwnerPrincipal)
static void	main(String[] args)
void	populateCredentials(Map<String,String> credentials, Map topoConf) Method that will be called on nimbus as part of submit topology.
void	renew(Map<String,String> credentials, Map topologyConf) Renew any credentials that need to be renewed.
void	shutdown()

Methods inherited from class org.apache.storm.common.AbstractAutoCreds

fillHadoopConfiguration, getCredentials, populateCredentials, populateCredentials, populateSubject, prepare, renew, updateSubject

Methods inherited from class java.lang.Object

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

Field Detail

HDFS_CREDENTIALS

public static final String HDFS_CREDENTIALS

See Also:

Constant Field Values

TOPOLOGY_HDFS_URI

public static final String TOPOLOGY_HDFS_URI

See Also:

Constant Field Values

Constructor Detail

AutoHDFS

public AutoHDFS()

Method Detail

doPrepare

public void doPrepare(Map conf)

Description copied from class: AbstractAutoCreds

Prepare the plugin

Specified by:

doPrepare in class AbstractAutoCreds

Parameters:

conf - the storm cluster conf set via storm.yaml

getConfigKeyString

protected String getConfigKeyString()

Description copied from class: AbstractAutoCreds

The lookup key for the config key string

Specified by:

getConfigKeyString in class AbstractAutoCreds

Returns:

the config key string

shutdown

public void shutdown()

getHadoopCredentials

protected byte[] getHadoopCredentials(Map<String,Object> conf,
                                      String configKey,
                                      String topologyOwnerPrincipal)

Specified by:

getHadoopCredentials in class AbstractAutoCreds

getHadoopCredentials

protected byte[] getHadoopCredentials(Map<String,Object> conf,
                                      String topologyOwnerPrincipal)

Specified by:

getHadoopCredentials in class AbstractAutoCreds

doRenew

public void doRenew(Map<String,String> credentials,
                    Map<String,Object> topologyConf,
                    String ownerPrincipal)

Specified by:

doRenew in class AbstractAutoCreds

getCredentialKey

protected String getCredentialKey(String configKey)

Description copied from class: AbstractAutoCreds

The key with which the credentials are stored in the credentials map

Specified by:

getCredentialKey in class AbstractAutoCreds

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

populateCredentials

public void populateCredentials(Map<String,String> credentials,
                                Map topoConf)

Description copied from interface: INimbusCredentialPlugin

Method that will be called on nimbus as part of submit topology. This plugin will be called at least once during the submit Topology action. It will be not be called during activate instead the credentials return by this method will be merged with the other credentials in the topology and stored in zookeeper. NOTE: THIS METHOD WILL BE CALLED THROUGH REFLECTION. Existing compiled implementations will still work but new implementations will not compile. A NOOP implementation can be added to make it compile.

Parameters:

credentials - credentials map where more credentials will be added.

topoConf - topology configuration

renew

public void renew(Map<String,String> credentials,
                  Map topologyConf)

Description copied from interface: ICredentialsRenewer

Renew any credentials that need to be renewed. (Update the credentials if needed) NOTE: THIS WILL BE CALLED THROUGH REFLECTION. So if the newer renew exists it will be called instead, but if it does not exist this will be called. That means that this is binary compatible but not source compatible with older version. To make the compilation work this can become a noop when the new API is implemented.

Parameters:

credentials - the credentials that may have something to renew.

topologyConf - topology configuration.