org.apache.storm.common

Class AbstractAutoCreds

java.lang.Object

org.apache.storm.common.AbstractAutoCreds

All Implemented Interfaces:

Shutdownable, IAutoCredentials, ICredentialsRenewer, INimbusCredentialPlugin

Direct Known Subclasses:

AutoHBase, AutoHDFS, AutoHive

public abstract class AbstractAutoCreds
extends Object
implements IAutoCredentials, ICredentialsRenewer, INimbusCredentialPlugin

The base class that for auto credential plugins that abstracts out some of the common functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_KEY_RESOURCES

Constructor Summary

Constructors

Constructor and Description
AbstractAutoCreds()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doPrepare(Map conf) Prepare the plugin
protected abstract void	doRenew(Map<String,String> credentials, Map<String,Object> topologyConf, String ownerPrincipal)
protected void	fillHadoopConfiguration(Map topoConf, String configKey, org.apache.hadoop.conf.Configuration configuration)
protected abstract String	getConfigKeyString() The lookup key for the config key string
protected abstract String	getCredentialKey(String configKey) The key with which the credentials are stored in the credentials map
protected Set<org.apache.commons.math3.util.Pair<String,org.apache.hadoop.security.Credentials>>	getCredentials(Map<String,String> credentials)
protected abstract byte[]	getHadoopCredentials(Map<String,Object> conf, String topologyOwnerPrincipal)
protected abstract byte[]	getHadoopCredentials(Map<String,Object> conf, String configKey, String topologyOwnerPrincipal)
void	populateCredentials(Map<String,String> credentials)
void	populateCredentials(Map<String,String> credentials, Map<String,Object> topoConf, String topologyOwnerPrincipal)
void	populateSubject(Subject subject, Map<String,String> credentials)
void	prepare(Map conf)
void	renew(Map<String,String> credentials, Map<String,Object> topologyConf, String ownerPrincipal)
void	updateSubject(Subject subject, Map<String,String> credentials)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.storm.security.auth.ICredentialsRenewer

renew

Methods inherited from interface org.apache.storm.security.INimbusCredentialPlugin

populateCredentials

Methods inherited from interface org.apache.storm.daemon.Shutdownable

shutdown

Field Detail

CONFIG_KEY_RESOURCES

public static final String CONFIG_KEY_RESOURCES

See Also:

Constant Field Values

Constructor Detail

AbstractAutoCreds

public AbstractAutoCreds()

Method Detail

prepare

public void prepare(Map conf)

Specified by:

prepare in interface IAutoCredentials

Specified by:

prepare in interface ICredentialsRenewer

Specified by:

prepare in interface INimbusCredentialPlugin

populateCredentials

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

Specified by:

populateCredentials in interface INimbusCredentialPlugin

renew

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

Specified by:

renew in interface ICredentialsRenewer

populateCredentials

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

Specified by:

populateCredentials in interface IAutoCredentials

populateSubject

public void populateSubject(Subject subject,
                            Map<String,String> credentials)

Specified by:

populateSubject in interface IAutoCredentials

updateSubject

public void updateSubject(Subject subject,
                          Map<String,String> credentials)

Specified by:

updateSubject in interface IAutoCredentials

getCredentials

protected Set<org.apache.commons.math3.util.Pair<String,org.apache.hadoop.security.Credentials>> getCredentials(Map<String,String> credentials)

fillHadoopConfiguration

protected void fillHadoopConfiguration(Map topoConf,
                                       String configKey,
                                       org.apache.hadoop.conf.Configuration configuration)

doPrepare

protected abstract void doPrepare(Map conf)

Prepare the plugin

Parameters:

conf - the storm cluster conf set via storm.yaml

getConfigKeyString

protected abstract String getConfigKeyString()

The lookup key for the config key string

Returns:

the config key string

getCredentialKey

protected abstract String getCredentialKey(String configKey)

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

getHadoopCredentials

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

getHadoopCredentials

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

doRenew

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