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

Interface EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    EhcacheEndpointBuilderFactory.EhcacheEndpointBuilder
    Enclosing interface:
    EhcacheEndpointBuilderFactory
    public static interface EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the Ehcache component.

    • Method Detail

      • cacheManagerConfiguration

        default EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder cacheManagerConfiguration​(Object cacheManagerConfiguration)
        The cache manager configuration. The option is a: <code>org.ehcache.config.Configuration</code> type. Group: common
        Parameters:
        cacheManagerConfiguration - the value to set
        Returns:
        the dsl builder

      • cacheManagerConfiguration

        default EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder cacheManagerConfiguration​(String cacheManagerConfiguration)
        The cache manager configuration. The option will be converted to a <code>org.ehcache.config.Configuration</code> type. Group: common
        Parameters:
        cacheManagerConfiguration - the value to set
        Returns:
        the dsl builder

      • configurationUri

        default EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder configurationUri​(String configurationUri)
        URI pointing to the Ehcache XML configuration file's location. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        configurationUri - the value to set
        Returns:
        the dsl builder

      • createCacheIfNotExist

        default EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder createCacheIfNotExist​(boolean createCacheIfNotExist)
        Configure if a cache need to be created if it does exist or can't be pre-configured. The option is a: <code>boolean</code> type. Default: true Group: common
        Parameters:
        createCacheIfNotExist - the value to set
        Returns:
        the dsl builder

      • createCacheIfNotExist

        default EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder createCacheIfNotExist​(String createCacheIfNotExist)
        Configure if a cache need to be created if it does exist or can't be pre-configured. The option will be converted to a <code>boolean</code> type. Default: true Group: common
        Parameters:
        createCacheIfNotExist - the value to set
        Returns:
        the dsl builder

      • action

        default EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder action​(String action)
        To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        action - the value to set
        Returns:
        the dsl builder

      • key

        default EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder key​(Object key)
        To configure the default action key. If a key is set in the message header, then the key from the header takes precedence. The option is a: <code>java.lang.Object</code> type. Group: producer
        Parameters:
        key - the value to set
        Returns:
        the dsl builder

      • key

        default EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder key​(String key)
        To configure the default action key. If a key is set in the message header, then the key from the header takes precedence. The option will be converted to a <code>java.lang.Object</code> type. Group: producer
        Parameters:
        key - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default EhcacheEndpointBuilderFactory.EhcacheEndpointProducerBuilder 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

      • lazyStartProducer

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