From 63e019d83e84e4a83040f917681d9329310d8830 Mon Sep 17 00:00:00 2001 From: Shane Bryzak Date: Sat, 10 Dec 2011 18:38:05 +1000 Subject: [PATCH] SEAMJCR-22 --- .../main/docbook/en-US/jcr-event-mapping.xml | 45 +++++++++++++------ .../main/docbook/en-US/jcr-introduction.xml | 7 ++- .../src/main/docbook/en-US/jcr-jackrabbit.xml | 7 ++- docs/src/main/docbook/en-US/jcr-modeshape.xml | 9 ++-- 4 files changed, 44 insertions(+), 24 deletions(-) diff --git a/docs/src/main/docbook/en-US/jcr-event-mapping.xml b/docs/src/main/docbook/en-US/jcr-event-mapping.xml index 06091de..0f7ac46 100644 --- a/docs/src/main/docbook/en-US/jcr-event-mapping.xml +++ b/docs/src/main/docbook/en-US/jcr-event-mapping.xml @@ -12,29 +12,46 @@ Seam JCR - Event Mapping +
- Seam JCR provides functionality to fire CDI Events based on events found in JCR. The - rules of how events are fired are based around the underlying implementation. - You will not have an active JCR Session during the event firing, a new one will need - to be created. - Some JCR implementations, like Modeshape fires events on a separate thread, so - probably you will get errors if your observer method is declared on a @RequestScoped - object, for example. + Introduction to Event Mapping + + + Seam JCR provides functionality to fire CDI Events based on events found in JCR. The + rules of how events are fired are based around the underlying implementation. + + + + You will not have an active JCR Session during the event firing, a new one will need + to be created. + + + + Some JCR implementations, like Modeshape fires events on a separate thread, so + probably you will get errors if your observer method is declared on a @RequestScoped + object, for example. +
+
- To observe an event, use the @Observes and the additional qualifiers on seam-jcr-api - module (Check package org.jboss.seam.jcr.annotations.events). If you need to watch any - JCR event, then avoid using any Qualifier at all. - Observing JMS events + + + To observe an event, use the @Observes and the additional qualifiers from the + seam-jcr-api module (Check package org.jboss.seam.jcr.annotations.events). + If you need to watch any JCR event, then avoid using any qualifier at all. + + + + }]]> +
diff --git a/docs/src/main/docbook/en-US/jcr-introduction.xml b/docs/src/main/docbook/en-US/jcr-introduction.xml index 292dd97..d4f5878 100644 --- a/docs/src/main/docbook/en-US/jcr-introduction.xml +++ b/docs/src/main/docbook/en-US/jcr-introduction.xml @@ -48,10 +48,9 @@ Substitute the expression ${seam.jcr.version} with the most recent or appropriate version of Seam JCR. Alternatively, you can create a - Maven - user-defined property - to satisfy this substitution so you can centrally manage the version. + Maven user-defined property + to satisfy this substitution so you can centrally manage the version. diff --git a/docs/src/main/docbook/en-US/jcr-jackrabbit.xml b/docs/src/main/docbook/en-US/jcr-jackrabbit.xml index 7875998..d11b955 100644 --- a/docs/src/main/docbook/en-US/jcr-jackrabbit.xml +++ b/docs/src/main/docbook/en-US/jcr-jackrabbit.xml @@ -33,14 +33,17 @@ - Substitute ${jackrabbit.version} for the JackRabbit version you are running against. Currently, Seam JCR tests against 2.2.4. Please review JackRabbit documentation to determine any additional dependencies. + Substitute ${jackrabbit.version} for the JackRabbit version you are running against. Currently, + Seam JCR tests against 2.2.4. Please review the + JackRabbit documentation + to determine any additional dependencies.
Usage - In order to use JackRabbit's Repository and Session objects in your application, you must define an injection point using the JcrConfiguration annotation based on JackRabbit's required configuration parameters. + In order to use JackRabbit's Repository and Session objects in your application, you must define an injection point using the JcrConfiguration annotation based on JackRabbit's required configuration parameters. Substitute ${modeshape.version} for the ModeShape version you are running against. Currently, Seam JCR tests against 2.5.0.Final. In addition, Lucene is - required to run ModeShape. Please consult the ModeShape getting stated guide for - exact versions. + required to run ModeShape. Please consult the ModeShape Getting Started Guide + for exact versions.
Usage In order to use ModeShape's Repository and Session objects in your application, you must define an injection point using the JcrConfiguration annotation based on - ModeShape's required configuration parameters. Please review the ModeShape getting - started guide for further details. + ModeShape's required configuration parameters. Please review the + ModeShape Getting Started Guide + for further details.