Package org.apache.camel.console

Interface DevConsoleRegistry

All Superinterfaces:
AutoCloseable, CamelContextAware, HasCamelContext, HasId, IdAware, Service, StaticService
public interface DevConsoleRegistry extends CamelContextAware, StaticService, IdAware
A registry for dev console.

  • Field Details

  • Method Details

    • isEnabled

      boolean isEnabled()
      Whether dev console is enabled globally

    • setEnabled

      void setEnabled(boolean enabled)
      Whether dev console is enabled globally

    • resolveById

      DevConsole resolveById(String id)
      Resolves DevConsole by id. Will first lookup in this DevConsoleRegistry and then Registry, and lastly do classpath scanning via ServiceFactory.
      Returns:
      either DevConsole, or null if none found.

    • register

      boolean register(DevConsole console)
      Registers a DevConsole.

    • unregister

      boolean unregister(DevConsole console)
      Unregisters a DevConsole.

    • getConsoleIDs

      default Collection<String> getConsoleIDs()
      A collection of dev console IDs.

    • getConsole

      default Optional<DevConsole> getConsole(String id)
      Returns the dev console identified by the given id if available.

    • get

      static DevConsoleRegistry get(CamelContext context)
      Returns an optional DevConsoleRegistry, by default no registry is present, and it must be explicit activated. Components can register/unregister dev consoles in response to life-cycle events (i.e. start/stop). This registry is not used by the camel context, but it is up to the implementation to properly use it.

    • stream

      Stream<DevConsole> stream()
      Returns a sequential Stream with the known DevConsole as its source.

    • loadDevConsoles

      void loadDevConsoles()
      Loads custom dev consoles by scanning classpath.

    • loadDevConsoles

      void loadDevConsoles(boolean force)
      Loads custom dev consoles by scanning classpath.
      Parameters:
      force - force re-scanning such as when additional JARs has been added to the classpath that can include custom dev consoles