blob: 9e2dfc4ebf0962208de79cde59afd6e60752ec25 [file] [log] [blame]
{"component":{"kind":"component","name":"zookeeper","title":"ZooKeeper","description":"Manage ZooKeeper clusters.","deprecated":false,"firstVersion":"2.9.0","label":"clustering,management,bigdata","javaType":"org.apache.camel.component.zookeeper.ZooKeeperComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-zookeeper","version":"3.18.1","scheme":"zookeeper","extendsScheme":"","syntax":"zookeeper:serverUrls/path","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelZooKeeperNode":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_NODE"},"CamelZooKeeperVersion":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"-1","description":"The node version","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_NODE_VERSION"},"CamelZookeeperAcl":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List<ACL>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"Ids.OPEN_ACL_UNSAFE","description":"The ACL","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_ACL"},"CamelZookeeperCreateMode":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.zookeeper.CreateMode or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The create mode","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_CREATE_MODE"},"CamelZookeeperStatistics":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.zookeeper.data.Stat","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The statistics","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_STATISTICS"},"CamelZookeeperEventType":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"org.apache.zookeeper.Watcher.Event.EventType","enum":["None","NodeCreated","NodeDeleted","NodeDataChanged","NodeChildrenChanged","DataWatchRemoved","ChildWatchRemoved"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event type","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_EVENT_TYPE"},"CamelZookeeperOperation":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.zookeeper.ZooKeeperMessage#ZOOKEEPER_OPERATION"}},"properties":{"serverUrls":{"kind":"path","displayName":"Server Urls","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The zookeeper server hosts (multiple servers can be separated by comma)"},"path":{"kind":"path","displayName":"Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The node in the ZooKeeper server (aka znode)"},"listChildren":{"kind":"parameter","displayName":"List Children","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Whether the children of the node should be listed"},"timeout":{"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The time interval to wait on connection before timing out."},"backoff":{"kind":"parameter","displayName":"Backoff","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The time interval to backoff for after an error before retrying."},"repeat":{"kind":"parameter","displayName":"Repeat","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Should changes to the znode be 'watched' and repeatedly processed."},"sendEmptyMessageOnDelete":{"kind":"parameter","displayName":"Send Empty Message On Delete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Upon the delete of a znode, should an empty message be send to the consumer"},"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."},"create":{"kind":"parameter","displayName":"Create","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"Should the endpoint create the node if it does not currently exist."},"createMode":{"kind":"parameter","displayName":"Create Mode","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["PERSISTENT","PERSISTENT_SEQUENTIAL","EPHEMERAL","EPHEMERAL_SEQUENTIAL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EPHEMERAL","configurationClass":"org.apache.camel.component.zookeeper.ZooKeeperConfiguration","configurationField":"configuration","description":"The create mode that should be used for the newly created node"},"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."}}}