Package org.apache.camel.spi

Interface RuntimeEndpointRegistry

All Superinterfaces:
AutoCloseable, Service, StaticService
public interface RuntimeEndpointRegistry extends StaticService
A registry which listen for runtime usage of Endpoint during routing in Camel.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    RuntimeEndpointRegistry.Statistic
    Statistics gathered about the endpoint.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Clears the registry
    List<String>
    getAllEndpoints(boolean includeInputs)
    Gets all the endpoint uris captured during runtime routing that are in-use of the routes.
    List<String>
    getEndpointsPerRoute(String routeId, boolean includeInputs)
    Gets all the endpoint uris captured from the given route during runtime routing that are in-use of the routes.
    List<RuntimeEndpointRegistry.Statistic>
    getEndpointStatistics()
    Gets details about all the endpoint captured from the given route during runtime routing that are in-use of the routes.
    int
    getLimit()
    Maximum number of endpoints to keep in the cache per route.
    boolean
    isEnabled()
    Whether gathering runtime usage is enabled or not.
    void
    reset()
    Reset the statistic counters
    void
    setEnabled(boolean enabled)
    Sets whether gathering runtime usage is enabled or not.
    void
    setLimit(int limit)
    Sets the maximum number of endpoints to keep in the cache per route.
    int
    size()
    Number of endpoints currently in the cache.

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

  • Method Details

    • isEnabled

      boolean isEnabled()
      Whether gathering runtime usage is enabled or not.

    • setEnabled

      void setEnabled(boolean enabled)
      Sets whether gathering runtime usage is enabled or not.

    • getLimit

      int getLimit()
      Maximum number of endpoints to keep in the cache per route.

      The default value is 1000

    • setLimit

      void setLimit(int limit)
      Sets the maximum number of endpoints to keep in the cache per route.

    • clear

      void clear()
      Clears the registry

    • reset

      void reset()
      Reset the statistic counters

    • size

      int size()
      Number of endpoints currently in the cache.

    • getAllEndpoints

      List<String> getAllEndpoints(boolean includeInputs)
      Gets all the endpoint uris captured during runtime routing that are in-use of the routes.
      Parameters:
      includeInputs - whether to include route inputs

    • getEndpointsPerRoute

      List<String> getEndpointsPerRoute(String routeId, boolean includeInputs)
      Gets all the endpoint uris captured from the given route during runtime routing that are in-use of the routes.
      Parameters:
      routeId - the route id
      includeInputs - whether to include route inputs

    • getEndpointStatistics

      List<RuntimeEndpointRegistry.Statistic> getEndpointStatistics()
      Gets details about all the endpoint captured from the given route during runtime routing that are in-use of the routes.