Interface CliConnectorFactory

public interface CliConnectorFactory
SPI factory for creating a CliConnector that enables Camel CLI management of a live integration.

The factory is discovered via the service key FACTORY using FactoryFinder when the camel-cli-connector module is on the classpath. At startup, CamelContext calls createConnector() and registers the returned connector as a managed Service. The factory also carries runtime metadata (platform name, version, main class) that the CLI uses to identify the integration process: setRuntime(String) / getRuntime(), setRuntimeVersion(String) / getRuntimeVersion(), and setRuntimeStartClass(String) / getRuntimeStartClass().

See Camel CLI (JBang) in the Camel user manual.

Since:
3.19
See Also:

  • Field Details

  • Method Details

    • setEnabled

      void setEnabled(boolean enabled)
      To enable CLI connector.

    • isEnabled

      boolean isEnabled()
      Whether CLI connector is enabled.

    • setRuntime

      void setRuntime(String runtime)
      What runtime platform is in use, such as camel-jbang, camel-spring-boot, or camel-quarkus etc.

    • getRuntime

      String getRuntime()
      What runtime platform is in use, such as camel-jbang, camel-spring-boot, or camel-quarkus etc.

    • setRuntimeVersion

      void setRuntimeVersion(String version)
      What runtime platform version is in use.

    • getRuntimeVersion

      String getRuntimeVersion()
      What runtime platform version is in use.

    • setRuntimeStartClass

      void setRuntimeStartClass(String className)
      The main class used by the runtime to start.

    • getRuntimeStartClass

      String getRuntimeStartClass()
      The main class used by the runtime to start.

    • createConnector

      CliConnector createConnector()
      Creates the connector which will be added as a Service to CamelContext as the lifecycle to start and stop the connector.