How do I configure endpoints?

There are a few different approaches to configuring components and endpoints.

Using Java Code

You can explicitly configure a Component using Java code as shown in this example

Or you can explicitly get hold of an Endpoint and configure it using Java code as shown in the Mock endpoint examples.

SomeEndpoint endpoint = camelContext.getEndpoint("someURI", SomeEndpoint.class);
endpoint.setSomething("aValue");

Using Guice

You can also use Guice as the dependency injection framework. For example see the Guice JMS Example

Using Spring XML

You can configure your Component or Endpoint instances in your Spring XML as follows.

<camelContext id="camel" xmlns="http://camel.apache.org/schema/spring">
    <jmxAgent id="agent" disabled="true"/>
</camelContext>

<bean id="activemq" class="org.apache.activemq.camel.component.ActiveMQComponent">
  <property name="connectionFactory">
    <bean class="org.apache.activemq.ActiveMQConnectionFactory">
      <property name="brokerURL" value="vm://localhost?broker.persistent=false&amp;broker.useJmx=false"/>
    </bean>
  </property>
</bean>

Which allows you to configure a component using some name (activemq in the above example), then you can refer to the component using activemq:[queue:|topic:]destinationName. This works by the SpringCamelContext lazily fetching components from the spring context for the scheme name you use for Endpoint URIs

Using Endpoint URIs

Another approach is to use the URI syntax. The URI syntax supports the query notation. So for example with the Mail component you can configure the password property via the URI

pop3://host:port?password=foo

Referring beans from Endpoint URIs

Available as of Camel 2.0

When configuring endpoints using URI syntax you can now refer to beans in the Registry using the # notation.
If the parameter value starts with a # sign then Camel will lookup in the Registry for a bean of the given type. For instance:

file://inbox?sorter=#mySpecialFileSorter

Will lookup a bean with the id mySpecialFileSorter in the Registry.

Configuring parameter values using raw values, eg such as passwords

Available as of Camel 2.11

When configuring endpoint options using URI syntax, then the values is by default URI encoded. This can be a problem if you want to configure passwords and just use the value as is without any encoding. For example you may have a plus sign in the password, which would be decimal encoded by default.

So from Camel 2.11 onwards we made this easier as you can denote a parameter value to be raw using the following syntax RAW(value). eg the value starts with RAW( and then ends with the parenthesis ). Here is a little example:

.to("ftp:joe@myftpserver.com?password=RAW(se+re?t&23)&binary=true"

In the above example, we have declare the password value as raw, and the actual password would be as typed, eg se+re?t&23.

Using property placeholders

Camel have extensive support for using property placeholders, which you can read more about here. For example in the ftp example above we can externalize the password to a .properties file.

For example configuring the property placeholder when using a XML DSL, where we declare the location of the .properties file. Though we can also define this in Java code. See the documentation for more details.

<camelContext ...>
   <propertyPlaceholder id="properties" location="myftp.properties"/>
   ...
</camelContext>

And the Camel route now refers to the placeholder using the {{ key }} notation:

.to("ftp:joe@myftpserver.com?password={{myFtpPassword}}&binary=true"

And have a myftp.properties file with password. Notice we still define the RAW(value) style to ensure the password is used as is

myFtpPassword=RAW(se+re?t&23)

We could still have used the RAW(value) in the Camel route instead:

.to("ftp:joe@myftpserver.com?password=RAW({{myFtpPassword}})&binary=true"

And then we would need to remove the RAW from the properties file:

myFtpPassword=se+re?t&23

To understand more about property placeholders, read the documentation.

See Also

• How do I add a component
• Spring
• URIs
• Using PropertyPlaceholder