docs/components/modules/ROOT/pages/service-component.adoc

[[service-component]]
= Service Component
//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
:page-source: components/camel-service/src/main/docs/service-component.adoc
:docTitle: Service
:artifactId: camel-service
:description: Register a Camel endpoint to a Service Registry (such as Consul, Etcd) and delegate to it.
:since: 2.22
:supportLevel: Stable
:component-header: Only consumer is supported

*Since Camel {since}*

*{component-header}*


== Using the service endpoint


== URI format

[source]
----
service:serviceName:endpoint[?options]
----


== Options

// component options: START
The Service component supports 4 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *service* (advanced) | Inject the service to use. |  | ServiceRegistry
| *serviceSelector* (advanced) | Inject the service selector used to lookup the ServiceRegistry to use. |  | Selector
|===
// component options: END

// endpoint options: START
The Service endpoint is configured using URI syntax:

----
service:delegateUri
----

with the following path and query parameters:

=== Path Parameters (1 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *delegateUri* | *Required* The endpoint uri to expose as service |  | String
|===


=== Query Parameters (5 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut |  | ExchangePattern
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|===
// endpoint options: END



== Implementations

Camel provide the following ServiceRegistry implementations:

- camel-consul
- camel-zookeeper
- camel-spring-cloud


include::camel-spring-boot::page$service-starter.adoc[]