com.ibm.websphere.logging.hpel.reader

Class LogQueryBean

  • java.lang.Object
    • com.ibm.websphere.logging.hpel.reader.LogQueryBean
  • All Implemented Interfaces:
    java.io.Serializable


    public class LogQueryBean
    extends java.lang.Object
    implements java.io.Serializable
    Simple bean class to hold more static parts of a given query. The client layer in the remote reader infraStructure has several scenarios where it must reQuery the host with various differences (ie: populating the next serverInstance or populating the next n rows of the current server instance). This stores the parts of the query less likely to change in those scenarios.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      LogQueryBean()
      default constructor, allows use of the set methods
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      static java.util.regex.Pattern compile(java.lang.String pattern)
      compiles pattern string into regular expression Pattern object.
      boolean equals(java.lang.Object obj) 
      java.lang.String[] getExcludeLoggers()
      gets the current array of loggers to exclude (all regular expressions)
      java.lang.String[] getIncludeLoggers()
      gets the current array of loggers to include (all regular expressions)
      java.util.logging.Level getMaxLevel()
      gets current value of maximum level
      java.util.Date getMaxTime()
      gets the current value of the maximum time
      java.lang.String[] getMessageContent()
      gets current array of message content search strings
      java.util.logging.Level getMinLevel()
      gets the current value of minimum level
      java.util.Date getMinTime()
      gets the current value of the minimum time
      int[] getThreadIDs()
      gets current array of threads to search for specifically
      int hashCode() 
      void setExcludeLoggers(java.lang.String[] excludeLoggers)
      sets string array of loggers to exclude in query
      void setIncludeLoggers(java.lang.String[] includeLoggers)
      sets string array of loggers to include in query
      void setLevels(java.util.logging.Level minLevel, java.util.logging.Level maxLevel)
      sets the current value for the minimum and maximum levels
      void setMessageContent(java.lang.String[] messageContent)
      sets string array of message contents
      void setThreadIDs(int[] threadIDs)
      sets integer array of thread ids to search on
      void setThreadIDs(java.lang.String[] threadIDs)
      sets string array, each string representing the hex value of a thread to search on
      void setTime(java.util.Date minTime, java.util.Date maxTime)
      sets the current value for the minimum and maximum time
      java.lang.String toString() 
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • LogQueryBean

        public LogQueryBean()
        default constructor, allows use of the set methods
    • Method Detail

      • getMinTime

        public java.util.Date getMinTime()
        gets the current value of the minimum time
        Returns:
        minimum time
      • getMaxTime

        public java.util.Date getMaxTime()
        gets the current value of the maximum time
        Returns:
        maximum time
      • setTime

        public void setTime(java.util.Date minTime,
                            java.util.Date maxTime)
                     throws java.lang.IllegalArgumentException
        sets the current value for the minimum and maximum time
        Parameters:
        minTime - minimum time
        maxTime - maximum time
        Throws:
        java.lang.IllegalArgumentException - if minTime is later than maxTime
      • getMinLevel

        public java.util.logging.Level getMinLevel()
        gets the current value of minimum level
        Returns:
        minimum level
      • getMaxLevel

        public java.util.logging.Level getMaxLevel()
        gets current value of maximum level
        Returns:
        maximum level
      • setLevels

        public void setLevels(java.util.logging.Level minLevel,
                              java.util.logging.Level maxLevel)
                       throws java.lang.IllegalArgumentException
        sets the current value for the minimum and maximum levels
        Parameters:
        minLevel - minimum level
        Throws:
        java.lang.IllegalArgumentException - if minLevel is bigger than maxLevel
      • getMessageContent

        public java.lang.String[] getMessageContent()
        gets current array of message content search strings
        Returns:
        message content string (string to search message content for)
      • setMessageContent

        public void setMessageContent(java.lang.String[] messageContent)
                               throws java.lang.IllegalArgumentException
        sets string array of message contents
        Parameters:
        messageContent - array of strings, representing content to search messages for
        Throws:
        java.lang.IllegalArgumentException - if string contains illegal patterns
      • getIncludeLoggers

        public java.lang.String[] getIncludeLoggers()
        gets the current array of loggers to include (all regular expressions)
        Returns:
        include logger array
      • setIncludeLoggers

        public void setIncludeLoggers(java.lang.String[] includeLoggers)
                               throws java.lang.IllegalArgumentException
        sets string array of loggers to include in query
        Parameters:
        includeLoggers - array of strings, each being a regular expression search for loggers
        Throws:
        java.lang.IllegalArgumentException - if strings contain illegal patterns
      • getExcludeLoggers

        public java.lang.String[] getExcludeLoggers()
        gets the current array of loggers to exclude (all regular expressions)
        Returns:
        exclude logger array
      • setExcludeLoggers

        public void setExcludeLoggers(java.lang.String[] excludeLoggers)
                               throws java.lang.IllegalArgumentException
        sets string array of loggers to exclude in query
        Parameters:
        excludeLoggers - array of strings, each being a regular expression search for loggers to exclude
        Throws:
        java.lang.IllegalArgumentException - if strings contain illegal patterns
      • compile

        public static java.util.regex.Pattern compile(java.lang.String pattern)
                                               throws java.lang.IllegalArgumentException
        compiles pattern string into regular expression Pattern object.
        Parameters:
        pattern - string containing WebSphere console specific pattern
        Returns:
        compiled version of the string
        Throws:
        java.lang.IllegalArgumentException - if pattern is null or contains an illegal pattern.
      • getThreadIDs

        public int[] getThreadIDs()
        gets current array of threads to search for specifically
        Returns:
        array of threads in search
      • setThreadIDs

        public void setThreadIDs(int[] threadIDs)
        sets integer array of thread ids to search on
        Parameters:
        threadIDs - array of thread ids (null if not filtering on threadId)
      • setThreadIDs

        public void setThreadIDs(java.lang.String[] threadIDs)
                          throws java.lang.IllegalArgumentException
        sets string array, each string representing the hex value of a thread to search on
        Parameters:
        threadIDs - array of thread ids (hex) (null if not filtering on threadId)
        Throws:
        java.lang.IllegalArgumentException - if strings contain something other than hexadecimal values.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object