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

Interface VmEndpointBuilderFactory.VmEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    VmEndpointBuilderFactory.VmEndpointBuilder
    Enclosing interface:
    VmEndpointBuilderFactory
    public static interface VmEndpointBuilderFactory.VmEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the VM component.

    • Method Detail

      • size

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder size​(int size)
        The maximum capacity of the SEDA queue (i.e., the number of messages it can hold). Will by default use the defaultSize set on the SEDA component. The option is a: <code>int</code> type. Default: 1000 Group: common
        Parameters:
        size - the value to set
        Returns:
        the dsl builder

      • size

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder size​(String size)
        The maximum capacity of the SEDA queue (i.e., the number of messages it can hold). Will by default use the defaultSize set on the SEDA component. The option will be converted to a <code>int</code> type. Default: 1000 Group: common
        Parameters:
        size - the value to set
        Returns:
        the dsl builder

      • blockWhenFull

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder blockWhenFull​(boolean blockWhenFull)
        Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        blockWhenFull - the value to set
        Returns:
        the dsl builder

      • blockWhenFull

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder blockWhenFull​(String blockWhenFull)
        Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will instead block and wait until the message can be accepted. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        blockWhenFull - the value to set
        Returns:
        the dsl builder

      • discardIfNoConsumers

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder discardIfNoConsumers​(boolean discardIfNoConsumers)
        Whether the producer should discard the message (do not add the message to the queue), when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        discardIfNoConsumers - the value to set
        Returns:
        the dsl builder

      • discardIfNoConsumers

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder discardIfNoConsumers​(String discardIfNoConsumers)
        Whether the producer should discard the message (do not add the message to the queue), when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        discardIfNoConsumers - the value to set
        Returns:
        the dsl builder

      • discardWhenFull

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder discardWhenFull​(boolean discardWhenFull)
        Whether a thread that sends messages to a full SEDA queue will be discarded. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will give up sending and continue, meaning that the message was not sent to the SEDA queue. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        discardWhenFull - the value to set
        Returns:
        the dsl builder

      • discardWhenFull

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder discardWhenFull​(String discardWhenFull)
        Whether a thread that sends messages to a full SEDA queue will be discarded. By default, an exception will be thrown stating that the queue is full. By enabling this option, the calling thread will give up sending and continue, meaning that the message was not sent to the SEDA queue. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        discardWhenFull - the value to set
        Returns:
        the dsl builder

      • failIfNoConsumers

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder failIfNoConsumers​(boolean failIfNoConsumers)
        Whether the producer should fail by throwing an exception, when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        failIfNoConsumers - the value to set
        Returns:
        the dsl builder

      • failIfNoConsumers

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder failIfNoConsumers​(String failIfNoConsumers)
        Whether the producer should fail by throwing an exception, when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        failIfNoConsumers - the value to set
        Returns:
        the dsl builder

      • offerTimeout

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder offerTimeout​(long offerTimeout)
        Offer timeout (in milliseconds) can be added to the block case when queue is full. You can disable timeout by using 0 or a negative value. The option is a: <code>long</code> type. Group: producer
        Parameters:
        offerTimeout - the value to set
        Returns:
        the dsl builder

      • offerTimeout

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder offerTimeout​(String offerTimeout)
        Offer timeout (in milliseconds) can be added to the block case when queue is full. You can disable timeout by using 0 or a negative value. The option will be converted to a <code>long</code> type. Group: producer
        Parameters:
        offerTimeout - the value to set
        Returns:
        the dsl builder

      • timeout

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder timeout​(long timeout)
        Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. The option is a: <code>long</code> type. Default: 30000 Group: producer
        Parameters:
        timeout - the value to set
        Returns:
        the dsl builder

      • timeout

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder timeout​(String timeout)
        Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. The option will be converted to a <code>long</code> type. Default: 30000 Group: producer
        Parameters:
        timeout - the value to set
        Returns:
        the dsl builder

      • waitForTaskToComplete

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder waitForTaskToComplete​(org.apache.camel.WaitForTaskToComplete waitForTaskToComplete)
        Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based. The default option is IfReplyExpected. The option is a: <code>org.apache.camel.WaitForTaskToComplete</code> type. Default: IfReplyExpected Group: producer
        Parameters:
        waitForTaskToComplete - the value to set
        Returns:
        the dsl builder

      • waitForTaskToComplete

        default VmEndpointBuilderFactory.VmEndpointProducerBuilder waitForTaskToComplete​(String waitForTaskToComplete)
        Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based. The default option is IfReplyExpected. The option will be converted to a <code>org.apache.camel.WaitForTaskToComplete</code> type. Default: IfReplyExpected Group: producer
        Parameters:
        waitForTaskToComplete - the value to set
        Returns:
        the dsl builder