[jboss-cvs] JBoss Messaging SVN: r6791 - trunk/docs/user-manual/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu May 14 08:53:48 EDT 2009
Author: jmesnil
Date: 2009-05-14 08:53:47 -0400 (Thu, 14 May 2009)
New Revision: 6791
Modified:
trunk/docs/user-manual/en/modules/intercepting-operations.xml
trunk/docs/user-manual/en/modules/large-messages.xml
trunk/docs/user-manual/en/modules/last-value-queues.xml
trunk/docs/user-manual/en/modules/message-expiry.xml
trunk/docs/user-manual/en/modules/message-grouping.xml
trunk/docs/user-manual/en/modules/pre-acknowledge.xml
trunk/docs/user-manual/en/modules/scheduled-messages.xml
trunk/docs/user-manual/en/modules/security.xml
trunk/docs/user-manual/en/modules/undelivered-messages.xml
Log:
user manual
* use the directory names to refer to the examples
Modified: trunk/docs/user-manual/en/modules/intercepting-operations.xml
===================================================================
--- trunk/docs/user-manual/en/modules/intercepting-operations.xml 2009-05-14 11:36:42 UTC (rev 6790)
+++ trunk/docs/user-manual/en/modules/intercepting-operations.xml 2009-05-14 12:53:47 UTC (rev 6791)
@@ -1,7 +1,46 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="intercepting-operations">
- <title>Intercepting Operations</title>
- <para>blah</para>
-
-
+ <title>Intercepting Operations</title>
+ <para>JBoss Messaging supports <emphasis>interceptors</emphasis> to add behavior into
+ the messaging server.</para>
+
+ <section>
+ <title>Implementing The Interceptors</title>
+ <para>A interceptor must implement the <literal>Interceptor interface</literal>:</para>
+ <programlisting>
+package org.jboss.messaging.core.remoting;
+
+public interface Interceptor
+{
+ boolean intercept(Packet packet, RemotingConnection connection) throws MessagingException;
+}
+ </programlisting>
+ <para>The returned boolean value is important:</para>
+ <itemizedlist>
+ <listitem><para>if <literal>true</literal> is returned, the process continues normally</para></listitem>
+ <listitem><para>if <literal>false</literal> is returned, the process is aborted, no other interceptors will be called
+ and the packet will not be handled by the server at all.</para></listitem>
+ </itemizedlist>
+
+ </section>
+
+ <section>
+ <title>Configuring The Interceptors</title>
+ <para>The interceptors are configured in <literal>jbm-configuration.xml</literal>:</para>
+ <programlisting>
+<remoting-interceptors>
+ <class-name>org.jboss.jms.example.LoginInterceptor</class-name>
+ <class-name>org.jboss.jms.example.AdditionalPropertyInterceptor</class-name>
+</remoting-interceptors>
+ </programlisting>
+ <para>The interceptors classes (and their dependencies) must be added to the server classpath
+ to be properly instantiated and called.</para>
+ </section>
+
+ <section>
+ <title>Example</title>
+ <para>The <ulink url="../../../../examples/jms/interceptor/readme.html"><literal>interceptor</literal>
+ example</ulink> shows how to use interceptors to add properties to a message on the server.</para>
+ </section>
+
</chapter>
Modified: trunk/docs/user-manual/en/modules/large-messages.xml
===================================================================
--- trunk/docs/user-manual/en/modules/large-messages.xml 2009-05-14 11:36:42 UTC (rev 6790)
+++ trunk/docs/user-manual/en/modules/large-messages.xml 2009-05-14 12:53:47 UTC (rev 6791)
@@ -175,7 +175,7 @@
<section>
<title>Example</title>
- <para>The <ulink url="../../../../examples/jms/large-message/readme.html">Large Message Example</ulink> shows
+ <para>The <ulink url="../../../../examples/jms/large-message/readme.html"><literal>large-message</literal> Example</ulink> shows
how large message is configured and used with JMS.</para>
</section>
Modified: trunk/docs/user-manual/en/modules/last-value-queues.xml
===================================================================
--- trunk/docs/user-manual/en/modules/last-value-queues.xml 2009-05-14 11:36:42 UTC (rev 6790)
+++ trunk/docs/user-manual/en/modules/last-value-queues.xml 2009-05-14 12:53:47 UTC (rev 6791)
@@ -46,7 +46,7 @@
<section>
<title>Example</title>
- <para>The <ulink url="../../../../examples/jms/last-value-queue/readme.html">Last-Value Queue example</ulink> shows
+ <para>The <ulink url="../../../../examples/jms/last-value-queue/readme.html"><literal>last-value-queue</literal> example</ulink> shows
how last value queues are configured and used with JMS.</para>
</section>
</chapter>
Modified: trunk/docs/user-manual/en/modules/message-expiry.xml
===================================================================
--- trunk/docs/user-manual/en/modules/message-expiry.xml 2009-05-14 11:36:42 UTC (rev 6790)
+++ trunk/docs/user-manual/en/modules/message-expiry.xml 2009-05-14 12:53:47 UTC (rev 6791)
@@ -67,7 +67,7 @@
</section>
<section>
<title>Example</title>
- <para>The <ulink url="../../../../examples/jms/expiry/readme.html">Expiry example</ulink> shows
+ <para>The <ulink url="../../../../examples/jms/expiry/readme.html"><literal>expiry</literal> example</ulink> shows
how message expiry is configured and used with JMS.</para>
</section>
</chapter>
Modified: trunk/docs/user-manual/en/modules/message-grouping.xml
===================================================================
--- trunk/docs/user-manual/en/modules/message-grouping.xml 2009-05-14 11:36:42 UTC (rev 6790)
+++ trunk/docs/user-manual/en/modules/message-grouping.xml 2009-05-14 12:53:47 UTC (rev 6791)
@@ -52,7 +52,7 @@
<section>
<title>Example</title>
- <para>The <ulink url="../../../../examples/jms/message-group/readme.html">Message Group example</ulink> shows
+ <para>The <ulink url="../../../../examples/jms/message-group/readme.html"><literal>message-group</literal> example</ulink> shows
how message groups are configured and used with JMS.</para>
</section>
</chapter>
Modified: trunk/docs/user-manual/en/modules/pre-acknowledge.xml
===================================================================
--- trunk/docs/user-manual/en/modules/pre-acknowledge.xml 2009-05-14 11:36:42 UTC (rev 6790)
+++ trunk/docs/user-manual/en/modules/pre-acknowledge.xml 2009-05-14 12:53:47 UTC (rev 6791)
@@ -34,7 +34,7 @@
<section>
<title>Example</title>
- <para>The <ulink url="../../../../examples/jms/pre-acknowledge/readme.html">Pre-acknowledgement example</ulink> shows
+ <para>The <ulink url="../../../../examples/jms/pre-acknowledge/readme.html"><literal>pre-acknowledge</literal> example</ulink> shows
how to use pre-acknowledgement mode with with JMS.</para>
</section>
Modified: trunk/docs/user-manual/en/modules/scheduled-messages.xml
===================================================================
--- trunk/docs/user-manual/en/modules/scheduled-messages.xml 2009-05-14 11:36:42 UTC (rev 6790)
+++ trunk/docs/user-manual/en/modules/scheduled-messages.xml 2009-05-14 12:53:47 UTC (rev 6791)
@@ -24,7 +24,7 @@
<section>
<title>Example</title>
- <para>The <ulink url="../../../../examples/jms/scheduled-message/readme.html">Scheduled Message example</ulink> shows
+ <para>The <ulink url="../../../../examples/jms/scheduled-message/readme.html"><literal>scheduled-message</literal> example</ulink> shows
how scheduled messages can be used with JMS.</para>
</section>
Modified: trunk/docs/user-manual/en/modules/security.xml
===================================================================
--- trunk/docs/user-manual/en/modules/security.xml 2009-05-14 11:36:42 UTC (rev 6790)
+++ trunk/docs/user-manual/en/modules/security.xml 2009-05-14 12:53:47 UTC (rev 6791)
@@ -218,7 +218,7 @@
</itemizedlist>
<section>
<title>Example</title>
- <para>The <ulink url="../../../../examples/jms/jaas/readme.html">JAAS example</ulink>
+ <para>The <ulink url="../../../../examples/jms/jaas/readme.html"><literal>jaas</literal> example</ulink>
shows how JBoss Messaging can be configured to use JAAS.</para>
</section>
</section>
Modified: trunk/docs/user-manual/en/modules/undelivered-messages.xml
===================================================================
--- trunk/docs/user-manual/en/modules/undelivered-messages.xml 2009-05-14 11:36:42 UTC (rev 6790)
+++ trunk/docs/user-manual/en/modules/undelivered-messages.xml 2009-05-14 12:53:47 UTC (rev 6791)
@@ -42,7 +42,7 @@
</section>
<section>
<title>Example</title>
- <para>The <ulink url="../../../../examples/jms/delayed-redelivery/readme.html">Delayed Redelivery example</ulink> shows
+ <para>The <ulink url="../../../../examples/jms/delayed-redelivery/readme.html"><literal>delayed-redelivery</literal> example</ulink> shows
how delayed redelivery is configured and used with JMS.</para>
</section>
</section>
@@ -87,7 +87,7 @@
</section>
<section>
<title>Example</title>
- <para>The <ulink url="../../../../examples/jms/dead-letter/readme.html">Dead Letter example</ulink> shows
+ <para>The <ulink url="../../../../examples/jms/dead-letter/readme.html"><literal>dead-letter</literal> example</ulink> shows
how dead letter is configured and used with JMS.</para>
</section>
</section>
More information about the jboss-cvs-commits
mailing list