Appendix F - DSL extensions index
This section summarizes all DSL extensions contributed by IPF components. These extensions are used with the IPF scripting layer.
The following sections list the DSL extensions grouped by the providing IPF component:
- DSL Extensions provided by platform-camel-core
- DSL Extensions provided by platform-camel-flow
- DSL Extensions provided by platform-camel-lbs
- DSL Extensions provided by platform-camel-event
- DSL Extensions provided by platform-camel-hl7
- DSL Extensions provided by platform-camel-cda
- DSL Extensions provided by platform-camel-test
- DSL Extensions provided by platform-camel-ihe-xds-core
- DSL Extensions provided by platform-camel-ihe-mllp-core
DSL Extensions provided by platform-camel-core
ProcessorType  |
|---|
ProcessorType process(String processorBeanName)  Adds a processor to the route that calls the given processor bean |
| ProcessorType process(Closure processorLogic) Adds a processor to the route that calls the given processor logic |
| ProcessorType intercept(Closure interceptorLogic) Adds an interceptor to the route that uses the given interceptor logic |
| ProcessorType unhandled() Drops the error handler from the route by using the noErrorHandler |
| ProcessorType filter(Closure predicateLogic) Adds a filter to the route using the predicate logic to find out if a message passes the filter or not |
| ProcessorType transform(Closure transformExpression) Sets a message body via the expression depending on the Message Exchange Pattern |
| ProcessorType setProperty(String name, Closure propertyExpression) Sets a property of an exchange to the result of the property expression |
| ProcessorType setHeader(String name, Closure headerExpression) Sets a header of the input message to the result of the header expression |
| ProcessorType setOutHeader(String name, Closure headerExpression) Sets a header of the output message to the result of the header expression |
| ProcessorType setFaultHeader(String name, Closure headerExpression) Sets a header of the fault message to the result of the header expression |
| ProcessorType setBody(Closure bodyExpression) Sets the input message body via the expression |
| ValidationType validation(Processor validator) Creates a validation workflow where actual validation is delegated to the given validator |
| ValidationType validation(String validationUri) Creates a validation workflow where actual validation is done by calling the given endpoint |
| ValidationType validation(Closure validatorLogic) Creates a validation workflow where actual validation is delegated to given validator logic |
| ProcessorType enrich(String resourceUri, AggregationStrategy aggregationStrategy) Calls an endpoint specified by the URI and merges the original exchange with the result of the call by applying the aggregation strategy |
| ProcessorType enrich(String resourceUri, Closure aggregationLogic) Calls an endpoint specified by the URI and merges the original exchange with the result of the call by applying the aggregation logic |
| SplitterType split(Expression splitExpression) Splits an exchange by evaluating the expression |
| SplitterType split(String splitExpressionBeanName) Splits an exchange by evaluating the expression defined by a bean reference |
| SplitterType split(Closure splitLogic) Splits an exchange by evaluating the split logic |
| TransmogrifierAdapterType transmogrify(Transmogrifier transmogrifier) Adds a transmogrifier to the route for message transformation |
| TransmogrifierAdapterType transmogrify(String transmogrifierBeanName) Adds a transmogrifier defined by a bean to the route |
| TransmogrifierAdapterType transmogrify(Closure transmogrifierLogic) Adds a transmogrifier defined by a closure to the route |
| TransmogrifierAdapterType transmogrify() Adds a transmogrifier to the route |
| ValidatorAdapterType validate() Validates a message |
| ValidatorAdapterType validate(Validator validator) Validates a message using the validator implementation |
| ValidatorAdapterType validate(String validatorBeanName) Validates a message using a validator bean |
| ValidatorAdapterType validate(Closure validatorLogic) Validates a message using the validator logic |
| ParserAdapterType parse(Parser parser) Parses a message to an internal format |
| RendererAdapterType render(Renderer renderer) Renders the message into an external representation |
| RendererAdapterType render(String rendererBeanName) Renders the message into an external representation via the given bean |
| ChoiceType (inherits from: ProcessorType) |
|---|
| ChoiceType when(Closure predicateLogic) Adds a routing decision for message routing using the predicate logic |
| DataFormatClause |
|---|
| ProcessorType [gnode](String schemaResource, boolean namespaceAware) fill me |
| ProcessorType [gnode](boolean namespaceAware) fill me |
| ProcessorType [gnode]() fill me |
| ProcessorType [gpath](String schemaResource, boolean namespaceAware) fill me |
| ProcessorType [gpath](boolean namespaceAware) fill me |
| ProcessorType [gpath]() fill me |
| ProcessorType parse(Parser parser) Parses a message to an internal format |
| ProcessorType parse(String parserBeanName) Parses a message to an internal format using a bean |
| ProcessorType render(Renderer renderer) Renders the message into an external representation |
| ProcessorType render(String rendererBeanName) Renders the message into an external representation via the given bean |
| ExpressionClause |
|---|
| Object exceptionObject() Retrieves the exception object from a handled exception in an exception route |
| Object exceptionMessage() Retrieves the exception message from a handled exception in an exception route |
| ExceptionType (inherits from: ProcessorType) |
|---|
| ExceptionType onWhen(Closure predicate) Allows for fine-grained exception handling |
| SpringRouteBuilder |
|---|
| AggregatorAdapter aggregationStrategy(Aggregator aggregator) Defines an AggregationStrategy via the Aggregator interface |
| AggregatorAdapter aggregationStrategy(String aggregatorBeanName) Defines an AggregationStrategy via a bean |
| AggregatorAdapter aggregationStrategy(Closure aggregationLogic) Defines an AggregationStrategy via a closure |
| PredicateAdapter predicate(Predicate predicate) Defines a Predicate via the Predicate interface |
| PredicateAdapter predicate(String predicateBeanName) Defines a Predicate via a bean |
| PredicateAdapter predicate(Closure predicateLogic) Defines a Predicate via a closure |
| ProcessorAdapterType (inherits from: ProcessorType) |
|---|
| ProcessorAdapterType input(Expression inputExpression) Defines the input to the adapter via the given expression |
| ProcessorAdapterType input(Closure inputExpression) Defines the input to the adapter via the closure expression |
| ProcessorAdapterType params(Expression paramsExpression) Defines the parameters for the adapter via the given expression |
| ProcessorAdapterType params(Closure paramsExpression) Defines the parameters for the adapter via the closure expression |
| ProcessorAdapterType staticParams(Object params) Defines the static parameters for the adapter |
| TransmogrifierAdapterType (inherits from: ProcessorAdapterType) |
|---|
| TransmogrifierAdapterType xslt() Specifies that the transformation is done via XSLT |
| TransmogrifierAdapterType xslt(Class clazz) Specifies that the transformation is done via XSLT |
| TransmogrifierAdapterType schematron() Specifies that a schematron validation report is generated |
| TransmogrifierAdapterType schematron(Class clazz) Specifies that a schematron validation report is generated |
| RendererAdapterType (inherits from: ProcessorAdapterType) |
|---|
| ParserAdapterType (inherits from: ProcessorAdapterType) |
|---|
| ValidatorAdapterType (inherits from: ProcessorAdapterType) |
|---|
| ValidatorAdapterType staticProfile(Object profile) Defines the static profile for the validation |
| ValidatorAdapterType profile(Expression profileExpression) Defines the profile for the validation via the given expression |
| ProcessorAdapterType profile(Closure profileExpression) Defines the profile for the validation via the given closure |
| ValidatorAdapterType xsd() Interprets the defined profile as W3C schema location and validates against it |
| ValidatorAdapterType schematron() Interprets the defined profile as Schematron rules location and validates against it |
| SplitterType (inherits from: ProcessorType) |
|---|
| SplitterType aggregate(Closure aggregationStrategy) Defines the aggregation logic for the split results as a closure |
| SplitterType aggregate(AggregationStrategy aggregationStrategy) Defines the aggregation logic for the split results via a strategy interface |
| ValidationType (inherits from: ProcessorType) |
|---|
| Adapter |
|---|
| Adapter input(Expression inputExpression) Sets an Expression for obtaining input data from an Exchange. Input data are passed to adapted modules API implementations. |
| Adapter input(Closure inputExpressionLogic) Sets an expression Closure for obtaining input data from an Exchange. Input data are passed to adapted modules API implementations. |
| Adapter params(Expression paramsExpression) Sets an Expression for obtaining input params from an Exchange. Input params are passed to adapted modules API implementations. |
| Adapter params(Closure paramsExpressionLogic) Sets an expression Closure for obtaining input params from an Exchange. Input params are passed to adapted modules API implementations. |
| Adapter staticParams(Object params) Configures this adapter to use the given params independent of the Exchange to be processed. |
| AdapterSupport (inherits from: Adapter) |
|---|
| AggregatorAdapter (inherits from: AdapterSupport) |
|---|
| AggregatorAdapter aggregationInput(Expression aggregationInputExpression) Sets an Expression for obtaining data to be obtained from an additional (new) Exchange. The default expression obtains the body from the input message. |
| Adapter aggregationInput(Closure aggregationInputExpressionLogic) Sets an expression Closure for obtaining data to be obtained from an additional (new) Exchange. The default expression obtains the body from the input message. |
| PredicateAdapter (inherits from: AdapterSupport) |
|---|
DSL Extensions provided by platform-camel-flow
| ProcessorType |
|---|
| FlowBeginProcessorType initFlow() Starts recording a message flow |
| FlowBeginProcessorType initFlow(String identifier) Starts recording a message flow with a specific identifier |
| FlowEndProcessorType ackFlow() Logs the successful delivery of a message |
| FlowErrorProcessorType nakFlow() Logs the erroneous processing of a message |
| DedupeType dedupeFlow() Filters messages during flow replay operations to avoid delivery of duplicates |
| FlowProcessorType (inherits from: ProcessorType) |
|---|
| FlowProcessorType inType(Class inType) Defines the type into which incoming messages are converted |
| FlowProcessorType outType(Class outType) Defines the type into which outgoing messages are converted |
| FlowProcessorType inFormat(DataFormat inFormat) Defines the data format used to convert incoming messages |
| FlowProcessorType outFormat(DataFormat outFormat) Defines the data format used to convert outgoing messages |
| FlowProcessorType outConversion(boolean outConversion) Defines whether conversion via outType or outFormat is performed or not |
| FlowProcessorType renderer(PlatformMessageRenderer messageRenderer) Sets the message renderer |
| FlowProcessorType renderer(String messageRendererBeanName) Sets the message renderer via a bean |
| FlowBeginProcessorType (inherits from: FlowProcessorType) |
|---|
| FlowProcessorType application(String application) Assigns an application name to created flows |
| FlowBeginProcessorType replayErrorHandler(String replayErrorUri) Defines the endpoint URI for error messages in case a flow replay fails |
| FlowBeginProcessorType expectedAckCount(int expectedAckCount) Defines the number of acknowledgments that are expected for a created flow |
| FlowEndProcessorType (inherits from: FlowProcessorType) |
|---|
| FlowErrorProcessorType (inherits from: FlowProcessorType) |
|---|
| DedupeType (inherits from: ProcessorType) |
|---|
DSL Extensions provided by platform-camel-lbs
| ProcessorType |
|---|
| StoreProcessorType store() Stores content within a large binary store |
| FetchProcessorType fetch() Fetches content from a large binary store |
| RouteType |
|---|
| NoStreamCachingType disableStreamCaching() Disables the Camel Stream Caching feature within the current route |
| StoreProcessorType (inherits from: ProcessorType) |
|---|
| StoreProcessorType with(String resourceHandlersBeanName) Configures the resource handlers via a bean |
| FetchProcessorType (inherits from: ProcessorType) |
|---|
| FetchProcessorType with(String resourceHandlersBeanName) Configures the resource handlers via a bean |
| NoStreamCachingType (inherits from: ProcessorType) |
|---|
DSL Extensions provided by platform-camel-event
| ProcessorType |
|---|
| PublishProcessorType publish(Closure publishingLogic) Publishes an event object |
| PublishProcessorType (inherits from: ProcessorType) |
|---|
| PublishProcessorType toTopic(String topic) Configures the topic that an event is publish with. If this method is not called, the event is published to the topic "default". |
| PublishProcessorType eventFactoryClosure(Closure closure) Sets the closure that is used to create the event |
| PublishProcessorType synchronous() Configures synchronous event object delivery (which is the default) |
| PublishProcessorType asynchronous() Configures asynchronous event object delivery |
| PublishProcessorType with(String eventEngineBean) Configures the event engine that the event object is published with |
DSL Extensions provided by platform-camel-hl7
| DataFormatClause |
|---|
| ProcessorType ghl7() Defines marshalling between a standard HL7 message and a MessageAdapter |
| ProcessorType ghl7(Parser parser) Defines marshalling between a standard HL7 message and a MessageAdapter via an HL7 parser |
| ProcessorType ghl7(String charset) Defines marshalling between a standard HL7 message and a MessageAdapter using the given charset |
| ProcessorType ghl7(Parser parser, String charset) Defines marshalling between a standard HL7 message and a MessageAdapter using the given charset and parser |
| ValidatorAdapterType (inherits from: ProcessorAdapterType) |
|---|
| ValidatorAdapterType ghl7() Configures a validator with HL7 support |
DSL Extensions provided by platform-camel-cda
| DataFormatClause |
|---|
| ProcessorType cdar2() Defines marshalling between a standard CDA document and a POCDMT000040ClinicalDocument object |
| ValidatorAdapterType (inherits from: ProcessorAdapterType) |
|---|
| ValidatorAdapterType cdar2() Parameterizes the xsd() validator to validate against a W3C CDA Schema |
| ValidatorAdapterType ccd(Map parameters) Parameterized Schematron validation using CCD constraints |
| ValidatorAdapterType ccd() Standard Schematron validation using CCD constraints |
DSL Extensions provided by platform-camel-test
| ProcessorType |
|---|
| MeasureType measure() Defines a performance measurement location in the route |
| MeasureType (inherits from: ProcessorType) |
|---|
| MeasureType time() Defines the initial measurement point |
| MeasureType checkpoint(String name) Defines a measurement checkpoint, between the initial and the last measurement points |
| MeasureType finish(String name) Defines the last measurement point |
DSL Extensions provided by platform-camel-ihe-xds-core
| ValidatorAdapterType (inherits from: ProcessorAdapterType) |
|---|
| ValidatorAdapterType iti14Request() Validates an ITI-14 request |
| ValidatorAdapterType iti14Response() Validates an ITI-14 response |
| ValidatorAdapterType iti15Request() Validates an ITI-15 request |
| ValidatorAdapterType iti15Response() Validates an ITI-15 response |
| ValidatorAdapterType iti16Request() Validates an ITI-16 request |
| ValidatorAdapterType iti16Response() Validates an ITI-16 response |
| ValidatorAdapterType iti18Request() Validates an ITI-18 request |
| ValidatorAdapterType iti18Response() Validates an ITI-18 response |
| ValidatorAdapterType iti41Request() Validates an ITI-41 request |
| ValidatorAdapterType iti41Response() Validates an ITI-41 response |
| ValidatorAdapterType iti42Request() Validates an ITI-42 request |
| ValidatorAdapterType iti42Response() Validates an ITI-42 response |
| ValidatorAdapterType iti43Request() Validates an ITI-43 request |
| ValidatorAdapterType iti43Response() Validates an ITI-43 response |
DSL Extensions provided by platform-camel-ihe-mllp-core
| ValidatorAdapterType (inherits from: ProcessorAdapterType) |
|---|
| ValidatorAdapterType iti8Request() Validates an ITI-8 request |
| ValidatorAdapterType iti8Response() Validates an ITI-8 response |
| ValidatorAdapterType iti9Request() Validates an ITI-9 request |
| ValidatorAdapterType iti9Response() Validates an ITI-9 response |
| ValidatorAdapterType iti10Request() Validates an ITI-10 request |
| ValidatorAdapterType iti10Response() Validates an ITI-10 response |
| ValidatorAdapterType iti21Request() Validates an ITI-21 request |
| ValidatorAdapterType iti21Response() Validates an ITI-21 response |
| ValidatorAdapterType iti22Request() Validates an ITI-22 request |
| ValidatorAdapterType iti22Response() Validates an ITI-22 response |