You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2019/09/23 09:16:56 UTC
[james-project] 12/16: JAMES-2886 Document Guice custom extensions
This is an automated email from the ASF dual-hosted git repository.
btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 1ffc03f900288fd1851fce8fb0e8b31f3daccf6a
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Sat Sep 21 08:20:54 2019 +0700
JAMES-2886 Document Guice custom extensions
---
src/site/xdoc/server/config-listeners.xml | 8 ++++++++
src/site/xdoc/server/dev-extend-mailet.xml | 8 ++++++++
src/site/xdoc/server/dev-extend-matcher.xml | 8 ++++++++
3 files changed, 24 insertions(+)
diff --git a/src/site/xdoc/server/config-listeners.xml b/src/site/xdoc/server/config-listeners.xml
index 0f9a41c..aa35f71 100644
--- a/src/site/xdoc/server/config-listeners.xml
+++ b/src/site/xdoc/server/config-listeners.xml
@@ -83,6 +83,14 @@
</li>
</ul>
</section>
+
+ <section name="Add custom Guice injections for extensions">
+ <p>Upon injections, the user can reference additional guice modules, that are going to be used only upon extensions instantiation.
+ In order to do that:</p>
+ <p> 1. Place the jar containing the guice module that should be used to instantiate your extensions within the /extensions-jars folder</p>
+ <p> 2. Register your module fully qualified class name within <a href="https://github.com/apache/james-projectdockerfiles/run/guice/memory/destination/conf/extensions.properties">
+ extensions.properties</a> under the <code>guice.extension.module</code> key.</p>
+ </section>
</body>
</document>
diff --git a/src/site/xdoc/server/dev-extend-mailet.xml b/src/site/xdoc/server/dev-extend-mailet.xml
index c343345..8b9fe24 100644
--- a/src/site/xdoc/server/dev-extend-mailet.xml
+++ b/src/site/xdoc/server/dev-extend-mailet.xml
@@ -175,6 +175,14 @@ public class MyMailet extends GenericMailet{
</p>
</subsection>
+ <subsection name="Add custom Guice injections for extensions">
+ <p>Upon injections, the user can reference additional guice modules, that are going to be used only upon extensions instantiation.
+ In order to do that:</p>
+ <p> 1. Place the jar containing the guice module that should be used to instantiate your extensions within the /extensions-jars folder</p>
+ <p> 2. Register your module fully qualified class name within <a href="https://github.com/apache/james-projectdockerfiles/run/guice/memory/destination/conf/extensions.properties">
+ extensions.properties</a> under the <code>guice.extension.module</code> key.</p>
+ </subsection>
+
<subsection name="James Configuration">
<p>Configuration of the processor chain is discussed
<a href="config-mailetcontainer.html">elsewhere</a> in this documentation. The
diff --git a/src/site/xdoc/server/dev-extend-matcher.xml b/src/site/xdoc/server/dev-extend-matcher.xml
index 9e1c55b..274d90d 100644
--- a/src/site/xdoc/server/dev-extend-matcher.xml
+++ b/src/site/xdoc/server/dev-extend-matcher.xml
@@ -145,6 +145,14 @@ After that restart james.
</p>
</subsection>
+ <subsection name="Add custom Guice injections for extensions">
+ <p>Upon injections, the user can reference additional guice modules, that are going to be used only upon extensions instantiation.
+ In order to do that:</p>
+ <p> 1. Place the jar containing the guice module that should be used to instantiate your extensions within the /extensions-jars folder</p>
+ <p> 2. Register your module fully qualified class name within <a href="https://github.com/apache/james-projectdockerfiles/run/guice/memory/destination/conf/extensions.properties">
+ extensions.properties</a> under the <code>guice.extension.module</code> key.</p>
+ </subsection>
+
<subsection name="James Configuration">
<p>Configuration of the processor chain is discussed
<a href="config-mailetcontainer.html">elsewhere</a> in this documentation. The
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org