Package org.apache.camel.main

Class HttpManagementServerConfigurationProperties

java.lang.Object
org.apache.camel.main.HttpManagementServerConfigurationProperties
All Implemented Interfaces:
Closeable, AutoCloseable, org.apache.camel.spi.BootstrapCloseable
@Configurer(extended=true) public class HttpManagementServerConfigurationProperties extends Object implements org.apache.camel.spi.BootstrapCloseable
Configuration for embedded HTTP management server for standalone Camel applications (not Spring Boot / Quarkus).

  • Constructor Details

  • Method Details

    • end

      public MainConfigurationProperties end()

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • isEnabled

      public boolean isEnabled()

    • setEnabled

      public void setEnabled(boolean enabled)
      Whether embedded HTTP server is enabled. By default, the server is not enabled.

    • getHost

      public String getHost()

    • setHost

      public void setHost(String host)
      Hostname to use for binding embedded HTTP server

    • getPort

      public int getPort()

    • setPort

      public void setPort(int port)
      Port to use for binding embedded HTTP server

    • getPath

      public String getPath()

    • setPath

      public void setPath(String path)
      Context-path to use for embedded HTTP server

    • isUseGlobalSslContextParameters

      public boolean isUseGlobalSslContextParameters()

    • setUseGlobalSslContextParameters

      public void setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Whether to use global SSL configuration for securing the embedded HTTP server.

    • isInfoEnabled

      public boolean isInfoEnabled()

    • setInfoEnabled

      public void setInfoEnabled(boolean infoEnabled)
      Whether to enable info console. If enabled then you can see some basic Camel information at /observe/info

    • isDevConsoleEnabled

      public boolean isDevConsoleEnabled()

    • setDevConsoleEnabled

      public void setDevConsoleEnabled(boolean devConsoleEnabled)
      Whether to enable developer console (not intended for production use). Dev console must also be enabled on CamelContext. For example by setting camel.context.dev-console=true in application.properties, or via code camelContext.setDevConsole(true); If enabled then you can access a basic developer console on context-path: /q/dev.

    • isHealthCheckEnabled

      public boolean isHealthCheckEnabled()

    • setHealthCheckEnabled

      public void setHealthCheckEnabled(boolean healthCheckEnabled)
      Whether to enable health-check console. If enabled then you can access health-check status on context-path: /observe/health

    • isJolokiaEnabled

      public boolean isJolokiaEnabled()

    • setJolokiaEnabled

      public void setJolokiaEnabled(boolean jolokiaEnabled)
      Whether to enable jolokia. If enabled then you can access jolokia api on context-path: /observe/jolokia

    • isMetricsEnabled

      public boolean isMetricsEnabled()

    • setMetricsEnabled

      public void setMetricsEnabled(boolean metricsEnabled)
      Whether to enable metrics. If enabled then you can access metrics on context-path: /observe/metrics

    • getInfoPath

      public String getInfoPath()

    • setInfoPath

      public void setInfoPath(String infoPath)
      The path endpoint used to expose the info status

    • getHealthPath

      public String getHealthPath()

    • setHealthPath

      public void setHealthPath(String healthPath)
      The path endpoint used to expose the health status

    • getJolokiaPath

      public String getJolokiaPath()

    • setJolokiaPath

      public void setJolokiaPath(String jolokiaPath)
      The path endpoint used to expose the jolokia data.

    • isUploadEnabled

      public boolean isUploadEnabled()

    • setUploadEnabled

      public void setUploadEnabled(boolean uploadEnabled)
      Whether to enable file upload via HTTP (not intended for production use). This functionality is for development to be able to reload Camel routes and code with source changes (if reload is enabled). If enabled then you can upload/delete files via HTTP PUT/DELETE on context-path: /q/upload/{name}. You must also configure the uploadSourceDir option.

    • getUploadSourceDir

      public String getUploadSourceDir()

    • setUploadSourceDir

      public void setUploadSourceDir(String uploadSourceDir)
      Source directory when upload is enabled.

    • isDownloadEnabled

      public boolean isDownloadEnabled()

    • setDownloadEnabled

      public void setDownloadEnabled(boolean downloadEnabled)
      Whether to enable file download via HTTP. This makes it possible to browse and download resource source files such as Camel XML or YAML routes. Only enable this for development, troubleshooting or special situations for management and monitoring.

    • isSendEnabled

      public boolean isSendEnabled()

    • setSendEnabled

      public void setSendEnabled(boolean sendEnabled)
      Whether to enable sending messages to Camel via HTTP. This makes it possible to use Camel to send messages to Camel endpoint URIs via HTTP.

    • isAuthenticationEnabled

      public boolean isAuthenticationEnabled()

    • setAuthenticationEnabled

      public void setAuthenticationEnabled(boolean authenticationEnabled)
      Whether to enable HTTP authentication for embedded server (for standalone applications; not Spring Boot or Quarkus).

    • getAuthenticationPath

      public String getAuthenticationPath()

    • setAuthenticationPath

      public void setAuthenticationPath(String authenticationPath)
      Set HTTP url path of embedded server that is protected by authentication configuration.

    • getAuthenticationRealm

      public String getAuthenticationRealm()

    • setAuthenticationRealm

      public void setAuthenticationRealm(String authenticationRealm)
      Sets the authentication realm

    • getBasicPropertiesFile

      public String getBasicPropertiesFile()

    • setBasicPropertiesFile

      public void setBasicPropertiesFile(String basicPropertiesFile)
      Name of the file that contains basic authentication info for Vert.x file auth provider.

    • getJwtKeystoreType

      public String getJwtKeystoreType()

    • setJwtKeystoreType

      public void setJwtKeystoreType(String jwtKeystoreType)
      Type of the keystore used for JWT tokens validation (jks, pkcs12, etc.).

    • getJwtKeystorePath

      public String getJwtKeystorePath()

    • setJwtKeystorePath

      public void setJwtKeystorePath(String jwtKeystorePath)
      Path to the keystore file used for JWT tokens validation.

    • getJwtKeystorePassword

      public String getJwtKeystorePassword()

    • setJwtKeystorePassword

      public void setJwtKeystorePassword(String jwtKeystorePassword)
      Password from the keystore used for JWT tokens validation.

    • withEnabled

      public HttpManagementServerConfigurationProperties withEnabled(boolean enabled)
      Whether embedded HTTP management server is enabled. By default, the server is not enabled.

    • withHost

      public HttpManagementServerConfigurationProperties withHost(String host)
      Hostname to use for binding embedded HTTP management server

    • withPort

      public HttpManagementServerConfigurationProperties withPort(int port)
      Port to use for binding embedded HTTP management server

    • withPath

      public HttpManagementServerConfigurationProperties withPath(String path)
      Context-path to use for embedded HTTP management server

    • withUseGlobalSslContextParameters

      public HttpManagementServerConfigurationProperties withUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Whether to use global SSL configuration for securing the embedded HTTP management server.

    • withInfoEnabled

      public HttpManagementServerConfigurationProperties withInfoEnabled(boolean infoEnabled)
      Whether to enable info console. If enabled then you can see some basic Camel information at /observe/info

    • withDevConsoleEnabled

      public HttpManagementServerConfigurationProperties withDevConsoleEnabled(boolean devConsoleEnabled)
      Whether to enable developer console (not intended for production use). Dev console must also be enabled on CamelContext. For example by setting camel.context.dev-console=true in application.properties, or via code camelContext.setDevConsole(true); If enabled then you can access a basic developer console on context-path: /observe/dev.

    • withHealthCheckEnabled

      public HttpManagementServerConfigurationProperties withHealthCheckEnabled(boolean healthCheckEnabled)
      Whether to enable health-check console. If enabled then you can access health-check status on context-path: /observe/health (default)

    • withJolokiaEnabled

      public HttpManagementServerConfigurationProperties withJolokiaEnabled(boolean jolokiaEnabled)
      Whether to enable jolokia. If enabled then you can access jolokia api on context-path: /observe/jolokia

    • withMetricsEnabled

      public HttpManagementServerConfigurationProperties withMetricsEnabled(boolean metricsEnabled)
      Whether to enable metrics. If enabled then you can access metrics on context-path: /observe/metrics (default)

    • withUploadEnabled

      public HttpManagementServerConfigurationProperties withUploadEnabled(boolean uploadEnabled)
      Whether to enable file upload via HTTP (not intended for production use). This functionality is for development to be able to reload Camel routes and code with source changes (if reload is enabled). If enabled then you can upload/delete files via HTTP PUT/DELETE on context-path: /q/upload/{name}. You must also configure the uploadSourceDir option.

    • withUploadSourceDir

      public HttpManagementServerConfigurationProperties withUploadSourceDir(String uploadSourceDir)
      Source directory when upload is enabled.

    • withDownloadEnabled

      public HttpManagementServerConfigurationProperties withDownloadEnabled(boolean downloadEnabled)
      Whether to enable file download via HTTP. This makes it possible to browse and download resource source files such as Camel XML or YAML routes. Only enable this for development, troubleshooting or special situations for management and monitoring.

    • withSendEnabled

      public HttpManagementServerConfigurationProperties withSendEnabled(boolean sendEnabled)
      Whether to enable sending messages to Camel via HTTP. This makes it possible to use Camel to send messages to Camel endpoint URIs via HTTP.

    • withAuthenticationEnabled

      public HttpManagementServerConfigurationProperties withAuthenticationEnabled(boolean authenticationEnabled)
      Whether to enable HTTP authentication for embedded server (for standalone applications; not Spring Boot or Quarkus).

    • withAuthenticationPath

      public HttpManagementServerConfigurationProperties withAuthenticationPath(String authenticationPath)
      Set HTTP url path of embedded management server that is protected by authentication configuration.

    • withAuthenticationRealm

      public HttpManagementServerConfigurationProperties withAuthenticationRealm(String authenticationRealm)
      Sets the authentication realm

    • withBasicPropertiesFile

      public HttpManagementServerConfigurationProperties withBasicPropertiesFile(String basicPropertiesFile)
      Name of the file that contains basic authentication info for Vert.x file auth provider.

    • withJwtKeystoreType

      public HttpManagementServerConfigurationProperties withJwtKeystoreType(String jwtKeystoreType)
      Type of the keystore used for JWT tokens validation (jks, pkcs12, etc.).

    • withJwtKeystorePath

      public HttpManagementServerConfigurationProperties withJwtKeystorePath(String jwtKeystorePath)
      Path to the keystore file used for JWT tokens validation.

    • withJwtKeystorePassword

      public HttpManagementServerConfigurationProperties withJwtKeystorePassword(String jwtKeystorePassword)
      Password from the keystore used for JWT tokens validation.

    • withInfoPath

      public HttpManagementServerConfigurationProperties withInfoPath(String infoPath)
      The path endpoint used to expose the info status

    • withHealthPath

      public HttpManagementServerConfigurationProperties withHealthPath(String healthPath)
      The path endpoint used to expose the health status

    • withJolokiaPath

      public HttpManagementServerConfigurationProperties withJolokiaPath(String jolokiaPath)
      The path endpoint used to expose the jolokia data.