For example we may name the XML file that declare a service through the
Manifest (with optional extension points)
Name_Of_The_Service.xml
The standalone XML files should be suffixed., We may choose let say
-component.xml (because -service.xml is already reserved by JBoss)
So a standalone XML component will be named:
Name_Of_The_Service-component.xml
And a component that declares only extensions (contributions) we may name it
Name_Of_The_Contributions-extension.xml
or
Name_Of_The_Contributions-contribution.xml
Bogdan
Bogdan Stefanescu wrote:
When starting to develop NXRuntime I've choosed "-bundle.xml" suffix
because I needed one..
It means an xml bundle -> a module like a JAR, SAR or other deployable
module but that is defined in an XML file
When first implemented, a -bundle.xml was able to contain any number
of components.
As NXRuntime was refined -bundle.xml files was limited to a single
component.
So, now the bundle file is no more a bundle but a component descriptor
file.
So if we want to rename it I think we may choose a more suggestive
suffix than -bundle.xml
As a remark, there are two methods to define XML components. Using the
Manifest (see Nuxeo-Component: entry in NXCore) or
by deploying a standalone -bundle.xml file.
The *encouraged* method is through the *Manifest* and not by using
standalone bundles.
Why? Because standalone XML files are specific to JBoss and because
the Manifest way is more OSGi like.
So if everyone would change their component deployment to use the
Manifest way to declare them we do no more need a -bundle.xml
suffix. The suffix is required by JBoss not by NXRuntime.
Anyway, there are still some components like the repository
(demo-ds-bundle.xml) that are more convenient to be deployed as
standalone files
(because they are not defined by any module)
But compoents declared inside a JARs like NXRuntime services should be
declared thorugh the Manifest.
Bogdan
Olivier Grisel wrote:
Hi all,
We are starting to grow quite a big number of NXRuntime extensions
and it's
getting hard to guess what XML file is responsible for each feature
in the final
Nuxeo app.
As the jar archives need a naming convention to tidy things a bit (->
lowercase
now), we need a naming convention for XML files that are provider or
consumers
of extension points.
Here is my proposal:
- extensions contributors (that register stuff at extension points)
should be named:
{lowercasenameofcomponent}-bundle-contrib.xml
- components that register extension-points to accept contributions
should be named:
{lowercasenameofcomponent}-bundle-xpoints.xml
- they are also components that are both provider and consumers at
the same
time: should we split their defintions into to seperate files or use
a single
-bundle.xml file?
The final goal is being able to do a shift-ctrl-r (resource search) for
something like *-bundle-*.xml and get all interesting information at
a glance.
Please feel free to comment and I'll add a Jira issue to track the
renaming task
once we reach an agreement on the naming convention (an agreement
means three +1 :).
_______________________________________________
ECM mailing list
[email protected]
http://lists.nuxeo.com/mailman/listinfo/ecm
_______________________________________________
ECM mailing list
[email protected]
http://lists.nuxeo.com/mailman/listinfo/ecm
