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

Interface QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    Enclosing interface:
    QuartzEndpointBuilderFactory
    public static interface QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Advanced builder for endpoint for the Quartz component.

    • Method Detail

      • bridgeErrorHandler

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder 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 (advanced)
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder 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 (advanced)
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder exceptionHandler​(org.apache.camel.spi.ExceptionHandler exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder exceptionHandler​(String exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder exchangePattern​(org.apache.camel.ExchangePattern exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder exchangePattern​(String exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • customCalendar

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder customCalendar​(org.quartz.Calendar customCalendar)
        Specifies a custom calendar to avoid specific range of date. The option is a: <code>org.quartz.Calendar</code> type. Group: advanced
        Parameters:
        customCalendar - the value to set
        Returns:
        the dsl builder

      • customCalendar

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder customCalendar​(String customCalendar)
        Specifies a custom calendar to avoid specific range of date. The option will be converted to a <code>org.quartz.Calendar</code> type. Group: advanced
        Parameters:
        customCalendar - the value to set
        Returns:
        the dsl builder

      • ignoreExpiredNextFireTime

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder ignoreExpiredNextFireTime​(boolean ignoreExpiredNextFireTime)
        Whether to ignore quartz cannot schedule a trigger because the trigger will never fire in the future. This can happen when using a cron trigger that are configured to only run in the past. By default, Quartz will fail to schedule the trigger and therefore fail to start the Camel route. You can set this to true which then logs a WARN and then ignore the problem, meaning that the route will never fire in the future. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        ignoreExpiredNextFireTime - the value to set
        Returns:
        the dsl builder

      • ignoreExpiredNextFireTime

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder ignoreExpiredNextFireTime​(String ignoreExpiredNextFireTime)
        Whether to ignore quartz cannot schedule a trigger because the trigger will never fire in the future. This can happen when using a cron trigger that are configured to only run in the past. By default, Quartz will fail to schedule the trigger and therefore fail to start the Camel route. You can set this to true which then logs a WARN and then ignore the problem, meaning that the route will never fire in the future. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        ignoreExpiredNextFireTime - the value to set
        Returns:
        the dsl builder

      • jobParameters

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder jobParameters​(String key,
                                                                                 Object value)
        To configure additional options on the job. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the jobParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • jobParameters

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder jobParameters​(Map values)
        To configure additional options on the job. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the jobParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • prefixJobNameWithEndpointId

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder prefixJobNameWithEndpointId​(boolean prefixJobNameWithEndpointId)
        Whether the job name should be prefixed with endpoint id. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        prefixJobNameWithEndpointId - the value to set
        Returns:
        the dsl builder

      • prefixJobNameWithEndpointId

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder prefixJobNameWithEndpointId​(String prefixJobNameWithEndpointId)
        Whether the job name should be prefixed with endpoint id. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        prefixJobNameWithEndpointId - the value to set
        Returns:
        the dsl builder

      • triggerParameters

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder triggerParameters​(String key,
                                                                                     Object value)
        To configure additional options on the trigger. The parameter timeZone is supported if the cron option is present. Otherwise the parameters repeatInterval and repeatCount are supported. Note: When using repeatInterval values of 1000 or less, the first few events after starting the camel context may be fired more rapidly than expected. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the triggerParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • triggerParameters

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder triggerParameters​(Map values)
        To configure additional options on the trigger. The parameter timeZone is supported if the cron option is present. Otherwise the parameters repeatInterval and repeatCount are supported. Note: When using repeatInterval values of 1000 or less, the first few events after starting the camel context may be fired more rapidly than expected. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the triggerParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • usingFixedCamelContextName

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder usingFixedCamelContextName​(boolean usingFixedCamelContextName)
        If it is true, JobDataMap uses the CamelContext name directly to reference the CamelContext, if it is false, JobDataMap uses use the CamelContext management name which could be changed during the deploy time. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        usingFixedCamelContextName - the value to set
        Returns:
        the dsl builder

      • usingFixedCamelContextName

        default QuartzEndpointBuilderFactory.AdvancedQuartzEndpointBuilder usingFixedCamelContextName​(String usingFixedCamelContextName)
        If it is true, JobDataMap uses the CamelContext name directly to reference the CamelContext, if it is false, JobDataMap uses use the CamelContext management name which could be changed during the deploy time. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        usingFixedCamelContextName - the value to set
        Returns:
        the dsl builder