blob: 03c14e679f799b1172e9a7621e9c01b0d26e09fd [file] [log] [blame]
{"component":{"kind":"component","name":"infinispan","title":"Infinispan","description":"Read and write from/to Infinispan distributed key/value store and data grid.","deprecated":false,"firstVersion":"2.13.0","label":"cache,datagrid,clustering","javaType":"org.apache.camel.component.infinispan.remote.InfinispanRemoteComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-infinispan","version":"3.18.1","scheme":"infinispan","extendsScheme":"","syntax":"infinispan:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelInfinispanEventType":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the received event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_TYPE"},"CamelInfinispanCacheName":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache participating in the operation or event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#CACHE_NAME"},"CamelInfinispanKey":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key to perform the operation to or the key generating the event.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#KEY"},"CamelInfinispanValue":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value to use for the operation.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#VALUE"},"CamelInfinispanDefaultValue":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The default value to use for a getOrDefault.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#DEFAULT_VALUE"},"CamelInfinispanOldValue":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value to use for a replace.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OLD_VALUE"},"CamelInfinispanMap":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A Map to use in case of CamelInfinispanOperationPutAll operation","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAP"},"CamelInfinispanOperation":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#OPERATION"},"CamelInfinispanOperationResult":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the header whose value is the result","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT"},"CamelInfinispanOperationResultHeader":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Store the operation result in a header instead of the message body","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#RESULT_HEADER"},"CamelInfinispanLifespanTime":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Lifespan time of a value inside the cache. Negative values are interpreted as infinity.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME"},"CamelInfinispanTimeUnit":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Lifespan Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#LIFESPAN_TIME_UNIT"},"CamelInfinispanMaxIdleTime":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum amount of time an entry is allowed to be idle for before it is considered as expired.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME"},"CamelInfinispanMaxIdleTimeUnit":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Time Unit of an entry Max Idle Time.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#MAX_IDLE_TIME_UNIT"},"CamelInfinispanEventData":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event data.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#EVENT_DATA"},"CamelInfinispanQueryBuilder":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The QueryBuilder to use for QUERY command, if not present the command defaults to InifinispanConfiguration's one","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#QUERY_BUILDER"},"CamelInfinispanEntryVersion":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Provides access to the version of the created cache entry.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#ENTRY_VERSION"},"CamelInfinispanCommandRetried":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This will be true if the write command that caused this had to be retried again due to a topology change.","constantName":"org.apache.camel.component.infinispan.InfinispanConstants#COMMAND_RETRIED"}},"properties":{"cacheName":{"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache to use. Use current to use the existing cache name from the currently configured cached manager. Or use default for the default cache manager name."},"hosts":{"kind":"parameter","displayName":"Hosts","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the host of the cache on Infinispan instance"},"queryBuilder":{"kind":"parameter","displayName":"Query Builder","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanQueryBuilder","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the query builder."},"secure":{"kind":"parameter","displayName":"Secure","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define if we are connecting to a secured Infinispan instance"},"customListener":{"kind":"parameter","displayName":"Custom Listener","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.remote.InfinispanRemoteCustomListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Returns the custom listener in use, if provided"},"eventTypes":{"kind":"parameter","displayName":"Event Types","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the set of event types to register by the consumer.Multiple event can be separated by comma. The possible event types are: CLIENT_CACHE_ENTRY_CREATED, CLIENT_CACHE_ENTRY_MODIFIED, CLIENT_CACHE_ENTRY_REMOVED, CLIENT_CACHE_ENTRY_EXPIRED, CLIENT_CACHE_FAILOVER"},"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."},"defaultValue":{"kind":"parameter","displayName":"Default Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific default value for some producer operations"},"key":{"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific key for producer operations"},"oldValue":{"kind":"parameter","displayName":"Old Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific old value for some producer operations"},"operation":{"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.infinispan.InfinispanOperation","enum":["PUT","PUTASYNC","PUTALL","PUTALLASYNC","PUTIFABSENT","PUTIFABSENTASYNC","GET","GETORDEFAULT","CONTAINSKEY","CONTAINSVALUE","REMOVE","REMOVEASYNC","REPLACE","REPLACEASYNC","SIZE","CLEAR","CLEARASYNC","QUERY","STATS","COMPUTE","COMPUTEASYNC"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PUT","configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"The operation to perform"},"value":{"kind":"parameter","displayName":"Value","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific value for producer operations"},"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."},"cacheContainer":{"kind":"parameter","displayName":"Cache Container","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.client.hotrod.RemoteCacheManager","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Specifies the cache Container to connect"},"cacheContainerConfiguration":{"kind":"parameter","displayName":"Cache Container Configuration","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.infinispan.client.hotrod.configuration.Configuration","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"The CacheContainer configuration. Used if the cacheContainer is not defined."},"configurationProperties":{"kind":"parameter","displayName":"Configuration Properties","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.String>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Implementation specific properties for the CacheManager"},"configurationUri":{"kind":"parameter","displayName":"Configuration Uri","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"An implementation specific URI for the CacheManager"},"flags":{"kind":"parameter","displayName":"Flags","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"A comma separated list of org.infinispan.client.hotrod.Flag to be applied by default on each cache invocation."},"remappingFunction":{"kind":"parameter","displayName":"Remapping Function","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.function.BiFunction","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Set a specific remappingFunction to use in a compute operation."},"resultHeader":{"kind":"parameter","displayName":"Result Header","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Store the operation result in a header instead of the message body. By default, resultHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If resultHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader"},"password":{"kind":"parameter","displayName":"Password","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the password to access the infinispan instance"},"saslMechanism":{"kind":"parameter","displayName":"Sasl Mechanism","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the SASL Mechanism to access the infinispan instance"},"securityRealm":{"kind":"parameter","displayName":"Security Realm","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the security realm to access the infinispan instance"},"securityServerName":{"kind":"parameter","displayName":"Security Server Name","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the security server name to access the infinispan instance"},"username":{"kind":"parameter","displayName":"Username","group":"security","label":"common,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration","configurationField":"configuration","description":"Define the username to access the infinispan instance"}}}