21 Sep
2012
21 Sep
'12
3:57 p.m.
Hi,
I wonder if they are some specific recommendations, in addition to
what's described in [1] and [2] ?
My particular use-case, is to know if there is such a rule as to
create one maven module for one xwiki component, or if several
components can be grouped in the same maven module.
Detailed description: for the xwiki-contrib-mailarchive-api, I started
from a monolithic class (@Component), then I started splitting it up
in several classes. While each of these sub-groups could be considered
components (highly related to the mail archive use-case, ie not
particularly re-usable), for now their life-cycle is managed by the
main Component (ie if one of them needs a query manager, it is not
injected by xwiki framework, but provided to it by the main
Component).
Would it be recommended to move to a whole component architecture, and
make all these sub-components Components managed by xwiki framework ?
Are there any limitations (perfs...) to do it that way ?
I'm pretty sure it's obvious to xwiki devs, but I prefer to ask.
Br,
Jeremie
[1] http://platform.xwiki.org/xwiki/bin/view/DevGuide/WritingComponents
[2] http://extensions.xwiki.org/xwiki/bin/view/Extension/Component+Module
21 Sep
21 Sep
4:20 p.m.
On Fri, Sep 21, 2012 at 3:57 PM, Jeremie BOUSQUET
<jeremie.bousquet(a)gmail.com> wrote:
Hi,
I wonder if they are some specific recommendations, in addition to
what's described in [1] and [2] ?
My particular use-case, is to know if there is such a rule as to
create one maven module for one xwiki component, or if several
components can be grouped in the same maven module.
I could not names much Maven modules with only one component (some
macros maybe a few more stuff) so no it's really not mandatory.
Detailed description: for the xwiki-contrib-mailarchive-api, I started
from a monolithic class (@Component), then I started splitting it up
in several classes. While each of these sub-groups could be considered
components (highly related to the mail archive use-case, ie not
particularly re-usable), for now their life-cycle is managed by the
main Component (ie if one of them needs a query manager, it is not
injected by xwiki framework, but provided to it by the main
Component).
Would it be recommended to move to a whole component architecture, and
make all these sub-components Components managed by xwiki framework ?
Are there any limitations (perfs...) to do it that way ?
I'm pretty sure it's obvious to xwiki devs, but I prefer to ask.
For me the rule of splitting modules does not have much to do with the
components.
Usually I split when I expect to be able to use one of the module
without some of the others.
For example in Extension Manager you have a lots of module but most of
them are actually optional extensions to extension manager itself
(maven repositories handler, xwiki repositories handler, jar extension
handler, xar extension handler, etc...) and in each case behind it
there is potential uses case where it make sense to use some modules
without the other.
Br,
Jeremie
[1] http://platform.xwiki.org/xwiki/bin/view/DevGuide/WritingComponents
[2] http://extensions.xwiki.org/xwiki/bin/view/Extension/Component+Module
_______________________________________________
users mailing list
users(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/users
--
Thomas Mortagne
4:41 p.m.
Thanks Thomas,
Usually I split when I expect to be able to use one of
the module
without some of the others.
For example in Extension Manager you have a lots of module but most of
them are actually optional extensions to extension manager itself
(maven repositories handler, xwiki repositories handler, jar extension
handler, xar extension handler, etc...) and in each case behind it
there is potential uses case where it make sense to use some modules
without the other.
So we're in line, as actual (module) split respects that same concept :)
My question was not really clear (sorry), in fact I wrongly assumed
that it was better to have only 1 Component per module, and restricted
myself from creating several Components for this mail archive module.
But I don't plan to split that in any more module.
Br,
Jeremie
2012/9/21 Thomas Mortagne <thomas.mortagne(a)xwiki.com>om>:
> On Fri, Sep 21, 2012 at 3:57 PM, Jeremie BOUSQUET
> <jeremie.bousquet(a)gmail.com> wrote:
>> Hi,
>>
>> I wonder if they are some specific recommendations, in addition to
>> what's described in [1] and [2] ?
>>
>> My particular use-case, is to know if there is such a rule as to
>> create one maven module for one xwiki component, or if several
>> components can be grouped in the same maven module.
>
> I could not names much Maven modules with only one component (some
> macros maybe a few more stuff) so no it's really not mandatory.
>
>>
>> Detailed description: for the xwiki-contrib-mailarchive-api, I started
>> from a monolithic class (@Component), then I started splitting it up
>> in several classes. While each of these sub-groups could be considered
>> components (highly related to the mail archive use-case, ie not
>> particularly re-usable), for now their life-cycle is managed by the
>> main Component (ie if one of them needs a query manager, it is not
>> injected by xwiki framework, but provided to it by the main
>> Component).
>> Would it be recommended to move to a whole component architecture, and
>> make all these sub-components Components managed by xwiki framework ?
>> Are there any limitations (perfs...) to do it that way ?
>>
>> I'm pretty sure it's obvious to xwiki devs, but I prefer to ask.
>
> For me the rule of splitting modules does not have much to do with the
> components.
>
Usually I split when I expect to be able to use one of
the module
without some of the others.
For example in Extension Manager you have a lots of module but most of
them are actually optional extensions to extension manager itself
(maven repositories handler, xwiki repositories handler, jar extension
handler, xar extension handler, etc...) and in each case behind it
there is potential uses case where it make sense to use some modules
without the other.
>
>>
>> Br,
>> Jeremie
>>
>>
>> [1] http://platform.xwiki.org/xwiki/bin/view/DevGuide/WritingComponents
>> [2] http://extensions.xwiki.org/xwiki/bin/view/Extension/Component+Module
>> _______________________________________________
>> users mailing list
>> users(a)xwiki.org
>> http://lists.xwiki.org/mailman/listinfo/users
>
>
>
> --
> Thomas Mortagne
> _______________________________________________
> users mailing list
> users(a)xwiki.org
> http://lists.xwiki.org/mailman/listinfo/users
4475
days inactive
4475
days old
2 comments
2 participants
participants (2)
-
Jeremie BOUSQUET -
Thomas Mortagne