blob: 3a4a9caec155054451240fd6c34c531d0cddd2d6 [file] [log] [blame]
{"component":{"kind":"component","name":"atlasmap","title":"AtlasMap","description":"Transforms the message using an AtlasMap transformation.","deprecated":false,"firstVersion":"3.7.0","label":"transformation","javaType":"org.apache.camel.component.atlasmap.AtlasMapComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-atlasmap","version":"3.18.1","scheme":"atlasmap","extendsScheme":"","syntax":"atlasmap:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelAtlasResourceUri":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The new resource URI to use.","constantName":"org.apache.camel.component.atlasmap.AtlasMapConstants#ATLAS_RESOURCE_URI"},"CamelAtlasMapping":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Atlas mapping to use.","constantName":"org.apache.camel.component.atlasmap.AtlasMapConstants#ATLAS_MAPPING"},"Content-Type":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content type that is set according to the datasource (json or xml).","constantName":"org.apache.camel.component.atlasmap.AtlasMapConstants#CONTENT_TYPE"}},"properties":{"resourceUri":{"kind":"path","displayName":"Resource Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."},"allowContextMapAll":{"kind":"parameter","displayName":"Allow Context Map All","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API."},"contentCache":{"kind":"parameter","displayName":"Content Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether to use resource content cache or not"},"forceReload":{"kind":"parameter","displayName":"Force Reload","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to enable or disable force reload mode. This is set to false by default and ADM file is loaded from a file only on a first Exchange, and AtlasContext will be reused after that until endpoint is recreated. If this is set to true, ADM file will be loaded from a file on every Exchange."},"sourceMapName":{"kind":"parameter","displayName":"Source Map Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Exchange property name for a source message map which hold java.util.Map<String, Message> where the key is AtlasMap Document ID. AtlasMap consumes Message bodies as source documents, as well as message headers as source properties where the scope equals to Document ID."},"targetMapMode":{"kind":"parameter","displayName":"Target Map Mode","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.atlasmap.AtlasMapEndpoint.TargetMapMode","enum":["MAP","MESSAGE_HEADER","EXCHANGE_PROPERTY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MAP","description":"TargetMapMode enum value to specify how multiple target documents are delivered if exist. 'MAP': Stores them into a java.util.Map, and the java.util.Map is set to an exchange property if 'targetMapName' is specified, otherwise message body. 'MESSAGE_HEADER': Stores them into message headers. 'EXCHANGE_PROPERTY': Stores them into exchange properties. )"},"targetMapName":{"kind":"parameter","displayName":"Target Map Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The Exchange property name for a target document map which hold java.util.Map<String, Object> where the key is AtlasMap Document ID. AtlasMap populates multiple target documents into this map."},"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."}}}