| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.camel.builder.endpoint.dsl; |
| |
| import javax.annotation.Generated; |
| import org.apache.camel.ExchangePattern; |
| import org.apache.camel.builder.EndpointConsumerBuilder; |
| import org.apache.camel.builder.EndpointProducerBuilder; |
| import org.apache.camel.builder.endpoint.AbstractEndpointBuilder; |
| import org.apache.camel.spi.ExceptionHandler; |
| |
| /** |
| * The Ignite Messaging endpoint is one of camel-ignite endpoints which allows |
| * you to send and consume messages from an Ignite topic. |
| * |
| * Generated by camel-package-maven-plugin - do not edit this file! |
| */ |
| @Generated("org.apache.camel.maven.packaging.EndpointDslMojo") |
| public interface IgniteMessagingEndpointBuilderFactory { |
| |
| |
| /** |
| * Builder for endpoint consumers for the Ignite Messaging component. |
| */ |
| public interface IgniteMessagingEndpointConsumerBuilder |
| extends |
| EndpointConsumerBuilder { |
| default AdvancedIgniteMessagingEndpointConsumerBuilder advanced() { |
| return (AdvancedIgniteMessagingEndpointConsumerBuilder) this; |
| } |
| /** |
| * Sets whether to propagate the incoming body if the return type of the |
| * underlying Ignite operation is void. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointConsumerBuilder propagateIncomingBodyIfNoReturnValue( |
| boolean propagateIncomingBodyIfNoReturnValue) { |
| doSetProperty("propagateIncomingBodyIfNoReturnValue", propagateIncomingBodyIfNoReturnValue); |
| return this; |
| } |
| /** |
| * Sets whether to propagate the incoming body if the return type of the |
| * underlying Ignite operation is void. |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointConsumerBuilder propagateIncomingBodyIfNoReturnValue( |
| String propagateIncomingBodyIfNoReturnValue) { |
| doSetProperty("propagateIncomingBodyIfNoReturnValue", propagateIncomingBodyIfNoReturnValue); |
| return this; |
| } |
| /** |
| * Sets whether to treat Collections as cache objects or as Collections |
| * of items to insert/update/compute, etc. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointConsumerBuilder treatCollectionsAsCacheObjects( |
| boolean treatCollectionsAsCacheObjects) { |
| doSetProperty("treatCollectionsAsCacheObjects", treatCollectionsAsCacheObjects); |
| return this; |
| } |
| /** |
| * Sets whether to treat Collections as cache objects or as Collections |
| * of items to insert/update/compute, etc. |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointConsumerBuilder treatCollectionsAsCacheObjects( |
| String treatCollectionsAsCacheObjects) { |
| doSetProperty("treatCollectionsAsCacheObjects", treatCollectionsAsCacheObjects); |
| return this; |
| } |
| /** |
| * 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. |
| * |
| * Group: consumer |
| */ |
| default IgniteMessagingEndpointConsumerBuilder bridgeErrorHandler( |
| boolean bridgeErrorHandler) { |
| doSetProperty("bridgeErrorHandler", bridgeErrorHandler); |
| return this; |
| } |
| /** |
| * 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. |
| * |
| * Group: consumer |
| */ |
| default IgniteMessagingEndpointConsumerBuilder bridgeErrorHandler( |
| String bridgeErrorHandler) { |
| doSetProperty("bridgeErrorHandler", bridgeErrorHandler); |
| return this; |
| } |
| } |
| |
| /** |
| * Advanced builder for endpoint consumers for the Ignite Messaging |
| * component. |
| */ |
| public interface AdvancedIgniteMessagingEndpointConsumerBuilder |
| extends |
| EndpointConsumerBuilder { |
| default IgniteMessagingEndpointConsumerBuilder basic() { |
| return (IgniteMessagingEndpointConsumerBuilder) this; |
| } |
| /** |
| * 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) |
| */ |
| default AdvancedIgniteMessagingEndpointConsumerBuilder exceptionHandler( |
| ExceptionHandler exceptionHandler) { |
| doSetProperty("exceptionHandler", exceptionHandler); |
| return this; |
| } |
| /** |
| * 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) |
| */ |
| default AdvancedIgniteMessagingEndpointConsumerBuilder exceptionHandler( |
| String exceptionHandler) { |
| doSetProperty("exceptionHandler", exceptionHandler); |
| return this; |
| } |
| /** |
| * Sets the exchange pattern when the consumer creates an exchange. |
| * |
| * The option is a: <code>org.apache.camel.ExchangePattern</code> type. |
| * |
| * Group: consumer (advanced) |
| */ |
| default AdvancedIgniteMessagingEndpointConsumerBuilder exchangePattern( |
| ExchangePattern exchangePattern) { |
| doSetProperty("exchangePattern", exchangePattern); |
| return this; |
| } |
| /** |
| * 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) |
| */ |
| default AdvancedIgniteMessagingEndpointConsumerBuilder exchangePattern( |
| String exchangePattern) { |
| doSetProperty("exchangePattern", exchangePattern); |
| return this; |
| } |
| /** |
| * Whether the endpoint should use basic property binding (Camel 2.x) or |
| * the newer property binding with additional capabilities. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointConsumerBuilder basicPropertyBinding( |
| boolean basicPropertyBinding) { |
| doSetProperty("basicPropertyBinding", basicPropertyBinding); |
| return this; |
| } |
| /** |
| * Whether the endpoint should use basic property binding (Camel 2.x) or |
| * the newer property binding with additional capabilities. |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointConsumerBuilder basicPropertyBinding( |
| String basicPropertyBinding) { |
| doSetProperty("basicPropertyBinding", basicPropertyBinding); |
| return this; |
| } |
| /** |
| * Sets whether synchronous processing should be strictly used, or Camel |
| * is allowed to use asynchronous processing (if supported). |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointConsumerBuilder synchronous( |
| boolean synchronous) { |
| doSetProperty("synchronous", synchronous); |
| return this; |
| } |
| /** |
| * Sets whether synchronous processing should be strictly used, or Camel |
| * is allowed to use asynchronous processing (if supported). |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointConsumerBuilder synchronous( |
| String synchronous) { |
| doSetProperty("synchronous", synchronous); |
| return this; |
| } |
| } |
| |
| /** |
| * Builder for endpoint producers for the Ignite Messaging component. |
| */ |
| public interface IgniteMessagingEndpointProducerBuilder |
| extends |
| EndpointProducerBuilder { |
| default AdvancedIgniteMessagingEndpointProducerBuilder advanced() { |
| return (AdvancedIgniteMessagingEndpointProducerBuilder) this; |
| } |
| /** |
| * Sets whether to propagate the incoming body if the return type of the |
| * underlying Ignite operation is void. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointProducerBuilder propagateIncomingBodyIfNoReturnValue( |
| boolean propagateIncomingBodyIfNoReturnValue) { |
| doSetProperty("propagateIncomingBodyIfNoReturnValue", propagateIncomingBodyIfNoReturnValue); |
| return this; |
| } |
| /** |
| * Sets whether to propagate the incoming body if the return type of the |
| * underlying Ignite operation is void. |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointProducerBuilder propagateIncomingBodyIfNoReturnValue( |
| String propagateIncomingBodyIfNoReturnValue) { |
| doSetProperty("propagateIncomingBodyIfNoReturnValue", propagateIncomingBodyIfNoReturnValue); |
| return this; |
| } |
| /** |
| * Sets whether to treat Collections as cache objects or as Collections |
| * of items to insert/update/compute, etc. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointProducerBuilder treatCollectionsAsCacheObjects( |
| boolean treatCollectionsAsCacheObjects) { |
| doSetProperty("treatCollectionsAsCacheObjects", treatCollectionsAsCacheObjects); |
| return this; |
| } |
| /** |
| * Sets whether to treat Collections as cache objects or as Collections |
| * of items to insert/update/compute, etc. |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointProducerBuilder treatCollectionsAsCacheObjects( |
| String treatCollectionsAsCacheObjects) { |
| doSetProperty("treatCollectionsAsCacheObjects", treatCollectionsAsCacheObjects); |
| return this; |
| } |
| /** |
| * The cluster group expression. |
| * |
| * The option is a: |
| * <code>org.apache.camel.component.ignite.ClusterGroupExpression</code> |
| * type. |
| * |
| * Group: producer |
| */ |
| default IgniteMessagingEndpointProducerBuilder clusterGroupExpression( |
| Object clusterGroupExpression) { |
| doSetProperty("clusterGroupExpression", clusterGroupExpression); |
| return this; |
| } |
| /** |
| * The cluster group expression. |
| * |
| * The option will be converted to a |
| * <code>org.apache.camel.component.ignite.ClusterGroupExpression</code> |
| * type. |
| * |
| * Group: producer |
| */ |
| default IgniteMessagingEndpointProducerBuilder clusterGroupExpression( |
| String clusterGroupExpression) { |
| doSetProperty("clusterGroupExpression", clusterGroupExpression); |
| return this; |
| } |
| /** |
| * 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. |
| * |
| * Group: producer |
| */ |
| default IgniteMessagingEndpointProducerBuilder lazyStartProducer( |
| boolean lazyStartProducer) { |
| doSetProperty("lazyStartProducer", lazyStartProducer); |
| return this; |
| } |
| /** |
| * 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. |
| * |
| * Group: producer |
| */ |
| default IgniteMessagingEndpointProducerBuilder lazyStartProducer( |
| String lazyStartProducer) { |
| doSetProperty("lazyStartProducer", lazyStartProducer); |
| return this; |
| } |
| /** |
| * The send mode to use. Possible values: UNORDERED, ORDERED. |
| * |
| * The option is a: |
| * <code>org.apache.camel.component.ignite.messaging.IgniteMessagingSendMode</code> type. |
| * |
| * Group: producer |
| */ |
| default IgniteMessagingEndpointProducerBuilder sendMode( |
| IgniteMessagingSendMode sendMode) { |
| doSetProperty("sendMode", sendMode); |
| return this; |
| } |
| /** |
| * The send mode to use. Possible values: UNORDERED, ORDERED. |
| * |
| * The option will be converted to a |
| * <code>org.apache.camel.component.ignite.messaging.IgniteMessagingSendMode</code> type. |
| * |
| * Group: producer |
| */ |
| default IgniteMessagingEndpointProducerBuilder sendMode(String sendMode) { |
| doSetProperty("sendMode", sendMode); |
| return this; |
| } |
| /** |
| * The timeout for the send operation when using ordered messages. |
| * |
| * The option is a: <code>java.lang.Long</code> type. |
| * |
| * Group: producer |
| */ |
| default IgniteMessagingEndpointProducerBuilder timeout(Long timeout) { |
| doSetProperty("timeout", timeout); |
| return this; |
| } |
| /** |
| * The timeout for the send operation when using ordered messages. |
| * |
| * The option will be converted to a <code>java.lang.Long</code> type. |
| * |
| * Group: producer |
| */ |
| default IgniteMessagingEndpointProducerBuilder timeout(String timeout) { |
| doSetProperty("timeout", timeout); |
| return this; |
| } |
| } |
| |
| /** |
| * Advanced builder for endpoint producers for the Ignite Messaging |
| * component. |
| */ |
| public interface AdvancedIgniteMessagingEndpointProducerBuilder |
| extends |
| EndpointProducerBuilder { |
| default IgniteMessagingEndpointProducerBuilder basic() { |
| return (IgniteMessagingEndpointProducerBuilder) this; |
| } |
| /** |
| * Whether the endpoint should use basic property binding (Camel 2.x) or |
| * the newer property binding with additional capabilities. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointProducerBuilder basicPropertyBinding( |
| boolean basicPropertyBinding) { |
| doSetProperty("basicPropertyBinding", basicPropertyBinding); |
| return this; |
| } |
| /** |
| * Whether the endpoint should use basic property binding (Camel 2.x) or |
| * the newer property binding with additional capabilities. |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointProducerBuilder basicPropertyBinding( |
| String basicPropertyBinding) { |
| doSetProperty("basicPropertyBinding", basicPropertyBinding); |
| return this; |
| } |
| /** |
| * Sets whether synchronous processing should be strictly used, or Camel |
| * is allowed to use asynchronous processing (if supported). |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointProducerBuilder synchronous( |
| boolean synchronous) { |
| doSetProperty("synchronous", synchronous); |
| return this; |
| } |
| /** |
| * Sets whether synchronous processing should be strictly used, or Camel |
| * is allowed to use asynchronous processing (if supported). |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointProducerBuilder synchronous( |
| String synchronous) { |
| doSetProperty("synchronous", synchronous); |
| return this; |
| } |
| } |
| |
| /** |
| * Builder for endpoint for the Ignite Messaging component. |
| */ |
| public interface IgniteMessagingEndpointBuilder |
| extends |
| IgniteMessagingEndpointConsumerBuilder, IgniteMessagingEndpointProducerBuilder { |
| default AdvancedIgniteMessagingEndpointBuilder advanced() { |
| return (AdvancedIgniteMessagingEndpointBuilder) this; |
| } |
| /** |
| * Sets whether to propagate the incoming body if the return type of the |
| * underlying Ignite operation is void. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointBuilder propagateIncomingBodyIfNoReturnValue( |
| boolean propagateIncomingBodyIfNoReturnValue) { |
| doSetProperty("propagateIncomingBodyIfNoReturnValue", propagateIncomingBodyIfNoReturnValue); |
| return this; |
| } |
| /** |
| * Sets whether to propagate the incoming body if the return type of the |
| * underlying Ignite operation is void. |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointBuilder propagateIncomingBodyIfNoReturnValue( |
| String propagateIncomingBodyIfNoReturnValue) { |
| doSetProperty("propagateIncomingBodyIfNoReturnValue", propagateIncomingBodyIfNoReturnValue); |
| return this; |
| } |
| /** |
| * Sets whether to treat Collections as cache objects or as Collections |
| * of items to insert/update/compute, etc. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointBuilder treatCollectionsAsCacheObjects( |
| boolean treatCollectionsAsCacheObjects) { |
| doSetProperty("treatCollectionsAsCacheObjects", treatCollectionsAsCacheObjects); |
| return this; |
| } |
| /** |
| * Sets whether to treat Collections as cache objects or as Collections |
| * of items to insert/update/compute, etc. |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: common |
| */ |
| default IgniteMessagingEndpointBuilder treatCollectionsAsCacheObjects( |
| String treatCollectionsAsCacheObjects) { |
| doSetProperty("treatCollectionsAsCacheObjects", treatCollectionsAsCacheObjects); |
| return this; |
| } |
| } |
| |
| /** |
| * Advanced builder for endpoint for the Ignite Messaging component. |
| */ |
| public interface AdvancedIgniteMessagingEndpointBuilder |
| extends |
| AdvancedIgniteMessagingEndpointConsumerBuilder, AdvancedIgniteMessagingEndpointProducerBuilder { |
| default IgniteMessagingEndpointBuilder basic() { |
| return (IgniteMessagingEndpointBuilder) this; |
| } |
| /** |
| * Whether the endpoint should use basic property binding (Camel 2.x) or |
| * the newer property binding with additional capabilities. |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointBuilder basicPropertyBinding( |
| boolean basicPropertyBinding) { |
| doSetProperty("basicPropertyBinding", basicPropertyBinding); |
| return this; |
| } |
| /** |
| * Whether the endpoint should use basic property binding (Camel 2.x) or |
| * the newer property binding with additional capabilities. |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointBuilder basicPropertyBinding( |
| String basicPropertyBinding) { |
| doSetProperty("basicPropertyBinding", basicPropertyBinding); |
| return this; |
| } |
| /** |
| * Sets whether synchronous processing should be strictly used, or Camel |
| * is allowed to use asynchronous processing (if supported). |
| * |
| * The option is a: <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointBuilder synchronous( |
| boolean synchronous) { |
| doSetProperty("synchronous", synchronous); |
| return this; |
| } |
| /** |
| * Sets whether synchronous processing should be strictly used, or Camel |
| * is allowed to use asynchronous processing (if supported). |
| * |
| * The option will be converted to a <code>boolean</code> type. |
| * |
| * Group: advanced |
| */ |
| default AdvancedIgniteMessagingEndpointBuilder synchronous( |
| String synchronous) { |
| doSetProperty("synchronous", synchronous); |
| return this; |
| } |
| } |
| |
| /** |
| * Proxy enum for |
| * <code>org.apache.camel.component.ignite.messaging.IgniteMessagingSendMode</code> enum. |
| */ |
| enum IgniteMessagingSendMode { |
| ORDERED, |
| UNORDERED; |
| } |
| /** |
| * Ignite Messaging (camel-ignite) |
| * The Ignite Messaging endpoint is one of camel-ignite endpoints which |
| * allows you to send and consume messages from an Ignite topic. |
| * |
| * Category: nosql,cache,messaging |
| * Since: 2.17 |
| * Maven coordinates: org.apache.camel:camel-ignite |
| * |
| * Syntax: <code>ignite-messaging:topic</code> |
| * |
| * Path parameter: topic (required) |
| * The topic name. |
| */ |
| default IgniteMessagingEndpointBuilder igniteMessaging(String path) { |
| class IgniteMessagingEndpointBuilderImpl extends AbstractEndpointBuilder implements IgniteMessagingEndpointBuilder, AdvancedIgniteMessagingEndpointBuilder { |
| public IgniteMessagingEndpointBuilderImpl(String path) { |
| super("ignite-messaging", path); |
| } |
| } |
| return new IgniteMessagingEndpointBuilderImpl(path); |
| } |
| } |