Utils (Storm 1.2.3 API)

java.lang.Object
- org.apache.storm.utils.Utils

Direct Known Subclasses:

TestUtils
```
public class Utils
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Utils.SmartThread` A thread that can answer if it is sleeping in the case of simulated time.
`static class`	`Utils.UptimeComputer`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLASS_PATH_SEPARATOR`
`static String`	`CURRENT_BLOB_SUFFIX_ID`
`static String`	`DEFAULT_BLOB_VERSION_SUFFIX`
`static String`	`DEFAULT_CURRENT_BLOB_SUFFIX`
`static String`	`DEFAULT_STREAM_ID`
`static String`	`FILE_PATH_SEPARATOR`
`static boolean`	`IS_ON_WINDOWS`
`static org.slf4j.Logger`	`LOG`
`static int`	`SIGKILL`
`static int`	`SIGTERM`

Constructor Summary

Constructors
Constructor and Description

Utils()

Constructors
Constructor and Description
`Utils()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addShutdownHookWithForceKillIn1Sec(Runnable func)` Adds the user supplied function as a shutdown hook for cleanup.
`static String`	`addToClasspath(Collection<String> classpaths, Collection<String> paths)`
`static String`	`addToClasspath(String classpath, Collection<String> paths)`
`String`	`addToClasspathImpl(Collection<String> classpaths, Collection<String> paths)`
`String`	`addToClasspathImpl(String classpath, Collection<String> paths)`
`static StormTopology`	`addVersions(StormTopology topology)` Add version information to the given topology
`static Utils.SmartThread`	`asyncLoop(Callable afn)` Convenience method used when only the function is given.
`static Utils.SmartThread`	`asyncLoop(Callable afn, boolean isDaemon, Thread.UncaughtExceptionHandler eh, int priority, boolean isFactory, boolean startImmediately, String threadName)` Creates a thread that calls the given code repeatedly, sleeping for an interval of seconds equal to the return value of the previous call.
`static Utils.SmartThread`	`asyncLoop(Callable afn, String threadName, Thread.UncaughtExceptionHandler eh)` Convenience method used when only the function and name suffix are given.
`static long`	`bitXor(Long a, Long b)`
`static long`	`bitXorVals(List<Long> coll)`
`static boolean`	`canUserReadBlob(ReadableBlobMeta meta, String user)`
`static boolean`	`CheckDirExists(String dir)`
`static boolean`	`checkFileExists(File path)`
`static boolean`	`checkFileExists(String path)`
`static boolean`	`checkFileExists(String dir, String file)`
`static String`	`constructBlobCurrentSymlinkName(String fileName)`
`static String`	`constructBlobWithVersionFileName(String fileName, long version)`
`static String`	`constructVersionFileName(String fileName)`
`static String`	`containerFilePath(String dir)`
`static Map<String,Object>`	`convertClojureMapToJavaMap(Map map)` converts a clojure PersistentMap to java HashMap
`static Localizer`	`createLocalizer(Map conf, String baseDir)`
`static String`	`currentClasspath()` Returns the value of java.class.path System property.
`String`	`currentClasspathImpl()`
`static <T> T`	`deserialize(byte[] serialized, Class<T> clazz)`
`static void`	`downloadResourcesAsSupervisor(String key, String localFile, ClientBlobStore cb)` Meant to be called only by the supervisor for stormjar/stormconf/stormcode files.
`void`	`downloadResourcesAsSupervisorImpl(String key, String localFile, ClientBlobStore cb)`
`static String`	`eventLogsFilename(String stormId, String port)`
`static boolean`	`exceptionCauseIsInstanceOf(Class klass, Throwable throwable)` Checks if a throwable is an instance of a particular class
`static int`	`execCommand(String... command)`
`static void`	`exitProcess(int val, String msg)`
`static void`	`extractDirFromJar(String jarpath, String dir, File destdir)` Extract dir from the jar to destdir
`void`	`extractDirFromJarImpl(String jarpath, String dir, File destdir)`
`static Map<String,Object>`	`findAndReadConfigFile(String name)`
`static Map<String,Object>`	`findAndReadConfigFile(String name, boolean mustExist)`
`static List<URL>`	`findResources(String name)`
`static void`	`forceDelete(String path)` Deletes a file or directory and its contents if it exists.
`protected void`	`forceDeleteImpl(String path)`
`static void`	`forceKillProcess(String pid)`
`static Map<String,Object>`	`fromCompressedJsonConf(byte[] serialized)`
`static <S,T> T`	`get(Map<S,T> m, S key, T def)`
`static int`	`getAvailablePort()`
`static int`	`getAvailablePort(int prefferedPort)`
`static boolean`	`getBoolean(Object o, boolean defaultValue)`
`static ClientBlobStore`	`getClientBlobStore(Map conf)`
`static ClientBlobStore`	`getClientBlobStoreForSupervisor(Map conf)`
`static ComponentCommon`	`getComponentCommon(StormTopology topology, String id)`
`static Object`	`getConfiguredClass(Map conf, Object configKey)` Return a new instance of a pluggable specified in the conf.
`static Double`	`getDouble(Object o)`
`static Double`	`getDouble(Object o, Double defaultValue)`
`static long`	`getDU(File dir)` Takes an input dir or file and returns the disk usage on that local directory.
`static String`	`getFileOwner(String path)`
`static GlobalStreamId`	`getGlobalStreamId(String streamId, String componentId)`
`static Integer`	`getInt(Object o)`
`static Integer`	`getInt(Object o, Integer defaultValue)`
`static BlobStore`	`getNimbusBlobStore(Map conf, NimbusInfo nimbusInfo)`
`static BlobStore`	`getNimbusBlobStore(Map conf, String baseDir, NimbusInfo nimbusInfo)`
`static List<String>`	`getRepeat(List<String> list)`
`static Object`	`getSetComponentObject(ComponentObject obj)`
`static String`	`getString(Object o)`
`static String`	`getString(Object o, String defaultValue)`
`static List<String>`	`getStrings(Object o)`
`static org.apache.zookeeper.data.ACL`	`getSuperUserAcl(Map<String,Object> conf)` Get the ACL for nimbus/supervisor.
`static String`	`getTopologyId(String name, Nimbus.Client client)`
`static TopologyInfo`	`getTopologyInfo(String name, String asUser, Map stormConf)`
`static List<org.apache.zookeeper.data.ACL>`	`getWorkerACL(Map<String,Object> conf)` Get the ZK ACLs that a worker should use when writing to ZK.
`static byte[]`	`gunzip(byte[] data)`
`static byte[]`	`gzip(byte[] data)`
`static void`	`handleUncaughtException(Throwable t)`
`static String`	`hostname()` Gets the storm.local.hostname value, or tries to figure out the local hostname if it is not set in the config.
`protected String`	`hostnameImpl()`
`static TreeMap<Integer,Integer>`	`integerDivided(int sum, int numPieces)`
`static <T> List<T>`	`interleaveAll(List<List<T>> nodeList)`
`static boolean`	`isAbsolutePath(String path)`
`static boolean`	`isOnWindows()`
`static boolean`	`isSystemId(String id)`
`static boolean`	`isValidConf(Map<String,Object> stormConf)`
`static boolean`	`isValidKey(String key)` Validates topology name / blob key.
`static boolean`	`isZkAuthenticationConfiguredStormServer(Map conf)` Is the cluster configured to interact with ZooKeeper in a secure way? This only works when called from within Nimbus or a Supervisor process.
`static boolean`	`isZkAuthenticationConfiguredTopology(Map conf)` Is the topology configured to have ZooKeeper authentication.
`static JarTransformer`	`jarTransformer(String klass)`
`static <T> T`	`javaDeserialize(byte[] serialized, Class<T> clazz)`
`static byte[]`	`javaSerialize(Object obj)`
`static <T> String`	`join(Iterable<T> coll, String sep)`
`static <K,V> Map<K,List<V>>`	`joinMaps(Map<K,V>... maps)` Joins any number of maps together into a single map, combining their values into a list, maintaining values in the order the maps were passed in.
`static void`	`killProcessWithSigTerm(String pid)`
`static clojure.lang.IFn`	`loadClojureFn(String namespace, String name)`
`static String`	`localHostname()`
`protected String`	`localHostnameImpl()`
`static long`	`localVersionOfBlob(String localFile)`
`static String`	`logsFilename(String stormId, String port)`
`static Utils.UptimeComputer`	`makeUptimeComputer()`
`Utils.UptimeComputer`	`makeUptimeComputerImpl()`
`static String`	`memoizedLocalHostname()`
`static Runnable`	`mkSuicideFn()`
`static org.apache.curator.framework.CuratorFramework`	`newCurator(Map conf, List<String> servers, Object port, String root, List<org.apache.zookeeper.data.ACL> defaultAcl)`
`static org.apache.curator.framework.CuratorFramework`	`newCurator(Map conf, List<String> servers, Object port, String root, ZookeeperAuthInfo auth, List<org.apache.zookeeper.data.ACL> defaultAcl)`
`static org.apache.curator.framework.CuratorFramework`	`newCurator(Map conf, List<String> servers, Object port, ZookeeperAuthInfo auth, List<org.apache.zookeeper.data.ACL> defaultAcl)`
`static org.apache.curator.framework.CuratorFramework`	`newCuratorStarted(Map conf, List<String> servers, Object port, String root, ZookeeperAuthInfo auth, List<org.apache.zookeeper.data.ACL> defaultAcl)`
`static org.apache.curator.framework.CuratorFramework`	`newCuratorStarted(Map conf, List<String> servers, Object port, ZookeeperAuthInfo auth, List<org.apache.zookeeper.data.ACL> defaultAcl)`
`static <T> T`	`newInstance(Class<T> klass)`
`static <T> T`	`newInstance(String klass)`
`<T> T`	`newInstanceImpl(Class<T> klass)`
`static long`	`nimbusVersionOfBlob(String key, ClientBlobStore cb)`
`static Object`	`nullToZero(Object v)`
`static <V> V`	`OR(V a, V b)` a or b the first one that is not null
`static Double`	`parseJvmHeapMemByChildOpts(List<String> options, Double defaultValue)` parses the arguments to extract jvm heap memory size in MB.
`static org.apache.zookeeper.data.Id`	`parseZkId(String id, String configName)`
`static <T> List<List<T>>`	`partitionFixed(int maxNumChunks, Collection<T> coll)` Fills up chunks out of a collection (given a maximum amount of chunks)
`static String`	`processPid()`
`static void`	`readAndLogStream(String prefix, InputStream in)`
`static Map<String,Object>`	`readCommandLineOpts()`
`static Map<String,Object>`	`readDefaultConfig()`
`static Collection<String>`	`readDirContents(String dir)` Returns a Collection of file names found under the given directory.
`static Map<String,Object>`	`readStormConfig()`
`static Object`	`readYamlFile(String yamlFile)`
`static Map<Object,String>`	`redactValue(Map<Object,String> m, Object key)` Creates a new map with a string value in the map replaced with an equivalently-lengthed string of ‘#’.
`static void`	`resetClassLoaderForJavaDeSerialize()`
`static void`	`restrictPermissions(String baseDir)`
`static HashMap`	`reverseMap(List listSeq)` “[[:a 1] [:b 1] [:c 2]} -> {1 [:a :b] 2 :c}” Reverses an assoc-list style Map like reverseMap(Map…)
`static <K,V> HashMap<V,List<K>>`	`reverseMap(Map<K,V> map)` “{:a 1 :b 1 :c 2} -> {1 [:a :b] 2 :c}”
`static String`	`scriptFilePath(String dir)`
`static long`	`secureRandomLong()`
`static void`	`sendSignalToProcess(long lpid, int signum)`
`static byte[]`	`serialize(Object obj)`
`static void`	`setClassLoaderForJavaDeSerialize(ClassLoader cl)`
`static Utils`	`setInstance(Utils u)` Provide an instance of this class for delegates to use.
`protected static void`	`setupBuilder(org.apache.curator.framework.CuratorFrameworkFactory.Builder builder, String zkStr, Map conf, ZookeeperAuthInfo auth)`
`static void`	`setupDefaultUncaughtExceptionHandler()`
`static String`	`shellCmd(List<String> command)` Returns the combined string, escaped for posix shell.
`static void`	`sleep(long millis)`
`static void`	`testSetupBuilder(org.apache.curator.framework.CuratorFrameworkFactory.Builder builder, String zkStr, Map conf, ZookeeperAuthInfo auth)`
`static String`	`threadDump()` Gets some information, including stack trace, for a running thread.
`static <T> T`	`thriftDeserialize(Class<T> c, byte[] b)`
`static <T> T`	`thriftDeserialize(Class<T> c, byte[] b, int offset, int length)`
`static byte[]`	`thriftSerialize(org.apache.thrift.TBase t)`
`static byte[]`	`toByteArray(ByteBuffer buffer)`
`static byte[]`	`toCompressedJsonConf(Map<String,Object> stormConf)`
`static int`	`toPositive(int number)` A cheap way to deterministically convert a number to a positive value.
`static List<Object>`	`tuple(Object... values)`
`static void`	`unJar(File jarFile, File toDir)` Unpack matching files from a jar.
`static void`	`unpack(File localrsrc, File dst, boolean symLinksDisabled)`
`static void`	`unTar(File inFile, File untarDir, boolean symlinksDisabled)` Given a Tar File as input it will untar the file in a the untar directory passed as the second parameter This utility will untar “.tar” files and “.tar.gz”,“tgz” files.
`static void`	`unZip(File inFile, File toDir)` Given a File input it will unzip the file in a the unzip directory passed as the second parameter
`static String`	`uuid()`
`static void`	`validateKeyName(String name)`
`static void`	`validateTopologyBlobStoreMap(Map<String,?> stormConf, Set<String> blobStoreKeys)`
`static RuntimeException`	`wrapInRuntime(Exception e)`
`static String`	`writeScript(String dir, List<String> command, Map<String,String> environment)` Writes a posix shell script file to be executed in its own process.
`static double`	`zeroIfNaNOrInf(double x)`
`static boolean`	`zipDoesContainDir(String zipfile, String target)` Determines if a zip archive contains a particular directory.
`static long`	`zipFileSize(File myFile)` Given a zip File input it will return its size Only works for zip files whose uncompressed size is less than 4 GB, otherwise returns the size module 2^32, per gzip specifications

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final org.slf4j.Logger LOG

DEFAULT_STREAM_ID

public static final String DEFAULT_STREAM_ID

See Also:: Constant Field Values

DEFAULT_BLOB_VERSION_SUFFIX

public static final String DEFAULT_BLOB_VERSION_SUFFIX

See Also:: Constant Field Values

CURRENT_BLOB_SUFFIX_ID

public static final String CURRENT_BLOB_SUFFIX_ID

See Also:: Constant Field Values

DEFAULT_CURRENT_BLOB_SUFFIX

public static final String DEFAULT_CURRENT_BLOB_SUFFIX

See Also:: Constant Field Values

IS_ON_WINDOWS

public static final boolean IS_ON_WINDOWS

FILE_PATH_SEPARATOR

public static final String FILE_PATH_SEPARATOR

CLASS_PATH_SEPARATOR

public static final String CLASS_PATH_SEPARATOR

SIGKILL
```
public static final int SIGKILL
```
See Also:

Constant Field Values

SIGTERM
```
public static final int SIGTERM
```
See Also:

Constant Field Values

Constructor Detail
- Utils
```
public Utils()
```

Method Detail

setInstance
```
public static Utils setInstance(Utils 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

newInstance

public static <T> T newInstance(String klass)

newInstance

public static <T> T newInstance(Class<T> klass)

newInstanceImpl

public <T> T newInstanceImpl(Class<T> klass)

jarTransformer

public static JarTransformer jarTransformer(String klass)

serialize

public static byte[] serialize(Object obj)

deserialize

public static <T> T deserialize(byte[] serialized,
                                Class<T> clazz)

thriftDeserialize

public static <T> T thriftDeserialize(Class<T> c,
                                      byte[] b,
                                      int offset,
                                      int length)

javaSerialize

public static byte[] javaSerialize(Object obj)

javaDeserialize

public static <T> T javaDeserialize(byte[] serialized,
                                    Class<T> clazz)

gzip

public static byte[] gzip(byte[] data)

gunzip

public static byte[] gunzip(byte[] data)

toCompressedJsonConf

public static byte[] toCompressedJsonConf(Map<String,Object> stormConf)

fromCompressedJsonConf

public static Map<String,Object> fromCompressedJsonConf(byte[] serialized)

join

public static <T> String join(Iterable<T> coll,
                              String sep)

bitXorVals

public static long bitXorVals(List<Long> coll)

sleep

public static void sleep(long millis)

findResources

public static List<URL> findResources(String name)

findAndReadConfigFile

public static Map<String,Object> findAndReadConfigFile(String name,
                                                       boolean mustExist)

findAndReadConfigFile

public static Map<String,Object> findAndReadConfigFile(String name)

readDefaultConfig

public static Map<String,Object> readDefaultConfig()

readCommandLineOpts

public static Map<String,Object> readCommandLineOpts()

readStormConfig

public static Map<String,Object> readStormConfig()

isValidConf

public static boolean isValidConf(Map<String,Object> stormConf)

getSetComponentObject

public static Object getSetComponentObject(ComponentObject obj)

get

public static <S,T> T get(Map<S,T> m,
                          S key,
                          T def)

tuple

public static List<Object> tuple(Object... values)

createLocalizer

public static Localizer createLocalizer(Map conf,
                                        String baseDir)

getClientBlobStoreForSupervisor

public static ClientBlobStore getClientBlobStoreForSupervisor(Map conf)

getNimbusBlobStore

public static BlobStore getNimbusBlobStore(Map conf,
                                           NimbusInfo nimbusInfo)

getNimbusBlobStore

public static BlobStore getNimbusBlobStore(Map conf,
                                           String baseDir,
                                           NimbusInfo nimbusInfo)

downloadResourcesAsSupervisor

public static void downloadResourcesAsSupervisor(String key,
                                                 String localFile,
                                                 ClientBlobStore cb)
                                          throws AuthorizationException,
                                                 KeyNotFoundException,
                                                 IOException

Meant to be called only by the supervisor for stormjar/stormconf/stormcode files.

Parameters:: key -; localFile -; cb -
Throws:: AuthorizationException; KeyNotFoundException; IOException

downloadResourcesAsSupervisorImpl

public void downloadResourcesAsSupervisorImpl(String key,
                                              String localFile,
                                              ClientBlobStore cb)
                                       throws AuthorizationException,
                                              KeyNotFoundException,
                                              IOException

Throws:: AuthorizationException; KeyNotFoundException; IOException

getClientBlobStore

public static ClientBlobStore getClientBlobStore(Map conf)

checkFileExists

public static boolean checkFileExists(File path)

checkFileExists

public static boolean checkFileExists(String path)

checkFileExists

public static boolean checkFileExists(String dir,
                                      String file)

CheckDirExists

public static boolean CheckDirExists(String dir)

nimbusVersionOfBlob

public static long nimbusVersionOfBlob(String key,
                                       ClientBlobStore cb)
                                throws AuthorizationException,
                                       KeyNotFoundException

Throws:: AuthorizationException; KeyNotFoundException

getFileOwner

public static String getFileOwner(String path)
                           throws IOException

Throws:: IOException

localVersionOfBlob

public static long localVersionOfBlob(String localFile)

constructBlobWithVersionFileName

public static String constructBlobWithVersionFileName(String fileName,
                                                      long version)

constructBlobCurrentSymlinkName

public static String constructBlobCurrentSymlinkName(String fileName)

constructVersionFileName

public static String constructVersionFileName(String fileName)

restrictPermissions

public static void restrictPermissions(String baseDir)

loadClojureFn

public static clojure.lang.IFn loadClojureFn(String namespace,
                                             String name)

isSystemId

public static boolean isSystemId(String id)

getComponentCommon

public static ComponentCommon getComponentCommon(StormTopology topology,
                                                 String id)

getStrings

public static List<String> getStrings(Object o)

getString

public static String getString(Object o)

getInt

public static Integer getInt(Object o)

thriftSerialize

public static byte[] thriftSerialize(org.apache.thrift.TBase t)

thriftDeserialize

public static <T> T thriftDeserialize(Class<T> c,
                                      byte[] b)

getInt

public static Integer getInt(Object o,
                             Integer defaultValue)

getDouble

public static Double getDouble(Object o)

getDouble

public static Double getDouble(Object o,
                               Double defaultValue)

getBoolean

public static boolean getBoolean(Object o,
                                 boolean defaultValue)

getString

public static String getString(Object o,
                               String defaultValue)

secureRandomLong
```
public static long secureRandomLong()
```

unJar
```
public static void unJar(File jarFile,
                         File toDir)
                  throws IOException
```
Unpack matching files from a jar. Entries inside the jar that do not match the given pattern will be skipped.

Parameters:

jarFile - the .jar file to unpack

toDir - the destination directory into which to unpack the jar

Throws:

IOException

unTar
```
public static void unTar(File inFile,
                         File untarDir,
                         boolean symlinksDisabled)
                  throws IOException
```
Given a Tar File as input it will untar the file in a the untar directory passed as the second parameter
This utility will untar “.tar” files and “.tar.gz”,“tgz” files.

Parameters:

inFile - The tar file as input.

untarDir - The untar directory where to untar the tar file.

symlinksDisabled - true if symlinks should be disabled, else false.

Throws:

IOException

isOnWindows
```
public static boolean isOnWindows()
```

isAbsolutePath

public static boolean isAbsolutePath(String path)

unpack

public static void unpack(File localrsrc,
                          File dst,
                          boolean symLinksDisabled)
                   throws IOException

Throws:: IOException

canUserReadBlob

public static boolean canUserReadBlob(ReadableBlobMeta meta,
                                      String user)

newCurator

public static org.apache.curator.framework.CuratorFramework newCurator(Map conf,
                                                                       List<String> servers,
                                                                       Object port,
                                                                       String root,
                                                                       List<org.apache.zookeeper.data.ACL> defaultAcl)

newCurator

public static org.apache.curator.framework.CuratorFramework newCurator(Map conf,
                                                                       List<String> servers,
                                                                       Object port,
                                                                       ZookeeperAuthInfo auth,
                                                                       List<org.apache.zookeeper.data.ACL> defaultAcl)

newCurator

public static org.apache.curator.framework.CuratorFramework newCurator(Map conf,
                                                                       List<String> servers,
                                                                       Object port,
                                                                       String root,
                                                                       ZookeeperAuthInfo auth,
                                                                       List<org.apache.zookeeper.data.ACL> defaultAcl)

setupBuilder

protected static void setupBuilder(org.apache.curator.framework.CuratorFrameworkFactory.Builder builder,
                                   String zkStr,
                                   Map conf,
                                   ZookeeperAuthInfo auth)

testSetupBuilder

public static void testSetupBuilder(org.apache.curator.framework.CuratorFrameworkFactory.Builder builder,
                                    String zkStr,
                                    Map conf,
                                    ZookeeperAuthInfo auth)

newCuratorStarted

public static org.apache.curator.framework.CuratorFramework newCuratorStarted(Map conf,
                                                                              List<String> servers,
                                                                              Object port,
                                                                              String root,
                                                                              ZookeeperAuthInfo auth,
                                                                              List<org.apache.zookeeper.data.ACL> defaultAcl)

newCuratorStarted

public static org.apache.curator.framework.CuratorFramework newCuratorStarted(Map conf,
                                                                              List<String> servers,
                                                                              Object port,
                                                                              ZookeeperAuthInfo auth,
                                                                              List<org.apache.zookeeper.data.ACL> defaultAcl)

integerDivided

public static TreeMap<Integer,Integer> integerDivided(int sum,
                                                      int numPieces)

toByteArray

public static byte[] toByteArray(ByteBuffer buffer)

readAndLogStream

public static void readAndLogStream(String prefix,
                                    InputStream in)

exceptionCauseIsInstanceOf
```
public static boolean exceptionCauseIsInstanceOf(Class klass,
                                                 Throwable throwable)
```
Checks if a throwable is an instance of a particular class

Parameters:

klass - The class you’re expecting

throwable - The throwable you expect to be an instance of klass

Returns:

true if throwable is instance of klass, false otherwise.

isZkAuthenticationConfiguredStormServer
```
public static boolean isZkAuthenticationConfiguredStormServer(Map conf)
```
Is the cluster configured to interact with ZooKeeper in a secure way? This only works when called from within Nimbus or a Supervisor process.

Parameters:

conf - the storm configuration, not the topology configuration

Returns:

true if it is configured else false.

isZkAuthenticationConfiguredTopology
```
public static boolean isZkAuthenticationConfiguredTopology(Map conf)
```
Is the topology configured to have ZooKeeper authentication.

Parameters:

conf - the topology configuration

Returns:

true if ZK is configured else false

parseZkId

public static org.apache.zookeeper.data.Id parseZkId(String id,
                                                     String configName)

getSuperUserAcl
```
public static org.apache.zookeeper.data.ACL getSuperUserAcl(Map<String,Object> conf)
```
Get the ACL for nimbus/supervisor. The Super User ACL. This assumes that security is enabled.

Parameters:

conf - the config to get the super User ACL from

Returns:

the super user ACL.

getWorkerACL
```
public static List<org.apache.zookeeper.data.ACL> getWorkerACL(Map<String,Object> conf)
```
Get the ZK ACLs that a worker should use when writing to ZK.

Parameters:

conf - the config for the topology.

Returns:

the ACLs

getDU
```
public static long getDU(File dir)
```
Takes an input dir or file and returns the disk usage on that local directory. Very basic implementation.

Parameters:

dir - The input dir to get the disk space of this local dir

Returns:

The total disk space of the input local directory

threadDump
```
public static String threadDump()
```
Gets some information, including stack trace, for a running thread.

Returns:

A human-readable string of the dump.

handleUncaughtException

public static void handleUncaughtException(Throwable t)

validateTopologyBlobStoreMap

public static void validateTopologyBlobStoreMap(Map<String,?> stormConf,
                                                Set<String> blobStoreKeys)
                                         throws InvalidTopologyException

Throws:: InvalidTopologyException

unZip
```
public static void unZip(File inFile,
                         File toDir)
                  throws IOException
```
Given a File input it will unzip the file in a the unzip directory passed as the second parameter

Parameters:

inFile - The zip file as input

toDir - The unzip directory where to unzip the zip file.

Throws:

IOException

zipFileSize
```
public static long zipFileSize(File myFile)
                        throws IOException
```
Given a zip File input it will return its size Only works for zip files whose uncompressed size is less than 4 GB, otherwise returns the size module 2^32, per gzip specifications

Parameters:

myFile - The zip file as input

Returns:

zip file size as a long

Throws:

IOException

zeroIfNaNOrInf

public static double zeroIfNaNOrInf(double x)

parseJvmHeapMemByChildOpts

public static Double parseJvmHeapMemByChildOpts(List<String> options,
                                                Double defaultValue)

parses the arguments to extract jvm heap memory size in MB.

Parameters:: input -; defaultValue -
Returns:: the value of the JVM heap memory setting (in MB) in a java command.

setClassLoaderForJavaDeSerialize

public static void setClassLoaderForJavaDeSerialize(ClassLoader cl)

resetClassLoaderForJavaDeSerialize

public static void resetClassLoaderForJavaDeSerialize()

getTopologyInfo

public static TopologyInfo getTopologyInfo(String name,
                                           String asUser,
                                           Map stormConf)

getTopologyId

public static String getTopologyId(String name,
                                   Nimbus.Client client)

toPositive
```
public static int toPositive(int number)
```
A cheap way to deterministically convert a number to a positive value. When the input is positive, the original value is returned. When the input number is negative, the returned positive value is the original value bit AND against Integer.MAX_VALUE(0x7fffffff) which is not its absolutely value.

Parameters:

number - a given number

Returns:

a positive number.

getGlobalStreamId

public static GlobalStreamId getGlobalStreamId(String streamId,
                                               String componentId)

wrapInRuntime

public static RuntimeException wrapInRuntime(Exception e)

getAvailablePort

public static int getAvailablePort(int prefferedPort)

getAvailablePort
```
public static int getAvailablePort()
```

zipDoesContainDir
```
public static boolean zipDoesContainDir(String zipfile,
                                        String target)
                                 throws IOException
```
Determines if a zip archive contains a particular directory.

Parameters:

zipfile - path to the zipped file

target - directory being looked for in the zip.

Returns:

boolean whether or not the directory exists in the zip.

Throws:

IOException

joinMaps
```
public static <K,V> Map<K,List<V>> joinMaps(Map<K,V>... maps)
```
Joins any number of maps together into a single map, combining their values into a list, maintaining values in the order the maps were passed in. Nulls are inserted for given keys when the map does not contain that key.
i.e. joinMaps({‘a’ => 1, ‘b’ => 2}, {‘b’ => 3}, {‘a’ => 4, ‘c’ => 5}) -> {‘a’ => [1, null, 4], ‘b’ => [2, 3, null], ‘c’ => [null, null, 5]}

Parameters:

maps - variable number of maps to join - order affects order of values in output.

Returns:

combined map

partitionFixed
```
public static <T> List<List<T>> partitionFixed(int maxNumChunks,
                                               Collection<T> coll)
```
Fills up chunks out of a collection (given a maximum amount of chunks)
i.e. partitionFixed(5, [1,2,3]) -> 1,2,3 partitionFixed(5, [1..9]) -> [[1,2], [3,4], [5,6], [7,8], [9]] partitionFixed(3, [1..10]) -> [[1,2,3,4], [5,6,7], [8,9,10]]

Parameters:

maxNumChunks - the maximum number of chunks to return

coll - the collection to be chunked up

Returns:

a list of the chunks, which are themselves lists.

getConfiguredClass
```
public static Object getConfiguredClass(Map conf,
                                        Object configKey)
```
Return a new instance of a pluggable specified in the conf.

Parameters:

conf - The conf to read from.

configKey - The key pointing to the pluggable class

Returns:

an instance of the class or null if it is not specified.

logsFilename

public static String logsFilename(String stormId,
                                  String port)

eventLogsFilename

public static String eventLogsFilename(String stormId,
                                       String port)

readYamlFile

public static Object readYamlFile(String yamlFile)

setupDefaultUncaughtExceptionHandler

public static void setupDefaultUncaughtExceptionHandler()

redactValue
```
public static Map<Object,String> redactValue(Map<Object,String> m,
                                             Object key)
```
Creates a new map with a string value in the map replaced with an equivalently-lengthed string of ‘#’.

Parameters:

m - The map that a value will be redacted from

key - The key pointing to the value to be redacted

Returns:

a new map with the value redacted. The original map will not be modified.

validateKeyName

public static void validateKeyName(String name)

localHostname

public static String localHostname()
                            throws UnknownHostException

Throws:: UnknownHostException

localHostnameImpl

protected String localHostnameImpl()
                            throws UnknownHostException

Throws:: UnknownHostException

memoizedLocalHostname

public static String memoizedLocalHostname()
                                    throws UnknownHostException

Throws:: UnknownHostException

hostname
```
public static String hostname()
                       throws UnknownHostException
```
Gets the storm.local.hostname value, or tries to figure out the local hostname if it is not set in the config.

Returns:

a string representation of the hostname.

Throws:

UnknownHostException

hostnameImpl

protected String hostnameImpl()
                       throws UnknownHostException

Throws:: UnknownHostException

uuid
```
public static String uuid()
```

exitProcess

public static void exitProcess(int val,
                               String msg)

mkSuicideFn
```
public static Runnable mkSuicideFn()
```

reverseMap
```
public static <K,V> HashMap<V,List<K>> reverseMap(Map<K,V> map)
```
“{:a 1 :b 1 :c 2} -> {1 [:a :b] 2 :c}”
Example usage in java: Map<Integer, String> tasks; Map<String, List> componentTasks = Utils.reverse_map(tasks);
The order of he resulting list values depends on the ordering properties of the Map passed in. The caller is responsible for passing an ordered map if they expect the result to be consistently ordered as well.

Parameters:

map - to reverse

Returns:

a reversed map

reverseMap
```
public static HashMap reverseMap(List listSeq)
```
“[[:a 1] [:b 1] [:c 2]} -> {1 [:a :b] 2 :c}” Reverses an assoc-list style Map like reverseMap(Map…)

Parameters:

listSeq - to reverse

Returns:

a reversed map

processPid
```
public static String processPid()
```
Returns:

the pid of this JVM, because Java doesn’t provide a real way to do this.

execCommand

public static int execCommand(String... command)
                       throws org.apache.commons.exec.ExecuteException,
                              IOException

Throws:: org.apache.commons.exec.ExecuteException; IOException

extractDirFromJar

public static void extractDirFromJar(String jarpath,
                                     String dir,
                                     File destdir)

Extract dir from the jar to destdir

Parameters:: jarpath - Path to the jar file; dir - Directory in the jar to pull out; destdir - Path to the directory where the extracted directory will be put

extractDirFromJarImpl

public void extractDirFromJarImpl(String jarpath,
                                  String dir,
                                  File destdir)

sendSignalToProcess

public static void sendSignalToProcess(long lpid,
                                       int signum)
                                throws IOException

Throws:: IOException

forceKillProcess

public static void forceKillProcess(String pid)
                             throws IOException

Throws:: IOException

killProcessWithSigTerm

public static void killProcessWithSigTerm(String pid)
                                   throws IOException

Throws:: IOException

addShutdownHookWithForceKillIn1Sec
```
public static void addShutdownHookWithForceKillIn1Sec(Runnable func)
```
Adds the user supplied function as a shutdown hook for cleanup. Also adds a function that sleeps for a second and then halts the runtime to avoid any zombie process in case cleanup function hangs.

shellCmd
```
public static String shellCmd(List<String> command)
```
Returns the combined string, escaped for posix shell.

Parameters:

command - the list of strings to be combined

Returns:

the resulting command string

scriptFilePath

public static String scriptFilePath(String dir)

containerFilePath

public static String containerFilePath(String dir)

nullToZero

public static Object nullToZero(Object v)

forceDelete
```
public static void forceDelete(String path)
                        throws IOException
```
Deletes a file or directory and its contents if it exists. Does not complain if the input is null or does not exist.

Parameters:

path - the path to the file or directory

Throws:

IOException

forceDeleteImpl

protected void forceDeleteImpl(String path)
                        throws IOException

Throws:: IOException

readDirContents
```
public static Collection<String> readDirContents(String dir)
```
Returns a Collection of file names found under the given directory.

Parameters:

dir - a directory

Returns:

the Collection of file names

currentClasspath
```
public static String currentClasspath()
```
Returns the value of java.class.path System property. Kept separate for testing.

Returns:

the classpath

currentClasspathImpl
```
public String currentClasspathImpl()
```

addToClasspath

public static String addToClasspath(String classpath,
                                    Collection<String> paths)

addToClasspath

public static String addToClasspath(Collection<String> classpaths,
                                    Collection<String> paths)

addToClasspathImpl

public String addToClasspathImpl(String classpath,
                                 Collection<String> paths)

addToClasspathImpl

public String addToClasspathImpl(Collection<String> classpaths,
                                 Collection<String> paths)

makeUptimeComputer

public static Utils.UptimeComputer makeUptimeComputer()

makeUptimeComputerImpl

public Utils.UptimeComputer makeUptimeComputerImpl()

OR
```
public static <V> V OR(V a,
                       V b)
```
a or b the first one that is not null

Parameters:

a - something

b - something else

Returns:

a or b the first one that is not null

writeScript
```
public static String writeScript(String dir,
                                 List<String> command,
                                 Map<String,String> environment)
                          throws IOException
```
Writes a posix shell script file to be executed in its own process.

Parameters:

dir - the directory under which the script is to be written

command - the command the script is to execute

environment - optional environment variables to set before running the script’s command. May be null.

Returns:

the path to the script that has been written

Throws:

IOException

asyncLoop
```
public static Utils.SmartThread asyncLoop(Callable afn,
                                          boolean isDaemon,
                                          Thread.UncaughtExceptionHandler eh,
                                          int priority,
                                          boolean isFactory,
                                          boolean startImmediately,
                                          String threadName)
```
Creates a thread that calls the given code repeatedly, sleeping for an interval of seconds equal to the return value of the previous call.
The given afn may be a callable that returns the number of seconds to sleep, or it may be a Callable that returns another Callable that in turn returns the number of seconds to sleep. In the latter case isFactory.

Parameters:

afn - the code to call on each iteration

isDaemon - whether the new thread should be a daemon thread

eh - code to call when afn throws an exception

priority - the new thread’s priority

isFactory - whether afn returns a callable instead of sleep seconds

startImmediately - whether to start the thread before returning

threadName - a suffix to be appended to the thread name

Returns:

the newly created thread

See Also:

Thread

asyncLoop

public static Utils.SmartThread asyncLoop(Callable afn,
                                          String threadName,
                                          Thread.UncaughtExceptionHandler eh)

Convenience method used when only the function and name suffix are given.

Parameters:: afn - the code to call on each iteration; threadName - a suffix to be appended to the thread name
Returns:: the newly created thread
See Also:: Thread

asyncLoop
```
public static Utils.SmartThread asyncLoop(Callable afn)
```
Convenience method used when only the function is given.

Parameters:

afn - the code to call on each iteration

Returns:

the newly created thread

interleaveAll

public static <T> List<T> interleaveAll(List<List<T>> nodeList)

bitXor

public static long bitXor(Long a,
                          Long b)

getRepeat

public static List<String> getRepeat(List<String> list)

convertClojureMapToJavaMap

public static Map<String,Object> convertClojureMapToJavaMap(Map map)

converts a clojure PersistentMap to java HashMap

addVersions
```
public static StormTopology addVersions(StormTopology topology)
```
Add version information to the given topology

Parameters:

topology - the topology being submitted (MIGHT BE MODIFIED)

Returns:

topology

isValidKey
```
public static boolean isValidKey(String key)
```
Validates topology name / blob key.

Parameters:

key - topology name / Key for the blob.

Class Utils

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

DEFAULT_STREAM_ID

DEFAULT_BLOB_VERSION_SUFFIX

CURRENT_BLOB_SUFFIX_ID

DEFAULT_CURRENT_BLOB_SUFFIX

IS_ON_WINDOWS

FILE_PATH_SEPARATOR

CLASS_PATH_SEPARATOR

SIGKILL

SIGTERM

Constructor Detail

Utils

Method Detail

setInstance

newInstance

newInstance

newInstanceImpl

jarTransformer

serialize

deserialize

thriftDeserialize

javaSerialize

javaDeserialize

gzip

gunzip

toCompressedJsonConf

fromCompressedJsonConf

join

bitXorVals

sleep

findResources

findAndReadConfigFile

findAndReadConfigFile

readDefaultConfig

readCommandLineOpts

readStormConfig

isValidConf

getSetComponentObject

get

tuple

createLocalizer

getClientBlobStoreForSupervisor

getNimbusBlobStore

getNimbusBlobStore

downloadResourcesAsSupervisor

downloadResourcesAsSupervisorImpl

getClientBlobStore

checkFileExists

checkFileExists

checkFileExists

CheckDirExists

nimbusVersionOfBlob

getFileOwner

localVersionOfBlob

constructBlobWithVersionFileName

constructBlobCurrentSymlinkName

constructVersionFileName

restrictPermissions

loadClojureFn

isSystemId

getComponentCommon

getStrings

getString

getInt

thriftSerialize

thriftDeserialize

getInt

getDouble

getDouble

getBoolean

getString

secureRandomLong

unJar