generated from camel.apache.org/component
Update wiki Home page for xj
parent
10b349becc
commit
b3ec4ba7c0
55
Home.md
55
Home.md
@ -1,21 +1,48 @@
|
|||||||
# Deploy the Project on CamelX Platform
|
# XJ
|
||||||
|
|
||||||
Deploy on CamelX Platform in three steps
|
Transform JSON and XML message using a XSLT.
|
||||||
|
|
||||||
## Step 1: Create a release
|
## Metadata
|
||||||
From the project space, click on **"Create a release"**
|
|
||||||
|
|
||||||
The new version is automatically available in the list
|
| Property | Value |
|
||||||
|
|----------|-------|
|
||||||
|
| Scheme | `xj` |
|
||||||
|
| Support Level | Stable |
|
||||||
|
| Labels | transformation |
|
||||||
|
| Version | 4.10.2 |
|
||||||
|
|
||||||
## Step 2: Deploy
|
## Maven Dependency
|
||||||
Click on **"Deploy"**
|
|
||||||
|
|
||||||
- **Version:** Select the desired release
|
```xml
|
||||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
<dependency>
|
||||||
- **Configuration:** Select the configuration source
|
<groupId>org.apache.camel</groupId>
|
||||||
- **Resources:** Set CPU and Memory
|
<artifactId>camel-xj</artifactId>
|
||||||
|
<version>4.10.2</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
## Step 3: Expose
|
## Endpoint Properties
|
||||||
Enable **"Expose"**
|
|
||||||
|
|
||||||
Choose an **API Gateway** (Internal, Public, etc.)
|
| Name | Type | Required | Default | Description |
|
||||||
|
|------|------|----------|---------|-------------|
|
||||||
|
| `resourceUri` | string | ✓ | | Path to the template. The following is supported by the default URIResolver. 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 |
|
||||||
|
| `allowStAX` | boolean | | `true` | Whether to allow using StAX as the javax.xml.transform.Source. You can enable this if the XSLT library supports StAX such as the Saxon library (camel-saxon). The Xalan library (default in JVM) does not support StAXSource. |
|
||||||
|
| `allowTemplateFromHeader` | boolean | | `false` | 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` | boolean | | `true` | Cache for the resource content (the stylesheet file) when it is loaded on startup. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation. |
|
||||||
|
| `deleteOutputFile` | boolean | | `false` | If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file, then it can be a good idea to delete it after use. |
|
||||||
|
| `failOnNullBody` | boolean | | `true` | Whether or not to throw an exception if the input body is null. |
|
||||||
|
| `output` | object | | `string` | Option to specify which output type to use. Possible values are: string, bytes, DOM, file. The first three options are all in memory based, where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key XsltConstants.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand, otherwise an exception is thrown at runtime. |
|
||||||
|
| `transformDirection` | object | ✓ | | Transform direction. Either XML2JSON or JSON2XML |
|
||||||
|
| `transformerCacheSize` | integer | | `0` | The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer(). |
|
||||||
|
| `lazyStartProducer` | boolean | | `false` | 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. |
|
||||||
|
| `entityResolver` | object | | | To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource. |
|
||||||
|
| `errorListener` | object | | | Allows to configure to use a custom javax.xml.transform.ErrorListener. Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases. |
|
||||||
|
| `resultHandlerFactory` | object | | | Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types. |
|
||||||
|
| `saxonConfiguration` | object | | | To use a custom Saxon configuration |
|
||||||
|
| `saxonExtensionFunctions` | string | | | Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry, where you can comma to separate multiple values to lookup. |
|
||||||
|
| `secureProcessing` | boolean | | `true` | Feature for XML secure processing (see javax.xml.XMLConstants). This is enabled by default. However, when using Saxon Professional you may need to turn this off to allow Saxon to be able to use Java extension functions. |
|
||||||
|
| `transformerFactory` | object | | | To use a custom XSLT transformer factory |
|
||||||
|
| `transformerFactoryClass` | string | | | To use a custom XSLT transformer factory, specified as a FQN class name |
|
||||||
|
| `transformerFactoryConfigurationStrategy` | object | | | A configuration strategy to apply on freshly created instances of TransformerFactory. |
|
||||||
|
| `uriResolver` | object | | | To use a custom javax.xml.transform.URIResolver |
|
||||||
|
| `xsltMessageLogger` | object | | | A consumer to messages generated during XSLT transformations. |
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user