org.apache.storm.security

Interface INimbusCredentialPlugin

All Superinterfaces:

Shutdownable

All Known Implementing Classes:

AbstractAutoCreds, AutoHBase, AutoHDFS, AutoHive

public interface INimbusCredentialPlugin
extends Shutdownable

Nimbus auto credential plugin that will be called on nimbus host during submit topology option. User can specify a list of implementation using config key nimbus.autocredential.plugins.classes.

Method Summary

Modifier and Type	Method and Description
void	populateCredentials(Map<String,String> credentials, Map topoConf) Deprecated.
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	prepare(Map conf) This method will be called when nimbus initializes.

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

shutdown

Method Detail

prepare

void prepare(Map conf)

This method will be called when nimbus initializes.

Parameters:

conf - the cluster config

populateCredentials

@Deprecated
void populateCredentials(Map<String,String> credentials,
                                     Map topoConf)

Deprecated.

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

populateCredentials

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

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.

Parameters:

credentials - credentials map where more credentials will be added.

topoConf - topology configuration

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