Interface RouteTopologyDumper

public interface RouteTopologyDumper

SPI that analyses the active Camel routes and computes a graph describing how they interconnect through shared endpoints.

The implementation is discovered via the service key FACTORY. The single dumpTopology(org.apache.camel.CamelContext) method returns a RouteTopologyDumper.TopologyResult record containing: RouteTopologyDumper.TopologyNode entries (one per route, classified as route or trigger), RouteTopologyDumper.TopologyEdge entries (connections between two routes via a shared endpoint URI, classified as internal for direct/seda or external for remote transports), and RouteTopologyDumper.TopologyExternalEndpoint entries (remote systems a route talks to). The developer console uses this output to render an interactive route graph.

See Camel CLI (camel-jbang) for the developer console that renders this graph.

Since:

4.21

See Also:

• ModelToXMLDumper
• ModelToYAMLDumper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	RouteTopologyDumper.TopologyEdge	An edge in the topology representing a connection between two routes via a shared endpoint.
static final record	RouteTopologyDumper.TopologyExternalEndpoint	An external endpoint representing a remote system that a route communicates with.
static final record	RouteTopologyDumper.TopologyNode	A node in the topology representing a route.
static final record	RouteTopologyDumper.TopologyResult	The result of computing route topology.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FACTORY	Service factory key.

Method Summary

Modifier and Type	Method	Description
RouteTopologyDumper.TopologyResult	dumpTopology(CamelContext context)	Computes the inter-route topology by analyzing route definitions and matching endpoints across routes.

Field Details

FACTORY

static final String FACTORY

Service factory key.

See Also:

• Constant Field Values

Method Details

dumpTopology

RouteTopologyDumper.TopologyResult dumpTopology(CamelContext context)

Computes the inter-route topology by analyzing route definitions and matching endpoints across routes.

Parameters:

context - the CamelContext

Returns:

the topology result with nodes and edges