APACHE SLING & FRIENDS TECH MEETUP

BERLIN, 23-25 SEPTEMBER 2013

Inter-Sling communication with a message queue
Tomasz Rę...
Agenda
•  Code bookmarks
•  http://bit.ly/adaptto-jms
•  Case 1: shared session
•  Running ActiveMQ in Sling
•  JMS connec...
adaptTo() 2013
 3
Solution overview
Shared session
Shared session
•  We have n publishes and the dispatcher
with stickySession enabled
•  We use the servlet session
•  In ca...
JMS-based shared session
Dispatcher+
Publish+1+
Publish+2+
Publish+3+
Publish+3+
JMS+
Update+shared+
session+
Session+has+...
Shared session
•  If a publish notices that the instance id in
the cookie is different from its own, it’ll
copy shared ses...
Shared session – demo
•  Local infrastructure description:
•  One author + two publishes
•  All available under local.cq	
...
adaptTo() 2013
 8
Shared session implementation details
Integrating ActiveMQ
Rough start: dependencies
•  I tried to use the activemq-­‐core	
  package.
This is what I saw in the /system/console:
ada...
Providing necessary dependencies
•  Some dependencies are taken from other OSGi
bundles – we don’t worry about them
•  Som...
Result: sling-­‐jms-­‐activemq	
  
•  We’ve created an OSGi bundle with all
necessary dependencies embedded
•  Optional de...
adaptTo() 2013
 12
Shared session implementation details
JMS Connection Provider
Creating JMS connection with ActiveMQ
adaptTo() 2013
 13
import	
  javax.jms.Connection;	
  
import	
  org.apache.activemq...
JMS connection provider	
  
•  We use OSGi to separate JMS implementation
from it’s interface
•  JmsConnectionProvider – c...
Example usage of JMS connection provider	
  
@Component	
  
public	
  class	
  MyComponent	
  implements	
  MessageListene...
adaptTo() 2013
 16
API overview & our JMS implementation
Discovery API
Sling Discovery API
•  New Sling API
•  Each instance can expose a list of key-value
properties to other instances
•  Exam...
Topology
Red$cluster$ Blue$cluster$
$
$
$
Orange$cluster$
Instance$1$
Instance$2$ Instance$3$
Instance$A$
Instance$B$ Inst...
Discovery OSGi services
•  DiscoveryService provides TopologyView	
  
•  Custom instance properties can be added
with Prop...
JMS discovery implementation
•  There is a default HTTP-based
implementation
•  requires providing all instance URLs on ea...
Discovery election
•  If some instance notices there is no leader for
some cluster, it sends message: WHO_IS_LEADER	
  
• ...
Discovery – demo
•  http://local.cq:4503/bin/jms/discovery/info.txt
adaptTo() 2013
 22	
  
adaptTo() 2013
 23
JMS discovery implementation details
Sling Message Consumer
Sling Message Listener
Writing JMS consumers in OSGi is all about
@Component	
  
public	
  class	
  MyComponent	
  impleme...
Sling Message Listener
Why don’t we
@SlingMessageConsumer(	
  
	
  	
  	
  	
  destinationType	
  =	
  DestinationType.TOP...
Sling Message Listener – filtering
In the message listener configuration you can
add the filter property to filter out inc...
adaptTo() 2013
 27
Solution overview
Reverse Replication Request
Reverse replication request
•  In CQ, the Author gathers content from publish
instances every 30 seconds (configurable in ...
Reverse replication request
•  OutboxEventHandler watches the outbox node
and sends information every time there is
some n...
Reverse replication request flow
Author'Publish'
User/generated'content'
OutboxEventHandler' Replica<onAgentInvoker'
Rever...
adaptTo() 2013
 31
Reverse replication request implementation details
Targeting messages with the Sling run mode
Send messages only to the Author
•  The outbox event handler should send
messages only to the Author
•  We can filter it m...
adaptTo() 2013
 33
Final remarks
Extra tools created during JMS research
•  Embedded ActiveMQ broker configurable
within the OSGi component
•  Out-of-the-b...
Bundles overview
•  sling-­‐jms-­‐activemq	
  
•  ActiveMQ + dependencies
•  sling-­‐jms-­‐api	
  
•  JMS Connection Provi...
Try it yourself!
•  https://github.com/Cognifide/PoC-Sling-JMS
•  All bundles
•  Some documentation
•  Temporary repo, wil...
adaptTo() 2013
 37
That’s all folks!
Upcoming SlideShare
Loading in...5
×

Inter-Sling communication with message queue

1,695

Published on

Sling instances tend to live in herds. Synchronizing content among them is quite easy, as the whole repository is available via the REST API. However, sending control messages ("create a user", "give me a list of modified pages") may be tricky. There is a better way than implementing dozens of servlets or event listeners: it is a message queue. During the presentation we will show how to integrate ActiveMQ with Sling and how to use it to exchange messages between instances. We will also present some real-world use cases.

Published in: Technology
0 Comments
3 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
1,695
On Slideshare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
27
Comments
0
Likes
3
Embeds 0
No embeds

No notes for slide

Inter-Sling communication with message queue

  1. 1. APACHE SLING & FRIENDS TECH MEETUP BERLIN, 23-25 SEPTEMBER 2013 Inter-Sling communication with a message queue Tomasz Rękawek
  2. 2. Agenda •  Code bookmarks •  http://bit.ly/adaptto-jms •  Case 1: shared session •  Running ActiveMQ in Sling •  JMS connection provider •  Case 2: JMS-based discovery API implementation •  Sling Message Listener •  Case 3: Reverse replication request •  Targeting instance by its run mode adaptTo() 2013 2  
  3. 3. adaptTo() 2013 3 Solution overview Shared session
  4. 4. Shared session •  We have n publishes and the dispatcher with stickySession enabled •  We use the servlet session •  In case one publish stops responding, the user will be redirected to the other publish •  We want the session to be transferred too adaptTo() 2013 4  
  5. 5. JMS-based shared session Dispatcher+ Publish+1+ Publish+2+ Publish+3+ Publish+3+ JMS+ Update+shared+ session+ Session+has+been+changed+ Shared+session+storage+–+stores+session+from+all+ publishes,+with+assigned+unique+shared+session+id+ Request+ Cookie+containing+unique+shared+session+id+(different+ than+JSESSION_ID)+and+unique+instance+id+ adaptTo() 2013 5  
  6. 6. Shared session •  If a publish notices that the instance id in the cookie is different from its own, it’ll copy shared session values to the HttpSession   •  The Administrator can configure names of the shared session properties (as a list of regular expressions)   adaptTo() 2013 6  
  7. 7. Shared session – demo •  Local infrastructure description: •  One author + two publishes •  All available under local.cq  domain •  We can switch between publishes using ?publish2   query string •  http://local.cq/bin/cognifide/session.txt •  http://local.cq/bin/cognifide/session.txt/add •  http://local.cq/bin/cognifide/session.txt? publish2 adaptTo() 2013 7  
  8. 8. adaptTo() 2013 8 Shared session implementation details Integrating ActiveMQ
  9. 9. Rough start: dependencies •  I tried to use the activemq-­‐core  package. This is what I saw in the /system/console: adaptTo() 2013 9  
  10. 10. Providing necessary dependencies •  Some dependencies are taken from other OSGi bundles – we don’t worry about them •  Some have to be embedded <Embed-­‐Dependency>activemq-­‐core,geronimo-­‐j2ee-­‐ management_1.1_spec,ejb-­‐api,jaxrpc-­‐api</Embed-­‐Dependency>   •  Some can be ignored •  Check the original pom.xml  for optional dependencies <Import-­‐Package>   !javax.jmdns.*,!org.apache.activeio.*,! org.apache.activemq.jaas.*,!org.apache.camel.*,! org.apache.commons.net.*,…,*   </Import-­‐Package>   adaptTo() 2013 10  
  11. 11. Result: sling-­‐jms-­‐activemq   •  We’ve created an OSGi bundle with all necessary dependencies embedded •  Optional dependencies are ignored and marked not-to-import •  Bundle provides ActiveMQ to any Sling instance adaptTo() 2013 11  
  12. 12. adaptTo() 2013 12 Shared session implementation details JMS Connection Provider
  13. 13. Creating JMS connection with ActiveMQ adaptTo() 2013 13 import  javax.jms.Connection;   import  org.apache.activemq.ActiveMQConnectionFactory;     ActiveMQConnectionFactory  factory;   factory  =  new  ActiveMQConnectionFactory();   Connection  connection  =  factory.createConnection();   •  In order to create JMS connection we need to import some ActiveMQ classes: •  So all JMS-related code will be also dependent on the ActiveMQ •  What if we want to change JMS implementation?
  14. 14. JMS connection provider   •  We use OSGi to separate JMS implementation from it’s interface •  JmsConnectionProvider – custom OSGi service providing javax.jms.Connection   •  Bundle sling-­‐jms-­‐api  contains service interface •  Implementation: sling-­‐jms-­‐impl-­‐activemq   •  Using sling-­‐jms-­‐api  and the connection provider makes us independent from the JMS implementation adaptTo() 2013 14  
  15. 15. Example usage of JMS connection provider   @Component   public  class  MyComponent  implements  MessageListener  {          @Reference        private  JmsConnectionProvider  connectionProvider;          private  javax.jms.Connection  connection;          @Activate        protected  void  activate()  throws  JMSException  {              connection  =  connectionProvider.getConnection();        }          @Deactivate        protected  void  deactivate()  throws  JMSException  {              connection.close();        }   }   adaptTo() 2013 15  
  16. 16. adaptTo() 2013 16 API overview & our JMS implementation Discovery API
  17. 17. Sling Discovery API •  New Sling API •  Each instance can expose a list of key-value properties to other instances •  Example usage: metadata for workflow offloading in CQ •  Properties are not meant to be messaging tool, they shouldn’t change too often •  Instances are grouped into clusters, each cluster has elected leader adaptTo() 2013 17  
  18. 18. Topology Red$cluster$ Blue$cluster$ $ $ $ Orange$cluster$ Instance$1$ Instance$2$ Instance$3$ Instance$A$ Instance$B$ Instance$C$ Single$Sling$ adaptTo() 2013 18  
  19. 19. Discovery OSGi services •  DiscoveryService provides TopologyView   •  Custom instance properties can be added with PropertyProvider implementations •  Changes in topology can be observed with TopologyEventListener adaptTo() 2013 19  
  20. 20. JMS discovery implementation •  There is a default HTTP-based implementation •  requires providing all instance URLs on each instance •  But JMS is a natural choice for the transport layer here •  sling-­‐jms-­‐discovery  – a new, JMS-based discovery implementation that doesn’t require any configuration adaptTo() 2013 20  
  21. 21. Discovery election •  If some instance notices there is no leader for some cluster, it sends message: WHO_IS_LEADER   •  If no one responds in 10 seconds, it sends the second message: ELECTION   •  Every instance in a given cluster has to respond with their Sling instance id in the VOTE message •  After 5 seconds instance with the smallest id is chosen and it sends the I_AM_LEADER message adaptTo() 2013 21  
  22. 22. Discovery – demo •  http://local.cq:4503/bin/jms/discovery/info.txt adaptTo() 2013 22  
  23. 23. adaptTo() 2013 23 JMS discovery implementation details Sling Message Consumer
  24. 24. Sling Message Listener Writing JMS consumers in OSGi is all about @Component   public  class  MyComponent  implements  MessageListener  {          @Reference        private  JmsConnectionProvider  connectionProvider;        private  Connection  connection;        private  Session  session;        private  MessageConsumer  consumer;          @Activate        protected  void  activate()  throws  JMSException  {              connection  =  connectionProvider.getConnection();              session  =  connection.createSession(false,  Session.AUTO_ACKNOWLEDGE);              Destination  dest  =  session.createTopic("my  topic");              consumer  =  session.createConsumer(dest);              consumer.setMessageListener(this);              connection.start();        }          @Deactivate        protected  void  deactivate()  throws  JMSException  {              consumer.close();              session.close();              connection.close();        }   }   adaptTo() 2013 24  
  25. 25. Sling Message Listener Why don’t we @SlingMessageConsumer(          destinationType  =  DestinationType.TOPIC,          subject  =  "my  topic")   public  class  MyComponent  implements  MessageListener  {                    public  void  onMessage(Message  msg)  {   //  …   adaptTo() 2013 25   •  @SlingMessageConsumer annotation is transformed into @Service, @Component  and @Properties by our sling-­‐jms-­‐scr  plugin   •  MessageListener services are collected by our MessageConsumerRegistry OSGi component •  Registry component creates JMS consumers and forward messages to appropriate listeners
  26. 26. Sling Message Listener – filtering In the message listener configuration you can add the filter property to filter out incoming messages. Use the LDAP format: @SlingMessageConsumer(        destinationType  =  DestinationType.TOPIC,        subject  =  "my  topic"        filter  =  "(requestType=VOTE)")   adaptTo() 2013 26  
  27. 27. adaptTo() 2013 27 Solution overview Reverse Replication Request
  28. 28. Reverse replication request •  In CQ, the Author gathers content from publish instances every 30 seconds (configurable in the ReverseReplicator service) •  Why can’t publish send user-generated content to the Author (push instead of pull)? •  Security issues – publishes are often in DMZ •  But publish can inform the Author there is something new to pull adaptTo() 2013 28  
  29. 29. Reverse replication request •  OutboxEventHandler watches the outbox node and sends information every time there is some new content to pull •  ReplicationAgentInvoker receives this information and invokes the reverse replication process •  It’s a good idea to disable the out-of-the-box ReverseReplicator service, so we don’t have two reverse replications at the same moment adaptTo() 2013 29  
  30. 30. Reverse replication request flow Author'Publish' User/generated'content' OutboxEventHandler' Replica<onAgentInvoker' Reverse'replica<on'agent'Outbox' Send'JMS'msg' Pull'content' adaptTo() 2013 30  
  31. 31. adaptTo() 2013 31 Reverse replication request implementation details Targeting messages with the Sling run mode
  32. 32. Send messages only to the Author •  The outbox event handler should send messages only to the Author •  We can filter it manually… •  …or use @SlingMessageConsumer  for the consumer and add MessageConsumerProperties.DESTINATION_RUN_MODE  to the message properties •  Messages will be filtered automatically adaptTo() 2013 32  
  33. 33. adaptTo() 2013 33 Final remarks
  34. 34. Extra tools created during JMS research •  Embedded ActiveMQ broker configurable within the OSGi component •  Out-of-the-band JCR binaries transfer •  You can send a message with metadata and some JCR path and the binary itself will be sent via HTTP •  Utilities to deal with serialization problems when sending ObjectMessage   adaptTo() 2013 34  
  35. 35. Bundles overview •  sling-­‐jms-­‐activemq   •  ActiveMQ + dependencies •  sling-­‐jms-­‐api   •  JMS Connection Provider •  Sling Message Consumer •  Blob & Object message utils •  sling-­‐jms-­‐impl-­‐activemq   •  Implementation of the API tools •  sling-­‐jms-­‐scr   •  Annotation processor for Sling Message Consumer •  sling-­‐jms-­‐sandbox   •  Example usage of the API tools •  Open-sourced use cases •  sling-­‐jms-­‐discovery   •  cq-­‐jms-­‐replication   •  sling-­‐jms-­‐session   adaptTo() 2013 35  
  36. 36. Try it yourself! •  https://github.com/Cognifide/PoC-Sling-JMS •  All bundles •  Some documentation •  Temporary repo, will be transferred, so clone it while you can ;) adaptTo() 2013 36  
  37. 37. adaptTo() 2013 37 That’s all folks!
  1. ¿Le ha llamado la atención una diapositiva en particular?

    Recortar diapositivas es una manera útil de recopilar información importante para consultarla más tarde.

×