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

Interface WebsocketComponentBuilderFactory.WebsocketComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.websocket.WebsocketComponent>
All Known Implementing Classes:
WebsocketComponentBuilderFactory.WebsocketComponentBuilderImpl
Enclosing interface:
WebsocketComponentBuilderFactory
public static interface WebsocketComponentBuilderFactory.WebsocketComponentBuilder extends ComponentBuilder<org.apache.camel.component.websocket.WebsocketComponent>
Builder for the Jetty Websocket component.

  • Method Details

    • host

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder host(String host)
      The hostname. The default value is 0.0.0.0. The option is a: <code>java.lang.String</code> type. Default: 0.0.0.0 Group: common
      Parameters:
      host - the value to set
      Returns:
      the dsl builder

    • port

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder port(Integer port)
      The port number. The default value is 9292. The option is a: <code>java.lang.Integer</code> type. Default: 9292 Group: common
      Parameters:
      port - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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

    • staticResources

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder staticResources(String staticResources)
      Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath, if you prefix with classpath:, otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:., or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      staticResources - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder 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

    • enableJmx

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

    • maxThreads

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder maxThreads(Integer maxThreads)
      To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores. The option is a: <code>java.lang.Integer</code> type. Group: advanced
      Parameters:
      maxThreads - the value to set
      Returns:
      the dsl builder

    • minThreads

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder minThreads(Integer minThreads)
      To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1. The option is a: <code>java.lang.Integer</code> type. Group: advanced
      Parameters:
      minThreads - the value to set
      Returns:
      the dsl builder

    • subprotocol

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder subprotocol(String subprotocol)
      This is a comma-separated list of subprotocols that are supported by the application. The list is in priority order. The first subprotocol on this list that is proposed by the client is the one that will be accepted. If no subprotocol on this list is proposed by the client, then the websocket connection is refused. The special value 'any' means that any subprotocol is acceptable. 'any' can be used on its own, or as a failsafe at the end of a list of more specific protocols. 'any' will also match the case where no subprotocol is proposed by the client. The option is a: <code>java.lang.String</code> type. Default: any Group: advanced
      Parameters:
      subprotocol - the value to set
      Returns:
      the dsl builder

    • threadPool

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder threadPool(org.eclipse.jetty.util.thread.ThreadPool threadPool)
      To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The option is a: <code>org.eclipse.jetty.util.thread.ThreadPool</code> type. Group: advanced
      Parameters:
      threadPool - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder 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 WebsocketComponentBuilderFactory.WebsocketComponentBuilder sslKeyPassword(String sslKeyPassword)
      The password for the keystore when using SSL. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslKeyPassword - the value to set
      Returns:
      the dsl builder

    • sslKeystore

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder sslKeystore(String sslKeystore)
      The path to the keystore. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslKeystore - the value to set
      Returns:
      the dsl builder

    • sslPassword

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder sslPassword(String sslPassword)
      The password when using SSL. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslPassword - the value to set
      Returns:
      the dsl builder

    • useGlobalSslContextParameters

      default WebsocketComponentBuilderFactory.WebsocketComponentBuilder 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