| {"component":{"kind":"component","name":"velocity","title":"Velocity","description":"Transform messages using a Velocity template.","deprecated":false,"firstVersion":"1.2.0","label":"transformation","javaType":"org.apache.camel.component.velocity.VelocityComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-velocity","version":"3.18.1","scheme":"velocity","extendsScheme":"","syntax":"velocity:resourceUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelVelocityResourceUri":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the velocity template.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_RESOURCE_URI"},"CamelVelocityTemplate":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content of the velocity template.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_TEMPLATE"},"CamelVelocityContext":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.velocity.context.Context","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The velocity context to use.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_CONTEXT"},"CamelVelocitySupplementalContext":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map<String, Object>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To add additional information to the used VelocityContext. The value of this header should be a Map with key/values that will added (override any existing key with the same name). This can be used to pre setup some common key/values you want to reuse in your velocity endpoints.","constantName":"org.apache.camel.component.velocity.VelocityConstants#VELOCITY_SUPPLEMENTAL_CONTEXT"}},"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."},"allowTemplateFromHeader":{"kind":"parameter","displayName":"Allow Template From Header","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care."},"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"},"encoding":{"kind":"parameter","displayName":"Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Character encoding of the resource content."},"loaderCache":{"kind":"parameter","displayName":"Loader Cache","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Enables / disables the velocity resource loader cache which is enabled by default"},"propertiesFile":{"kind":"parameter","displayName":"Properties File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The URI of the properties file which is used for VelocityEngine initialization."},"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."}}} |