Package kieker.monitoring.core.controller

Interface IProbeController

All Known Subinterfaces:
IMonitoringController
All Known Implementing Classes:
MonitoringController, ProbeController
public interface IProbeController
Since:
1.6
Author:
Jan Waller

  • Method Summary

    Modifier and Type Method Description
    boolean activateProbe​(java.lang.String pattern)
    Activates a probe.
    void addPatternParameter​(java.lang.String pattern, java.lang.String name, java.util.List<java.lang.String> values)
    Adds or updates a parameter for the given pattern.
    void addPatternParameterValue​(java.lang.String pattern, java.lang.String name, java.lang.String value)
    Add one value to a list of parameter values for a pattern.
    void clearPatternParameters​(java.lang.String pattern)
    Deletes all parameters from the given pattern.
    boolean deactivateProbe​(java.lang.String pattern)
    Deactivates a probe.
    void deletePatternParameter​(java.lang.String pattern, java.lang.String name)
    Deletes a parameter from the given pattern.
    java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getAllPatternParameters​(java.lang.String pattern)
    Looks up the parameters for a probe /the pattern of the probe and returns them, may be null.
    java.util.List<java.lang.String> getProbePatternList()
    Returns the current list of patterns with a prefix indicating whether the pattern is active or not.
    boolean isProbeActivated​(java.lang.String signature)
    Tests if a probe is active.
    void removePatternParameterValue​(java.lang.String pattern, java.lang.String name, java.lang.String value)
    Remove one value to a list of parameter values for a pattern.
    void setProbePatternList​(java.util.List<java.lang.String> patternList)
    Overwrites the current list of patterns with a new pattern list.

  • Method Details

    • activateProbe

      boolean activateProbe​(java.lang.String pattern)
      Activates a probe.
      Parameters:
      pattern - pattern for the probe
      Returns:
      true on success
      Since:
      1.6

    • deactivateProbe

      boolean deactivateProbe​(java.lang.String pattern)
      Deactivates a probe.
      Parameters:
      pattern - pattern for the probe
      Returns:
      true on success
      Since:
      1.6

    • isProbeActivated

      boolean isProbeActivated​(java.lang.String signature)
      Tests if a probe is active. This test is ignorant of the fact whether monitoring itself is enabled/disabled/terminated.
      Parameters:
      signature - signature of the probe
      Returns:
      true if the probe with this signature is active
      Since:
      1.6

    • setProbePatternList

      void setProbePatternList​(java.util.List<java.lang.String> patternList)
      Overwrites the current list of patterns with a new pattern list.
      Parameters:
      patternList - list of strings with patterns where each string starts either with a + or -. The list can be empty (in which case the internal pattern list and the internal cache are cleared) - but not null.
      Since:
      1.6

    • getProbePatternList

      java.util.List<java.lang.String> getProbePatternList()
      Returns the current list of patterns with a prefix indicating whether the pattern is active or not.
      Returns:
      list of strings with patterns where each string starts either with a + or -
      Since:
      1.6

    • getAllPatternParameters

      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getAllPatternParameters​(java.lang.String pattern)
      Looks up the parameters for a probe /the pattern of the probe and returns them, may be null.
      Parameters:
      pattern - The pattern of the probe.
      Returns:
      The parameters of the probe, may be null.
      Since:
      1.14

    • deletePatternParameter

      void deletePatternParameter​(java.lang.String pattern, java.lang.String name)
      Deletes a parameter from the given pattern.
      Parameters:
      pattern - The parameters to be deleted.
      name - The name of the parameter.
      Since:
      1.14

    • clearPatternParameters

      void clearPatternParameters​(java.lang.String pattern)
      Deletes all parameters from the given pattern.
      Parameters:
      pattern - The parameters to be deleted.
      Since:
      1.14

    • addPatternParameter

      void addPatternParameter​(java.lang.String pattern, java.lang.String name, java.util.List<java.lang.String> values)
      Adds or updates a parameter for the given pattern.
      Parameters:
      pattern - The pattern of the probe.
      name - The name of the parameter.
      values - a List of entries for this parameter.
      Since:
      1.14

    • addPatternParameterValue

      void addPatternParameterValue​(java.lang.String pattern, java.lang.String name, java.lang.String value)
      Add one value to a list of parameter values for a pattern.
      Parameters:
      pattern - identifying the pattern for the parameter
      name - name of the parameter
      value - value to be added to the list of parameter values.
      Since:
      1.15

    • removePatternParameterValue

      void removePatternParameterValue​(java.lang.String pattern, java.lang.String name, java.lang.String value)
      Remove one value to a list of parameter values for a pattern.
      Parameters:
      pattern - identifying the pattern for the parameter
      name - name of the parameter
      value - value to be removed from the list of parameter values.
      Since:
      1.15