Package org.apache.camel.builder.endpoint.dsl

Interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
    Enclosing interface:
    WebsocketEndpointBuilderFactory
    public static interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the Jetty Websocket component.

    • Method Detail

      • maxBinaryMessageSize

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder maxBinaryMessageSize​(Integer maxBinaryMessageSize)
        Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited). The option is a: <code>java.lang.Integer</code> type. Default: -1 Group: common
        Parameters:
        maxBinaryMessageSize - the value to set
        Returns:
        the dsl builder

      • maxBinaryMessageSize

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder maxBinaryMessageSize​(String maxBinaryMessageSize)
        Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited). The option will be converted to a <code>java.lang.Integer</code> type. Default: -1 Group: common
        Parameters:
        maxBinaryMessageSize - the value to set
        Returns:
        the dsl builder

      • sendTimeout

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder sendTimeout​(Integer sendTimeout)
        Timeout in millis when sending to a websocket channel. The default timeout is 30000 (30 seconds). The option is a: <code>java.lang.Integer</code> type. Default: 30000 Group: producer
        Parameters:
        sendTimeout - the value to set
        Returns:
        the dsl builder

      • sendTimeout

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder sendTimeout​(String sendTimeout)
        Timeout in millis when sending to a websocket channel. The default timeout is 30000 (30 seconds). The option will be converted to a <code>java.lang.Integer</code> type. Default: 30000 Group: producer
        Parameters:
        sendTimeout - the value to set
        Returns:
        the dsl builder

      • sendToAll

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder sendToAll​(Boolean sendToAll)
        To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the WebsocketConstants.SEND_TO_ALL header on the message. The option is a: <code>java.lang.Boolean</code> type. Group: producer
        Parameters:
        sendToAll - the value to set
        Returns:
        the dsl builder

      • sendToAll

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder sendToAll​(String sendToAll)
        To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the WebsocketConstants.SEND_TO_ALL header on the message. The option will be converted to a <code>java.lang.Boolean</code> type. Group: producer
        Parameters:
        sendToAll - the value to set
        Returns:
        the dsl builder

      • crossOriginFilterOn

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder crossOriginFilterOn​(boolean crossOriginFilterOn)
        Whether to enable CORS. The option is a: <code>boolean</code> type. Default: false Group: cors
        Parameters:
        crossOriginFilterOn - the value to set
        Returns:
        the dsl builder

      • enableJmx

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder 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: monitoring
        Parameters:
        enableJmx - the value to set
        Returns:
        the dsl builder

      • enableJmx

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

      • sslContextParameters

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder 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

      • sslContextParameters

        default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder sslContextParameters​(String sslContextParameters)
        To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder