You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@stanbol.apache.org by Fabian Christ <ch...@googlemail.com> on 2011/03/24 11:35:54 UTC

Stanbol Enhancer blocks use of root URL "/"

Hi,

currently you have to use the Stanbol Enhancer Jersey bundle to get
the enhancement functionality. This bundle registers the root resource
on "/" and presents a nice intro page when going to localhost:8080.

When you are in a scenario where you want to include Stanbol in
another technology stack, e.g. the IKS, you don't want this behaviour
as you would like to control what happens on root "/".

I think it's nice that Stanbol provides this starting screen but what
about to map it localhost:8080/stanbol or something similar? Or should
we split this and create an own welcome screen bundle. Then an
integrator can decide whether to load this bundle or not. Perhaps this
could be refactored into an online documentation/demo bundle?

WDYT?

-- 
Fabian

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Tommaso Teofili <to...@gmail.com>.
2011/3/24 Olivier Grisel <ol...@ensta.org>

> I would rather extract the generic part (the OSGi component, the
> RootResource, ...) of stanbol/enhancer/jersey into a toplevel
> stanbol/web or stanbol/jersey and have the stanbol/enhancer/jersey
> keep the JAX-RS resources related to enhancement of content items that
> would incrementally contribute to the OSGi HTTP endpoint, contributing
> both the implementation of the JAX-resource and the API documentation
> of the resource.
>
>
I agree, that sounds good to me.
Tommaso

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Olivier Grisel <ol...@ensta.org>.
2011/3/24 Fabian Christ <ch...@googlemail.com>:
>> Good idea, but that sounds too much to do it all at once. I would
>> first do the extraction of the OGSi HTTP endpoint + root resource as
>> it is in a top level component and once this is done, extract the
>> welcome page into another toplevel component.
>
> Agreed. I will create two JIRA issues for this:
>
> 1) Extract Stanbol HTTP endpoint into top level component, so that
> other components can contribute their JAX-resources to this.
>
> 2) Extract the Stanbol welcome page into its own component.
>
>> Also I think this refactoring should be done in a branch to avoid
>> breaking the trunk while work is under progress while allowing for
>> several developers to work on the same code base for testing and
>> helping in the refactoring (I might be able to find so opportunity to
>> help you on this Fabian either tomorrow or next week).
>
> Okay. I will create a branch called "http-endpoint-refactoring" where
> we can do the changes without breaking anything.

Perfect. I will try to stick around on IRC shall you have any question
on implementation details of the existing code base. Please prefix
your messages with "ogrisel" so that my IRC client notifies me of your
questions.

-- 
Olivier
http://twitter.com/ogrisel - http://github.com/ogrisel

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Fabian Christ <ch...@googlemail.com>.
> Good idea, but that sounds too much to do it all at once. I would
> first do the extraction of the OGSi HTTP endpoint + root resource as
> it is in a top level component and once this is done, extract the
> welcome page into another toplevel component.

Agreed. I will create two JIRA issues for this:

1) Extract Stanbol HTTP endpoint into top level component, so that
other components can contribute their JAX-resources to this.

2) Extract the Stanbol welcome page into its own component.

> Also I think this refactoring should be done in a branch to avoid
> breaking the trunk while work is under progress while allowing for
> several developers to work on the same code base for testing and
> helping in the refactoring (I might be able to find so opportunity to
> help you on this Fabian either tomorrow or next week).

Okay. I will create a branch called "http-endpoint-refactoring" where
we can do the changes without breaking anything.

Best,
 - Fabian

-- 
Fabian

Fwd: Stanbol Enhancer blocks use of root URL "/"

Posted by Olivier Grisel <ol...@ensta.org>.
Should have replied to all....


---------- Forwarded message ----------
From: Olivier Grisel <ol...@ensta.org>
Date: 2011/3/24
Subject: Re: Stanbol Enhancer blocks use of root URL "/"
To: Enrico Daga <en...@gmail.com>


2011/3/24 Enrico Daga <en...@gmail.com>:
>
>> I would rather extract the generic part (the OSGi component, the
>> RootResource, ...) of stanbol/enhancer/jersey into a toplevel
>> stanbol/web or stanbol/jersey and have the stanbol/enhancer/jersey
>> keep the JAX-RS resources related to enhancement of content items that
>> would incrementally contribute to the OSGi HTTP endpoint, contributing
>> both the implementation of the JAX-resource and the API documentation
>> of the resource.
> Why don't separate the stanbol rest commons and the welcome/demo staff?

Good idea, but that sounds too much to do it all at once. I would
first do the extraction of the OGSi HTTP endpoint + root resource as
it is in a top level component and once this is done, extract the
welcome page into another toplevel component.

Also I think this refactoring should be done in a branch to avoid
breaking the trunk while work is under progress while allowing for
several developers to work on the same code base for testing and
helping in the refactoring (I might be able to find so opportunity to
help you on this Fabian either tomorrow or next week).

--
Olivier
http://twitter.com/ogrisel - http://github.com/ogrisel



-- 
Olivier
http://twitter.com/ogrisel - http://github.com/ogrisel

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Enrico Daga <en...@gmail.com>.
On 24 March 2011 10:51, Olivier Grisel <ol...@ensta.org> wrote:
> 2011/3/24 Fabian Christ <ch...@googlemail.com>:
>> Thinking about this,
>>
>> what about an new bundle
>>
>> org.apache.stanbol.welcome
>> or
>> org.apache.stanbol.doc
>>
>> this bundle would include
>>
>> * A welcome and intro page to Stanbol
>> * Links to API docs that are generated and automatically included in this bundle
>> * same for REST API docs
>> * Further documentation
>> * (Interactive) demos/tutorials that show how to use Stanbol
>>
>> To start this bundle would use the existing pages from the
>> enhancer/jersey bundle.
>>
>> And as I'm working on something similar for the IKS project I would
>> like to work on this in Stanbol. People who create new features for
>> Stanbol can easily provide demos this way.
>>
>> WDYT?
>>
>> Best,
>>  - Fabian
>>
>> 2011/3/24 Fabian Christ <ch...@googlemail.com>:
>>> Hi,
>>>
>>> currently you have to use the Stanbol Enhancer Jersey bundle to get
>>> the enhancement functionality. This bundle registers the root resource
>>> on "/" and presents a nice intro page when going to localhost:8080.
>>>
>>> When you are in a scenario where you want to include Stanbol in
>>> another technology stack, e.g. the IKS, you don't want this behaviour
>>> as you would like to control what happens on root "/".
>>>
>>> I think it's nice that Stanbol provides this starting screen but what
>>> about to map it localhost:8080/stanbol or something similar? Or should
>>> we split this and create an own welcome screen bundle. Then an
>>> integrator can decide whether to load this bundle or not. Perhaps this
>>> could be refactored into an online documentation/demo bundle?
>>>
>>> WDYT?
>
> I would rather extract the generic part (the OSGi component, the
> RootResource, ...) of stanbol/enhancer/jersey into a toplevel
> stanbol/web or stanbol/jersey and have the stanbol/enhancer/jersey
> keep the JAX-RS resources related to enhancement of content items that
> would incrementally contribute to the OSGi HTTP endpoint, contributing
> both the implementation of the JAX-resource and the API documentation
> of the resource.
Why don't separate the stanbol rest commons and the welcome/demo staff?
>
> --
> Olivier
> http://twitter.com/ogrisel - http://github.com/ogrisel
>



-- 
Enrico Daga

--
http://www.enridaga.net
skype: enri-pan

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Olivier Grisel <ol...@ensta.org>.
2011/3/24 Fabian Christ <ch...@googlemail.com>:
> Thinking about this,
>
> what about an new bundle
>
> org.apache.stanbol.welcome
> or
> org.apache.stanbol.doc
>
> this bundle would include
>
> * A welcome and intro page to Stanbol
> * Links to API docs that are generated and automatically included in this bundle
> * same for REST API docs
> * Further documentation
> * (Interactive) demos/tutorials that show how to use Stanbol
>
> To start this bundle would use the existing pages from the
> enhancer/jersey bundle.
>
> And as I'm working on something similar for the IKS project I would
> like to work on this in Stanbol. People who create new features for
> Stanbol can easily provide demos this way.
>
> WDYT?
>
> Best,
>  - Fabian
>
> 2011/3/24 Fabian Christ <ch...@googlemail.com>:
>> Hi,
>>
>> currently you have to use the Stanbol Enhancer Jersey bundle to get
>> the enhancement functionality. This bundle registers the root resource
>> on "/" and presents a nice intro page when going to localhost:8080.
>>
>> When you are in a scenario where you want to include Stanbol in
>> another technology stack, e.g. the IKS, you don't want this behaviour
>> as you would like to control what happens on root "/".
>>
>> I think it's nice that Stanbol provides this starting screen but what
>> about to map it localhost:8080/stanbol or something similar? Or should
>> we split this and create an own welcome screen bundle. Then an
>> integrator can decide whether to load this bundle or not. Perhaps this
>> could be refactored into an online documentation/demo bundle?
>>
>> WDYT?

I would rather extract the generic part (the OSGi component, the
RootResource, ...) of stanbol/enhancer/jersey into a toplevel
stanbol/web or stanbol/jersey and have the stanbol/enhancer/jersey
keep the JAX-RS resources related to enhancement of content items that
would incrementally contribute to the OSGi HTTP endpoint, contributing
both the implementation of the JAX-resource and the API documentation
of the resource.

-- 
Olivier
http://twitter.com/ogrisel - http://github.com/ogrisel

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Enrico Daga <en...@gmail.com>.
On 24 March 2011 10:46, Fabian Christ <ch...@googlemail.com> wrote:
> Thinking about this,
>
> what about an new bundle
>
> org.apache.stanbol.welcome
> or
> org.apache.stanbol.doc
>
> this bundle would include
>
> * A welcome and intro page to Stanbol
> * Links to API docs that are generated and automatically included in this bundle
> * same for REST API docs
> * Further documentation
> * (Interactive) demos/tutorials that show how to use Stanbol
>
> To start this bundle would use the existing pages from the
> enhancer/jersey bundle.
>
> And as I'm working on something similar for the IKS project I would
> like to work on this in Stanbol. People who create new features for
> Stanbol can easily provide demos this way.
>
> WDYT?
Big +1 for this.


>
> Best,
>  - Fabian
>
> 2011/3/24 Fabian Christ <ch...@googlemail.com>:
>> Hi,
>>
>> currently you have to use the Stanbol Enhancer Jersey bundle to get
>> the enhancement functionality. This bundle registers the root resource
>> on "/" and presents a nice intro page when going to localhost:8080.
>>
>> When you are in a scenario where you want to include Stanbol in
>> another technology stack, e.g. the IKS, you don't want this behaviour
>> as you would like to control what happens on root "/".
>>
>> I think it's nice that Stanbol provides this starting screen but what
>> about to map it localhost:8080/stanbol or something similar? Or should
>> we split this and create an own welcome screen bundle. Then an
>> integrator can decide whether to load this bundle or not. Perhaps this
>> could be refactored into an online documentation/demo bundle?
>>
>> WDYT?
>>
>> --
>> Fabian
>>
>
>
>
> --
> Fabian
>



-- 
Enrico Daga

--
http://www.enridaga.net
skype: enri-pan

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Fabian Christ <ch...@googlemail.com>.
Thinking about this,

what about an new bundle

org.apache.stanbol.welcome
or
org.apache.stanbol.doc

this bundle would include

* A welcome and intro page to Stanbol
* Links to API docs that are generated and automatically included in this bundle
* same for REST API docs
* Further documentation
* (Interactive) demos/tutorials that show how to use Stanbol

To start this bundle would use the existing pages from the
enhancer/jersey bundle.

And as I'm working on something similar for the IKS project I would
like to work on this in Stanbol. People who create new features for
Stanbol can easily provide demos this way.

WDYT?

Best,
 - Fabian

2011/3/24 Fabian Christ <ch...@googlemail.com>:
> Hi,
>
> currently you have to use the Stanbol Enhancer Jersey bundle to get
> the enhancement functionality. This bundle registers the root resource
> on "/" and presents a nice intro page when going to localhost:8080.
>
> When you are in a scenario where you want to include Stanbol in
> another technology stack, e.g. the IKS, you don't want this behaviour
> as you would like to control what happens on root "/".
>
> I think it's nice that Stanbol provides this starting screen but what
> about to map it localhost:8080/stanbol or something similar? Or should
> we split this and create an own welcome screen bundle. Then an
> integrator can decide whether to load this bundle or not. Perhaps this
> could be refactored into an online documentation/demo bundle?
>
> WDYT?
>
> --
> Fabian
>



-- 
Fabian

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Fabian Christ <ch...@googlemail.com>.
2011/3/24 Olivier Grisel <ol...@ensta.org>:
> If I am not mistaken the root prefix is a configuration parameter of
> the Jersey Endpoint of the OSGi service. If it's not the case, we
> should implement that instead of hardcoding a prefix.

Ah okay, thanks for the hint. I will check this.

-- 
Fabian

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Fabian Christ <ch...@googlemail.com>.
2011/3/24 Olivier Grisel <ol...@ensta.org>:
> If I am not mistaken the root prefix is a configuration parameter of
> the Jersey Endpoint of the OSGi service. If it's not the case, we
> should implement that instead of hardcoding a prefix.

You're right. This can already be configured via OSGI at
org.apache.stanbol.enhancer.jersey.JerseyEndpoint.name.

-- 
Fabian

Re: Stanbol Enhancer blocks use of root URL "/"

Posted by Olivier Grisel <ol...@ensta.org>.
2011/3/24 Fabian Christ <ch...@googlemail.com>:
> Hi,
>
> currently you have to use the Stanbol Enhancer Jersey bundle to get
> the enhancement functionality. This bundle registers the root resource
> on "/" and presents a nice intro page when going to localhost:8080.
>
> When you are in a scenario where you want to include Stanbol in
> another technology stack, e.g. the IKS, you don't want this behaviour
> as you would like to control what happens on root "/".
>
> I think it's nice that Stanbol provides this starting screen but what
> about to map it localhost:8080/stanbol or something similar? Or should
> we split this and create an own welcome screen bundle. Then an
> integrator can decide whether to load this bundle or not. Perhaps this
> could be refactored into an online documentation/demo bundle?

If I am not mistaken the root prefix is a configuration parameter of
the Jersey Endpoint of the OSGi service. If it's not the case, we
should implement that instead of hardcoding a prefix.


-- 
Olivier
http://twitter.com/ogrisel - http://github.com/ogrisel