com.ibm.rational.test.lt.kernel.logging

Interface IHistory



  • public interface IHistory
    Interface for processing execution history events produced by a tests running in the engine.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void close()
      Do any special processing that is required to cleanly end an execution history
      void deleteTempFiles()
      Delete any temp files associated with the execution history (see ICache and IAnnotation.)
      void flush()
      Make sure that all accepted events are delivered.
      void flush(boolean waitFlag)
      Make sure that all accepted events are delivered.
      IAnnotation getAnnotation()
      Get the IAnnotation (if any) associated with this execution history
      ICache getCache() 
      IQueue getQueue() 
      long getTotalHistorySize()
      Total history size.
      boolean isAlwaysLog() 
      void pause()
      Temporarily suspend the delivery of execution history events
      void resume()
      Resume delivering execution history events
      void setAlwaysLog(boolean value)
      This is used for overriding options set in schedule logging.
      boolean writeEvent(org.eclipse.hyades.test.common.event.ExecutionEvent e, int level)
      Writes a hyades ExecutionEvent to the execution history.
    • Method Detail

      • writeEvent

        boolean writeEvent(org.eclipse.hyades.test.common.event.ExecutionEvent e,
                         int level)
        Writes a hyades ExecutionEvent to the execution history. The level specifies the history level for which this event applies. If there is an associated cache, the event (and level) is offered to the cache via ICache.write() which returns true if the event is cached, or false if not. The ICache.write() returns false writeEvent() then processes the event, returning true if the event is accepted or false if the event cannot be processed.
        Parameters:
        e - The execution history event
        level - the level for this event
        Returns:
        true iff the event was accepted (history is not closed)
      • flush

        void flush()
        Make sure that all accepted events are delivered. flush() does not return until all events are processed.
      • flush

        void flush(boolean waitFlag)
        Make sure that all accepted events are delivered. If waitFlag is true, wait for all events to be processed, else return immediately after beginning the flush allowing the processing to occur in the background.
        Parameters:
        waitFlag -
      • close

        void close()
        Do any special processing that is required to cleanly end an execution history
      • deleteTempFiles

        void deleteTempFiles()
        Delete any temp files associated with the execution history (see ICache and IAnnotation.)
      • getAnnotation

        IAnnotation getAnnotation()
        Get the IAnnotation (if any) associated with this execution history
        Returns:
        the IAnnotation
      • pause

        void pause()
        Temporarily suspend the delivery of execution history events
      • resume

        void resume()
        Resume delivering execution history events
      • getTotalHistorySize

        long getTotalHistorySize()
        Total history size.
      • setAlwaysLog

        void setAlwaysLog(boolean value)
        This is used for overriding options set in schedule logging. It is used for a value you always want logged regardless of logging level.
        Parameters:
        value - - used to set flag to always log
      • isAlwaysLog

        boolean isAlwaysLog()
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.