Package org.apache.camel.builder.component.dsl

Interface JettyComponentBuilderFactory.JettyComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.jetty12.JettyHttpComponent12>
All Known Implementing Classes:
JettyComponentBuilderFactory.JettyComponentBuilderImpl
Enclosing interface:
JettyComponentBuilderFactory
public static interface JettyComponentBuilderFactory.JettyComponentBuilder extends ComponentBuilder<org.apache.camel.component.jetty12.JettyHttpComponent12>
Builder for the Jetty component.

  • Method Details

    • bridgeErrorHandler

      default JettyComponentBuilderFactory.JettyComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • continuationTimeout

      default JettyComponentBuilderFactory.JettyComponentBuilder continuationTimeout(Long continuationTimeout)
      Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine. The option is a: <code>java.lang.Long</code> type. Default: 30000 Group: consumer
      Parameters:
      continuationTimeout - the value to set
      Returns:
      the dsl builder

    • enableJmx

      default JettyComponentBuilderFactory.JettyComponentBuilder enableJmx(boolean enableJmx)
      If this option is true, Jetty JMX support will be enabled for this endpoint. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      enableJmx - the value to set
      Returns:
      the dsl builder

    • maxThreads

      default JettyComponentBuilderFactory.JettyComponentBuilder maxThreads(Integer maxThreads)
      To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured. The option is a: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      maxThreads - the value to set
      Returns:
      the dsl builder

    • minThreads

      default JettyComponentBuilderFactory.JettyComponentBuilder minThreads(Integer minThreads)
      To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured. The option is a: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      minThreads - the value to set
      Returns:
      the dsl builder

    • muteException

      default JettyComponentBuilderFactory.JettyComponentBuilder muteException(boolean muteException)
      If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      muteException - the value to set
      Returns:
      the dsl builder

    • requestBufferSize

      default JettyComponentBuilderFactory.JettyComponentBuilder requestBufferSize(Integer requestBufferSize)
      Allows to configure a custom value of the request buffer size on the Jetty connectors. The option is a: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      requestBufferSize - the value to set
      Returns:
      the dsl builder

    • requestHeaderSize

      default JettyComponentBuilderFactory.JettyComponentBuilder requestHeaderSize(Integer requestHeaderSize)
      Allows to configure a custom value of the request header size on the Jetty connectors. The option is a: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      requestHeaderSize - the value to set
      Returns:
      the dsl builder

    • responseBufferSize

      default JettyComponentBuilderFactory.JettyComponentBuilder responseBufferSize(Integer responseBufferSize)
      Allows to configure a custom value of the response buffer size on the Jetty connectors. The option is a: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      responseBufferSize - the value to set
      Returns:
      the dsl builder

    • responseHeaderSize

      default JettyComponentBuilderFactory.JettyComponentBuilder responseHeaderSize(Integer responseHeaderSize)
      Allows to configure a custom value of the response header size on the Jetty connectors. The option is a: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      responseHeaderSize - the value to set
      Returns:
      the dsl builder

    • sendServerVersion

      default JettyComponentBuilderFactory.JettyComponentBuilder sendServerVersion(boolean sendServerVersion)
      If the option is true, jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      sendServerVersion - the value to set
      Returns:
      the dsl builder

    • useContinuation

      default JettyComponentBuilderFactory.JettyComponentBuilder useContinuation(boolean useContinuation)
      Whether or not to use Jetty continuations for the Jetty Server. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      useContinuation - the value to set
      Returns:
      the dsl builder

    • useXForwardedForHeader

      default JettyComponentBuilderFactory.JettyComponentBuilder useXForwardedForHeader(boolean useXForwardedForHeader)
      To use the X-Forwarded-For header in HttpServletRequest.getRemoteAddr. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      useXForwardedForHeader - the value to set
      Returns:
      the dsl builder

    • fileSizeThreshold

      default JettyComponentBuilderFactory.JettyComponentBuilder fileSizeThreshold(int fileSizeThreshold)
      The size threshold after which files will be written to disk for multipart/form-data requests. By default the files are not written to disk. The option is a: <code>int</code> type. Default: 0 Group: consumer (advanced)
      Parameters:
      fileSizeThreshold - the value to set
      Returns:
      the dsl builder

    • filesLocation

      default JettyComponentBuilderFactory.JettyComponentBuilder filesLocation(String filesLocation)
      The directory location where files will be store for multipart/form-data requests. By default the files are written in the system temporary folder. The option is a: <code>java.lang.String</code> type. Group: consumer (advanced)
      Parameters:
      filesLocation - the value to set
      Returns:
      the dsl builder

    • maxFileSize

      default JettyComponentBuilderFactory.JettyComponentBuilder maxFileSize(long maxFileSize)
      The maximum size allowed for uploaded files. -1 means no limit. The option is a: <code>long</code> type. Default: -1 Group: consumer (advanced)
      Parameters:
      maxFileSize - the value to set
      Returns:
      the dsl builder

    • maxRequestSize

      default JettyComponentBuilderFactory.JettyComponentBuilder maxRequestSize(long maxRequestSize)
      The maximum size allowed for multipart/form-data requests. -1 means no limit. The option is a: <code>long</code> type. Default: -1 Group: consumer (advanced)
      Parameters:
      maxRequestSize - the value to set
      Returns:
      the dsl builder

    • threadPool

      default JettyComponentBuilderFactory.JettyComponentBuilder threadPool(org.eclipse.jetty.util.thread.ThreadPool threadPool)
      To use a custom thread pool for the server. This option should only be used in special circumstances. The option is a: <code>org.eclipse.jetty.util.thread.ThreadPool</code> type. Group: consumer (advanced)
      Parameters:
      threadPool - the value to set
      Returns:
      the dsl builder

    • allowJavaSerializedObject

      default JettyComponentBuilderFactory.JettyComponentBuilder allowJavaSerializedObject(boolean allowJavaSerializedObject)
      Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      allowJavaSerializedObject - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default JettyComponentBuilderFactory.JettyComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • errorHandler

      default JettyComponentBuilderFactory.JettyComponentBuilder errorHandler(org.eclipse.jetty.server.handler.ErrorHandler errorHandler)
      This option is used to set the ErrorHandler that Jetty server uses. The option is a: <code>org.eclipse.jetty.server.handler.ErrorHandler</code> type. Group: advanced
      Parameters:
      errorHandler - the value to set
      Returns:
      the dsl builder

    • httpBinding

      default JettyComponentBuilderFactory.JettyComponentBuilder httpBinding(org.apache.camel.http.common.HttpBinding httpBinding)
      Not to be used - use JettyHttpBinding instead. The option is a: <code>org.apache.camel.http.common.HttpBinding</code> type. Group: advanced
      Parameters:
      httpBinding - the value to set
      Returns:
      the dsl builder

    • httpConfiguration

      default JettyComponentBuilderFactory.JettyComponentBuilder httpConfiguration(org.apache.camel.http.common.HttpConfiguration httpConfiguration)
      Jetty component does not use HttpConfiguration. The option is a: <code>org.apache.camel.http.common.HttpConfiguration</code> type. Group: advanced
      Parameters:
      httpConfiguration - the value to set
      Returns:
      the dsl builder

    • mbContainer

      default JettyComponentBuilderFactory.JettyComponentBuilder mbContainer(org.eclipse.jetty.jmx.MBeanContainer mbContainer)
      To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans. The option is a: <code>org.eclipse.jetty.jmx.MBeanContainer</code> type. Group: advanced
      Parameters:
      mbContainer - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default JettyComponentBuilderFactory.JettyComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: filter
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default JettyComponentBuilderFactory.JettyComponentBuilder proxyHost(String proxyHost)
      To use a http proxy to configure the hostname. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default JettyComponentBuilderFactory.JettyComponentBuilder proxyPort(Integer proxyPort)
      To use a http proxy to configure the port number. The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • keystore

      default JettyComponentBuilderFactory.JettyComponentBuilder keystore(String keystore)
      Specifies the location of the Java keystore file, which contains the Jetty server's own X.509 certificate in a key entry. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      keystore - the value to set
      Returns:
      the dsl builder

    • socketConnectorProperties

      default JettyComponentBuilderFactory.JettyComponentBuilder socketConnectorProperties(Map<String,Object> socketConnectorProperties)
      A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: security
      Parameters:
      socketConnectorProperties - the value to set
      Returns:
      the dsl builder

    • socketConnectors

      default JettyComponentBuilderFactory.JettyComponentBuilder socketConnectors(Map<Integer,org.eclipse.jetty.server.Connector> socketConnectors)
      A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors. The option is a: <code>java.util.Map&lt;java.lang.Integer, org.eclipse.jetty.server.Connector&gt;</code> type. Group: security
      Parameters:
      socketConnectors - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default JettyComponentBuilderFactory.JettyComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • sslKeyPassword

      default JettyComponentBuilderFactory.JettyComponentBuilder sslKeyPassword(String sslKeyPassword)
      The key password, which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option). The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslKeyPassword - the value to set
      Returns:
      the dsl builder

    • sslPassword

      default JettyComponentBuilderFactory.JettyComponentBuilder sslPassword(String sslPassword)
      The ssl password, which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option). The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslPassword - the value to set
      Returns:
      the dsl builder

    • sslSocketConnectorProperties

      default JettyComponentBuilderFactory.JettyComponentBuilder sslSocketConnectorProperties(Map<String,Object> sslSocketConnectorProperties)
      A map which contains general SSL connector properties. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: security
      Parameters:
      sslSocketConnectorProperties - the value to set
      Returns:
      the dsl builder

    • sslSocketConnectors

      default JettyComponentBuilderFactory.JettyComponentBuilder sslSocketConnectors(Map<Integer,org.eclipse.jetty.server.Connector> sslSocketConnectors)
      A map which contains per port number specific SSL connectors. The option is a: <code>java.util.Map&lt;java.lang.Integer, org.eclipse.jetty.server.Connector&gt;</code> type. Group: security
      Parameters:
      sslSocketConnectors - the value to set
      Returns:
      the dsl builder

    • useGlobalSslContextParameters

      default JettyComponentBuilderFactory.JettyComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useGlobalSslContextParameters - the value to set
      Returns:
      the dsl builder