blob: 6b3fc5fb4a1fd5fe6d57d1a16efe0d001927eaa0 [file] [log] [blame]
{"component":{"kind":"component","name":"spring-integration","title":"Spring Integration","description":"Bridge Camel with Spring Integration.","deprecated":false,"firstVersion":"1.4.0","label":"spring,eventbus","javaType":"org.apache.camel.component.spring.integration.SpringIntegrationComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-spring-integration","version":"3.18.1","scheme":"spring-integration","extendsScheme":"","syntax":"spring-integration:defaultChannel","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"id":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"java.util.UUID","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message id.","constantName":"org.apache.camel.component.spring.integration.SpringIntegrationConstants#ID"},"replyChannel":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.springframework.integration.channel.DirectChannel","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The reply channel.","constantName":"org.apache.camel.component.spring.integration.SpringIntegrationConstants#REPLY_CHANNEL"},"timestamp":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message.","constantName":"org.apache.camel.component.spring.integration.SpringIntegrationConstants#TIMESTAMP"}},"properties":{"defaultChannel":{"kind":"path","displayName":"Default Channel","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider."},"inOut":{"kind":"parameter","displayName":"In Out","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"The exchange pattern that the Spring integration endpoint should use. If inOut=true then a reply channel is expected, either from the Spring Integration Message header or configured on the endpoint."},"inputChannel":{"kind":"parameter","displayName":"Input Channel","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Spring integration input channel name that this endpoint wants to consume from Spring integration."},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"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."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"outputChannel":{"kind":"parameter","displayName":"Output Channel","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Spring integration output channel name that is used to send messages to Spring integration."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."}}}