Interface RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.rest.openapi.RestOpenApiComponent>
- All Known Implementing Classes:
RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilderImpl
- Enclosing interface:
RestOpenapiComponentBuilderFactory
public static interface RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder
extends ComponentBuilder<org.apache.camel.component.rest.openapi.RestOpenApiComponent>
Builder for the REST OpenApi component.
-
Method Summary
Modifier and TypeMethodDescriptionautowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.API basePath, for example /v2.componentName
(String componentName) Name of the Camel component that will perform the requests.What payload type this component capable of consuming.Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).What payload type this component is producing.requestValidationCustomizer
(org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer requestValidationCustomizer) If request validation is enabled, this option provides the capability to customize the creation of OpenApiInteractionValidator used to validate requests.requestValidationEnabled
(boolean requestValidationEnabled) Enable validation of requests against the configured OpenAPI specification.specificationUri
(URI specificationUri) Path to the OpenApi specification file.sslContextParameters
(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) Customize TLS parameters used by the component.useGlobalSslContextParameters
(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
basePath
API basePath, for example /v2. Default is unset, if set overrides the value present in OpenApi specification. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
basePath
- the value to set- Returns:
- the dsl builder
-
componentName
default RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder componentName(String componentName) 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- Parameters:
componentName
- the value to set- Returns:
- the dsl builder
-
consumes
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- Parameters:
consumes
- the value to set- Returns:
- the dsl builder
-
host
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 name (e.g. petstore) that REST configuration is consulted first, rest-openapi next, and global configuration last. If set overrides any value found in the OpenApi specification, RestConfiguration. Can be overridden in endpoint configuration. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
host
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder lazyStartProducer(boolean lazyStartProducer) 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. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
produces
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- Parameters:
produces
- the value to set- Returns:
- the dsl builder
-
requestValidationCustomizer
default RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder requestValidationCustomizer(org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer requestValidationCustomizer) 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- Parameters:
requestValidationCustomizer
- the value to set- Returns:
- the dsl builder
-
requestValidationEnabled
default RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder requestValidationEnabled(boolean requestValidationEnabled) Enable validation of requests against the configured OpenAPI specification. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
requestValidationEnabled
- the value to set- Returns:
- the dsl builder
-
specificationUri
default RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder specificationUri(URI specificationUri) 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 component and endpoint of this Component should contain the scheme, hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Can be overridden in endpoint configuration. The option is a: <code>java.net.URI</code> type. Default: openapi.json Group: producer- Parameters:
specificationUri
- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder autowiredEnabled(boolean autowiredEnabled) 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 type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced- Parameters:
autowiredEnabled
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) Customize TLS parameters used by the component. If not set defaults to the TLS parameters set in the Camel context. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
useGlobalSslContextParameters
default RestOpenapiComponentBuilderFactory.RestOpenapiComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useGlobalSslContextParameters
- the value to set- Returns:
- the dsl builder
-