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) Called to populate the credentials on the client side.
void	populateCredentials(Map<String,String> credentials, Map<String,Object> topoConf, String topologyOwnerPrincipal) Method that will be called on nimbus as part of submit topology.
void	populateSubject(Subject subject, Map<String,String> credentials) Called to initially populate the subject on the worker side with credentials passed in.
void	prepare(Map conf) Called when initializing the service.
void	renew(Map<String,String> credentials, Map<String,Object> topologyConf, String ownerPrincipal) Renew any credentials that need to be renewed.
void	updateSubject(Subject subject, Map<String,String> credentials) Called to update the subject on the worker side when new credentials are recieved.

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)

Description copied from interface: ICredentialsRenewer

Called when initializing the service.

Specified by:

prepare in interface IAutoCredentials

Specified by:

prepare in interface ICredentialsRenewer

Specified by:

prepare in interface INimbusCredentialPlugin

Parameters:

conf - the storm cluster configuration.

populateCredentials

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

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.

Specified by:

populateCredentials in interface INimbusCredentialPlugin

Parameters:

credentials - credentials map where more credentials will be added.

topoConf - topology configuration

topologyOwnerPrincipal - the full principal name of the owner of the topology

renew

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

Description copied from interface: ICredentialsRenewer

Renew any credentials that need to be renewed. (Update the credentials if needed)

Specified by:

renew in interface ICredentialsRenewer

Parameters:

credentials - the credentials that may have something to renew.

topologyConf - topology configuration.

ownerPrincipal - the full principal name of the owner of the topology

populateCredentials

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

Description copied from interface: IAutoCredentials

Called to populate the credentials on the client side.

Specified by:

populateCredentials in interface IAutoCredentials

Parameters:

credentials - the credentials to be populated.

populateSubject

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

Called to initially populate the subject on the worker side with credentials passed in.

Specified by:

populateSubject in interface IAutoCredentials

Parameters:

subject - the subject to optionally put credentials in.

credentials - the credentials to be used.

updateSubject

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

Called to update the subject on the worker side when new credentials are recieved. This means that populateSubject has already been called on this subject.

Specified by:

updateSubject in interface IAutoCredentials

Parameters:

subject - the subject to optionally put credentials in.

credentials - the credentials to be used.

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)