org.openksavi.sponge.core.util

Class SpongeUtils

java.lang.Object

org.openksavi.sponge.core.util.SpongeUtils

public abstract class SpongeUtils
extends Object

This class defines a set of utility methods. It also wraps some of the external dependencies like Guava to avoid version conflicts in the client code. All Sponge projects except sponge-core should use only such wrapper methods defined here.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_SECURITY_ALGORITHM
static String	TAG_SECURITY_KEY_PASSWORD
static String	TAG_SECURITY_KEY_STORE
static String	TAG_SECURITY_KEY_STORE_PASSWORD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpongeUtils()

Method Summary

Modifier and Type	Method and Description
static void	applyCategory(CategoryMeta categoryMeta, ProcessorAdapter processorAdapter)
static void	applyCategory(ProcessorAdapter processorAdapter)
static boolean	awaitUntil(Callable<Boolean> callable)
static boolean	awaitUntil(Callable<Boolean> callable, long timeout, TimeUnit unit)
static List<Object>	buildActionArgsList(ActionAdapter actionAdapter, Map<String,?> argsMap)
static List<Object>	buildActionArgsList(ActionAdapter actionAdapter, Map<String,?> argsMap, boolean ignoreUnknownArgs)
static LocalCacheBuilder	cacheBuilder()
static int	calculateInitialDynamicThreadPoolSize(SpongeEngine engine, int maxPoolSize)
static void	close(InputStream stream)
static void	close(OutputStream stream)
static void	closeQuietly(Reader reader)
static RuleEventSpec	convertRuleEventSpec(KnowledgeBase knowledgeBase, String eventStringSpec)
static List<RuleEventSpec>	convertRuleEventSpecs(KnowledgeBase knowledgeBase, List<String> eventStringSpecs)
static String	createControlEventName(Class<? extends ControlEvent> controlEventClass)
static String	createErrorMessage(Throwable exception, ExceptionContext context, boolean includeStackTrace)
static String	createGlobalLoggerName(KnowledgeBaseEngineOperations knowledgeBaseEngineOperations)
static <T> T	createInstance(String className, Class<T> javaClass)
static KeyManagerFactory	createKeyManagerFactory(KeyStore ks, SslConfiguration sslConfiguration)
static KeyManagerFactory	createKeyManagerFactory(SslConfiguration sslConfiguration)
static String	createLoggerName(KnowledgeBase knowledgeBase, String targetName)
static String	createNonScriptKnowledgeBaseName(KnowledgeBase knowledgeBase)
static String	createPluginLoggerName()
static EventCondition	createRuleEventConditionForMethod(Rule rule, String name)
static EventCondition	createRuleEventConditionForMethods(Rule rule, List<String> names)
static SslConfiguration	createSslConfiguration(Configuration configuration)
static SSLContext	createSslContext(SslConfiguration sslConfiguration)
static <T> List<T>	createUnmodifiableList(List<T> source)
static <K,V> Map<K,V>	createUnmodifiableMap(Map<K,V> source)
static <T extends Serializable> T	deepClone(T source)
static void	doInWrappedException(KnowledgeBase knowledgeBase, Runnable runnable, String sourceName)
protected static void	doValidateType(DataType type, String valueName, Deque<DataType> stack)
static String	dumpConfiguration(org.apache.commons.configuration2.Configuration configuration) Dumps configuration to string.
static Future<?>	executeConcurrentlyOnce(SpongeEngine engine, Runnable runnable, String name)
static String	getAbbreviatedEventSequenceString(BaseRule rule)
static Map<String,Integer>	getActionArgIndexes(ActionAdapter actionAdapter, Set<String> argNames, boolean ignoreUnknownArgs)
static int	getCategoryIndex(SpongeEngine engine, CategoryMeta category)
static Class<?>	getClass(String className) Finds a class by the name.
static String	getConfigurationFileDir(SpongeEngine engine) Returns the configuration file directory or null if the configuration file is not present.
static String	getDisplayLabel(Descriptive descriptive)
static String	getFileDir(URL fileUrl)
static File	getFileDirAsFile(String filePath)
static InputStream	getInputStream(String filename) Opens an input stream for a file.
protected static KeyStore	getKeyStoreInstance()
static int	getKnowledgeBaseIndex(SpongeEngine engine, KnowledgeBase kb)
static KnowledgeBaseType	getKnowledgeBaseType(SpongeEngine engine, String language)
static String	getLastSubdirectory(String dir)
static List<String>	getNameList(String namesSpec)
static String	getPackagePath(Class<?> cls)
static ProcessorQualifiedName	getProcessorQualifiedName(ProcessorOperations processorOperations)
static List<ProcessorQualifiedName>	getProcessorQualifiedNameList(String processorQualifiedNamesSpec)
static String	getRandomUuidString()
static Reader	getReader(String filename) Opens a reader for a file.
static Reader	getReader(String filename, Charset charset) Opens a reader for a file.
static String	getRequiredConfigurationString(Configuration configuration, String key)
static ScriptKnowledgeBaseInterpreter	getScriptInterpreter(SpongeEngine engine, String kbName)
static String	getSourceName(Throwable exception)
static KnowledgeBaseEngineOperations	getSponge(KnowledgeBaseInterpreter interpreter)
static List<Class<? extends DataType>>	getSupportedTypes()
static URL	getUrlFromClasspath(String resourceName)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1, K k2, V v2)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1, K k2, V v2, K k3, V v3)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)
static <E> Set<E>	immutableSetOf(E e)
static <E> Set<E>	immutableSetOf(E e1, E e2)
static <E> Set<E>	immutableSetOf(E e1, E e2, E e3)
static <E> Set<E>	immutableSetOf(E e1, E e2, E e3, E e4)
static <E> Set<E>	immutableSetOf(E e1, E e2, E e3, E e4, E e5)
static Object	invokeMethod(Object target, String name, Object... args)
static boolean	isAbstract(Class<?> cls)
static boolean	isSingleton(Processor<?> processor)
static boolean	isSystemEvent(Event event)
static void	mergeInheritedRecordType(RecordType type)
protected static void	mergeTypes(DataType baseType, DataType subType)
static byte[]	readFileToByteArray(String filename)
static void	registerShutdownHook(SpongeEngine engine)
static String	removeLeadingExceptionClassNamesFromMessage(Throwable e)
static Object	searchConfigurationValueByAttributeValue(Configuration root, String parentKey, String attrName, String attrValue)
static void	setupType(DataType type)
static void	shutdownExecutorService(Object named, ExecutorService executorService, long timeout)
static void	shutdownExecutorService(SpongeEngine engine, Object named, ExecutorService executorService)
static List<String>	split(String text, char separator)
static <T> Stream<T>	stream(Iterator<T> iterator)
static int	toInt(Object value)
static String	toStringArrayEventSequence(Collection<Event> events, String attributeName)
static String	toStringEventSequence(Collection<Event> events)
static String	toStringEventSequence(Collection<Event> events, String attributeName)
static String	toUpperCamelCaseFromUnderscore(String s)
static void	validateEventName(String name)
static void	validateRecordFieldName(String name, String valueName)
static void	validateType(DataType type, String valueName)
static SpongeException	wrapException(KnowledgeBaseInterpreter interpreter, Throwable throwable)
static SpongeException	wrapException(Processor<?> processor, Throwable throwable)
static SpongeException	wrapException(String sourceName, KnowledgeBaseInterpreter interpreter, Throwable throwable)
static SpongeException	wrapException(String sourceName, String specificErrorMessage, Throwable throwable)
static SpongeException	wrapException(String sourceName, Throwable throwable) Wraps or creates a new Sponge exception.
static SpongeException	wrapException(Throwable throwable) Wraps or creates a new Sponge exception.
static SpongeException	wrapInvokeException(Object target, String method, KnowledgeBaseInterpreter interpreter, Throwable throwable)
static void	writeByteArrayToFile(byte[] bytes, String filename)

Methods inherited from class java.lang.Object

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

Field Detail

TAG_SECURITY_KEY_STORE_PASSWORD

public static final String TAG_SECURITY_KEY_STORE_PASSWORD

See Also:

Constant Field Values

TAG_SECURITY_KEY_PASSWORD

public static final String TAG_SECURITY_KEY_PASSWORD

See Also:

Constant Field Values

TAG_SECURITY_KEY_STORE

public static final String TAG_SECURITY_KEY_STORE

See Also:

Constant Field Values

TAG_SECURITY_ALGORITHM

public static final String TAG_SECURITY_ALGORITHM

See Also:

Constant Field Values

Constructor Detail

SpongeUtils

protected SpongeUtils()

Method Detail

createInstance

public static <T> T createInstance(String className,
                                   Class<T> javaClass)

invokeMethod

public static Object invokeMethod(Object target,
                                  String name,
                                  Object... args)

deepClone

public static <T extends Serializable> T deepClone(T source)

getReader

public static Reader getReader(String filename)

Opens a reader for a file. The file search order is: the file system, the classpath.

Parameters:

filename - the filename.

Returns:

a reader or null if not found.

getReader

public static Reader getReader(String filename,
                               Charset charset)

Opens a reader for a file. The file search order is: the file system, the classpath.

Parameters:

filename - the filename.

charset - the charset.

Returns:

a reader or null if not found.

getInputStream

public static InputStream getInputStream(String filename)

Opens an input stream for a file. The file search order is: the file system, the classpath.

Parameters:

filename - the filename.

Returns:

an input stream or null if not found.

getUrlFromClasspath

public static URL getUrlFromClasspath(String resourceName)

dumpConfiguration

public static String dumpConfiguration(org.apache.commons.configuration2.Configuration configuration)

Dumps configuration to string.

Parameters:

configuration - a configuration.

Returns:

a configuration dump string.

searchConfigurationValueByAttributeValue

public static Object searchConfigurationValueByAttributeValue(Configuration root,
                                                              String parentKey,
                                                              String attrName,
                                                              String attrValue)

executeConcurrentlyOnce

public static Future<?> executeConcurrentlyOnce(SpongeEngine engine,
                                                Runnable runnable,
                                                String name)

createGlobalLoggerName

public static String createGlobalLoggerName(KnowledgeBaseEngineOperations knowledgeBaseEngineOperations)

createPluginLoggerName

public static String createPluginLoggerName()

createLoggerName

public static String createLoggerName(KnowledgeBase knowledgeBase,
                                      String targetName)

createErrorMessage

public static String createErrorMessage(Throwable exception,
                                        ExceptionContext context,
                                        boolean includeStackTrace)

createNonScriptKnowledgeBaseName

public static String createNonScriptKnowledgeBaseName(KnowledgeBase knowledgeBase)

shutdownExecutorService

public static void shutdownExecutorService(Object named,
                                           ExecutorService executorService,
                                           long timeout)

shutdownExecutorService

public static void shutdownExecutorService(SpongeEngine engine,
                                           Object named,
                                           ExecutorService executorService)

getScriptInterpreter

public static ScriptKnowledgeBaseInterpreter getScriptInterpreter(SpongeEngine engine,
                                                                  String kbName)

getSponge

public static KnowledgeBaseEngineOperations getSponge(KnowledgeBaseInterpreter interpreter)

getAbbreviatedEventSequenceString

public static String getAbbreviatedEventSequenceString(BaseRule rule)

wrapException

public static SpongeException wrapException(String sourceName,
                                            String specificErrorMessage,
                                            Throwable throwable)

wrapException

public static SpongeException wrapException(Throwable throwable)

Wraps or creates a new Sponge exception.

Parameters:

throwable - source throwable.

Returns:

Sponge exception.

wrapException

public static SpongeException wrapException(String sourceName,
                                            Throwable throwable)

Wraps or creates a new Sponge exception.

Parameters:

sourceName - source name of the exception.

throwable - source throwable.

Returns:

Sponge exception.

wrapException

public static SpongeException wrapException(Processor<?> processor,
                                            Throwable throwable)

wrapException

public static SpongeException wrapException(KnowledgeBaseInterpreter interpreter,
                                            Throwable throwable)

wrapException

public static SpongeException wrapException(String sourceName,
                                            KnowledgeBaseInterpreter interpreter,
                                            Throwable throwable)

wrapInvokeException

public static SpongeException wrapInvokeException(Object target,
                                                  String method,
                                                  KnowledgeBaseInterpreter interpreter,
                                                  Throwable throwable)

getSourceName

public static String getSourceName(Throwable exception)

toStringEventSequence

public static String toStringEventSequence(Collection<Event> events)

toStringEventSequence

public static String toStringEventSequence(Collection<Event> events,
                                           String attributeName)

toStringArrayEventSequence

public static String toStringArrayEventSequence(Collection<Event> events,
                                                String attributeName)

createControlEventName

public static String createControlEventName(Class<? extends ControlEvent> controlEventClass)

calculateInitialDynamicThreadPoolSize

public static int calculateInitialDynamicThreadPoolSize(SpongeEngine engine,
                                                        int maxPoolSize)

getPackagePath

public static String getPackagePath(Class<?> cls)

getLastSubdirectory

public static String getLastSubdirectory(String dir)

immutableSetOf

public static <E> Set<E> immutableSetOf(E e)

immutableSetOf

public static <E> Set<E> immutableSetOf(E e1,
                                        E e2)

immutableSetOf

public static <E> Set<E> immutableSetOf(E e1,
                                        E e2,
                                        E e3)

immutableSetOf

public static <E> Set<E> immutableSetOf(E e1,
                                        E e2,
                                        E e3,
                                        E e4)

immutableSetOf

public static <E> Set<E> immutableSetOf(E e1,
                                        E e2,
                                        E e3,
                                        E e4,
                                        E e5)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1,
                                            K k2,
                                            V v2)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1,
                                            K k2,
                                            V v2,
                                            K k3,
                                            V v3)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1,
                                            K k2,
                                            V v2,
                                            K k3,
                                            V v3,
                                            K k4,
                                            V v4)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1,
                                            K k2,
                                            V v2,
                                            K k3,
                                            V v3,
                                            K k4,
                                            V v4,
                                            K k5,
                                            V v5)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1,
                                            K k2,
                                            V v2,
                                            K k3,
                                            V v3,
                                            K k4,
                                            V v4,
                                            K k5,
                                            V v5,
                                            K k6,
                                            V v6)

stream

public static <T> Stream<T> stream(Iterator<T> iterator)

split

public static List<String> split(String text,
                                 char separator)

close

public static void close(InputStream stream)

close

public static void close(OutputStream stream)

closeQuietly

public static void closeQuietly(Reader reader)

getRequiredConfigurationString

public static String getRequiredConfigurationString(Configuration configuration,
                                                    String key)

toInt

public static int toInt(Object value)

registerShutdownHook

public static void registerShutdownHook(SpongeEngine engine)

toUpperCamelCaseFromUnderscore

public static String toUpperCamelCaseFromUnderscore(String s)

isAbstract

public static boolean isAbstract(Class<?> cls)

awaitUntil

public static boolean awaitUntil(Callable<Boolean> callable,
                                 long timeout,
                                 TimeUnit unit)

awaitUntil

public static boolean awaitUntil(Callable<Boolean> callable)

isSystemEvent

public static boolean isSystemEvent(Event event)

getProcessorQualifiedNameList

public static List<ProcessorQualifiedName> getProcessorQualifiedNameList(String processorQualifiedNamesSpec)

getNameList

public static List<String> getNameList(String namesSpec)

getKeyStoreInstance

protected static KeyStore getKeyStoreInstance()

createKeyManagerFactory

public static KeyManagerFactory createKeyManagerFactory(KeyStore ks,
                                                        SslConfiguration sslConfiguration)

createKeyManagerFactory

public static KeyManagerFactory createKeyManagerFactory(SslConfiguration sslConfiguration)

createSslContext

public static SSLContext createSslContext(SslConfiguration sslConfiguration)

createSslConfiguration

public static SslConfiguration createSslConfiguration(Configuration configuration)

getProcessorQualifiedName

public static ProcessorQualifiedName getProcessorQualifiedName(ProcessorOperations processorOperations)

getClass

public static Class<?> getClass(String className)

Finds a class by the name.

Parameters:

className - the class name.

Returns:

the class or null if not found.

doInWrappedException

public static void doInWrappedException(KnowledgeBase knowledgeBase,
                                        Runnable runnable,
                                        String sourceName)

validateType

public static void validateType(DataType type,
                                String valueName)

doValidateType

protected static void doValidateType(DataType type,
                                     String valueName,
                                     Deque<DataType> stack)

setupType

public static void setupType(DataType type)

mergeInheritedRecordType

public static void mergeInheritedRecordType(RecordType type)

mergeTypes

protected static void mergeTypes(DataType baseType,
                                 DataType subType)

getSupportedTypes

public static List<Class<? extends DataType>> getSupportedTypes()

getConfigurationFileDir

public static String getConfigurationFileDir(SpongeEngine engine)

Returns the configuration file directory or null if the configuration file is not present.

Parameters:

engine - the engine.

Returns:

the configuration file directory.

getFileDir

public static String getFileDir(URL fileUrl)

getFileDirAsFile

public static File getFileDirAsFile(String filePath)

cacheBuilder

public static LocalCacheBuilder cacheBuilder()

getRandomUuidString

public static String getRandomUuidString()

readFileToByteArray

public static byte[] readFileToByteArray(String filename)

writeByteArrayToFile

public static void writeByteArrayToFile(byte[] bytes,
                                        String filename)

createUnmodifiableList

public static <T> List<T> createUnmodifiableList(List<T> source)

createUnmodifiableMap

public static <K,V> Map<K,V> createUnmodifiableMap(Map<K,V> source)

validateEventName

public static void validateEventName(String name)

validateRecordFieldName

public static void validateRecordFieldName(String name,
                                           String valueName)

getKnowledgeBaseIndex

public static int getKnowledgeBaseIndex(SpongeEngine engine,
                                        KnowledgeBase kb)

getCategoryIndex

public static int getCategoryIndex(SpongeEngine engine,
                                   CategoryMeta category)

getDisplayLabel

public static String getDisplayLabel(Descriptive descriptive)

convertRuleEventSpecs

public static List<RuleEventSpec> convertRuleEventSpecs(KnowledgeBase knowledgeBase,
                                                        List<String> eventStringSpecs)

convertRuleEventSpec

public static RuleEventSpec convertRuleEventSpec(KnowledgeBase knowledgeBase,
                                                 String eventStringSpec)

createRuleEventConditionForMethods

public static EventCondition createRuleEventConditionForMethods(Rule rule,
                                                                List<String> names)

createRuleEventConditionForMethod

public static EventCondition createRuleEventConditionForMethod(Rule rule,
                                                               String name)

getKnowledgeBaseType

public static KnowledgeBaseType getKnowledgeBaseType(SpongeEngine engine,
                                                     String language)

buildActionArgsList

public static List<Object> buildActionArgsList(ActionAdapter actionAdapter,
                                               Map<String,?> argsMap)

buildActionArgsList

public static List<Object> buildActionArgsList(ActionAdapter actionAdapter,
                                               Map<String,?> argsMap,
                                               boolean ignoreUnknownArgs)

getActionArgIndexes

public static Map<String,Integer> getActionArgIndexes(ActionAdapter actionAdapter,
                                                      Set<String> argNames,
                                                      boolean ignoreUnknownArgs)

removeLeadingExceptionClassNamesFromMessage

public static String removeLeadingExceptionClassNamesFromMessage(Throwable e)

isSingleton

public static boolean isSingleton(Processor<?> processor)

applyCategory

public static void applyCategory(CategoryMeta categoryMeta,
                                 ProcessorAdapter processorAdapter)

applyCategory

public static void applyCategory(ProcessorAdapter processorAdapter)