camel-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hadrian Zbarcea (JIRA)" <>
Subject [jira] [Commented] (CAMEL-4256) Adding a EndpointConfiguration interface
Date Sat, 30 Jul 2011 23:40:10 GMT


Hadrian Zbarcea commented on CAMEL-4256:

I attached a patch that should give an idea of what I proposed in this issue. There are few
more things remaining to be done:
 * add a MappedEndpointConfiguration extends DefaultEndpointConfiguration that takes all the
parameters and stores them in a Map.This will be the class used by default by the DefaultEndpoint
and will assist in migration and will preserve backwards compatibility
 * validation, the part described by Keith Babo above, which I didn't touch on. It will require
an extra dependency in camel-core on javax.validation.
 * toUriFormat is fairly easy, but I need to define a few annotations like @ProviderConfiguration,
@ConsumerConfiguration that would mark some parameters as making sense only one one side of
the messaging channel.

Once the above is done we can start tackling components one by one and add better unit testing
for supported configurations.

Please review and comment (or nod). I will not commit attached patch for a few days. 

> Adding a EndpointConfiguration interface
> ----------------------------------------
>                 Key: CAMEL-4256
>                 URL:
>             Project: Camel
>          Issue Type: New Feature
>          Components: camel-core
>    Affects Versions: 2.8.0
>            Reporter: Hadrian Zbarcea
>            Assignee: Hadrian Zbarcea
>             Fix For: 2.9.0, 3.0.0
>         Attachments: camel-4256.patch
> One of the key missing pieces from the API is the explicit concept of EndpointConfiguration.
We use URIs for that, ant that's great, but we don't have it in the API. Some components do
have an informal version though.
> I am proposing adding an EndpointConfiguration interface:
> {code}
> public interface EndpointConfiguration {
>   void fromUri(String uri);
>   String toUri();
> }
> {code}
> and maybe other methods, we could also use URI instead of string for pre-parsing. Same
as with other concepts the default implementation would be in impl and components would extend
that and add fields for configuration parameters. 
> This would solve problems related to URI uniqueness to a good extent as toUri() should
always place parameters in the same order. The Endpoint interface would change though.
> The main advantage would be that we can annotate parameters and use javax.validation
to specify if a field is @ProducerOnly, @ConsumerOnly for example, which may exclude them
from toUri() (yes, there are some impacts, the id uri would be different than the config uric).
We could annotate them with @Secret to indicate that at least the value should not appear
in clear in the uri, etc. We could also add an @Default("value"), allowing us to exclude from
the uri fields set on the default value (even if the filed was explicitly set) and so on.
> This would also make static validation possible unit testing configuration would be vastly
simplified and we could improve coverage. We can do it in an incremental way without a big
impact on existing components (especially outside camel) via changes in DefaultEndpoint. I
am working on a prototype, but feedback is highly appreciated.

This message is automatically generated by JIRA.
For more information on JIRA, see:


View raw message