Package org.ow2.clif.analyze.api

Interface AnalyzerExternalAccess

  • public interface AnalyzerExternalAccess
    Provide an external access interface to Analyzer.
    Author:
    Grégory CALONNIER, Jordan BRUNIER

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ANALYZER_EXTERNAL_ACCESS
      The Constant ANALYZER_EXTERNAL_ACCESS.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void closeEventIterator​(java.io.Serializable iteratorKey)
      Discards the iterator associated to the given key, possibly releasing resources.
      long countEvents​(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter)
      Counts the number of available events matching a given filter.
      java.util.Properties getBladeProperties​(java.lang.String testName, java.lang.String bladeId)
      Gets the java system properties for the given blade from the given test run.
      java.lang.String[] getEventFieldLabels​(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel)
      Gets the labels of fields hold by a given event type.
      java.io.Serializable getEventIterator​(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter)
      Creates an event iterator.
      BladeEvent[] getNextEvents​(java.io.Serializable iteratorKey, int count)
      Gets next events from the given event iterator.
      BladeDescriptor[] getTestPlan​(java.lang.String testName, BladeFilter filter)
      Gets the test plan definition for a given test run name.
      TestDescriptor[] getTests​(TestFilter filter)
      Gets a list of test runs matching a given filter.

    • Field Detail

      • ANALYZER_EXTERNAL_ACCESS

        static final java.lang.String ANALYZER_EXTERNAL_ACCESS
        The Constant ANALYZER_EXTERNAL_ACCESS.
        See Also:
        Constant Field Values

    • Method Detail

      • getTests

        TestDescriptor[] getTests​(TestFilter filter)
                   throws ClifException
        Gets a list of test runs matching a given filter.
        Parameters:
        filter - the test run filter. If null, all available test runs are returned.
        Returns:
        an array of test run descriptors
        Throws:
        ClifException - the clif exception

      • getBladeProperties

        java.util.Properties getBladeProperties​(java.lang.String testName,
                                        java.lang.String bladeId)
                                 throws ClifException
        Gets the java system properties for the given blade from the given test run.
        Parameters:
        testName - the test run name
        bladeId - the blade identifier
        Returns:
        the Java system properties for the given blade
        Throws:
        ClifException - the clif exception

      • getTestPlan

        BladeDescriptor[] getTestPlan​(java.lang.String testName,
                              BladeFilter filter)
                       throws ClifException
        Gets the test plan definition for a given test run name.
        Parameters:
        filter - retains only blades (injectors, probes) accepted by this filter. If null, all blades are retained.
        testName - the test run name
        Returns:
        an array of descriptors for blades composing the test run and accepted by the optional filter.
        Throws:
        ClifException - the clif exception

      • getEventFieldLabels

        java.lang.String[] getEventFieldLabels​(java.lang.String testName,
                                       java.lang.String bladeId,
                                       java.lang.String eventTypeLabel)
        Gets the labels of fields hold by a given event type.
        Parameters:
        testName - the test run name
        bladeId - the blade identifier from the given test run
        eventTypeLabel - the label of the event type
        Returns:
        an array of event field labels provided by the given event type

      • getEventIterator

        java.io.Serializable getEventIterator​(java.lang.String testName,
                                      java.lang.String bladeId,
                                      java.lang.String eventTypeLabel,
                                      EventFilter filter)
                               throws ClifException
        Creates an event iterator.
        Parameters:
        testName - the test name to retrieve events from
        bladeId - the blade identifier in this test to retrieve events from
        eventTypeLabel - the type label of the retrieved events
        filter - the filter object to be used for event selection. If null, the iterator will return all events. The filter object may throw a NoMoreEvent exception, in which case current iterator step stops and currently selected events are returned.
        Returns:
        the iterator key to be used to iterate on getting events, and then to discard the iterator when done
        Throws:
        ClifException - the given test, blade, or event type could not be found
        See Also:
        getNextEvents(Serializable, int), closeEventIterator(Serializable)

      • closeEventIterator

        void closeEventIterator​(java.io.Serializable iteratorKey)
        Discards the iterator associated to the given key, possibly releasing resources.
        Parameters:
        iteratorKey - the key for the target event iterator

      • countEvents

        long countEvents​(java.lang.String testName,
                 java.lang.String bladeId,
                 java.lang.String eventTypeLabel,
                 EventFilter filter)
          throws ClifException
        Counts the number of available events matching a given filter.
        Parameters:
        testName - the test name to retrieve events from
        bladeId - the blade identifier in this test to retrieve events from
        eventTypeLabel - the type label of the retrieved events
        filter - the filter object to be used for event selection. If null, all events are counted. Counting stops before completion if the filter object throws a NoMoreEvent exception, in which case count value before exception is returned.
        Returns:
        the number of available blade events matching the provided filter.
        Throws:
        ClifException - the clif exception