Added asynchronous event emission whenever a handling event is registered, so that interested parties can be notified if a cargo is misdirected (is unloaded, is late, has arrived, or whatever).

Two different implementations a available: JMS and a simple thread-based one.

Also, the cargo service track method now uses TrackingId in the signature, for consistency.

dddsample/pom.xml

@@ -23,13 +23,13 @@
     <repository>
       <id>maven2-repository.dev.java.net</id>
       <name>Java.net Repository for Maven</name>
-      <url>http://download.java.net/maven/2/</url>
+      <url>http://download.java.net/maven/2</url>
       <layout>default</layout>
     </repository>
     <repository>
       <id>maven-repository.dev.java.net</id>
       <name>Java.net Repository for Maven 1</name>
-      <url>http://download.java.net/maven/1/</url>
+      <url>http://download.java.net/maven/1</url>
       <layout>legacy</layout>
     </repository>
   </repositories>
@@ -37,7 +37,7 @@
     <pluginRepository>
       <id>maven2-repository.dev.java.net</id>
       <name>Java.net Repository for Maven</name>
-      <url>http://download.java.net/maven/2/</url>
+      <url>http://download.java.net/maven/2</url>
     </pluginRepository>
   </pluginRepositories>
   <developers>
@@ -178,6 +178,11 @@
     </dependency>
     <dependency>
       <groupId>org.springframework</groupId>
+      <artifactId>spring-jms</artifactId>
+      <version>${spring.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
       <artifactId>spring-test</artifactId>
       <version>${spring.version}</version>
       <scope>test</scope>
@@ -216,6 +221,10 @@
           <groupId>avalon-framework</groupId>
           <artifactId>avalon-framework</artifactId>
         </exclusion>
+        <exclusion>
+          <groupId>logkit</groupId>
+          <artifactId>logkit</artifactId>
+        </exclusion>
       </exclusions>
     </dependency>
     <dependency>
@@ -251,6 +260,23 @@
       <scope>runtime</scope>
     </dependency>
     <dependency>
+      <groupId>org.apache.activemq</groupId>
+      <artifactId>activemq-core</artifactId>
+      <version>5.0.0</version>
+      <exclusions>
+        <!--
+          This is a snapshot dependency, with no published pom.
+          It does not appear to be needed either:
+          
+          http://mail-archives.apache.org/mod_mbox/activemq-commits/200610.mbox/%3C20061005025744.0C6591A981A@eris.apache.org%3E
+        -->
+        <exclusion>
+          <groupId>org.apache.activemq</groupId>
+          <artifactId>activeio-core</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+    <dependency>
       <groupId>org.easymock</groupId>
       <artifactId>easymock</artifactId>
       <version>2.3</version>
@@ -259,7 +285,11 @@
 
     <!-- JAX-WS integration with Spring. Lots of broken pom files unfortunately,
       so we need a few excluded-and-overridden dependencies.
-      This problem will mostly go away when we move to Java 6. -->
+      This problem will mostly go away when we move to Java 6.
+
+      javax.activation is excluded because of class loading issues with Jetty:
+      http://jira.codehaus.org/browse/JETTY-420
+      -->
     <dependency>
       <groupId>org.jvnet.jax-ws-commons.spring</groupId>
       <artifactId>jaxws-spring</artifactId>
@@ -277,6 +307,10 @@
           <groupId>org.jvnet.staxex</groupId>
           <artifactId>stax-ex</artifactId>
         </exclusion>
+        <exclusion>
+          <groupId>javax.activation</groupId>
+          <artifactId>activation</artifactId>
+        </exclusion>
       </exclusions>
     </dependency>
     <dependency>
@@ -284,12 +318,24 @@
       <artifactId>stax-ex</artifactId>
       <version>1.2</version>
       <scope>runtime</scope>
+      <exclusions>
+        <exclusion>
+          <groupId>javax.activation</groupId>
+          <artifactId>activation</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
     <dependency>
       <groupId>com.sun.xml.stream.buffer</groupId>
       <artifactId>streambuffer</artifactId>
       <version>0.7</version>
       <scope>runtime</scope>
+      <exclusions>
+        <exclusion>
+          <groupId>javax.activation</groupId>
+          <artifactId>activation</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
     <dependency>
       <groupId>com.sun.xml.ws</groupId>

dddsample/src/main/java/se/citerus/dddsample/service/CargoService.java

@@ -1,5 +1,6 @@
 package se.citerus.dddsample.service;
 
+import se.citerus.dddsample.domain.TrackingId;
 import se.citerus.dddsample.service.dto.CargoWithHistoryDTO;
 
 /**
@@ -12,6 +13,12 @@ public interface CargoService {
    * @param trackingId tracking id
    * @return A cargo and its delivery history, or null if no cargo with given tracking id is found.
    */
-  CargoWithHistoryDTO track(String trackingId);
+  CargoWithHistoryDTO track(TrackingId trackingId);
 
+  /**
+   * Sends a notification to whom it may concern if a cargo is misrouted.  
+   *
+   * @param trackingId cargo tracking id
+   */
+  void notifyIfMisdirected(TrackingId trackingId);
 }

dddsample/src/main/java/se/citerus/dddsample/service/CargoServiceImpl.java

@@ -1,5 +1,7 @@
 package se.citerus.dddsample.service;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.springframework.transaction.annotation.Transactional;
 import se.citerus.dddsample.domain.*;
 import se.citerus.dddsample.repository.CargoRepository;
@@ -10,11 +12,11 @@ import java.util.List;
 
 public class CargoServiceImpl implements CargoService {
   private CargoRepository cargoRepository;
+  private static final Log logger = LogFactory.getLog(CargoServiceImpl.class);
 
   @Transactional(readOnly = true)
-  public CargoWithHistoryDTO track(String trackingId) {
-    final TrackingId tid = new TrackingId(trackingId);
-    final Cargo cargo = cargoRepository.find(tid);
+  public CargoWithHistoryDTO track(TrackingId trackingId) {
+    final Cargo cargo = cargoRepository.find(trackingId);
     if (cargo == null) {
       return null;
     }
@@ -49,6 +51,16 @@ public class CargoServiceImpl implements CargoService {
 
   }
 
+  @Transactional(readOnly = true)
+  public void notifyIfMisdirected(TrackingId trackingId) {
+    Cargo cargo = cargoRepository.find(trackingId);
+    if (cargo.isMisdirected()) {
+      // TODO: more elaborate notification than logging - mail, xmpp, other?
+      logger.info("Cargo " + trackingId + " has been misdirected. " +
+                  "Last event was " + cargo.deliveryHistory().lastEvent());
+    }
+  }
+
   public void setCargoRepository(CargoRepository cargoRepository) {
     this.cargoRepository = cargoRepository;
   }

dddsample/src/main/java/se/citerus/dddsample/service/EventService.java

@@ -0,0 +1,14 @@
+package se.citerus.dddsample.service;
+
+import se.citerus.dddsample.domain.HandlingEvent;
+
+/**
+ * Event service.
+ */
+public interface EventService {
+
+  /**
+   * @param event handling event
+   */
+  void fireHandlingEventRegistered(HandlingEvent event);
+}

dddsample/src/main/java/se/citerus/dddsample/service/HandlingEventMessageDelegate.java

@@ -0,0 +1,37 @@
+package se.citerus.dddsample.service;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import se.citerus.dddsample.domain.TrackingId;
+
+import javax.jms.JMSException;
+import javax.jms.Message;
+import javax.jms.MessageListener;
+
+/**
+ * Consumes JMS messages and delegates notification of misdirected
+ * cargo to the cargo service.
+ *
+ * This point of this is to decouple the cargo service from JMS,
+ * and to allow a thread-based messaging implementation to live in
+ * parallell. 
+ */
+public class HandlingEventMessageDelegate implements MessageListener {
+
+  CargoService cargoService;
+  private static final Log logger = LogFactory.getLog(HandlingEventMessageDelegate.class);
+
+  public void onMessage(Message message) {
+    logger.info("Received message " + message);
+    try {
+      String tidString = message.getStringProperty(TrackingId.class.getName());
+      cargoService.notifyIfMisdirected(new TrackingId(tidString));
+    } catch (JMSException e) {
+      logger.error(e, e);
+    }
+  }
+
+  public void setCargoService(CargoService cargoService) {
+    this.cargoService = cargoService;
+  }
+}

dddsample/src/main/java/se/citerus/dddsample/service/HandlingEventServiceImpl.java

@@ -15,6 +15,7 @@ public class HandlingEventServiceImpl implements HandlingEventService {
   private CarrierMovementRepository carrierMovementRepository;
   private HandlingEventRepository handlingEventRepository;
   private LocationRepository locationRepository;
+  private EventService eventService;
 
   @Transactional(readOnly = false)
   public void register(Date completionTime, TrackingId trackingId, CarrierMovementId carrierMovementId, UnLocode unlocode, HandlingEvent.Type type) throws UnknownCarrierMovementIdException, UnknownTrackingIdException, UnknownLocationException {
@@ -27,9 +28,8 @@ public class HandlingEventServiceImpl implements HandlingEventService {
     CarrierMovement carrierMovement = findCarrierMovement(carrierMovementId);
     Location location = findLocation(unlocode);
     Date registrationTime = new Date();
-    HandlingEvent event = new HandlingEvent(cargo, completionTime, registrationTime, type, location, carrierMovement);
 
-    handlingEventRepository.save(event);
+    HandlingEvent event = new HandlingEvent(cargo, completionTime, registrationTime, type, location, carrierMovement);
 
     /*
       NOTE:
@@ -41,6 +41,9 @@ public class HandlingEventServiceImpl implements HandlingEventService {
         are enforced synchronously in the transaction, but consistency rules of other aggregates
         are enforced by asynchronous updates, after the commit of this transaction.
      */
+    handlingEventRepository.save(event);
+
+    eventService.fireHandlingEventRegistered(event);
   }
 
   private CarrierMovement findCarrierMovement(CarrierMovementId carrierMovementId) throws UnknownCarrierMovementIdException {
@@ -72,7 +75,7 @@ public class HandlingEventServiceImpl implements HandlingEventService {
     this.cargoRepository = cargoRepository;
   }
 
-  public void setCarrierRepository(CarrierMovementRepository carrierMovementRepository) {
+  public void setCarrierMovementRepository(CarrierMovementRepository carrierMovementRepository) {
     this.carrierMovementRepository = carrierMovementRepository;
   }
 
@@ -83,4 +86,8 @@ public class HandlingEventServiceImpl implements HandlingEventService {
   public void setLocationRepository(LocationRepository locationRepository) {
     this.locationRepository = locationRepository;
   }
+
+  public void setEventService(EventService eventService) {
+    this.eventService = eventService;
+  }
 }

dddsample/src/main/java/se/citerus/dddsample/service/JmsEventServiceImpl.java

@@ -0,0 +1,36 @@
+package se.citerus.dddsample.service;
+
+import org.springframework.jms.core.JmsOperations;
+import org.springframework.jms.core.MessageCreator;
+import se.citerus.dddsample.domain.HandlingEvent;
+import se.citerus.dddsample.domain.TrackingId;
+
+import javax.jms.*;
+
+/**
+ * JMS based implementation.
+ */
+public class JmsEventServiceImpl implements EventService {
+  private JmsOperations jmsOperations;
+  private Destination destination;
+
+  public void fireHandlingEventRegistered(final HandlingEvent event) {
+    jmsOperations.send(destination, new MessageCreator() {
+
+      public Message createMessage(Session session) throws JMSException {
+        MapMessage message = session.createMapMessage();
+        message.setStringProperty(TrackingId.class.getName(), event.cargo().trackingId().idString());
+        return message;
+      }
+
+    });
+  }
+  
+  public void setJmsOperations(JmsOperations jmsOperations) {
+    this.jmsOperations = jmsOperations;
+  }
+
+  public void setDestination(Destination destination) {
+    this.destination = destination;
+  }
+}

dddsample/src/main/java/se/citerus/dddsample/service/ThreadBasedEventServiceImpl.java

@@ -0,0 +1,22 @@
+package se.citerus.dddsample.service;
+
+import se.citerus.dddsample.domain.HandlingEvent;
+
+/**
+ * Thread based implementation.
+ */
+public class ThreadBasedEventServiceImpl implements EventService {
+  private CargoService cargoService;
+
+  public void fireHandlingEventRegistered(final HandlingEvent event) {
+    new Thread(new Runnable() {
+      public void run() {
+        cargoService.notifyIfMisdirected(event.cargo().trackingId());
+      }
+    }).start();
+  }
+
+  public void setCargoService(CargoService cargoService) {
+    this.cargoService = cargoService;
+  }
+}

dddsample/src/main/java/se/citerus/dddsample/web/CargoTrackingController.java

@@ -3,6 +3,7 @@ package se.citerus.dddsample.web;
 import org.springframework.validation.BindException;
 import org.springframework.web.servlet.ModelAndView;
 import org.springframework.web.servlet.mvc.SimpleFormController;
+import se.citerus.dddsample.domain.TrackingId;
 import se.citerus.dddsample.service.CargoService;
 import se.citerus.dddsample.service.dto.CargoWithHistoryDTO;
 import se.citerus.dddsample.web.command.TrackCommand;
@@ -29,7 +30,8 @@ public class CargoTrackingController extends SimpleFormController {
   @Override
   protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors) throws Exception {
     final TrackCommand trackCommand = (TrackCommand) command;
-    final CargoWithHistoryDTO cargo = cargoService.track(trackCommand.getTrackingId());
+    final String tidStr = trackCommand.getTrackingId();
+    final CargoWithHistoryDTO cargo = cargoService.track(new TrackingId(tidStr));
 
     final Map<String, Object> model = new HashMap<String, Object>();
     if (cargo != null) {

dddsample/src/main/resources/context-messaging.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:jms="http://www.springframework.org/schema/jms"
+       xmlns:amq="http://activemq.org/config/1.0"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="
+        http://activemq.org/config/1.0 http://activemq.apache.org/schema/core/activemq-core-5.0.0.xsd
+        http://www.springframework.org/schema/jms http://www.springframework.org/schema/jms/spring-jms-2.5.xsd
+        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
+
+  <amq:broker useJmx="false" persistent="false">
+    <amq:transportConnectors>
+      <amq:transportConnector uri="tcp://localhost:0"/>
+    </amq:transportConnectors>
+  </amq:broker>
+
+  <amq:connectionFactory id="jmsConnectionFactory" brokerURL="vm://localhost"/>
+
+  <amq:topic id="handlingEventTopic" name="HandlingEventTopic" physicalName="HandlingEventTopic"/>
+
+  <bean id="handlingEventMessageDelegate" class="se.citerus.dddsample.service.HandlingEventMessageDelegate">
+    <property name="cargoService" ref="cargoService"/>
+  </bean>
+
+  <bean id="jmsContainer" class="org.springframework.jms.listener.DefaultMessageListenerContainer">
+    <property name="connectionFactory" ref="jmsConnectionFactory"/>
+    <property name="destination" ref="handlingEventTopic"/>
+    <property name="messageListener" ref="handlingEventMessageDelegate"/>
+  </bean>
+
+  <bean id="jmsOperations" class="org.springframework.jms.core.JmsTemplate">
+    <property name="connectionFactory" ref="jmsConnectionFactory"/>
+  </bean>
+
+</beans>

dddsample/src/main/resources/context-service.xml

@@ -20,8 +20,20 @@
   <bean id="handlingEventService" class="se.citerus.dddsample.service.HandlingEventServiceImpl">
     <property name="cargoRepository" ref="cargoRepository"/>
     <property name="handlingEventRepository" ref="handlingEventRepository"/>
-    <property name="carrierRepository" ref="carrierMovementRepository"/>
+    <property name="carrierMovementRepository" ref="carrierMovementRepository"/>
     <property name="locationRepository" ref="locationRepository"/>
+    <property name="eventService" ref="eventService"/>
   </bean>
 
+  <bean id="eventService" class="se.citerus.dddsample.service.JmsEventServiceImpl">
+    <property name="jmsOperations" ref="jmsOperations"/>
+    <property name="destination" ref="handlingEventTopic"/>
+  </bean>
+
+  <!--
+  <bean id="eventService" class="se.citerus.dddsample.service.ThreadBasedEventServiceImpl">
+    <property name="cargoService" ref="cargoService"/>
+  </bean>
+  -->
+
 </beans>

dddsample/src/test/java/se/citerus/dddsample/service/CargoServiceTest.java

@@ -99,7 +99,7 @@ public class CargoServiceTest extends AbstractDependencyInjectionSpringContextTe
 
 
     // Tested call
-    CargoWithHistoryDTO cargoDTO = cargoService.track("XYZ");
+    CargoWithHistoryDTO cargoDTO = cargoService.track(new TrackingId("XYZ"));
 
 
     assertEquals("XYZ", cargoDTO.getTrackingId());
@@ -137,7 +137,7 @@ public class CargoServiceTest extends AbstractDependencyInjectionSpringContextTe
     replay(cargoRepository);
 
     // Tested call
-    CargoWithHistoryDTO cargoDTO = cargoService.track("XYZ");
+    CargoWithHistoryDTO cargoDTO = cargoService.track(new TrackingId("XYZ"));
     
     assertNull(cargoDTO);
   }

dddsample/src/test/java/se/citerus/dddsample/service/HandlingEventServiceTest.java

@@ -12,6 +12,7 @@ import java.util.Date;
 
 public class HandlingEventServiceTest extends TestCase {
   private HandlingEventServiceImpl service;
+  private EventService eventService;
   private CargoRepository cargoRepository;
   private CarrierMovementRepository carrierMovementRepository;
   private HandlingEventRepository handlingEventRepository;
@@ -40,15 +41,17 @@ public class HandlingEventServiceTest extends TestCase {
     carrierMovementRepository = createMock(CarrierMovementRepository.class);
     handlingEventRepository = createMock(HandlingEventRepository.class);
     locationRepository = createMock(LocationRepository.class);
-    
+    eventService = createMock(EventService.class);
+
     service.setCargoRepository(cargoRepository);
-    service.setCarrierRepository(carrierMovementRepository);
+    service.setCarrierMovementRepository(carrierMovementRepository);
     service.setHandlingEventRepository(handlingEventRepository);
     service.setLocationRepository(locationRepository);
+    service.setEventService(eventService);
   }
 
   protected void tearDown() throws Exception {
-    verify(cargoRepository, carrierMovementRepository, handlingEventRepository);
+    verify(cargoRepository, carrierMovementRepository, handlingEventRepository, eventService);
   }
 
   public void testRegisterEvent() throws Exception {
@@ -65,8 +68,9 @@ public class HandlingEventServiceTest extends TestCase {
 
     // TODO: does not inspect the handling event instance in a sufficient way
     handlingEventRepository.save(isA(HandlingEvent.class));
+    eventService.fireHandlingEventRegistered(isA(HandlingEvent.class));
 
-    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository);
+    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository, eventService);
     
     service.register(date, trackingId, carrierMovementId, unLocode, HandlingEvent.Type.LOAD);
   }
@@ -78,10 +82,11 @@ public class HandlingEventServiceTest extends TestCase {
     expect(cargoRepository.find(trackingId)).andReturn(cargoABC);
 
     handlingEventRepository.save(isA(HandlingEvent.class));
-    
+    eventService.fireHandlingEventRegistered(isA(HandlingEvent.class));
+
     expect(locationRepository.find(stockholm.unLocode())).andReturn(stockholm);
 
-    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository);
+    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository, eventService);
 
     service.register(date, trackingId, null, stockholm.unLocode(), HandlingEvent.Type.CLAIM);
   }
@@ -98,7 +103,7 @@ public class HandlingEventServiceTest extends TestCase {
 
     expect(locationRepository.find(melbourne.unLocode())).andReturn(melbourne);
     
-    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository);
+    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository, eventService);
     
     try {
       service.register(date, trackingId, carrierMovementId, melbourne.unLocode(), HandlingEvent.Type.UNLOAD);
@@ -114,7 +119,7 @@ public class HandlingEventServiceTest extends TestCase {
 
     expect(locationRepository.find(hongkong.unLocode())).andReturn(hongkong);
     
-    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository);
+    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository, eventService);
     
     try {
       service.register(date, trackingId, null, hongkong.unLocode(), HandlingEvent.Type.CLAIM);
@@ -130,7 +135,7 @@ public class HandlingEventServiceTest extends TestCase {
     UnLocode wayOff = new UnLocode("XX", "YYY");
     expect(locationRepository.find(wayOff)).andReturn(null);
     
-    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository);
+    replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository, eventService);
     
     try {
       service.register(date, trackingId, null, wayOff, HandlingEvent.Type.CLAIM);

dddsample/src/test/java/se/citerus/dddsample/web/CargoTrackingControllerTest.java

@@ -39,10 +39,10 @@ public class CargoTrackingControllerTest extends TestCase {
 
   private CargoService getCargoServiceMock() {
     return new CargoService() {
-      public CargoWithHistoryDTO track(String trackingId) {
+      public CargoWithHistoryDTO track(TrackingId trackingId) {
         final Location a5 = new Location(new UnLocode("AA","AAA"), "AAAAA");
         final Location b5 = new Location(new UnLocode("BB","BBB"), "BBBBB");
-        Cargo cargo = new Cargo(new TrackingId(trackingId), a5, b5);
+        Cargo cargo = new Cargo(trackingId, a5, b5);
         HandlingEvent event = new HandlingEvent(cargo, new Date(10L), new Date(20L), HandlingEvent.Type.RECEIVE, b5);
 //        cargo.handle(event);
 
@@ -61,14 +61,18 @@ public class CargoTrackingControllerTest extends TestCase {
           event.completionTime()));
         return cargoDTO;
       }
+
+      public void notifyIfMisdirected(TrackingId trackingId) {
+      }
     };
   }
   
   private CargoService getCargoServiceNullMock() {
     return new CargoService() {
-      public CargoWithHistoryDTO track(String trackingId) {
+      public CargoWithHistoryDTO track(TrackingId trackingId) {
         return null;
       }
+      public void notifyIfMisdirected(TrackingId trackingId) {}
     };
   }
 

dddsample/src/test/resources/mock-context-persistence.xml

@@ -20,7 +20,16 @@
     <constructor-arg value="se.citerus.dddsample.repository.CarrierMovementRepository"/>
   </bean>
 
-  <bean id="locationRepository" class="se.citerus.dddsample.repository.LocationRepositoryHibernate">
-    <property name="sessionFactory" ref="sessionFactory"/>
+  <bean id="locationRepository" class="org.easymock.EasyMock" factory-method="createMock">
+    <constructor-arg value="se.citerus.dddsample.repository.LocationRepository"/>
   </bean>
+
+  <bean id="jmsOperations" class="org.easymock.EasyMock" factory-method="createMock">
+    <constructor-arg value="org.springframework.jms.core.JmsOperations"/>
+  </bean>
+
+  <bean id="handlingEventTopic" class="org.easymock.EasyMock" factory-method="createMock">
+    <constructor-arg value="javax.jms.Destination"/>
+  </bean>
+  
 </beans>