Package org.apache.camel.main

Class HttpServerConfigurationProperties

java.lang.Object
org.apache.camel.main.HttpServerConfigurationProperties
All Implemented Interfaces:
Closeable, AutoCloseable, org.apache.camel.spi.BootstrapCloseable
@Configurer(extended=true) public class HttpServerConfigurationProperties extends Object implements org.apache.camel.spi.BootstrapCloseable
Configuration for embedded HTTP 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

    • getMaxBodySize

      public Long getMaxBodySize()

    • setMaxBodySize

      public void setMaxBodySize(Long maxBodySize)
      Maximum HTTP body size the embedded HTTP server can accept.

    • isUseGlobalSslContextParameters

      public boolean isUseGlobalSslContextParameters()

    • setUseGlobalSslContextParameters

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

    • isFileUploadEnabled

      public boolean isFileUploadEnabled()

    • setFileUploadEnabled

      public void setFileUploadEnabled(boolean fileUploadEnabled)
      Whether to enable file uploads being supported (such as POST multipart/form-data) and stored into a temporary directory.

    • getFileUploadDirectory

      public String getFileUploadDirectory()

    • setFileUploadDirectory

      public void setFileUploadDirectory(String fileUploadDirectory)
      Directory to temporary store file uploads while Camel routes the incoming request. If no directory has been explicit configured, then a temporary directory is created in the java.io.tmpdir directory.

    • isStaticEnabled

      public boolean isStaticEnabled()

    • setStaticEnabled

      public void setStaticEnabled(boolean staticEnabled)
      Whether serving static files is enabled. If enabled then Camel can host html/js and other web files that makes it possible to include small web applications.

    • getStaticSourceDir

      public String getStaticSourceDir()

    • setStaticSourceDir

      public void setStaticSourceDir(String staticSourceDir)
      Additional directory that holds static content when static is enabled.

    • getStaticContextPath

      public String getStaticContextPath()

    • setStaticContextPath

      public void setStaticContextPath(String staticContextPath)
      The context-path to use for serving static content. By default, the root path is used. And if there is an index.html page then this is automatically loaded.

    • 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 HttpServerConfigurationProperties withEnabled(boolean enabled)
      Whether embedded HTTP server is enabled. By default, the server is not enabled.

    • withHost

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

    • withPort

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

    • withPath

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

    • withMaxBodySize

      public HttpServerConfigurationProperties withMaxBodySize(long maxBodySize)
      Maximum HTTP body size the embedded HTTP server can accept.

    • withUseGlobalSslContextParameters

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

    • withFileUploadEnabled

      public HttpServerConfigurationProperties withFileUploadEnabled(boolean fileUploadEnabled)
      Whether to enable file uploads being supported (such as POST multipart/form-data) and stored into a temporary directory.

    • withFileUploadDirectory

      public HttpServerConfigurationProperties withFileUploadDirectory(String fileUploadDirectory)
      Directory to temporary store file uploads while Camel routes the incoming request. If no directory has been explicit configured, then a temporary directory is created in the java.io.tmpdir directory.

    • withStaticEnabled

      public HttpServerConfigurationProperties withStaticEnabled(boolean staticEnabled)
      Whether serving static files is enabled. If enabled then Camel can host html/js and other web files that makes it possible to include small web applications.

    • withStaticSourceDir

      public HttpServerConfigurationProperties withStaticSourceDir(String staticSourceDir)
      Additional directory that holds static content when static is enabled.

    • withStaticContextPath

      public HttpServerConfigurationProperties withStaticContextPath(String staticContextPath)
      The context-path to use for serving static content. By default, the root path is used. And if there is an index.html page then this is automatically loaded.

    • withAuthenticationEnabled

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

    • withAuthenticationPath

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

    • withAuthenticationRealm

      public HttpServerConfigurationProperties withAuthenticationRealm(String authenticationRealm)
      Sets the authentication realm

    • withBasicPropertiesFile

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

    • withJwtKeystoreType

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

    • withJwtKeystorePath

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

    • withJwtKeystorePassword

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