Interface RouteDiagramDumper

public interface RouteDiagramDumper
To dump routes as visual diagrams as PNG images.
Since:
4.21

  • Field Details

  • Method Details

    • dumpRoutesToFile

      void dumpRoutesToFile(String filter, RouteDiagramDumper.Theme theme, File file) throws IOException
      Dumps the routes as PNG files in the given file
      Parameters:
      filter - to filter routes
      theme - the coloring theme
      file - the name of the file to store
      Throws:
      IOException

    • dumpRoutesToFolder

      void dumpRoutesToFolder(String filter, RouteDiagramDumper.Theme theme, File folder) throws IOException
      Dumps the routes as PNG files in the given folder
      Parameters:
      filter - to filter routes
      theme - the coloring theme
      folder - the folder to store the files
      Throws:
      IOException

    • dumpRoutesAsImage

      default BufferedImage dumpRoutesAsImage(String filter, RouteDiagramDumper.Theme theme)
      Dumps the routes as a PNG image
      Parameters:
      filter - to filter routes
      theme - the coloring theme

    • dumpRoutesAsImage

      BufferedImage dumpRoutesAsImage(String filter, RouteDiagramDumper.Theme theme, boolean metrics, RouteDiagramDumper.NodeLabelMode nodeLabel, int nodeWidth, int fontSize)
      Dumps the routes as a PNG image
      Parameters:
      filter - to filter routes
      theme - the coloring theme
      metrics - whether to include live metric counters
      nodeLabel - what information to display in the nodes
      nodeWidth - the width in pixels of the node boxes
      fontSize - the font size

    • imageToBase64

      String imageToBase64(BufferedImage image) throws IOException
      Converts the image to base64
      Throws:
      IOException

    • dumpRoutesAsAsciiArt

      default String dumpRoutesAsAsciiArt(String filter)
      Dumps the routes as ASCII art text
      Parameters:
      filter - to filter routes

    • dumpRoutesAsAsciiArt

      default String dumpRoutesAsAsciiArt(String filter, RouteDiagramDumper.NodeLabelMode nodeLabel, int nodeWidth)
      Dumps the routes as ASCII art text
      Parameters:
      filter - to filter routes
      nodeLabel - what information to display in the nodes
      nodeWidth - the width in pixels of the node boxes

    • dumpRoutesAsAsciiArt

      default String dumpRoutesAsAsciiArt(String filter, RouteDiagramDumper.NodeLabelMode nodeLabel, int nodeWidth, boolean unicode)
      Dumps the routes as ASCII art or Unicode box-drawing text
      Parameters:
      filter - to filter routes
      nodeLabel - what information to display in the nodes
      nodeWidth - the width in pixels of the node boxes
      unicode - whether to use Unicode box-drawing characters

    • dumpTopologyToFolder

      default void dumpTopologyToFolder(RouteDiagramDumper.Theme theme, boolean external, File folder) throws IOException
      Dumps the route topology as a PNG file in the given folder
      Parameters:
      theme - the coloring theme
      external - whether to include external systems (kafka, http, etc.)
      folder - the folder to store the file
      Throws:
      IOException
      Since:
      4.21

    • dumpTopologyAsAsciiArt

      default String dumpTopologyAsAsciiArt(int nodeWidth, boolean unicode)
      Dumps the route topology as ASCII art or Unicode box-drawing text
      Parameters:
      nodeWidth - the width in pixels of the node boxes
      unicode - whether to use Unicode box-drawing characters
      Since:
      4.21

    • dumpTopologyAsAsciiArt

      default String dumpTopologyAsAsciiArt(int nodeWidth, boolean unicode, boolean external)
      Dumps the route topology as ASCII art or Unicode box-drawing text
      Parameters:
      nodeWidth - the width in pixels of the node boxes
      unicode - whether to use Unicode box-drawing characters
      external - whether to include external systems (kafka, http, etc.)
      Since:
      4.21

    • dumpTopologyAsImage

      default BufferedImage dumpTopologyAsImage(RouteDiagramDumper.Theme theme, boolean metrics, int nodeWidth, int fontSize)
      Dumps the route topology as a PNG image
      Parameters:
      theme - the coloring theme
      metrics - whether to include live metric counters
      nodeWidth - the width in pixels of the node boxes
      fontSize - the font size
      Since:
      4.21

    • dumpTopologyAsImage

      default BufferedImage dumpTopologyAsImage(RouteDiagramDumper.Theme theme, boolean metrics, int nodeWidth, int fontSize, boolean external)
      Dumps the route topology as a PNG image
      Parameters:
      theme - the coloring theme
      metrics - whether to include live metric counters
      nodeWidth - the width in pixels of the node boxes
      fontSize - the font size
      external - whether to include external systems (kafka, http, etc.)
      Since:
      4.21