You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2013/04/24 16:32:30 UTC

svn commit: r1471437 - in /karaf/cellar/trunk: assembly/src/main/resources/ event/src/main/java/org/apache/karaf/cellar/event/ event/src/main/resources/OSGI-INF/blueprint/

Author: jbonofre
Date: Wed Apr 24 14:32:30 2013
New Revision: 1471437

URL: http://svn.apache.org/r1471437
Log:
Code cleanup.

Added:
    karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEvent.java
      - copied, changed from r1471423, karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEvent.java
    karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEventHandler.java
      - copied, changed from r1471423, karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEventHandler.java
Removed:
    karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEvent.java
    karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEventHandler.java
Modified:
    karaf/cellar/trunk/assembly/src/main/resources/node.cfg
    karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/Constants.java
    karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/EventSupport.java
    karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/LocalEventListener.java
    karaf/cellar/trunk/event/src/main/resources/OSGI-INF/blueprint/blueprint.xml

Modified: karaf/cellar/trunk/assembly/src/main/resources/node.cfg
URL: http://svn.apache.org/viewvc/karaf/cellar/trunk/assembly/src/main/resources/node.cfg?rev=1471437&r1=1471436&r2=1471437&view=diff
==============================================================================
--- karaf/cellar/trunk/assembly/src/main/resources/node.cfg (original)
+++ karaf/cellar/trunk/assembly/src/main/resources/node.cfg Wed Apr 24 14:32:30 2013
@@ -25,7 +25,7 @@ handler.org.apache.karaf.cellar.features
 # DOSGi event handler
 handler.org.apache.karaf.cellar.dosgi.RemoteServiceCallHandler = true
 # OSGi event handler
-handler.org.apache.karaf.cellar.event.RemoteEventHandler = true
+handler.org.apache.karaf.cellar.event.ClusterEventHandler = true
 # OBR event handler
 handler.org.apache.karaf.cellar.obr.ObrBundleEventHandler = true
 handler.org.apache.karaf.cellar.obr.ObrUrlEventHandler = true
\ No newline at end of file

Copied: karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEvent.java (from r1471423, karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEvent.java)
URL: http://svn.apache.org/viewvc/karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEvent.java?p2=karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEvent.java&p1=karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEvent.java&r1=1471423&r2=1471437&rev=1471437&view=diff
==============================================================================
--- karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEvent.java (original)
+++ karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEvent.java Wed Apr 24 14:32:30 2013
@@ -18,12 +18,15 @@ import org.apache.karaf.cellar.core.even
 import java.io.Serializable;
 import java.util.Map;
 
-public class RemoteEvent extends Event {
+/**
+ * Cluster event.
+ */
+public class ClusterEvent extends Event {
 
     private String topicName;
     private Map<String, Serializable> properties;
 
-    public RemoteEvent(String topicName, Map<String, Serializable> properties) {
+    public ClusterEvent(String topicName, Map<String, Serializable> properties) {
         super(topicName);
         this.topicName = topicName;
         this.properties = properties;

Copied: karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEventHandler.java (from r1471423, karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEventHandler.java)
URL: http://svn.apache.org/viewvc/karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEventHandler.java?p2=karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEventHandler.java&p1=karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEventHandler.java&r1=1471423&r2=1471437&rev=1471437&view=diff
==============================================================================
--- karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/RemoteEventHandler.java (original)
+++ karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/ClusterEventHandler.java Wed Apr 24 14:32:30 2013
@@ -26,14 +26,18 @@ import org.slf4j.LoggerFactory;
 import java.io.Serializable;
 import java.util.Map;
 
-public class RemoteEventHandler extends EventSupport implements EventHandler<RemoteEvent> {
+/**
+ * Handler for cluster event.
+ */
+public class ClusterEventHandler extends EventSupport implements EventHandler<ClusterEvent> {
 
-    private static final transient Logger LOGGER = LoggerFactory.getLogger(RemoteEventHandler.class);
+    private static final transient Logger LOGGER = LoggerFactory.getLogger(ClusterEventHandler.class);
 
     public static final String SWITCH_ID = "org.apache.karaf.cellar.event.handler";
     private final Switch eventSwitch = new BasicSwitch(SWITCH_ID);
 
-    public void handle(RemoteEvent event) {
+    @Override
+    public void handle(ClusterEvent event) {
 
         // check if the handler is ON
         if (this.getSwitch().getStatus().equals(SwitchStatus.OFF)) {
@@ -42,7 +46,7 @@ public class RemoteEventHandler extends 
         }
         
         if (groupManager == null) {
-        	//in rare cases for example right after installation this happens!
+        	// in rare cases for example right after installation this happens!
         	LOGGER.error("CELLAR EVENT: retrieved event {} while groupManager is not available yet!", event);
         	return;
         }
@@ -60,26 +64,26 @@ public class RemoteEventHandler extends 
                 properties.put(Constants.EVENT_SOURCE_GROUP_KEY, event.getSourceGroup());
                 properties.put(Constants.EVENT_SOURCE_NODE_KEY, event.getSourceNode());
                 postEvent(event.getTopicName(), properties);
-            } else LOGGER.warn("CELLAR EVENT: event {} is marked as BLOCKED INBOUND", event.getTopicName());
+            } else LOGGER.warn("CELLAR EVENT: event {} is marked BLOCKED INBOUND for cluster group {}", event.getTopicName(), event.getSourceGroup().getName());
         } catch (Exception e) {
             LOGGER.error("CELLAR EVENT: failed to handle event", e);
         }
     }
 
-    /**
-     * Initialization method.
-     */
     public void init() {
-
+        // nothing to do
     }
 
-    /**
-     * Destroy method.
-     */
     public void destroy() {
-
+        // nothing to do
     }
 
+    /**
+     * Get the handler switch.
+     *
+     * @return the handler switch.
+     */
+    @Override
     public Switch getSwitch() {
         // load the switch status from the config
         try {
@@ -97,9 +101,15 @@ public class RemoteEventHandler extends 
         }
         return eventSwitch;
     }
-    
-    public Class<RemoteEvent> getType() {
-        return RemoteEvent.class;
+
+    /**
+     * Get the event type handled by this handler.
+     *
+     * @return the cluster event type.
+     */
+    @Override
+    public Class<ClusterEvent> getType() {
+        return ClusterEvent.class;
     }
 
 }

Modified: karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/Constants.java
URL: http://svn.apache.org/viewvc/karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/Constants.java?rev=1471437&r1=1471436&r2=1471437&view=diff
==============================================================================
--- karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/Constants.java (original)
+++ karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/Constants.java Wed Apr 24 14:32:30 2013
@@ -13,6 +13,9 @@
  */
 package org.apache.karaf.cellar.event;
 
+/**
+ * Event configuration constants.
+ */
 public class Constants {
 
     public static final String CATEGORY = "event";

Modified: karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/EventSupport.java
URL: http://svn.apache.org/viewvc/karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/EventSupport.java?rev=1471437&r1=1471436&r2=1471437&view=diff
==============================================================================
--- karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/EventSupport.java (original)
+++ karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/EventSupport.java Wed Apr 24 14:32:30 2013
@@ -21,14 +21,17 @@ import java.io.Serializable;
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Generic Cellar OSGi event support.
+ */
 public class EventSupport extends CellarSupport {
     
     protected EventAdmin eventAdmin;
 
     /**
-     * Reads a {@code Event} object and creates a map object out of it.
+     * Read a local {@code Event} and create a map object out of it.
      *
-     * @param event the event to read
+     * @param event the local event to read.
      * @return the map
      */
     public Map<String, Serializable> getEventProperties(Event event) {
@@ -47,9 +50,9 @@ public class EventSupport extends Cellar
     }
 
     /**
-     * Reads {@code Event} object and checks if a property exists.
+     * Read a local {@code Event} and check if a property exists.
      *
-     * @param event the event to read.
+     * @param event the local event to read.
      * @param name  the property name to check.
      * @return true if the property exists in the event, false else.
      */

Modified: karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/LocalEventListener.java
URL: http://svn.apache.org/viewvc/karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/LocalEventListener.java?rev=1471437&r1=1471436&r2=1471437&view=diff
==============================================================================
--- karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/LocalEventListener.java (original)
+++ karaf/cellar/trunk/event/src/main/java/org/apache/karaf/cellar/event/LocalEventListener.java Wed Apr 24 14:32:30 2013
@@ -14,7 +14,6 @@
 package org.apache.karaf.cellar.event;
 
 import org.apache.karaf.cellar.core.Group;
-import org.apache.karaf.cellar.core.Node;
 import org.apache.karaf.cellar.core.control.SwitchStatus;
 import org.apache.karaf.cellar.core.event.EventProducer;
 import org.apache.karaf.cellar.core.event.EventType;
@@ -24,7 +23,6 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.Serializable;
-import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
@@ -67,9 +65,9 @@ public class LocalEventListener extends 
                         Map<String, Serializable> properties = getEventProperties(event);
                         if (isAllowed(group, Constants.CATEGORY, topicName, EventType.OUTBOUND)) {
                             // broadcast the event
-                            RemoteEvent remoteEvent = new RemoteEvent(topicName, properties);
-                            remoteEvent.setSourceGroup(group);
-                            eventProducer.produce(remoteEvent);
+                            ClusterEvent clusterEvent = new ClusterEvent(topicName, properties);
+                            clusterEvent.setSourceGroup(group);
+                            eventProducer.produce(clusterEvent);
                         } else if (!topicName.startsWith("org/osgi/service/log/LogEntry/"))
                                 LOGGER.warn("CELLAR EVENT: event {} is marked as BLOCKED OUTBOUND", topicName);
                     }

Modified: karaf/cellar/trunk/event/src/main/resources/OSGI-INF/blueprint/blueprint.xml
URL: http://svn.apache.org/viewvc/karaf/cellar/trunk/event/src/main/resources/OSGI-INF/blueprint/blueprint.xml?rev=1471437&r1=1471436&r2=1471437&view=diff
==============================================================================
--- karaf/cellar/trunk/event/src/main/resources/OSGI-INF/blueprint/blueprint.xml (original)
+++ karaf/cellar/trunk/event/src/main/resources/OSGI-INF/blueprint/blueprint.xml Wed Apr 24 14:32:30 2013
@@ -39,18 +39,17 @@
     </service>
 
     <!-- Cluster Event Handler -->
-    <bean id="remoteEventHandler" class="org.apache.karaf.cellar.event.RemoteEventHandler" init-method="init" destroy-method="destroy">
+    <bean id="clusterEventHandler" class="org.apache.karaf.cellar.event.ClusterEventHandler" init-method="init" destroy-method="destroy">
         <property name="configurationAdmin" ref="configurationAdmin"/>
         <property name="clusterManager" ref="clusterManager"/>
         <property name="eventAdmin" ref="eventAdmin"/>
     </bean>
-    <service ref="remoteEventHandler" interface="org.apache.karaf.cellar.core.event.EventHandler">
+    <service ref="clusterEventHandler" interface="org.apache.karaf.cellar.core.event.EventHandler">
         <service-properties>
             <entry key="managed" value="true"/>
         </service-properties>
     </service>
 
-    <!-- Cluster Core Services -->
     <reference id="clusterManager" interface="org.apache.karaf.cellar.core.ClusterManager"/>
     <reference id="groupManager" interface="org.apache.karaf.cellar.core.GroupManager"/>
     <reference id="configurationAdmin" interface="org.osgi.service.cm.ConfigurationAdmin"/>