blob: e5e5c95f7aec1e3f2159b53c6f964de2fd4a3dd0 [file] [log] [blame]
{"component":{"kind":"component","name":"hazelcast-instance","title":"Hazelcast Instance","description":"Consume join/leave events of a cache instance in a Hazelcast cluster.","deprecated":false,"firstVersion":"2.7.0","label":"cache,datagrid","javaType":"org.apache.camel.component.hazelcast.instance.HazelcastInstanceComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-hazelcast","version":"3.18.1","scheme":"hazelcast-instance","extendsScheme":"","syntax":"hazelcast-instance:cacheName","async":false,"api":false,"consumerOnly":true,"producerOnly":false,"lenientProperties":false},"headers":{"CamelHazelcastListenerAction":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event - here added and removed","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_ACTION"},"CamelHazelcastListenerType":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The map consumer","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TYPE"},"CamelHazelcastListenerTime":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time of the event in millis","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#LISTENER_TIME"},"CamelHazelcastInstanceHost":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The host name of the instance","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#INSTANCE_HOST"},"CamelHazelcastInstancePort":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The port number of the instance","constantName":"org.apache.camel.component.hazelcast.HazelcastConstants#INSTANCE_PORT"}},"properties":{"cacheName":{"kind":"path","displayName":"Cache Name","group":"consumer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"defaultOperation":{"kind":"parameter","displayName":"Default Operation","group":"consumer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.hazelcast.HazelcastOperation","enum":["put","delete","get","update","query","getAll","clear","putIfAbsent","addAll","removeAll","retainAll","evict","evictAll","valueCount","containsKey","containsValue","getKeys","removeValue","increment","decrement","setValue","destroy","compareAndSet","getAndAdd","add","offer","peek","poll","remainingCapacity","drainTo","removeIf","take","publish","readOnceHead","readOnceTail","capacity"],"deprecated":false,"autowired":false,"secret":false,"description":"To specify a default operation to use, if no operation header has been provided."},"hazelcastInstance":{"kind":"parameter","displayName":"Hazelcast Instance","group":"consumer","label":"","required":false,"type":"object","javaType":"com.hazelcast.core.HazelcastInstance","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference which can be used for hazelcast endpoint."},"hazelcastInstanceName":{"kind":"parameter","displayName":"Hazelcast Instance Name","group":"consumer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."},"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."}}}