org.apache.camel.builder.endpoint.dsl

Interface RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

RestSwaggerEndpointBuilderFactory

public static interface RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the REST Swagger component.

Method Summary

Modifier and Type	Method and Description
default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder	basePath(String basePath) API basePath, for example /v2.
default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder	componentName(String componentName) Name of the Camel component that will perform the requests.
default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder	consumes(String consumes) What payload type this component capable of consuming.
default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder	host(String host) Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port.
default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder	produces(String produces) What payload type this component is producing.
default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder	sslContextParameters(Object sslContextParameters) To configure security using SSLContextParameters.
default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder	sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

basePath

default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder basePath(String basePath)

API basePath, for example /v2. Default is unset, if set overrides the value present in Swagger specification and in the component configuration. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

basePath - the value to set

Returns:

the dsl builder

componentName

default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder 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. Overrides component configuration. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

componentName - the value to set

Returns:

the dsl builder

consumes

default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder consumes(String 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 Swagger specification and. in the component configuration. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

consumes - the value to set

Returns:

the dsl builder

host

default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder host(String 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-swagger next, and global configuration last. If set overrides any value found in the Swagger specification, RestConfiguration. Overrides all other 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 RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder 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

lazyStartProducer

default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder lazyStartProducer(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

produces

default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder produces(String 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 Swagger specification. Overrides all other configuration. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

produces - the value to set

Returns:

the dsl builder

sslContextParameters

default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder sslContextParameters(Object sslContextParameters)

To configure security using SSLContextParameters. 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

sslContextParameters

default RestSwaggerEndpointBuilderFactory.RestSwaggerEndpointBuilder sslContextParameters(String sslContextParameters)

To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder