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

Interface NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    NatsEndpointBuilderFactory.NatsEndpointBuilder
    Enclosing interface:
    NatsEndpointBuilderFactory
    public static interface NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Nats component.

    • Method Detail

      • connectionTimeout

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder connectionTimeout​(int connectionTimeout)
        Timeout for connection attempts. (in milliseconds). The option is a: <code>int</code> type. Default: 2000 Group: common
        Parameters:
        connectionTimeout - the value to set
        Returns:
        the dsl builder

      • connectionTimeout

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder connectionTimeout​(String connectionTimeout)
        Timeout for connection attempts. (in milliseconds). The option will be converted to a <code>int</code> type. Default: 2000 Group: common
        Parameters:
        connectionTimeout - the value to set
        Returns:
        the dsl builder

      • flushConnection

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder flushConnection​(boolean flushConnection)
        Define if we want to flush connection when stopping or not. The option is a: <code>boolean</code> type. Default: true Group: common
        Parameters:
        flushConnection - the value to set
        Returns:
        the dsl builder

      • flushConnection

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder flushConnection​(String flushConnection)
        Define if we want to flush connection when stopping or not. The option will be converted to a <code>boolean</code> type. Default: true Group: common
        Parameters:
        flushConnection - the value to set
        Returns:
        the dsl builder

      • flushTimeout

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder flushTimeout​(int flushTimeout)
        Set the flush timeout (in milliseconds). The option is a: <code>int</code> type. Default: 1000 Group: common
        Parameters:
        flushTimeout - the value to set
        Returns:
        the dsl builder

      • flushTimeout

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder flushTimeout​(String flushTimeout)
        Set the flush timeout (in milliseconds). The option will be converted to a <code>int</code> type. Default: 1000 Group: common
        Parameters:
        flushTimeout - the value to set
        Returns:
        the dsl builder

      • maxPingsOut

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder maxPingsOut​(int maxPingsOut)
        maximum number of pings have not received a response allowed by the client. The option is a: <code>int</code> type. Default: 2 Group: common
        Parameters:
        maxPingsOut - the value to set
        Returns:
        the dsl builder

      • maxPingsOut

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder maxPingsOut​(String maxPingsOut)
        maximum number of pings have not received a response allowed by the client. The option will be converted to a <code>int</code> type. Default: 2 Group: common
        Parameters:
        maxPingsOut - the value to set
        Returns:
        the dsl builder

      • maxReconnectAttempts

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder maxReconnectAttempts​(int maxReconnectAttempts)
        Max reconnection attempts. The option is a: <code>int</code> type. Default: 60 Group: common
        Parameters:
        maxReconnectAttempts - the value to set
        Returns:
        the dsl builder

      • maxReconnectAttempts

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder maxReconnectAttempts​(String maxReconnectAttempts)
        Max reconnection attempts. The option will be converted to a <code>int</code> type. Default: 60 Group: common
        Parameters:
        maxReconnectAttempts - the value to set
        Returns:
        the dsl builder

      • noEcho

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder noEcho​(boolean noEcho)
        Turn off echo. If supported by the gnatsd version you are connecting to this flag will prevent the server from echoing messages back to the connection if it has subscriptions on the subject being published to. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        noEcho - the value to set
        Returns:
        the dsl builder

      • noEcho

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder noEcho​(String noEcho)
        Turn off echo. If supported by the gnatsd version you are connecting to this flag will prevent the server from echoing messages back to the connection if it has subscriptions on the subject being published to. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        noEcho - the value to set
        Returns:
        the dsl builder

      • noRandomizeServers

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder noRandomizeServers​(boolean noRandomizeServers)
        Whether or not randomizing the order of servers for the connection attempts. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        noRandomizeServers - the value to set
        Returns:
        the dsl builder

      • noRandomizeServers

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder noRandomizeServers​(String noRandomizeServers)
        Whether or not randomizing the order of servers for the connection attempts. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        noRandomizeServers - the value to set
        Returns:
        the dsl builder

      • pedantic

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder pedantic​(boolean pedantic)
        Whether or not running in pedantic mode (this affects performance). The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        pedantic - the value to set
        Returns:
        the dsl builder

      • pedantic

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder pedantic​(String pedantic)
        Whether or not running in pedantic mode (this affects performance). The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        pedantic - the value to set
        Returns:
        the dsl builder

      • pingInterval

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder pingInterval​(int pingInterval)
        Ping interval to be aware if connection is still alive (in milliseconds). The option is a: <code>int</code> type. Default: 120000 Group: common
        Parameters:
        pingInterval - the value to set
        Returns:
        the dsl builder

      • pingInterval

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder pingInterval​(String pingInterval)
        Ping interval to be aware if connection is still alive (in milliseconds). The option will be converted to a <code>int</code> type. Default: 120000 Group: common
        Parameters:
        pingInterval - the value to set
        Returns:
        the dsl builder

      • reconnect

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder reconnect​(boolean reconnect)
        Whether or not using reconnection feature. The option is a: <code>boolean</code> type. Default: true Group: common
        Parameters:
        reconnect - the value to set
        Returns:
        the dsl builder

      • reconnect

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder reconnect​(String reconnect)
        Whether or not using reconnection feature. The option will be converted to a <code>boolean</code> type. Default: true Group: common
        Parameters:
        reconnect - the value to set
        Returns:
        the dsl builder

      • reconnectTimeWait

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder reconnectTimeWait​(int reconnectTimeWait)
        Waiting time before attempts reconnection (in milliseconds). The option is a: <code>int</code> type. Default: 2000 Group: common
        Parameters:
        reconnectTimeWait - the value to set
        Returns:
        the dsl builder

      • reconnectTimeWait

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder reconnectTimeWait​(String reconnectTimeWait)
        Waiting time before attempts reconnection (in milliseconds). The option will be converted to a <code>int</code> type. Default: 2000 Group: common
        Parameters:
        reconnectTimeWait - the value to set
        Returns:
        the dsl builder

      • requestCleanupInterval

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder requestCleanupInterval​(int requestCleanupInterval)
        Interval to clean up cancelled/timed out requests. The option is a: <code>int</code> type. Default: 5000 Group: common
        Parameters:
        requestCleanupInterval - the value to set
        Returns:
        the dsl builder

      • requestCleanupInterval

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder requestCleanupInterval​(String requestCleanupInterval)
        Interval to clean up cancelled/timed out requests. The option will be converted to a <code>int</code> type. Default: 5000 Group: common
        Parameters:
        requestCleanupInterval - the value to set
        Returns:
        the dsl builder

      • servers

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder servers​(String servers)
        URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        servers - the value to set
        Returns:
        the dsl builder

      • verbose

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder verbose​(boolean verbose)
        Whether or not running in verbose mode. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        verbose - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder 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

      • bridgeErrorHandler

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder bridgeErrorHandler​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • maxMessages

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder maxMessages​(String maxMessages)
        Stop receiving messages from a topic we are subscribing to after maxMessages. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        maxMessages - the value to set
        Returns:
        the dsl builder

      • poolSize

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder poolSize​(int poolSize)
        Consumer thread pool size (default is 10). The option is a: <code>int</code> type. Default: 10 Group: consumer
        Parameters:
        poolSize - the value to set
        Returns:
        the dsl builder

      • queueName

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder queueName​(String queueName)
        The Queue name if we are using nats for a queue configuration. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        queueName - the value to set
        Returns:
        the dsl builder

      • replyToDisabled

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder replyToDisabled​(boolean replyToDisabled)
        Can be used to turn off sending back reply message in the consumer. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        replyToDisabled - the value to set
        Returns:
        the dsl builder

      • replyToDisabled

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder replyToDisabled​(String replyToDisabled)
        Can be used to turn off sending back reply message in the consumer. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        replyToDisabled - the value to set
        Returns:
        the dsl builder

      • secure

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder secure​(boolean secure)
        Set secure option indicating TLS is required. The option is a: <code>boolean</code> type. Default: false Group: security
        Parameters:
        secure - the value to set
        Returns:
        the dsl builder

      • secure

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder secure​(String secure)
        Set secure option indicating TLS is required. The option will be converted to a <code>boolean</code> type. Default: false Group: security
        Parameters:
        secure - the value to set
        Returns:
        the dsl builder

      • sslContextParameters

        default NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder sslContextParameters​(Object 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 NatsEndpointBuilderFactory.NatsEndpointConsumerBuilder 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