JAMES-2886 Allow to load extensions in WebAdmin #2701

chibenwa · 2019-09-20T04:59:11Z

Next step of #2699 , this work enables one to add new custom routes within the WebAdmin protocol from the extensions-jars folder.

The example of the ApacheCon preparation can then be handled as completly indepandantly source code.

.../protocols/webadmin/webadmin-core/src/test/java/org/apache/james/webadmin/WebAdminUtils.java

mbaechler · 2019-09-20T15:18:42Z

Could you please provide the documentation of how you use this feature?

chibenwa · 2019-09-20T16:23:52Z

[2548fc9180ecba4bc19dd71fda109d9b6151032f] bloop 14:04:12.525 [ERROR] spark.Spark - ignite failed
[2548fc9180ecba4bc19dd71fda109d9b6151032f] java.net.BindException: Address already in use
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at java.base/sun.nio.ch.Net.bind0(Native Method)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at java.base/sun.nio.ch.Net.bind(Net.java:461)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at java.base/sun.nio.ch.Net.bind(Net.java:453)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at java.base/sun.nio.ch.ServerSocketChannelImpl.bind(ServerSocketChannelImpl.java:227)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at java.base/sun.nio.ch.ServerSocketAdaptor.bind(ServerSocketAdaptor.java:80)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at org.eclipse.jetty.server.ServerConnector.openAcceptChannel(ServerConnector.java:342)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	... 9 common frames omitted
[2548fc9180ecba4bc19dd71fda109d9b6151032f] Wrapped by: java.io.IOException: Failed to bind to /0.0.0.0:40261
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at org.eclipse.jetty.server.ServerConnector.openAcceptChannel(ServerConnector.java:346)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at org.eclipse.jetty.server.ServerConnector.open(ServerConnector.java:308)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at org.eclipse.jetty.server.AbstractNetworkConnector.doStart(AbstractNetworkConnector.java:80)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at org.eclipse.jetty.server.ServerConnector.doStart(ServerConnector.java:236)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at org.eclipse.jetty.util.component.AbstractLifeCycle.start(AbstractLifeCycle.java:68)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at org.eclipse.jetty.server.Server.doStart(Server.java:396)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at org.eclipse.jetty.util.component.AbstractLifeCycle.start(AbstractLifeCycle.java:68)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at spark.embeddedserver.jetty.EmbeddedJettyServer.ignite(EmbeddedJettyServer.java:149)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at spark.Service.lambda$init$2(Service.java:574)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] 	at java.base/java.lang.Thread.run(Thread.java:834)
[2548fc9180ecba4bc19dd71fda109d9b6151032f] [INFO]

test this please

src/site/xdoc/server/config-webadmin.xml

mbaechler · 2019-09-23T07:35:53Z

Thank you for the update on the webadmin configuration.
However, I would rather read a general "customization" or "extension" documentation explaining how to achieve that (how should I write my route? can I rely on guice? how to package the classes and their dependencies?)

rouazana

nice, thanks!

src/site/xdoc/server/dev-extend.xml

...e/protocols/webadmin/src/main/java/org/apache/james/modules/server/WebAdminServerModule.java

dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/webadmin.properties

We demonstrate: - A previously defined route can not be overwritten - That public routes are applied after private routes, thus if a private route is already defined, the public route is ignored.

Note that route injection was revisited on this occasion: - Make WebAdmin server responsible of private/public triage. This avoids errors like the one with SwaggerRoutes where the developer forgets to declare his route as public upon injections. This also factorize the code between code & test (as a user might want to define custom public routes as well)

mbaechler · 2019-09-24T08:13:50Z

src/site/xdoc/server/dev-extend.xml

+        Your extension class-loader will be the modified one (James and extensions-jars content) but James class-loader
+        stays unmodified everywhere else.</p>
+
+        <p>Once done, you need to explicitly require James to load your extensions. This needs to be done in the following


Why don't we use an SPI for that? (https://docs.oracle.com/javase/tutorial/sound/SPI-intro.html)
It's the standard way of implementing extensions so why would we create a custom solution for that?

How does SPI interacts with injection system?

Do you want the users extensions to fully rely on SPI for their dependency resolution?

I would consider this being a burdon...

SPI is just a way to declare extension points so that people can put an extension on the classpath an get it loaded.

AFAIK, it doesn't mean that you can't use @Inject or any other DI system.

What it does mean is:

we define clearly with a standard how to extend James

we rely on a standard jar META-INF to declare extensions

I got with your link how as an extension writer I can declare the Services I implement,

I did not get how as an extension user how I select the Services implementations I want to use....

What if a Jat contains listenerA & listenerB & I only want listenerA?

it should be in two different files then

unless your jar parse some configuration by itself

Also does this mean a breaking change for already provided extensions (mailboxListeners?)

src/site/xdoc/server/dev-extend.xml

…ensions

chibenwa · 2019-10-15T03:15:37Z

Merged

chibenwa added the contribution Contribution of a kind contributor - also applicable for community oriented efforts. label Sep 20, 2019

chibenwa added this to the Sprint 11 - Robusta beans milestone Sep 20, 2019

Arsnael approved these changes Sep 20, 2019

View reviewed changes

rouazana reviewed Sep 20, 2019

View reviewed changes

.../protocols/webadmin/webadmin-core/src/test/java/org/apache/james/webadmin/WebAdminUtils.java Outdated Show resolved Hide resolved

chibenwa force-pushed the webadmin-routes-extensions branch 2 times, most recently from d98291d to 2548fc9 Compare September 20, 2019 13:01

Arsnael approved these changes Sep 23, 2019

View reviewed changes

rouazana reviewed Sep 23, 2019

View reviewed changes

src/site/xdoc/server/config-webadmin.xml Outdated Show resolved Hide resolved

rouazana reviewed Sep 23, 2019

View reviewed changes

src/site/xdoc/server/dev-extend.xml Outdated Show resolved Hide resolved

src/site/xdoc/server/dev-extend.xml Outdated Show resolved Hide resolved

src/site/xdoc/server/dev-extend.xml Show resolved Hide resolved

remk reviewed Sep 23, 2019

View reviewed changes

...e/protocols/webadmin/src/main/java/org/apache/james/modules/server/WebAdminServerModule.java Outdated Show resolved Hide resolved

remk reviewed Sep 23, 2019

View reviewed changes

dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/webadmin.properties Show resolved Hide resolved

chibenwa added 12 commits September 24, 2019 09:15

JAMES-2886 Test route overriding behavior

7fd85b8

We demonstrate: - A previously defined route can not be overwritten - That public routes are applied after private routes, thus if a private route is already defined, the public route is ignored.

JAMES-2886 guice.extension.module should be optional

da63b6a

JAMES-2886 Swagger routes should be public

c69675b

fixup! JAMES-2886 Allow a user to define custom routes

d65f6f8

JAMES-2886 Document custom routes within webAdmin

affb8a8

JAMES-2886 Document extensions.routes in webadmin.properties

5ed3139

fixup! JAMES-2886 Document extensions.routes in webadmin.properties

c2370f8

JAMES-2886 Clear documentation for all guice extensions

b64de45

fixup! JAMES-2886 Clear documentation for all guice extensions

80a63e8

fixup! JAMES-2886 Allow a user to define custom routes

c52296b

fixup! JAMES-2886 Configuration examples for custom Guice injections

4e55cdc

chibenwa force-pushed the webadmin-routes-extensions branch from ba6703c to 4e55cdc Compare September 24, 2019 02:21

fixup! fixup! JAMES-2886 Allow a user to define custom routes

424c80a

mbaechler reviewed Sep 24, 2019

View reviewed changes

fixup! fixup! JAMES-2886 Clear documentation for all guice extensions

2511e32

remk reviewed Sep 24, 2019

View reviewed changes

src/site/xdoc/server/dev-extend.xml Outdated Show resolved Hide resolved

chibenwa self-assigned this Sep 27, 2019

chibenwa modified the milestones: Sprint 11 - Robusta beans, Sprint 12 - Robusta beans Oct 1, 2019

fixup! fixup! fixup! JAMES-2886 Clear documentation for all guice ext…

b4b77dc

…ensions

Arsnael approved these changes Oct 14, 2019

View reviewed changes

chibenwa closed this Oct 15, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JAMES-2886 Allow to load extensions in WebAdmin #2701

JAMES-2886 Allow to load extensions in WebAdmin #2701

chibenwa commented Sep 20, 2019

mbaechler commented Sep 20, 2019

chibenwa commented Sep 20, 2019

mbaechler commented Sep 23, 2019

rouazana left a comment

mbaechler Sep 24, 2019

chibenwa Sep 24, 2019

mbaechler Sep 24, 2019

chibenwa Sep 24, 2019

mbaechler Sep 24, 2019

mbaechler Sep 24, 2019

chibenwa Sep 25, 2019

mbaechler Sep 27, 2019

chibenwa commented Oct 15, 2019

JAMES-2886 Allow to load extensions in WebAdmin #2701

JAMES-2886 Allow to load extensions in WebAdmin #2701

Conversation

chibenwa commented Sep 20, 2019

mbaechler commented Sep 20, 2019

chibenwa commented Sep 20, 2019

mbaechler commented Sep 23, 2019

rouazana left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chibenwa commented Oct 15, 2019