com.ibm.websphere.pmi.stat

Class WSStatsHelper

  1. java.lang.Object
  2. extended bycom.ibm.websphere.pmi.stat.WSStatsHelper

  1. public class WSStatsHelper
  2. extends java.lang.Object
Stats helper class. This class helps to enable/disable textual information (name, description, and unit) in the Stats object. By default, textual information is enabled with default Locale.
The Stats textual information is initialized in the client side. This initialization happens automatically when the Stats configuration files are located in the classpath.
If the Stats configuration files are not in classpath then the client side should be initialized with the Stats configuration objects using initTextInfo method. The Stats configuration objects can be obtained from the server by invoking public PmiModuleConfig[] getConfigs(java.util.Locale locale) on the Perf MBean.

Constructor Summary

Constructor and Description
WSStatsHelper()

Method Summary

Modifier and Type Method and Description
  1. static
  2. boolean
getTextInfoEnabled()
Returns true if textual information is enabled.
  1. static
  2. boolean
getTextInfoTranslationEnabled()
Returns true if textual information translation is enabled.
  1. static
  2. java.util.Locale
getTextInfoTranslationLocale()
Returns the Locale that is used for textual information translation.
  1. static
  2. void
initTextInfo(PmiModuleConfig[] cfg,java.util.Locale locale)
Initialize the client side with the Stats configuration objects.
  1. static
  2. void
setTextInfoEnabled(boolean textInfoEnabled)
This method is use to enable/disable the textual information in the Stats object.
  1. static
  2. void
setTextInfoTranslationEnabled(boolean textInfoTranslationEnabled,java.util.Locale locale)
This method allows translation of the textual information.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WSStatsHelper

  1. public WSStatsHelper()

Method Detail

initTextInfo

  1. public static void initTextInfo( PmiModuleConfig[] cfg,
  2. java.util.Locale locale)
Initialize the client side with the Stats configuration objects.
Parameters:
cfg - Stats configuration object from the server
locale - Locale of the configuration

setTextInfoEnabled

  1. public static void setTextInfoEnabled( boolean textInfoEnabled)
This method is use to enable/disable the textual information in the Stats object. By default textual information is enabled.
Parameters:
textInfoEnabled - enable/disable

setTextInfoTranslationEnabled

  1. public static void setTextInfoTranslationEnabled( boolean textInfoTranslationEnabled,
  2. java.util.Locale locale)
This method allows translation of the textual information. By default translation is enabled using the default Locale.
Parameters:
textInfoTranslationEnabled - enable/disable
locale - Locale to use for translation

getTextInfoEnabled

  1. public static boolean getTextInfoEnabled( )
Returns true if textual information is enabled.
Returns:
true - enabled; false - disabled

getTextInfoTranslationEnabled

  1. public static boolean getTextInfoTranslationEnabled( )
Returns true if textual information translation is enabled.
Returns:
true - enabled; false - disabled

getTextInfoTranslationLocale

  1. public static java.util.Locale getTextInfoTranslationLocale( )
Returns the Locale that is used for textual information translation.
Returns:
Locale used for translation