Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Logging incoming and outgoing messages for Red Hat AMQ 7

October 26, 2018
Chandra Shekhar Pandey
Related topics:
Java
Related products:
Streams for Apache Kafka

Share:

    In this article, I will discuss how to capture incoming and outgoing messages for Red Hat AMQ 7 (RHAMQ 7). This might advantageous if you need to log the incoming or outgoing traffic, or the messages from a broker, or during development and/or testing when you want to see all message. Additionally, There may also be a need to modify messages in transit. Using RHAMQ 7 interceptors, you can intercept traffic to and from the RHAMQ 7 broker. You can also modify messages using the interceptor.

    On my personal GitHub page, there is one example of using the interceptor, which works with the core protocol of RHAMQ 7.

    The first step in creating an interceptor is to implement the Interceptor interface.

    package org.apache.artemis.activemq.api.core.interceptor;
    
    public interface Interceptor
    {
    boolean intercept(Packet packet, RemotingConnection connection) throws ActiveMQException;
    }
    

    At the GitHub page mentioned above, there is  a simple Java class, SimpleInterceptor.java, which implements the Interceptor interface and intercepts messages using the following code:

    public boolean intercept(final Packet packet, final RemotingConnection connection) throws ActiveMQException {
    
    if (packet instanceof SessionSendMessage) {
    System.out.println("SimpleInterceptor gets called!.... Packet: " + packet.getClass().getName() + "RemotingConnection: " + connection.getRemoteAddress() );
    SessionSendMessage realPacket = (SessionSendMessage) packet;
    Message msg = realPacket.getMessage();
    if((msg.getTimestamp()>0) && msg.getUserID()!=null)
    System.out.println("Msg: "+msg.toString());
    }
    else if (packet instanceof SessionReceiveMessage) {
    System.out.println("SimpleInterceptor gets called!.... Packet: " + packet.getClass().getName() + "RemotingConnection: " + connection.getRemoteAddress() );
    SessionReceiveMessage realPacket = (SessionReceiveMessage) packet;
    Message msg = realPacket.getMessage();
    if((msg.getTimestamp()>0) && msg.getUserID()!=null)
    System.out.println("Msg: "+msg.toString());
    }
    
    return true;
    }
    

    It should be noted that when a packet is an instance of SessionSendMessage, it is an incoming message. When a packet is an instance of SessionReceiveMessage, it is an outgoing message, allowing the consumer/subscriber to further process it.

    By returning true, we then call the next interceptor (if any) or target. If we return false, further processing is aborted, so neither the next interceptor would be called nor would any target be sent the message.

    Build the project using mvn package  and copy the JAR to the location amq_broker_home/lib.

    In the broker configuration file broker.xml, we have to specify this interceptor for incoming as well as outgoing messages in the following manner:

    <core...>
    <remoting-incoming-interceptors>
       <class-name>com.mycompany.interceptor.SimpleInterceptor</class-name>
    </remoting-incoming-interceptors>
    <remoting-outgoing-interceptors>
       <class-name>com.mycompany.interceptor.SimpleInterceptor</class-name>
    </remoting-outgoing-interceptors>
    </core>

    At this point, we can start the RHAMQ 7 broker  to begin testing. Run the following commands from the directory amq_broker_home/bin:

    ./artemis consumer --url tcp://localhost:61616 --user admin --password admin --destination queue://TESTCP --verbose
    ./artemis producer --url tcp://localhost:61616 --user admin --password admin --destination queue://TESTCP --message-count 1
    

    You should see the following results:

    #For Sender
    SimpleInterceptor gets called!.... Packet: org.apache.activemq.artemis.core.protocol.core.impl.wireformat.SessionSendMessageRemotingConnection: /127.0.0.1:49896 Msg: CoreMessage[messageID=0,durable=true,userID=4e094a2a-d6e0-11e8-a444-e8b1fc466329,priority=4, timestamp=Tue Oct 23 21:55:50 IST 2018,expiration=0, durable=true, address=exampleQueue,size=270,properties=TypedProperties[__AMQ_CID=4df09207-d6e0-11e8-a444-e8b1fc466329,_AMQ_ROUTING_TYPE=1]]@183519025
    
    #For Receiver
    SimpleInterceptor gets called!.... Packet: org.apache.activemq.artemis.core.protocol.core.impl.wireformat.SessionReceiveMessageRemotingConnection: /127.0.0.1:49896 Msg: CoreMessage[messageID=3333,durable=true,userID=4e094a2a-d6e0-11e8-a444-e8b1fc466329,priority=4, timestamp=Tue Oct 23 21:55:50 IST 2018,expiration=0, durable=true, address=exampleQueue,size=270,properties=TypedProperties[__AMQ_CID=4df09207-d6e0-11e8-a444-e8b1fc466329,_AMQ_ROUTING_TYPE=1]]@1835190256
    
    

    We can also get destination (queue/topic) statistics by using the following command from the location amq_broker_home/bin:

    /artemis queue stat --url tcp://localhost:61621 --user admin --password admin --queueName TESTCP --verbose
    

    As mentioned earlier, this interceptor will only log messages in the core protocol. For the Stomp protocol, our interceptor should implement the interface StompFrameInterceptor:

    package org.apache.activemq.artemis.core.protocol.stomp;
    
    public interface StompFrameInterceptor extends BaseInterceptor
    {
       boolean intercept(StompFrame stompFrame, RemotingConnection connection);
    }
    

    Similarly, for the MQTT protocol, an interceptor should implement the interface MQTTInterceptor:

    package org.apache.activemq.artemis.core.protocol.mqtt;
    
    public interface MQTTInterceptor extends BaseInterceptor
    {
        boolean intercept(MqttMessage mqttMessage, RemotingConnection connection);
    }
    

    That's it! I hope this article will help you in setting up an RHAMQ 7 interceptor and logging or modifying the incoming or outgoing messages.

    Additional resources

    Here are related articles on the Red Hat Developer blog:

    • Asynchronous communication between microservices using AMQP and Vert.x
    • Monitoring Red Hat AMQ 7 with the jmxtrans agent 
    • How to set up LDAP authentication for the Red Hat AMQ 7 message broker console
    • Setting up RBAC on Red Hat AMQ Broker
    • How to integrate A-MQ 6.3 on Red Hat JBoss EAP 7
    Last updated: September 3, 2019

    Recent Posts

    • More Essential AI tutorials for Node.js Developers

    • How to run a fraud detection AI model on RHEL CVMs

    • How we use software provenance at Red Hat

    • Alternatives to creating bootc images from scratch

    • How to update OpenStack Services on OpenShift

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue