activemq-artemis/examples/features/standard/interceptor-client-amqp
Justin Bertram 8703d9d51d [maven-release-plugin] prepare for next development iteration 2017-11-01 00:38:57 -05:00
..
src/main ARTEMIS-1385 fixed incomplete comment and typo (appendix) 2017-09-06 10:24:43 -04:00
pom.xml [maven-release-plugin] prepare for next development iteration 2017-11-01 00:38:57 -05:00
readme.html ARTEMIS-1169 - Implement Interceptors for the AMQP protocol 2017-05-17 14:07:23 -05:00

readme.html

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<html>
  <head>
    <title>ActiveMQ Artemis AMQP Interceptor Example</title>
    <link rel="stylesheet" type="text/css" href="../../../common/common.css" />
    <link rel="stylesheet" type="text/css" href="../../../common/prettify.css" />
    <script type="text/javascript" src="../../../common/prettify.js"></script>
  </head>
  <body onload="prettyPrint()">
     <h1>AMQP Interceptor Example</h1>

     <pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre>


     <p>This example shows you how to implement and configure a simple incoming, server-side AMQP interceptor with ActiveMQ Artemis.</p>

     <p>ActiveMQ Artemis allows an application to use an interceptor to hook into the messaging system. All that needs to do is to implement the
     Interceptor interface, as defined below: </p>
     <pre class="prettyprint">
     <code>
         public interface AmqpInterceptor
         {
            boolean intercept(final AMQPMessage message, RemotingConnection connection);
         }
     </code>
     </pre>
     <p>Once you have your own interceptor class, add it to the broker.xml, as follows:</p>
     <pre class="prettyprint">
     <code>
        &lt;configuration&gt;
        ...
           &lt;remoting-incoming-interceptors&gt;
              &lt;class-name&gt;org.apache.activemq.artemis.amqp.example.SimpleAMQPInterceptor&lt;/class-name&gt;
           &lt;/remoting-incoming-interceptors&gt;
        ...
        &lt;/configuration&gt;
     </code>
     </pre>

     <p>With interceptor, you can handle various events in message processing. In this example, a simple interceptor, SimpleAMQPInterceptor, is implemented and configured.
     When the example is running, the interceptor examine and log properties of the AMQP message.</p>

     <p>With our interceptor we always return <code>true</code> from the <code>intercept</code> method. If we were
     to return <code>false</code> that signifies that no more interceptors are to run.
         Throw an exception to abort processing of the packet.</p>
  </body>
</html>