I think that is a great thought. IMHO, build a solid (nested) XML Schema first for the Synapse Configuration, with reuse of common (complex/simple) types. It seems this has been started already [1]. After that, select the right approach/tooling to deal with it in Java. A schema will help validating the Synapse configuration file(s), especially when using an existing XML parser. Of course, AXIOM can be used too, with validation as described in [2]. But that is just a matter of choice, I guess.
[1]: http://svn.apache.org/viewvc/synapse/trunk/java/repository/schema/ [2]: http://wso2.org/library/2905 Cheers, Peter -----Oorspronkelijk bericht----- Van: Hiranya Jayathilaka [mailto:[email protected]] Verzonden: ma 21-6-2010 10:10 Aan: [email protected] Onderwerp: Re: Facilitating documentation in Synapse Configuration model May be as a part of this impl we should introduce a new interface common to all functional components of Synapse (mediators, sequences, endpoints, tasks etc). Currently we have lot of common functionality distributed among multiple interfaces (eg: setFileName, getFileName, getName). It would be great to unify these stuff into a single interface. The documentation should also be a part of this high level interface. WDYT? Thanks, Hiranya On Mon, Jun 21, 2010 at 11:09 AM, Kasun Indrasiri <[email protected]>wrote: > > +1 > IMO, adding <documentation> tag is pretty straight forward than preserving > the comments during building/serialization. > > -Kasun > > On Sun, Jun 20, 2010 at 11:53 PM, Supun Kamburugamuva > <[email protected]>wrote: > >> Hi All, >> >> It is a good thing to facilitate documentation within the configuration >> model it self. At the moment users can use XML comments. But when synapse >> configuration model is built and serialized these XML comments get lost. So >> it is better to have support for documentation comments. >> >> So one option is to add a documentation tag and a optional attribute to >> the XML configuration elements to facilitate the documentations. Please add >> your thoughts and comments. >> >> Thanks, >> Supun.. >> >> >> >> > > > -- > Kasun Indrasiri > Senior Software Engineer, > WSO2 Inc. - "Lean . Enterprise . Middleware" - http://www.wso2.com/ > Blog : http://kasunpanorama.blogspot.com/ > > -- Hiranya Jayathilaka Senior Software Engineer; WSO2 Inc.; http://wso2.org E-mail: [email protected]; Mobile: +94 77 633 3491 Blog: http://techfeast-hiranya.blogspot.com Please help Logica to respect the environment by not printing this email / Pour contribuer comme Logica au respect de l'environnement, merci de ne pas imprimer ce mail / Bitte drucken Sie diese Nachricht nicht aus und helfen Sie so Logica dabei, die Umwelt zu schützen. / Por favor ajude a Logica a respeitar o ambiente nao imprimindo este correio electronico. This e-mail and any attachment is for authorised use by the intended recipient(s) only. It may contain proprietary material, confidential information and/or be subject to legal privilege. It should not be copied, disclosed to, retained or used by, any other party. If you are not an intended recipient then please promptly delete this e-mail and any attachment and all copies and inform the sender. Thank you.
<<winmail.dat>>
--------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
