org.apache.storm.utils

Class ConfigUtils

java.lang.Object

org.apache.storm.utils.ConfigUtils

public class ConfigUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_SEPARATOR
static String	NIMBUS_DO_NOT_REASSIGN
static String	RESOURCES_SUBDIR

Constructor Summary

Constructors

Constructor and Description
ConfigUtils()

Method Summary

Modifier and Type	Method and Description
static String	absoluteHealthCheckDir(Map conf)
static String	absoluteStormBlobStoreDir(Map<String,Object> conf)
static String	absoluteStormLocalDir(Map conf)
static List<Object>	All_CONFIGS()
static String	clojureConfigName(String name)
static String	clusterMode(Map conf)
static String	concatIfNotNull(String dir)
static Callable<Boolean>	evenSampler(int samplingFreq)
static String	getIdFromBlobKey(String key)
static String	getLogDir()
static File	getLogMetaDataFile(Map conf, String id, Integer port)
static File	getLogMetaDataFile(String fname)
static List<String>	getTopoLogsGroups(Map topologyConf)
static List<String>	getTopoLogsUsers(Map topologyConf)
static List<String>	getValueAsList(String name, Map<String,Object> conf) Get the given config value as a List <String>, if possible.
static File	getWorkerDirFromRoot(String logRoot, String id, Integer port)
static boolean	isLocalMode(Map<String,Object> conf)
static Map<String,Object>	maskPasswords(Map<String,Object> conf)
static String	masterInbox(Map conf)
static String	masterInimbusDir(Map conf)
static String	masterLocalDir(Map conf)
static String	masterStormCodeKey(String topologyId)
static String	masterStormConfKey(String topologyId)
static String	masterStormDistRoot(Map conf)
static String	masterStormDistRoot(Map conf, String stormId)
static String	masterStormJarKey(String topologyId)
static String	masterStormJarPath(String stormRoot)
static Callable<Boolean>	mkStatsSampler(Map conf)
static LocalState	nimbusTopoHistoryState(Map conf)
LocalState	nimbusTopoHistoryStateImpl(Map conf)
static Map	overrideLoginConfigWithSystemProperty(Map conf)
static Map<String,Object>	readStormConfig()
Map<String,Object>	readStormConfigImpl()
static StormTopology	readSupervisorStormCodeGivenPath(String stormCodePath, AdvancedFSOps ops)
static Map<String,Object>	readSupervisorStormConf(Map<String,Object> conf, String stormId)
static Map<String,Object>	readSupervisorStormConfGivenPath(Map<String,Object> conf, String stormConfPath)
Map<String,Object>	readSupervisorStormConfImpl(Map<String,Object> conf, String stormId)
static StormTopology	readSupervisorTopology(Map conf, String stormId, AdvancedFSOps ops)
StormTopology	readSupervisorTopologyImpl(Map conf, String stormId, AdvancedFSOps ops)
static Map	readYamlConfig(String name)
static Map	readYamlConfig(String name, boolean mustExist)
static int	samplingRate(Map conf)
static ConfigUtils	setInstance(ConfigUtils u) Provide an instance of this class for delegates to use.
static String	stormDistPath(String stormRoot)
static String	supervisorIsupervisorDir(Map conf)
static String	supervisorLocalDir(Map conf)
String	supervisorLocalDirImpl(Map conf)
static LocalState	supervisorState(Map conf)
LocalState	supervisorStateImpl(Map conf)
static String	supervisorStormCodePath(String stormRoot)
static String	supervisorStormConfPath(String stormRoot)
static String	supervisorStormDistRoot(Map conf)
static String	supervisorStormDistRoot(Map conf, String stormId)
String	supervisorStormDistRootImpl(Map conf)
String	supervisorStormDistRootImpl(Map conf, String stormId)
static String	supervisorStormJarPath(String stormRoot)
static String	supervisorStormResourcesPath(String stormRoot)
static String	supervisorTmpDir(Map conf)
static String	workerArtifactsPidPath(Map conf, String id, Integer port)
static String	workerArtifactsRoot(Map conf)
static String	workerArtifactsRoot(Map conf, String id)
static String	workerArtifactsRoot(Map conf, String id, Integer port)
String	workerArtifactsRootImpl(Map conf)
static String	workerHeartbeatsRoot(Map conf, String id)
static String	workerPidPath(Map<String,Object> conf, String id, long pid)
static String	workerPidPath(Map conf, String id, String pid)
static String	workerPidsRoot(Map conf, String id)
static String	workerRoot(Map conf)
static String	workerRoot(Map conf, String id)
String	workerRootImpl(Map conf)
static LocalState	workerState(Map conf, String id)
static String	workerTmpRoot(Map conf, String id)
static String	workerUserFile(Map conf, String workerId)
static String	workerUserRoot(Map conf)

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCES_SUBDIR

public static final String RESOURCES_SUBDIR

See Also:

Constant Field Values

NIMBUS_DO_NOT_REASSIGN

public static final String NIMBUS_DO_NOT_REASSIGN

See Also:

Constant Field Values

FILE_SEPARATOR

public static final String FILE_SEPARATOR

Constructor Detail

ConfigUtils

public ConfigUtils()

Method Detail

maskPasswords

public static Map<String,Object> maskPasswords(Map<String,Object> conf)

setInstance

public static ConfigUtils setInstance(ConfigUtils u)

Provide an instance of this class for delegates to use. To mock out delegated methods, provide an instance of a subclass that overrides the implementation of the delegated method.

Parameters:

u - a Utils instance

Returns:

the previously set instance

getLogDir

public static String getLogDir()

clojureConfigName

public static String clojureConfigName(String name)

All_CONFIGS

public static List<Object> All_CONFIGS()

clusterMode

public static String clusterMode(Map conf)

isLocalMode

public static boolean isLocalMode(Map<String,Object> conf)

samplingRate

public static int samplingRate(Map conf)

evenSampler

public static Callable<Boolean> evenSampler(int samplingFreq)

mkStatsSampler

public static Callable<Boolean> mkStatsSampler(Map conf)

readStormConfig

public static Map<String,Object> readStormConfig()

readStormConfigImpl

public Map<String,Object> readStormConfigImpl()

readYamlConfig

public static Map readYamlConfig(String name,
                                 boolean mustExist)

readYamlConfig

public static Map readYamlConfig(String name)

absoluteStormLocalDir

public static String absoluteStormLocalDir(Map conf)

absoluteStormBlobStoreDir

public static String absoluteStormBlobStoreDir(Map<String,Object> conf)

absoluteHealthCheckDir

public static String absoluteHealthCheckDir(Map conf)

masterLocalDir

public static String masterLocalDir(Map conf)
                             throws IOException

Throws:

IOException

masterStormJarKey

public static String masterStormJarKey(String topologyId)

masterStormCodeKey

public static String masterStormCodeKey(String topologyId)

masterStormConfKey

public static String masterStormConfKey(String topologyId)

masterStormDistRoot

public static String masterStormDistRoot(Map conf)
                                  throws IOException

Throws:

IOException

masterStormDistRoot

public static String masterStormDistRoot(Map conf,
                                         String stormId)
                                  throws IOException

Throws:

IOException

stormDistPath

public static String stormDistPath(String stormRoot)

readSupervisorStormConfGivenPath

public static Map<String,Object> readSupervisorStormConfGivenPath(Map<String,Object> conf,
                                                                  String stormConfPath)
                                                           throws IOException

Throws:

IOException

readSupervisorStormCodeGivenPath

public static StormTopology readSupervisorStormCodeGivenPath(String stormCodePath,
                                                             AdvancedFSOps ops)
                                                      throws IOException

Throws:

IOException

masterStormJarPath

public static String masterStormJarPath(String stormRoot)

masterInbox

public static String masterInbox(Map conf)
                          throws IOException

Throws:

IOException

masterInimbusDir

public static String masterInimbusDir(Map conf)
                               throws IOException

Throws:

IOException

supervisorLocalDir

public static String supervisorLocalDir(Map conf)
                                 throws IOException

Throws:

IOException

supervisorLocalDirImpl

public String supervisorLocalDirImpl(Map conf)
                              throws IOException

Throws:

IOException

supervisorIsupervisorDir

public static String supervisorIsupervisorDir(Map conf)
                                       throws IOException

Throws:

IOException

supervisorStormDistRoot

public static String supervisorStormDistRoot(Map conf)
                                      throws IOException

Throws:

IOException

supervisorStormDistRootImpl

public String supervisorStormDistRootImpl(Map conf)
                                   throws IOException

Throws:

IOException

supervisorStormDistRoot

public static String supervisorStormDistRoot(Map conf,
                                             String stormId)
                                      throws IOException

Throws:

IOException

supervisorStormDistRootImpl

public String supervisorStormDistRootImpl(Map conf,
                                          String stormId)
                                   throws IOException

Throws:

IOException

concatIfNotNull

public static String concatIfNotNull(String dir)

supervisorStormJarPath

public static String supervisorStormJarPath(String stormRoot)

supervisorStormCodePath

public static String supervisorStormCodePath(String stormRoot)

supervisorStormConfPath

public static String supervisorStormConfPath(String stormRoot)

supervisorTmpDir

public static String supervisorTmpDir(Map conf)
                               throws IOException

Throws:

IOException

supervisorStormResourcesPath

public static String supervisorStormResourcesPath(String stormRoot)

supervisorState

public static LocalState supervisorState(Map conf)
                                  throws IOException

Throws:

IOException

supervisorStateImpl

public LocalState supervisorStateImpl(Map conf)
                               throws IOException

Throws:

IOException

nimbusTopoHistoryState

public static LocalState nimbusTopoHistoryState(Map conf)
                                         throws IOException

Throws:

IOException

nimbusTopoHistoryStateImpl

public LocalState nimbusTopoHistoryStateImpl(Map conf)
                                      throws IOException

Throws:

IOException

readSupervisorStormConf

public static Map<String,Object> readSupervisorStormConf(Map<String,Object> conf,
                                                         String stormId)
                                                  throws IOException

Throws:

IOException

readSupervisorStormConfImpl

public Map<String,Object> readSupervisorStormConfImpl(Map<String,Object> conf,
                                                      String stormId)
                                               throws IOException

Throws:

IOException

readSupervisorTopology

public static StormTopology readSupervisorTopology(Map conf,
                                                   String stormId,
                                                   AdvancedFSOps ops)
                                            throws IOException

Throws:

IOException

readSupervisorTopologyImpl

public StormTopology readSupervisorTopologyImpl(Map conf,
                                                String stormId,
                                                AdvancedFSOps ops)
                                         throws IOException

Throws:

IOException

workerUserRoot

public static String workerUserRoot(Map conf)

workerUserFile

public static String workerUserFile(Map conf,
                                    String workerId)

getIdFromBlobKey

public static String getIdFromBlobKey(String key)

workerArtifactsRoot

public static String workerArtifactsRoot(Map conf)

workerArtifactsRootImpl

public String workerArtifactsRootImpl(Map conf)

workerArtifactsRoot

public static String workerArtifactsRoot(Map conf,
                                         String id)

workerArtifactsRoot

public static String workerArtifactsRoot(Map conf,
                                         String id,
                                         Integer port)

workerArtifactsPidPath

public static String workerArtifactsPidPath(Map conf,
                                            String id,
                                            Integer port)

getLogMetaDataFile

public static File getLogMetaDataFile(String fname)

getLogMetaDataFile

public static File getLogMetaDataFile(Map conf,
                                      String id,
                                      Integer port)

getWorkerDirFromRoot

public static File getWorkerDirFromRoot(String logRoot,
                                        String id,
                                        Integer port)

workerRoot

public static String workerRoot(Map conf)

workerRootImpl

public String workerRootImpl(Map conf)

workerRoot

public static String workerRoot(Map conf,
                                String id)

workerPidsRoot

public static String workerPidsRoot(Map conf,
                                    String id)

workerTmpRoot

public static String workerTmpRoot(Map conf,
                                   String id)

workerPidPath

public static String workerPidPath(Map conf,
                                   String id,
                                   String pid)

workerPidPath

public static String workerPidPath(Map<String,Object> conf,
                                   String id,
                                   long pid)

workerHeartbeatsRoot

public static String workerHeartbeatsRoot(Map conf,
                                          String id)

workerState

public static LocalState workerState(Map conf,
                                     String id)
                              throws IOException

Throws:

IOException

overrideLoginConfigWithSystemProperty

public static Map overrideLoginConfigWithSystemProperty(Map conf)

getTopoLogsUsers

public static List<String> getTopoLogsUsers(Map topologyConf)

getTopoLogsGroups

public static List<String> getTopoLogsGroups(Map topologyConf)

getValueAsList

public static List<String> getValueAsList(String name,
                                          Map<String,Object> conf)

Get the given config value as a List <String>, if possible.

Parameters:

name -

• the config key

conf -

• the config map

Returns:

• the config value converted to a List <String> if found, otherwise null.

Throws:

IllegalArgumentException - if conf is null

NullPointerException - if name is null and the conf map doesn’t support null keys