com.ibm.ws.performance.tuning.rule

Class RuleOutput

  • java.lang.Object
    • com.ibm.ws.performance.tuning.rule.RuleOutput
  • All Implemented Interfaces:
    java.io.Serializable


    public class RuleOutput
    extends java.lang.Object
    implements java.io.Serializable
    This class represents the advise which is the result of executing advisor rules. This class contains the severity, message and a set of symptoms. It also contains a placeholder object for a recommended configuration.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      RuleOutput(int type, com.ibm.ws.performance.tuning.rule.MessageWrapper msg, com.ibm.ws.performance.tuning.rule.MessageWrapper sym, SuggestedConfig[] cfg) 
      RuleOutput(java.lang.String title, com.ibm.websphere.pmi.client.PerfDescriptor myDD, int type, com.ibm.ws.performance.tuning.rule.MessageWrapper msg, com.ibm.ws.performance.tuning.rule.MessageWrapper[] syms, SuggestedConfig[] cfg) 
      RuleOutput(java.lang.String title, com.ibm.websphere.pmi.client.PerfDescriptor myDD, int type, com.ibm.ws.performance.tuning.rule.MessageWrapper msg, com.ibm.ws.performance.tuning.rule.MessageWrapper sym, SuggestedConfig[] cfg) 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addAdditionalInformation(com.ibm.ws.performance.tuning.rule.MessageWrapper sym) 
      void addSympton(com.ibm.ws.performance.tuning.rule.MessageWrapper sym) 
      java.lang.String getAction()
      Returns the action that an user should take to resolve the problem.
      java.lang.String[] getAdditionalInformation()
      Returns additional information, if any.
      java.lang.String getDescription()
      Returns the detailed description of the Rule Output.
      java.lang.String getMessage()
      Returns the message of the Rule Output.
      java.lang.Object[] getMessageArgs() 
      java.lang.String getMessageId() 
      java.lang.String getName()
      Returns the name of the Rule.
      java.lang.String getNodeName() 
      int getOutputType()
      Returns the type of the Rule Output.
      com.ibm.websphere.pmi.client.PerfDescriptor getPerfDescriptor()
      Returns the stats module representation.
      java.lang.String getServerName() 
      SuggestedConfig[] getSuggestedCfg()
      Returns the suggested configuration changes, if any, to resolve the problem.
      java.lang.String[] getSymptoms()
      Returns the symptoms which resulted in the advise output.This returns an array of strings containing the message.
      void setLocale(java.util.Locale locale)
      Set the Locale of the Rule Output.
      java.lang.String toString()
      Returns the RuleOutput as a string for debug.
      void updateOutputType(int type) 
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • RuleOutput

        public RuleOutput(int type,
                  com.ibm.ws.performance.tuning.rule.MessageWrapper msg,
                  com.ibm.ws.performance.tuning.rule.MessageWrapper sym,
                  SuggestedConfig[] cfg)
      • RuleOutput

        public RuleOutput(java.lang.String title,
                  com.ibm.websphere.pmi.client.PerfDescriptor myDD,
                  int type,
                  com.ibm.ws.performance.tuning.rule.MessageWrapper msg,
                  com.ibm.ws.performance.tuning.rule.MessageWrapper sym,
                  SuggestedConfig[] cfg)
      • RuleOutput

        public RuleOutput(java.lang.String title,
                  com.ibm.websphere.pmi.client.PerfDescriptor myDD,
                  int type,
                  com.ibm.ws.performance.tuning.rule.MessageWrapper msg,
                  com.ibm.ws.performance.tuning.rule.MessageWrapper[] syms,
                  SuggestedConfig[] cfg)
    • Method Detail

      • setLocale

        public void setLocale(java.util.Locale locale)
        Set the Locale of the Rule Output.
      • addSympton

        public void addSympton(com.ibm.ws.performance.tuning.rule.MessageWrapper sym)
      • getName

        public java.lang.String getName()
        Returns the name of the Rule.
      • getPerfDescriptor

        public com.ibm.websphere.pmi.client.PerfDescriptor getPerfDescriptor()
        Returns the stats module representation.
      • getOutputType

        public int getOutputType()
        Returns the type of the Rule Output. For example 101=NO_PROBLEM, 102=WARNING, 103=ALERT, 104=ALERT, 105=CONFIG_ALERT, 106=CANCEL_ALERT, 108=FATAL.
      • updateOutputType

        public void updateOutputType(int type)
      • getMessage

        public java.lang.String getMessage()
        Returns the message of the Rule Output.
      • getMessageId

        public java.lang.String getMessageId()
      • getMessageArgs

        public java.lang.Object[] getMessageArgs()
      • getDescription

        public java.lang.String getDescription()
        Returns the detailed description of the Rule Output.
      • getAction

        public java.lang.String getAction()
        Returns the action that an user should take to resolve the problem.
      • getSymptoms

        public java.lang.String[] getSymptoms()
        Returns the symptoms which resulted in the advise output.This returns an array of strings containing the message.
      • getSuggestedCfg

        public SuggestedConfig[] getSuggestedCfg()
        Returns the suggested configuration changes, if any, to resolve the problem.
      • getServerName

        public java.lang.String getServerName()
      • getNodeName

        public java.lang.String getNodeName()
      • getAdditionalInformation

        public java.lang.String[] getAdditionalInformation()
        Returns additional information, if any.
      • addAdditionalInformation

        public void addAdditionalInformation(com.ibm.ws.performance.tuning.rule.MessageWrapper sym)
      • toString

        public java.lang.String toString()
        Returns the RuleOutput as a string for debug.
        Overrides:
        toString in class java.lang.Object
IBM WebSphere Application ServerTM
Release 8.5