You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2024/03/28 14:40:15 UTC
(camel) 01/38: CAMEL-20557: Rest DSL to use openapi spec directly
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch openapi2
in repository https://gitbox.apache.org/repos/asf/camel.git
commit ea8682c1e77c8d3c7ac1f33dcfed3f423c7f9ace
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Sun Mar 24 11:56:41 2024 +0100
CAMEL-20557: Rest DSL to use openapi spec directly
---
.../camel/catalog/components/rest-openapi.json | 34 ++--
.../camel/component/rest/openapi/rest-openapi.json | 34 ++--
.../rest/openapi/RestOpenApiComponent.java | 49 ++---
.../rest/openapi/RestOpenApiEndpoint.java | 35 ++--
.../org/apache/camel/spi/RestConsumerFactory.java | 1 +
...actory.java => RestOpenApiConsumerFactory.java} | 20 +-
.../main/support/MockRestConsumerFactory.java | 4 +
.../dsl/RestOpenapiComponentBuilderFactory.java | 156 ++++++++--------
.../dsl/RestOpenApiEndpointBuilderFactory.java | 204 ++++++++++-----------
9 files changed, 254 insertions(+), 283 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/rest-openapi.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/rest-openapi.json
index 3393cc929be..9242b3b9735 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/rest-openapi.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/rest-openapi.json
@@ -24,15 +24,15 @@
},
"componentProperties": {
"basePath": { "index": 0, "kind": "property", "displayName": "Base Path", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "API basePath, for example \/v2. Default is unset, if set overrides the value present in OpenApi specification." },
- "componentName": { "index": 1, "kind": "property", "displayName": "Component Name", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for sing [...]
- "consumes": { "index": 2, "kind": "property", "displayName": "Consumes", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component capable of consuming. Could be one type, like application\/json or multiple types as application\/json, application\/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP he [...]
- "host": { "index": 3, "kind": "property", "displayName": "Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Scheme hostname and port to direct the HTTP requests to in the form of https:\/\/hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a nam [...]
- "lazyStartProducer": { "index": 4, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 [...]
- "produces": { "index": 5, "kind": "property", "displayName": "Produces", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component is producing. For example application\/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Can be [...]
- "requestValidationCustomizer": { "index": 6, "kind": "property", "displayName": "Request Validation Customizer", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer", "description": "If request validation is enabled, [...]
- "requestValidationEnabled": { "index": 7, "kind": "property", "displayName": "Request Validation Enabled", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable validation of requests against the configured OpenAPI specification" },
- "specificationUri": { "index": 8, "kind": "property", "displayName": "Specification Uri", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.net.URI", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "openapi.json", "description": "Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If [...]
- "autowiredEnabled": { "index": 9, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching t [...]
+ "host": { "index": 1, "kind": "property", "displayName": "Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Scheme hostname and port to direct the HTTP requests to in the form of https:\/\/hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a nam [...]
+ "lazyStartProducer": { "index": 2, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 [...]
+ "requestValidationEnabled": { "index": 3, "kind": "property", "displayName": "Request Validation Enabled", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable validation of requests against the configured OpenAPI specification" },
+ "specificationUri": { "index": 4, "kind": "property", "displayName": "Specification Uri", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.net.URI", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "openapi.json", "description": "Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If [...]
+ "componentName": { "index": 5, "kind": "property", "displayName": "Component Name", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH [...]
+ "consumes": { "index": 6, "kind": "property", "displayName": "Consumes", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component capable of consuming. Could be one type, like application\/json or multiple types as application\/json, application\/xml; q=0.5 according to the RFC7231. This equates to the val [...]
+ "produces": { "index": 7, "kind": "property", "displayName": "Produces", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component is producing. For example application\/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi sp [...]
+ "autowiredEnabled": { "index": 8, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching t [...]
+ "requestValidationCustomizer": { "index": 9, "kind": "property", "displayName": "Request Validation Customizer", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer", "deprecated": false, "autowired": false, "secret": false, "description": "If request validation is enabled, this option provides the capability to customize the creation of OpenApiInteractionValidator us [...]
"sslContextParameters": { "index": 10, "kind": "property", "displayName": "Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "object", "javaType": "org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false, "autowired": false, "secret": false, "description": "Customize TLS parameters used by the component. If not set defaults to the TLS parameters set in the Camel context" },
"useGlobalSslContextParameters": { "index": 11, "kind": "property", "displayName": "Use Global Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable usage of global SSL context parameters." }
},
@@ -40,13 +40,13 @@
"specificationUri": { "index": 0, "kind": "path", "displayName": "Specification Uri", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.net.URI", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "openapi.json", "description": "Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If not [...]
"operationId": { "index": 1, "kind": "path", "displayName": "Operation Id", "group": "producer", "label": "producer", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "ID of the operation from the OpenApi specification." },
"basePath": { "index": 2, "kind": "parameter", "displayName": "Base Path", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "API basePath, for example \/v3. Default is unset, if set overrides the value present in OpenApi specification and in the component configuration." },
- "componentName": { "index": 3, "kind": "parameter", "displayName": "Component Name", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for sin [...]
- "consumes": { "index": 4, "kind": "parameter", "displayName": "Consumes", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component capable of consuming. Could be one type, like application\/json or multiple types as application\/json, application\/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP h [...]
- "host": { "index": 5, "kind": "parameter", "displayName": "Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Scheme hostname and port to direct the HTTP requests to in the form of https:\/\/hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a na [...]
- "produces": { "index": 6, "kind": "parameter", "displayName": "Produces", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component is producing. For example application\/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Overri [...]
- "requestValidationCustomizer": { "index": 7, "kind": "parameter", "displayName": "Request Validation Customizer", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer", "description": "If request validation is enabled [...]
- "requestValidationEnabled": { "index": 8, "kind": "parameter", "displayName": "Request Validation Enabled", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable validation of requests against the configured OpenAPI specification" },
- "requestValidationLevels": { "index": 9, "kind": "parameter", "displayName": "Request Validation Levels", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "validation.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "Levels for specific OpenAPI request validation options. Multiple options can be specified as URI options prefixed by 'validatio [...]
- "lazyStartProducer": { "index": 10, "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 produ [...]
+ "consumes": { "index": 3, "kind": "parameter", "displayName": "Consumes", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component capable of consuming. Could be one type, like application\/json or multiple types as application\/json, application\/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP h [...]
+ "host": { "index": 4, "kind": "parameter", "displayName": "Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Scheme hostname and port to direct the HTTP requests to in the form of https:\/\/hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a na [...]
+ "produces": { "index": 5, "kind": "parameter", "displayName": "Produces", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component is producing. For example application\/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Overri [...]
+ "requestValidationEnabled": { "index": 6, "kind": "parameter", "displayName": "Request Validation Enabled", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable validation of requests against the configured OpenAPI specification" },
+ "componentName": { "index": 7, "kind": "parameter", "displayName": "Component Name", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH [...]
+ "lazyStartProducer": { "index": 8, "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 produc [...]
+ "requestValidationCustomizer": { "index": 9, "kind": "parameter", "displayName": "Request Validation Customizer", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer", "deprecated": false, "autowired": false, "secret": false, "description": "If request validation is enabled, this option provides the capability to customize the creation of OpenApiInteractionValidator u [...]
+ "requestValidationLevels": { "index": 10, "kind": "parameter", "displayName": "Request Validation Levels", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "validation.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "Levels for specific OpenAPI request validation options. Multiple options can be specified as URI options prefixed by ' [...]
}
}
diff --git a/components/camel-rest-openapi/src/generated/resources/META-INF/org/apache/camel/component/rest/openapi/rest-openapi.json b/components/camel-rest-openapi/src/generated/resources/META-INF/org/apache/camel/component/rest/openapi/rest-openapi.json
index 3393cc929be..9242b3b9735 100644
--- a/components/camel-rest-openapi/src/generated/resources/META-INF/org/apache/camel/component/rest/openapi/rest-openapi.json
+++ b/components/camel-rest-openapi/src/generated/resources/META-INF/org/apache/camel/component/rest/openapi/rest-openapi.json
@@ -24,15 +24,15 @@
},
"componentProperties": {
"basePath": { "index": 0, "kind": "property", "displayName": "Base Path", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "API basePath, for example \/v2. Default is unset, if set overrides the value present in OpenApi specification." },
- "componentName": { "index": 1, "kind": "property", "displayName": "Component Name", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for sing [...]
- "consumes": { "index": 2, "kind": "property", "displayName": "Consumes", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component capable of consuming. Could be one type, like application\/json or multiple types as application\/json, application\/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP he [...]
- "host": { "index": 3, "kind": "property", "displayName": "Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Scheme hostname and port to direct the HTTP requests to in the form of https:\/\/hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a nam [...]
- "lazyStartProducer": { "index": 4, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 [...]
- "produces": { "index": 5, "kind": "property", "displayName": "Produces", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component is producing. For example application\/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Can be [...]
- "requestValidationCustomizer": { "index": 6, "kind": "property", "displayName": "Request Validation Customizer", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer", "description": "If request validation is enabled, [...]
- "requestValidationEnabled": { "index": 7, "kind": "property", "displayName": "Request Validation Enabled", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable validation of requests against the configured OpenAPI specification" },
- "specificationUri": { "index": 8, "kind": "property", "displayName": "Specification Uri", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.net.URI", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "openapi.json", "description": "Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If [...]
- "autowiredEnabled": { "index": 9, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching t [...]
+ "host": { "index": 1, "kind": "property", "displayName": "Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Scheme hostname and port to direct the HTTP requests to in the form of https:\/\/hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a nam [...]
+ "lazyStartProducer": { "index": 2, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 [...]
+ "requestValidationEnabled": { "index": 3, "kind": "property", "displayName": "Request Validation Enabled", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable validation of requests against the configured OpenAPI specification" },
+ "specificationUri": { "index": 4, "kind": "property", "displayName": "Specification Uri", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.net.URI", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "openapi.json", "description": "Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If [...]
+ "componentName": { "index": 5, "kind": "property", "displayName": "Component Name", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH [...]
+ "consumes": { "index": 6, "kind": "property", "displayName": "Consumes", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component capable of consuming. Could be one type, like application\/json or multiple types as application\/json, application\/xml; q=0.5 according to the RFC7231. This equates to the val [...]
+ "produces": { "index": 7, "kind": "property", "displayName": "Produces", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component is producing. For example application\/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi sp [...]
+ "autowiredEnabled": { "index": 8, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching t [...]
+ "requestValidationCustomizer": { "index": 9, "kind": "property", "displayName": "Request Validation Customizer", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer", "deprecated": false, "autowired": false, "secret": false, "description": "If request validation is enabled, this option provides the capability to customize the creation of OpenApiInteractionValidator us [...]
"sslContextParameters": { "index": 10, "kind": "property", "displayName": "Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "object", "javaType": "org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false, "autowired": false, "secret": false, "description": "Customize TLS parameters used by the component. If not set defaults to the TLS parameters set in the Camel context" },
"useGlobalSslContextParameters": { "index": 11, "kind": "property", "displayName": "Use Global Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable usage of global SSL context parameters." }
},
@@ -40,13 +40,13 @@
"specificationUri": { "index": 0, "kind": "path", "displayName": "Specification Uri", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.net.URI", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "openapi.json", "description": "Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If not [...]
"operationId": { "index": 1, "kind": "path", "displayName": "Operation Id", "group": "producer", "label": "producer", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "ID of the operation from the OpenApi specification." },
"basePath": { "index": 2, "kind": "parameter", "displayName": "Base Path", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "API basePath, for example \/v3. Default is unset, if set overrides the value present in OpenApi specification and in the component configuration." },
- "componentName": { "index": 3, "kind": "parameter", "displayName": "Component Name", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for sin [...]
- "consumes": { "index": 4, "kind": "parameter", "displayName": "Consumes", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component capable of consuming. Could be one type, like application\/json or multiple types as application\/json, application\/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP h [...]
- "host": { "index": 5, "kind": "parameter", "displayName": "Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Scheme hostname and port to direct the HTTP requests to in the form of https:\/\/hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a na [...]
- "produces": { "index": 6, "kind": "parameter", "displayName": "Produces", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component is producing. For example application\/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Overri [...]
- "requestValidationCustomizer": { "index": 7, "kind": "parameter", "displayName": "Request Validation Customizer", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer", "description": "If request validation is enabled [...]
- "requestValidationEnabled": { "index": 8, "kind": "parameter", "displayName": "Request Validation Enabled", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable validation of requests against the configured OpenAPI specification" },
- "requestValidationLevels": { "index": 9, "kind": "parameter", "displayName": "Request Validation Levels", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "validation.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "Levels for specific OpenAPI request validation options. Multiple options can be specified as URI options prefixed by 'validatio [...]
- "lazyStartProducer": { "index": 10, "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 produ [...]
+ "consumes": { "index": 3, "kind": "parameter", "displayName": "Consumes", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component capable of consuming. Could be one type, like application\/json or multiple types as application\/json, application\/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP h [...]
+ "host": { "index": 4, "kind": "parameter", "displayName": "Host", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Scheme hostname and port to direct the HTTP requests to in the form of https:\/\/hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a na [...]
+ "produces": { "index": 5, "kind": "parameter", "displayName": "Produces", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "What payload type this component is producing. For example application\/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Overri [...]
+ "requestValidationEnabled": { "index": 6, "kind": "parameter", "displayName": "Request Validation Enabled", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable validation of requests against the configured OpenAPI specification" },
+ "componentName": { "index": 7, "kind": "parameter", "displayName": "Component Name", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH [...]
+ "lazyStartProducer": { "index": 8, "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 produc [...]
+ "requestValidationCustomizer": { "index": 9, "kind": "parameter", "displayName": "Request Validation Customizer", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer", "deprecated": false, "autowired": false, "secret": false, "description": "If request validation is enabled, this option provides the capability to customize the creation of OpenApiInteractionValidator u [...]
+ "requestValidationLevels": { "index": 10, "kind": "parameter", "displayName": "Request Validation Levels", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "validation.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "Levels for specific OpenAPI request validation options. Multiple options can be specified as URI options prefixed by ' [...]
}
}
diff --git a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiComponent.java b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiComponent.java
index a20dc157392..ec4acc1707d 100644
--- a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiComponent.java
+++ b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiComponent.java
@@ -78,32 +78,22 @@ import static org.apache.camel.util.StringHelper.notEmpty;
*/
@Component("rest-openapi")
public final class RestOpenApiComponent extends DefaultComponent implements SSLContextParametersAware {
+
public static final String DEFAULT_BASE_PATH = "/";
static final URI DEFAULT_SPECIFICATION_URI = URI.create(RestOpenApiComponent.DEFAULT_SPECIFICATION_URI_STR);
static final String DEFAULT_SPECIFICATION_URI_STR = "openapi.json";
- @Metadata(
- description = "API basePath, for example \"`/v2`\". Default is unset, if set overrides the value present in OpenApi specification.",
- defaultValue = "", label = "producer")
+ @Metadata(description = "API basePath, for example \"`/v2`\". Default is unset, if set overrides the value present in OpenApi specification.",
+ label = "producer")
private String basePath = "";
-
@Metadata(description = "Name of the Camel component that will perform the requests. The component must be present"
+ " in Camel registry and it must implement RestProducerFactory service provider interface. If not set"
+ " CLASSPATH is searched for single component that implements RestProducerFactory SPI. Can be overridden in"
+ " endpoint configuration.",
- label = "producer", required = false)
+ label = "producer,advanced")
private String componentName;
-
- @Metadata(
- description = "What payload type this component capable of consuming. Could be one type, like `application/json`"
- + " or multiple types as `application/json, application/xml; q=0.5` according to the RFC7231. This equates"
- + " to the value of `Accept` HTTP header. If set overrides any value found in the OpenApi specification."
- + " Can be overridden in endpoint configuration",
- label = "producer")
- private String consumes;
-
@Metadata(description = "Scheme hostname and port to direct the HTTP requests to in the form of"
+ " `http[s]://hostname[:port]`. Can be configured at the endpoint, component or in the corresponding"
+ " REST configuration in the Camel Context. If you give this component a name (e.g. `petstore`) that"
@@ -112,14 +102,17 @@ public final class RestOpenApiComponent extends DefaultComponent implements SSLC
+ " configuration.",
label = "producer")
private String host;
-
- @Metadata(
- description = "What payload type this component is producing. For example `application/json`"
+ @Metadata(description = "What payload type this component capable of consuming. Could be one type, like `application/json`"
+ + " or multiple types as `application/json, application/xml; q=0.5` according to the RFC7231. This equates"
+ + " to the value of `Accept` HTTP header. If set overrides any value found in the OpenApi specification."
+ + " Can be overridden in endpoint configuration",
+ label = "producer,advanced")
+ private String consumes;
+ @Metadata(description = "What payload type this component is producing. For example `application/json`"
+ " according to the RFC7231. This equates to the value of `Content-Type` HTTP header. If set overrides"
+ " any value present in the OpenApi specification. Can be overridden in endpoint configuration.",
- label = "producer")
+ label = "producer,advanced")
private String produces;
-
@Metadata(description = "Path to the OpenApi specification file. The scheme, host base path are taken from this"
+ " specification, but these can be overridden with properties on the component or endpoint level. If not"
+ " given the component tries to load `openapi.json` resource. Note that the `host` defined on the"
@@ -128,24 +121,18 @@ public final class RestOpenApiComponent extends DefaultComponent implements SSLC
+ " configuration.",
defaultValue = DEFAULT_SPECIFICATION_URI_STR, label = "producer")
private URI specificationUri;
-
- @Metadata(description = "Customize TLS parameters used by the component. If not set defaults to the TLS parameters"
- + " set in the Camel context ",
- label = "security")
- private SSLContextParameters sslContextParameters;
-
- @Metadata(description = "Enable usage of global SSL context parameters.", label = "security",
- defaultValue = "false")
- private boolean useGlobalSslContextParameters;
-
@Metadata(description = "Enable validation of requests against the configured OpenAPI specification",
defaultValue = "false")
private boolean requestValidationEnabled;
-
@Metadata(description = "If request validation is enabled, this option provides the capability to customize"
+ " the creation of OpenApiInteractionValidator used to validate requests.",
- defaultValue = "org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer")
+ label = "advanced")
private RequestValidationCustomizer requestValidationCustomizer;
+ @Metadata(description = "Enable usage of global SSL context parameters.", label = "security")
+ private boolean useGlobalSslContextParameters;
+ @Metadata(description = "Customize TLS parameters used by the component. If not set defaults to the TLS parameters set in the Camel context ",
+ label = "security")
+ private SSLContextParameters sslContextParameters;
public RestOpenApiComponent() {
}
diff --git a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpoint.java b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpoint.java
index f7916a278d5..0bd4ca6a251 100644
--- a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpoint.java
+++ b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpoint.java
@@ -103,23 +103,14 @@ public final class RestOpenApiEndpoint extends DefaultEndpoint {
@UriParam(description = "API basePath, for example \"`/v3`\". Default is unset, if set overrides the value present in"
+ " OpenApi specification and in the component configuration.",
- defaultValue = "", label = "producer")
+ label = "producer")
private String basePath;
-
@UriParam(description = "Name of the Camel component that will perform the requests. The component must be present"
+ " in Camel registry and it must implement RestProducerFactory service provider interface. If not set"
+ " CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides"
+ " component configuration.",
- label = "producer")
+ label = "producer,advanced")
private String componentName;
-
- @UriParam(description = "What payload type this component capable of consuming. Could be one type, like `application/json`"
- + " or multiple types as `application/json, application/xml; q=0.5` according to the RFC7231. This equates"
- + " to the value of `Accept` HTTP header. If set overrides any value found in the OpenApi specification and."
- + " in the component configuration",
- label = "producer")
- private String consumes;
-
@UriParam(description = "Scheme hostname and port to direct the HTTP requests to in the form of"
+ " `http[s]://hostname[:port]`. Can be configured at the endpoint, component or in the corresponding"
+ " REST configuration in the Camel Context. If you give this component a name (e.g. `petstore`) that"
@@ -128,17 +119,20 @@ public final class RestOpenApiEndpoint extends DefaultEndpoint {
+ " configuration.",
label = "producer")
private String host;
-
@UriPath(description = "ID of the operation from the OpenApi specification.", label = "producer")
@Metadata(required = true)
private String operationId;
-
+ @UriParam(description = "What payload type this component capable of consuming. Could be one type, like `application/json`"
+ + " or multiple types as `application/json, application/xml; q=0.5` according to the RFC7231. This equates"
+ + " to the value of `Accept` HTTP header. If set overrides any value found in the OpenApi specification and."
+ + " in the component configuration",
+ label = "producer")
+ private String consumes;
@UriParam(description = "What payload type this component is producing. For example `application/json`"
+ " according to the RFC7231. This equates to the value of `Content-Type` HTTP header. If set overrides"
+ " any value present in the OpenApi specification. Overrides all other configuration.",
label = "producer")
private String produces;
-
@UriPath(description = "Path to the OpenApi specification file. The scheme, host base path are taken from this"
+ " specification, but these can be overridden with properties on the component or endpoint level. If not"
+ " given the component tries to load `openapi.json` resource from the classpath. Note that the `host` defined on the"
@@ -151,20 +145,16 @@ public final class RestOpenApiEndpoint extends DefaultEndpoint {
defaultValue = RestOpenApiComponent.DEFAULT_SPECIFICATION_URI_STR,
defaultValueNote = "By default loads `openapi.json` file", label = "producer")
private URI specificationUri = RestOpenApiComponent.DEFAULT_SPECIFICATION_URI;
-
- @UriParam(description = "Enable validation of requests against the configured OpenAPI specification",
- defaultValue = "false")
+ @UriParam(description = "Enable validation of requests against the configured OpenAPI specification")
private boolean requestValidationEnabled;
-
@UriParam(description = "If request validation is enabled, this option provides the capability to customize"
+ " the creation of OpenApiInteractionValidator used to validate requests.",
- defaultValue = "org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer")
+ label = "advanced")
private RequestValidationCustomizer requestValidationCustomizer;
-
@UriParam(description = "Levels for specific OpenAPI request validation options. Multiple options can be"
+ " specified as URI options prefixed by 'validation.'. For example, validation.request.body=ERROR"
+ "&validation.request.body.unexpected=IGNORED. Supported values are INFO, ERROR, WARN & IGNORE.",
- prefix = "validation.", multiValue = true)
+ label = "advanced", prefix = "validation.", multiValue = true)
private Map<String, Object> requestValidationLevels = new HashMap<>();
public RestOpenApiEndpoint() {
@@ -605,8 +595,7 @@ public final class RestOpenApiEndpoint extends DefaultEndpoint {
try {
uris.add(new URI(parseVariables(server.getUrl(), server)));
} catch (URISyntaxException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
+ // ignore
}
}
}
diff --git a/core/camel-api/src/main/java/org/apache/camel/spi/RestConsumerFactory.java b/core/camel-api/src/main/java/org/apache/camel/spi/RestConsumerFactory.java
index 9784bc58c4c..06ccdb8f94a 100644
--- a/core/camel-api/src/main/java/org/apache/camel/spi/RestConsumerFactory.java
+++ b/core/camel-api/src/main/java/org/apache/camel/spi/RestConsumerFactory.java
@@ -28,6 +28,7 @@ import org.apache.camel.Processor;
* <a href="http://camel.apache.org/rest-dsl">rest-dsl</a>.
*
* @see RestApiConsumerFactory
+ * @see RestOpenApiConsumerFactory
* @see RestApiProcessorFactory
*/
public interface RestConsumerFactory {
diff --git a/core/camel-api/src/main/java/org/apache/camel/spi/RestConsumerFactory.java b/core/camel-api/src/main/java/org/apache/camel/spi/RestOpenApiConsumerFactory.java
similarity index 66%
copy from core/camel-api/src/main/java/org/apache/camel/spi/RestConsumerFactory.java
copy to core/camel-api/src/main/java/org/apache/camel/spi/RestOpenApiConsumerFactory.java
index 9784bc58c4c..5022a1b8bf2 100644
--- a/core/camel-api/src/main/java/org/apache/camel/spi/RestConsumerFactory.java
+++ b/core/camel-api/src/main/java/org/apache/camel/spi/RestOpenApiConsumerFactory.java
@@ -16,21 +16,22 @@
*/
package org.apache.camel.spi;
-import java.util.Map;
-
import org.apache.camel.CamelContext;
import org.apache.camel.Consumer;
import org.apache.camel.Processor;
+import java.util.Map;
+
/**
- * Allows SPI to plugin a {@link RestConsumerFactory} that creates the Camel {@link Consumer} responsible for handling
+ * Allows SPI to plugin a {@link RestOpenApiConsumerFactory} that creates the Camel {@link Consumer} responsible for handling
* incoming HTTP requests from clients that request to access REST services which has been created using the
- * <a href="http://camel.apache.org/rest-dsl">rest-dsl</a>.
+ * <a href="http://camel.apache.org/rest-dsl">rest-dsl</a> for an entire open-api specification.
*
* @see RestApiConsumerFactory
+ * @see RestOpenApiConsumerFactory
* @see RestApiProcessorFactory
*/
-public interface RestConsumerFactory {
+public interface RestOpenApiConsumerFactory {
/**
* Creates a new REST <a href="http://camel.apache.org/event-driven-consumer.html">Event Driven Consumer</a>, which
@@ -38,19 +39,12 @@ public interface RestConsumerFactory {
*
* @param camelContext the camel context
* @param processor the processor
- * @param verb HTTP verb such as GET, POST
- * @param basePath base path
- * @param uriTemplate uri template
- * @param consumes media-types for what this REST service consume as input (accept-type), is <tt>null</tt> or
- * <tt>*/*</tt> for anything
- * @param produces media-types for what this REST service produces as output, can be <tt>null</tt>
* @param configuration REST configuration
* @param parameters additional parameters
* @return a newly created REST consumer
* @throws Exception can be thrown
*/
Consumer createConsumer(
- CamelContext camelContext, Processor processor, String verb, String basePath, String uriTemplate,
- String consumes, String produces, RestConfiguration configuration, Map<String, Object> parameters)
+ CamelContext camelContext, Processor processor, RestConfiguration configuration, Map<String, Object> parameters)
throws Exception;
}
diff --git a/core/camel-main/src/test/java/org/apache/camel/main/support/MockRestConsumerFactory.java b/core/camel-main/src/test/java/org/apache/camel/main/support/MockRestConsumerFactory.java
index e54fa2ea09a..6188601f62f 100644
--- a/core/camel-main/src/test/java/org/apache/camel/main/support/MockRestConsumerFactory.java
+++ b/core/camel-main/src/test/java/org/apache/camel/main/support/MockRestConsumerFactory.java
@@ -24,7 +24,11 @@ import org.apache.camel.Processor;
import org.apache.camel.spi.RestConfiguration;
import org.apache.camel.spi.RestConsumerFactory;
+/**
+ * Used for testing purpose in dsl
+ */
public final class MockRestConsumerFactory implements RestConsumerFactory {
+
@Override
public Consumer createConsumer(
CamelContext camelContext,
diff --git a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/RestOpenapiComponentBuilderFactory.java b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/RestOpenapiComponentBuilderFactory.java
index 710861be507..3a2f0efae63 100644
--- a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/RestOpenapiComponentBuilderFactory.java
+++ b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/RestOpenapiComponentBuilderFactory.java
@@ -65,43 +65,6 @@ public interface RestOpenapiComponentBuilderFactory {
doSetProperty("basePath", basePath);
return this;
}
- /**
- * Name of the Camel component that will perform the requests. The
- * component must be present in Camel registry and it must implement
- * RestProducerFactory service provider interface. If not set CLASSPATH
- * is searched for single component that implements RestProducerFactory
- * SPI. Can be overridden in endpoint configuration.
- *
- * The option is a: <code>java.lang.String</code> type.
- *
- * Group: producer
- *
- * @param componentName the value to set
- * @return the dsl builder
- */
- default RestOpenapiComponentBuilder componentName(
- java.lang.String componentName) {
- doSetProperty("componentName", componentName);
- return this;
- }
- /**
- * What payload type this component capable of consuming. Could be one
- * type, like application/json or multiple types as application/json,
- * application/xml; q=0.5 according to the RFC7231. This equates to the
- * value of Accept HTTP header. If set overrides any value found in the
- * OpenApi specification. Can be overridden in endpoint configuration.
- *
- * The option is a: <code>java.lang.String</code> type.
- *
- * Group: producer
- *
- * @param consumes the value to set
- * @return the dsl builder
- */
- default RestOpenapiComponentBuilder consumes(java.lang.String consumes) {
- doSetProperty("consumes", consumes);
- return this;
- }
/**
* Scheme hostname and port to direct the HTTP requests to in the form
* of https://hostname:port. Can be configured at the endpoint,
@@ -147,44 +110,6 @@ public interface RestOpenapiComponentBuilderFactory {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
- /**
- * What payload type this component is producing. For example
- * application/json according to the RFC7231. This equates to the value
- * of Content-Type HTTP header. If set overrides any value present in
- * the OpenApi specification. Can be overridden in endpoint
- * configuration.
- *
- * The option is a: <code>java.lang.String</code> type.
- *
- * Group: producer
- *
- * @param produces the value to set
- * @return the dsl builder
- */
- default RestOpenapiComponentBuilder produces(java.lang.String produces) {
- doSetProperty("produces", produces);
- return this;
- }
- /**
- * If request validation is enabled, this option provides the capability
- * to customize the creation of OpenApiInteractionValidator used to
- * validate requests.
- *
- * The option is a:
- * <code>org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer</code> type.
- *
- * Default:
- * org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer
- * Group: producer
- *
- * @param requestValidationCustomizer the value to set
- * @return the dsl builder
- */
- default RestOpenapiComponentBuilder requestValidationCustomizer(
- org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer requestValidationCustomizer) {
- doSetProperty("requestValidationCustomizer", requestValidationCustomizer);
- return this;
- }
/**
* Enable validation of requests against the configured OpenAPI
* specification.
@@ -225,6 +150,61 @@ public interface RestOpenapiComponentBuilderFactory {
doSetProperty("specificationUri", specificationUri);
return this;
}
+ /**
+ * Name of the Camel component that will perform the requests. The
+ * component must be present in Camel registry and it must implement
+ * RestProducerFactory service provider interface. If not set CLASSPATH
+ * is searched for single component that implements RestProducerFactory
+ * SPI. Can be overridden in endpoint configuration.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: producer (advanced)
+ *
+ * @param componentName the value to set
+ * @return the dsl builder
+ */
+ default RestOpenapiComponentBuilder componentName(
+ java.lang.String componentName) {
+ doSetProperty("componentName", componentName);
+ return this;
+ }
+ /**
+ * What payload type this component capable of consuming. Could be one
+ * type, like application/json or multiple types as application/json,
+ * application/xml; q=0.5 according to the RFC7231. This equates to the
+ * value of Accept HTTP header. If set overrides any value found in the
+ * OpenApi specification. Can be overridden in endpoint configuration.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: producer (advanced)
+ *
+ * @param consumes the value to set
+ * @return the dsl builder
+ */
+ default RestOpenapiComponentBuilder consumes(java.lang.String consumes) {
+ doSetProperty("consumes", consumes);
+ return this;
+ }
+ /**
+ * What payload type this component is producing. For example
+ * application/json according to the RFC7231. This equates to the value
+ * of Content-Type HTTP header. If set overrides any value present in
+ * the OpenApi specification. Can be overridden in endpoint
+ * configuration.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: producer (advanced)
+ *
+ * @param produces the value to set
+ * @return the dsl builder
+ */
+ default RestOpenapiComponentBuilder produces(java.lang.String produces) {
+ doSetProperty("produces", produces);
+ return this;
+ }
/**
* Whether autowiring is enabled. This is used for automatic autowiring
* options (the option must be marked as autowired) by looking up in the
@@ -246,6 +226,24 @@ public interface RestOpenapiComponentBuilderFactory {
doSetProperty("autowiredEnabled", autowiredEnabled);
return this;
}
+ /**
+ * If request validation is enabled, this option provides the capability
+ * to customize the creation of OpenApiInteractionValidator used to
+ * validate requests.
+ *
+ * The option is a:
+ * <code>org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer</code> type.
+ *
+ * Group: advanced
+ *
+ * @param requestValidationCustomizer the value to set
+ * @return the dsl builder
+ */
+ default RestOpenapiComponentBuilder requestValidationCustomizer(
+ org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer requestValidationCustomizer) {
+ doSetProperty("requestValidationCustomizer", requestValidationCustomizer);
+ return this;
+ }
/**
* Customize TLS parameters used by the component. If not set defaults
* to the TLS parameters set in the Camel context.
@@ -297,15 +295,15 @@ public interface RestOpenapiComponentBuilderFactory {
Object value) {
switch (name) {
case "basePath": ((RestOpenApiComponent) component).setBasePath((java.lang.String) value); return true;
- case "componentName": ((RestOpenApiComponent) component).setComponentName((java.lang.String) value); return true;
- case "consumes": ((RestOpenApiComponent) component).setConsumes((java.lang.String) value); return true;
case "host": ((RestOpenApiComponent) component).setHost((java.lang.String) value); return true;
case "lazyStartProducer": ((RestOpenApiComponent) component).setLazyStartProducer((boolean) value); return true;
- case "produces": ((RestOpenApiComponent) component).setProduces((java.lang.String) value); return true;
- case "requestValidationCustomizer": ((RestOpenApiComponent) component).setRequestValidationCustomizer((org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer) value); return true;
case "requestValidationEnabled": ((RestOpenApiComponent) component).setRequestValidationEnabled((boolean) value); return true;
case "specificationUri": ((RestOpenApiComponent) component).setSpecificationUri((java.net.URI) value); return true;
+ case "componentName": ((RestOpenApiComponent) component).setComponentName((java.lang.String) value); return true;
+ case "consumes": ((RestOpenApiComponent) component).setConsumes((java.lang.String) value); return true;
+ case "produces": ((RestOpenApiComponent) component).setProduces((java.lang.String) value); return true;
case "autowiredEnabled": ((RestOpenApiComponent) component).setAutowiredEnabled((boolean) value); return true;
+ case "requestValidationCustomizer": ((RestOpenApiComponent) component).setRequestValidationCustomizer((org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer) value); return true;
case "sslContextParameters": ((RestOpenApiComponent) component).setSslContextParameters((org.apache.camel.support.jsse.SSLContextParameters) value); return true;
case "useGlobalSslContextParameters": ((RestOpenApiComponent) component).setUseGlobalSslContextParameters((boolean) value); return true;
default: return false;
diff --git a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/RestOpenApiEndpointBuilderFactory.java b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/RestOpenApiEndpointBuilderFactory.java
index 4a64b8a2b84..47d90bae33f 100644
--- a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/RestOpenApiEndpointBuilderFactory.java
+++ b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/RestOpenApiEndpointBuilderFactory.java
@@ -60,24 +60,6 @@ public interface RestOpenApiEndpointBuilderFactory {
doSetProperty("basePath", basePath);
return this;
}
- /**
- * Name of the Camel component that will perform the requests. The
- * component must be present in Camel registry and it must implement
- * RestProducerFactory service provider interface. If not set CLASSPATH
- * is searched for single component that implements RestProducerFactory
- * SPI. Overrides component configuration.
- *
- * The option is a: <code>java.lang.String</code> type.
- *
- * Group: producer
- *
- * @param componentName the value to set
- * @return the dsl builder
- */
- default RestOpenApiEndpointBuilder componentName(String componentName) {
- doSetProperty("componentName", componentName);
- return this;
- }
/**
* What payload type this component capable of consuming. Could be one
* type, like application/json or multiple types as application/json,
@@ -133,46 +115,6 @@ public interface RestOpenApiEndpointBuilderFactory {
doSetProperty("produces", produces);
return this;
}
- /**
- * If request validation is enabled, this option provides the capability
- * to customize the creation of OpenApiInteractionValidator used to
- * validate requests.
- *
- * The option is a:
- * <code>org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer</code> type.
- *
- * Default:
- * org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer
- * Group: producer
- *
- * @param requestValidationCustomizer the value to set
- * @return the dsl builder
- */
- default RestOpenApiEndpointBuilder requestValidationCustomizer(
- org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer requestValidationCustomizer) {
- doSetProperty("requestValidationCustomizer", requestValidationCustomizer);
- return this;
- }
- /**
- * If request validation is enabled, this option provides the capability
- * to customize the creation of OpenApiInteractionValidator used to
- * validate requests.
- *
- * The option will be converted to a
- * <code>org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer</code> type.
- *
- * Default:
- * org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer
- * Group: producer
- *
- * @param requestValidationCustomizer the value to set
- * @return the dsl builder
- */
- default RestOpenApiEndpointBuilder requestValidationCustomizer(
- String requestValidationCustomizer) {
- doSetProperty("requestValidationCustomizer", requestValidationCustomizer);
- return this;
- }
/**
* Enable validation of requests against the configured OpenAPI
* specification.
@@ -208,51 +150,6 @@ public interface RestOpenApiEndpointBuilderFactory {
doSetProperty("requestValidationEnabled", requestValidationEnabled);
return this;
}
- /**
- * Levels for specific OpenAPI request validation options. Multiple
- * options can be specified as URI options prefixed by 'validation.'.
- * For example,
- * validation.request.body=ERROR&amp;validation.request.body.unexpected=IGNORED. Supported values are INFO, ERROR, WARN &amp; IGNORE.
- *
- * The option is a: <code>java.util.Map&lt;java.lang.String,
- * java.lang.Object&gt;</code> type.
- * The option is multivalued, and you can use the
- * requestValidationLevels(String, Object) method to add a value (call
- * the method multiple times to set more values).
- *
- * Group: producer
- *
- * @param key the option key
- * @param value the option value
- * @return the dsl builder
- */
- default RestOpenApiEndpointBuilder requestValidationLevels(
- String key,
- Object value) {
- doSetMultiValueProperty("requestValidationLevels", "validation." + key, value);
- return this;
- }
- /**
- * Levels for specific OpenAPI request validation options. Multiple
- * options can be specified as URI options prefixed by 'validation.'.
- * For example,
- * validation.request.body=ERROR&amp;validation.request.body.unexpected=IGNORED. Supported values are INFO, ERROR, WARN &amp; IGNORE.
- *
- * The option is a: <code>java.util.Map&lt;java.lang.String,
- * java.lang.Object&gt;</code> type.
- * The option is multivalued, and you can use the
- * requestValidationLevels(String, Object) method to add a value (call
- * the method multiple times to set more values).
- *
- * Group: producer
- *
- * @param values the values
- * @return the dsl builder
- */
- default RestOpenApiEndpointBuilder requestValidationLevels(Map values) {
- doSetMultiValueProperties("requestValidationLevels", "validation.", values);
- return this;
- }
}
/**
@@ -264,6 +161,25 @@ public interface RestOpenApiEndpointBuilderFactory {
default RestOpenApiEndpointBuilder basic() {
return (RestOpenApiEndpointBuilder) this;
}
+ /**
+ * Name of the Camel component that will perform the requests. The
+ * component must be present in Camel registry and it must implement
+ * RestProducerFactory service provider interface. If not set CLASSPATH
+ * is searched for single component that implements RestProducerFactory
+ * SPI. Overrides component configuration.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: producer (advanced)
+ *
+ * @param componentName the value to set
+ * @return the dsl builder
+ */
+ default AdvancedRestOpenApiEndpointBuilder componentName(
+ String componentName) {
+ doSetProperty("componentName", componentName);
+ return this;
+ }
/**
* Whether the producer should be started lazy (on the first message).
* By starting lazy you can use this to allow CamelContext and routes to
@@ -313,6 +229,88 @@ public interface RestOpenApiEndpointBuilderFactory {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
+ /**
+ * If request validation is enabled, this option provides the capability
+ * to customize the creation of OpenApiInteractionValidator used to
+ * validate requests.
+ *
+ * The option is a:
+ * <code>org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer</code> type.
+ *
+ * Group: advanced
+ *
+ * @param requestValidationCustomizer the value to set
+ * @return the dsl builder
+ */
+ default AdvancedRestOpenApiEndpointBuilder requestValidationCustomizer(
+ org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer requestValidationCustomizer) {
+ doSetProperty("requestValidationCustomizer", requestValidationCustomizer);
+ return this;
+ }
+ /**
+ * If request validation is enabled, this option provides the capability
+ * to customize the creation of OpenApiInteractionValidator used to
+ * validate requests.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer</code> type.
+ *
+ * Group: advanced
+ *
+ * @param requestValidationCustomizer the value to set
+ * @return the dsl builder
+ */
+ default AdvancedRestOpenApiEndpointBuilder requestValidationCustomizer(
+ String requestValidationCustomizer) {
+ doSetProperty("requestValidationCustomizer", requestValidationCustomizer);
+ return this;
+ }
+ /**
+ * Levels for specific OpenAPI request validation options. Multiple
+ * options can be specified as URI options prefixed by 'validation.'.
+ * For example,
+ * validation.request.body=ERROR&amp;validation.request.body.unexpected=IGNORED. Supported values are INFO, ERROR, WARN &amp; IGNORE.
+ *
+ * The option is a: <code>java.util.Map&lt;java.lang.String,
+ * java.lang.Object&gt;</code> type.
+ * The option is multivalued, and you can use the
+ * requestValidationLevels(String, Object) method to add a value (call
+ * the method multiple times to set more values).
+ *
+ * Group: advanced
+ *
+ * @param key the option key
+ * @param value the option value
+ * @return the dsl builder
+ */
+ default AdvancedRestOpenApiEndpointBuilder requestValidationLevels(
+ String key,
+ Object value) {
+ doSetMultiValueProperty("requestValidationLevels", "validation." + key, value);
+ return this;
+ }
+ /**
+ * Levels for specific OpenAPI request validation options. Multiple
+ * options can be specified as URI options prefixed by 'validation.'.
+ * For example,
+ * validation.request.body=ERROR&amp;validation.request.body.unexpected=IGNORED. Supported values are INFO, ERROR, WARN &amp; IGNORE.
+ *
+ * The option is a: <code>java.util.Map&lt;java.lang.String,
+ * java.lang.Object&gt;</code> type.
+ * The option is multivalued, and you can use the
+ * requestValidationLevels(String, Object) method to add a value (call
+ * the method multiple times to set more values).
+ *
+ * Group: advanced
+ *
+ * @param values the values
+ * @return the dsl builder
+ */
+ default AdvancedRestOpenApiEndpointBuilder requestValidationLevels(
+ Map values) {
+ doSetMultiValueProperties("requestValidationLevels", "validation.", values);
+ return this;
+ }
}
public interface RestOpenApiBuilders {