org.qbroker.monitor

Class MonitorUtils

java.lang.Object

org.qbroker.monitor.MonitorUtils

public class MonitorUtils
extends java.lang.Object

MonitorUtils wrappes some utilities for Monitor stuff

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_SEPARATOR
static java.lang.String	JAVA_VERSION
static java.lang.String	OS_ARCH
static java.lang.String	OS_NAME
static java.lang.String	OS_VERSION
static int	REPT_SKIP
static int	REPT_STATUS
static int	REPT_TIME
static java.lang.String	USER_NAME

Constructor Summary

Constructors

Constructor and Description
MonitorUtils()

Method Summary

Modifier and Type	Method and Description
static int	checkDependencies(long currentTime, java.util.List[] dependencies, java.lang.String prefix) It returns MonitorReport.NOSKIP if there is at least one group of dependencies with status of NOSKIP.
static void	clearDependencies(java.util.List[] dependencies) It cleans up all the dependency objects.
static void	clearMapArray(java.util.Map[] hmGroup)
static boolean	filter(java.lang.String text, org.apache.oro.text.regex.Pattern[][] patterns, org.apache.oro.text.regex.Perl5Matcher pm, boolean def)
static java.util.List[]	getDependencies(java.util.List groupList)
static java.util.List<java.util.Map>	getGenericMapList(java.util.List list, org.apache.oro.text.regex.Perl5Compiler pc, Template template) It returns a list of maps with each map contains three objects of Pattern, TextSubstitution and Template.
static int[]	getHeartbeat(int[] group) It generates the heartbeat array from the input array.
static java.util.Map<java.lang.String,java.util.List>	getIncludes(java.lang.String basename, java.util.Map<java.lang.String,java.lang.Object> includeGroup, java.util.Map props) It returns a Map with the same keys of IncludeGroup and values of List that contains Sets for names of the primary includes.
static java.lang.String	getMappedName(java.lang.String name, java.util.List<java.util.Map> mapList, org.apache.oro.text.regex.Perl5Matcher pm) Based on a list of generic name mapping rules, it trys to match the given name with the pattern to select the substition.
static Template	getMappedTemplate(java.lang.String name, java.util.List<java.util.Map> mapList, org.apache.oro.text.regex.Perl5Matcher pm) Based on a list of generic name mapping rules, it trys to match the given name with the pattern to select the template.
static MonitorAction	getNewAction(java.util.Map props)
static MonitorReport	getNewReport(java.util.Map props)
static org.apache.oro.text.regex.Pattern[][]	getPatterns(java.lang.String name, java.util.Map ph, org.apache.oro.text.regex.Perl5Compiler pc)
static org.apache.oro.text.regex.Pattern[][]	getPatterns(java.lang.String name, java.util.Map ph, org.apache.oro.text.regex.Perl5Compiler pc, Template template, java.util.Map map)
static java.util.Map	getPrivateReport() returns the private report of current thread from default container
static java.util.Map	getReport(java.lang.String name) returns the report map of the name from the default container
static int	getReportMode(java.lang.String mode)
static java.lang.String[]	getSecondaryIncludes(java.lang.String[] primaryItems, java.util.Map policyMap, java.util.Map props) Given the names of primary includes, the policy map for secondary includes, and the master property map, it looks for all the names of secondary includes required by those the primarily included objects.
static java.lang.String[]	getSecondaryIncludes(java.lang.String[] primaryItems, java.lang.String cfgDir, java.util.Map policyMap) Given the names of primary includes, the policy map for secondary includes, and the name of the configration folder, it looks for names of all the secondary includes, required by the given primary includes.
static MonitorReport	getStaticDependency(java.util.Map props) return a MonitorReport for static dependency
static void	initReport(java.lang.String name, long tm, int status, int skip) initializes the report of the name in the default container
static void	initReport(java.lang.String name, java.lang.String[] keys, java.util.Map report, int mode) initializes the report of the name in the default container
static java.util.Map<java.lang.String,java.lang.String>	mergeSecondaryIncludes(java.lang.String listName, java.util.Map policyMap, java.util.Map group, java.util.Map props) It returns a Map with all names secondarily included in a given list of the primary objects.
static Event	runScript(java.lang.String program, int timeout) runs a script within the timeout and return an event.
static java.lang.String	select(java.lang.Object obj) use this with care since the dependency may not be defined.
static java.lang.String	substitute(java.lang.String input, Template template)
static java.lang.String	substitute(java.lang.String input, Template template, java.util.Map map)

Methods inherited from class java.lang.Object

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

Field Detail

REPT_STATUS

public static final int REPT_STATUS

See Also:

Constant Field Values

REPT_SKIP

public static final int REPT_SKIP

See Also:

Constant Field Values

REPT_TIME

public static final int REPT_TIME

See Also:

Constant Field Values

OS_NAME

public static final java.lang.String OS_NAME

OS_ARCH

public static final java.lang.String OS_ARCH

OS_VERSION

public static final java.lang.String OS_VERSION

FILE_SEPARATOR

public static final java.lang.String FILE_SEPARATOR

USER_NAME

public static final java.lang.String USER_NAME

JAVA_VERSION

public static final java.lang.String JAVA_VERSION

Constructor Detail

MonitorUtils

public MonitorUtils()

Method Detail

getDependencies

public static java.util.List[] getDependencies(java.util.List groupList)

getStaticDependency

public static MonitorReport getStaticDependency(java.util.Map props)

return a MonitorReport for static dependency

checkDependencies

public static int checkDependencies(long currentTime,
                                    java.util.List[] dependencies,
                                    java.lang.String prefix)

It returns MonitorReport.NOSKIP if there is at least one group of dependencies with status of NOSKIP. Otherwise, it returns either MonitorReport.DISABLED without exceptions or MonitorReport.EXCEPTION with exceptions.

NOSKIP: true
SKIPPED, DISABLED: false
EXCEPTION: exception

clearDependencies

public static void clearDependencies(java.util.List[] dependencies)

It cleans up all the dependency objects.

getReportMode

public static int getReportMode(java.lang.String mode)

getNewReport

public static MonitorReport getNewReport(java.util.Map props)

getNewAction

public static MonitorAction getNewAction(java.util.Map props)

runScript

public static Event runScript(java.lang.String program,
                              int timeout)

runs a script within the timeout and return an event. Caller is supposed to add name, site and other fields to the event and sends it

substitute

public static java.lang.String substitute(java.lang.String input,
                                          Template template)

substitute

public static java.lang.String substitute(java.lang.String input,
                                          Template template,
                                          java.util.Map map)

getPatterns

public static org.apache.oro.text.regex.Pattern[][] getPatterns(java.lang.String name,
                                                                java.util.Map ph,
                                                                org.apache.oro.text.regex.Perl5Compiler pc)
                                                         throws org.apache.oro.text.regex.MalformedPatternException

Throws:

org.apache.oro.text.regex.MalformedPatternException

getPatterns

public static org.apache.oro.text.regex.Pattern[][] getPatterns(java.lang.String name,
                                                                java.util.Map ph,
                                                                org.apache.oro.text.regex.Perl5Compiler pc,
                                                                Template template,
                                                                java.util.Map map)
                                                         throws org.apache.oro.text.regex.MalformedPatternException

Throws:

org.apache.oro.text.regex.MalformedPatternException

filter

public static boolean filter(java.lang.String text,
                             org.apache.oro.text.regex.Pattern[][] patterns,
                             org.apache.oro.text.regex.Perl5Matcher pm,
                             boolean def)

clearMapArray

public static void clearMapArray(java.util.Map[] hmGroup)

select

public static java.lang.String select(java.lang.Object obj)

use this with care since the dependency may not be defined. It returns the obj if obj is a String, otherwise return the String value for the first hit evaluation.

getIncludes

public static java.util.Map<java.lang.String,java.util.List> getIncludes(java.lang.String basename,
                                                                         java.util.Map<java.lang.String,java.lang.Object> includeGroup,
                                                                         java.util.Map props)

It returns a Map with the same keys of IncludeGroup and values of List that contains Sets for names of the primary includes. IncludeGroup is a Map that specifies the components to be primarily included in a given property Map with the name of basename. Its keys are either the basename or a property name for either a map or a list. The corresponding values are either a empty string or a list of names. It supports the following three scenarios:
LIST/LIST: {"MonitorGroup": ["Monitor"]}
LIST: {"Flow": ["Receiver", "Node", "Persister"]}
MAP: {"ConfigRepository": ""}


where Flow is the basename in this context.

The returned Map contains the same keys as those of IncludeGroup. But the value for ecah key is a List of Set for names of the primary includes. The index of the Set in the List is corresponding to the index of the group instance that contains the primary includes.

getSecondaryIncludes

public static java.lang.String[] getSecondaryIncludes(java.lang.String[] primaryItems,
                                                      java.util.Map policyMap,
                                                      java.util.Map props)

Given the names of primary includes, the policy map for secondary includes, and the master property map, it looks for all the names of secondary includes required by those the primarily included objects. The policyMap defines what types of the primary objects need to be examined for the secondary includes, via their classnames. It returns a String Array with all the names of the secondary includes. In case of failure, it returns an empty array.

getSecondaryIncludes

public static java.lang.String[] getSecondaryIncludes(java.lang.String[] primaryItems,
                                                      java.lang.String cfgDir,
                                                      java.util.Map policyMap)

Given the names of primary includes, the policy map for secondary includes, and the name of the configration folder, it looks for names of all the secondary includes, required by the given primary includes. The policyMap defines what types of the primary includes need to be examined for the secondary includes, via their classnames. Since the master property map is not provided, it tries to load the primary includes from the specified folder to look up properties. If saxParser is null, the config files are assumed to have the names with the extension of ".json". Upon success, it returns a String Array with the names of the all secondary includes. In case of failure, it returns an empty array.

mergeSecondaryIncludes

public static java.util.Map<java.lang.String,java.lang.String> mergeSecondaryIncludes(java.lang.String listName,
                                                                                      java.util.Map policyMap,
                                                                                      java.util.Map group,
                                                                                      java.util.Map props)

It returns a Map with all names secondarily included in a given list of the primary objects. The listName is the name of the list for the primary objects that need to be included from the configuration directory. The policyMap defines what types of the primary objects need to be examined for the secondary includes, via their classnames. The group contains all the 2nd includes temporarily. The props contains all the listed primary includes. Upon return, all the 2nd includes will be merged into their primary includes. The returned map contains the names for merged 2nd includes in the keySet. The value for each key is the name of the primary include.

getPrivateReport

public static java.util.Map getPrivateReport()

returns the private report of current thread from default container

getReport

public static java.util.Map getReport(java.lang.String name)

returns the report map of the name from the default container

initReport

public static void initReport(java.lang.String name,
                              long tm,
                              int status,
                              int skip)

initializes the report of the name in the default container

initReport

public static void initReport(java.lang.String name,
                              java.lang.String[] keys,
                              java.util.Map report,
                              int mode)

initializes the report of the name in the default container

getHeartbeat

public static int[] getHeartbeat(int[] group)

It generates the heartbeat array from the input array.

getGenericMapList

public static java.util.List<java.util.Map> getGenericMapList(java.util.List list,
                                                              org.apache.oro.text.regex.Perl5Compiler pc,
                                                              Template template)
                                                       throws org.apache.oro.text.regex.MalformedPatternException

It returns a list of maps with each map contains three objects of Pattern, TextSubstitution and Template. The list is for mapping a name into a new name with the hit pattern to select the substitution and/or the template.

Throws:

org.apache.oro.text.regex.MalformedPatternException

getMappedName

public static java.lang.String getMappedName(java.lang.String name,
                                             java.util.List<java.util.Map> mapList,
                                             org.apache.oro.text.regex.Perl5Matcher pm)

Based on a list of generic name mapping rules, it trys to match the given name with the pattern to select the substition. Once it finds a match, the name will be transformed with the substition rule. The result will be returned as the new name. Otherwise, the original name will be returned.

getMappedTemplate

public static Template getMappedTemplate(java.lang.String name,
                                         java.util.List<java.util.Map> mapList,
                                         org.apache.oro.text.regex.Perl5Matcher pm)

Based on a list of generic name mapping rules, it trys to match the given name with the pattern to select the template. Once it finds a match, the template will be returned. Otherwise, it returns null.