Slight method name changes (deriveStatusFromHandling => deriveDeliveryProgress).

Fixed cloning of Date in a few places.

Explicitly roll back transaction if handling event registration fails.

Using single-parameter validation + message in more places (instead of arrays)

dddsample/src/main/java/se/citerus/dddsample/application/impl/CargoInspectionServiceImpl.java

@@ -40,9 +40,9 @@ public class CargoInspectionServiceImpl implements CargoInspectionService {
       return;
     }
 
-    final List<HandlingEvent> deliveryHistory = handlingEventRepository.findEventsForCargo(trackingId);
+    final List<HandlingEvent> handlingEvents = handlingEventRepository.findEventsForCargo(trackingId);
 
-    cargo.deriveStatusFromHandling(deliveryHistory);
+    cargo.deriveDeliveryProgress(handlingEvents);
 
     if (cargo.isMisdirected()) {
       applicationEvents.cargoWasMisdirected(cargo);

dddsample/src/main/java/se/citerus/dddsample/application/impl/HandlingEventServiceImpl.java

@@ -3,6 +3,7 @@ package se.citerus.dddsample.application.impl;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.springframework.transaction.annotation.Transactional;
+import static org.springframework.transaction.interceptor.TransactionAspectSupport.currentTransactionStatus;
 import se.citerus.dddsample.application.ApplicationEvents;
 import se.citerus.dddsample.application.HandlingEventService;
 import se.citerus.dddsample.domain.model.cargo.TrackingId;
@@ -58,7 +59,8 @@ public final class HandlingEventServiceImpl implements HandlingEventService {
     } catch (CannotCreateHandlingEventException e) {
       /* This may be a bogus attempt, for example containing a tracking id
          that doesn't match any cargo that we're tracking. */
-      logger.error(e, e);
+      logger.error(e);
+      currentTransactionStatus().setRollbackOnly();
     }
   }
 

dddsample/src/main/java/se/citerus/dddsample/application/util/SampleDataGenerator.java

@@ -255,7 +255,7 @@ public class SampleDataGenerator implements ServletContextListener {
         }
 
         List<HandlingEvent> handlingEvents = handlingEventRepository.findEventsForCargo(trackingId);
-        abc123.deriveStatusFromHandling(handlingEvents);
+        abc123.deriveDeliveryProgress(handlingEvents);
 
         session.update(abc123);
 
@@ -300,7 +300,7 @@ public class SampleDataGenerator implements ServletContextListener {
         }
 
         List<HandlingEvent> handlingEvents1 = handlingEventRepository.findEventsForCargo(trackingId1);
-        jkl567.deriveStatusFromHandling(handlingEvents1);
+        jkl567.deriveDeliveryProgress(handlingEvents1);
 
         session.update(jkl567);
       }

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/Cargo.java

@@ -61,7 +61,7 @@ public class Cargo implements Entity<Cargo> {
     this.trackingId = trackingId;
     this.origin = origin;
     this.routeSpecification = routeSpecification;
-    deriveStatusFromHandling(Collections.<HandlingEvent>emptyList());
+    deriveDeliveryProgress(Collections.<HandlingEvent>emptyList());
   }
 
   /**
@@ -165,12 +165,12 @@ public class Cargo implements Entity<Cargo> {
    * @return estimated time of arrival
    */
   public Date estimatedTimeOfArrival() {
-    return eta;
+    return new Date(eta.getTime());
   }
 
   /**
    * Updates all aspects of the cargo aggregate status
-   * based on the current route specification, itinerary and delivery history.
+   * based on the current route specification, itinerary and handling of the cargo.
    * <p/>
    * When either of those three changes, i.e. when a new route is specified for the cargo,
    * the cargo is assigned to a route or when the cargo is handled, the status must be
@@ -181,12 +181,12 @@ public class Cargo implements Entity<Cargo> {
    * but changes to the delivery history (when a cargo is handled) cause the status update
    * to happen <b>asynchronously</b> since {@link HandlingEvent} is in a different aggregate.
    *
-   * @param deliveryHistory all handling events for this cargo
+   * @param handlingEvents all handling events for this cargo
    */
-  public void deriveStatusFromHandling(final List<HandlingEvent> deliveryHistory) {
+  public void deriveDeliveryProgress(final List<HandlingEvent> handlingEvents) {
     // Delivery is a value object, so we can simply discard the old one
-    // and replace with a new
-    this.delivery = Delivery.derivedFrom(deliveryHistory);
+    // and replace it with a new
+    this.delivery = Delivery.derivedFrom(handlingEvents);
     this.routingStatus = deriveRoutingStatus();
     this.misdirected = deriveMisdirectionStatus();
     this.eta = deriveEta();

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/Itinerary.java

@@ -117,7 +117,7 @@ public class Itinerary implements ValueObject<Itinerary> {
     if (lastLeg == null) {
       return new Date(END_OF_DAYS.getTime());
     } else {
-      return lastLeg.unloadTime();
+      return new Date(lastLeg.unloadTime().getTime());
     }
   }
 

dddsample/src/main/java/se/citerus/dddsample/domain/model/cargo/RouteSpecification.java

@@ -33,7 +33,7 @@ public class RouteSpecification extends AbstractSpecification<Itinerary> impleme
 
     this.origin = origin;
     this.destination = destination;
-    this.arrivalDeadline = arrivalDeadline;
+    this.arrivalDeadline = (Date) arrivalDeadline.clone();
   }
 
   /**
@@ -54,7 +54,7 @@ public class RouteSpecification extends AbstractSpecification<Itinerary> impleme
    * @return Arrival deadline.
    */
   public Date arrivalDeadline() {
-    return arrivalDeadline;
+    return new Date(arrivalDeadline.getTime());
   }
 
   @Override

dddsample/src/main/java/se/citerus/dddsample/domain/model/handling/CannotCreateHandlingEventException.java

@@ -2,7 +2,7 @@ package se.citerus.dddsample.domain.model.handling;
 
 /**
  * If a {@link se.citerus.dddsample.domain.model.handling.HandlingEvent} can't be
- * created from an incoming {@link #se.citerus.dddsample.application.HandlingEventRegistrationAttempt},
+ * created from a given set of parameters.
  *
  * It is a checked exception because it's not a programming error, but rather a
  * special case that the application is built to handle. It can occur during normal

dddsample/src/main/java/se/citerus/dddsample/domain/model/handling/HandlingEvent.java

@@ -107,9 +107,12 @@ public final class HandlingEvent implements DomainEvent<HandlingEvent> {
                        final Type type,
                        final Location location,
                        final Voyage voyage) {
-    Validate.noNullElements(new Object[]
-      {cargo, completionTime, registrationTime, type, location, voyage}
-    );
+    Validate.notNull(cargo, "Cargo is required");
+    Validate.notNull(completionTime, "Completion time is required");
+    Validate.notNull(registrationTime, "Registration time is required");
+    Validate.notNull(type, "Handling event type is required");
+    Validate.notNull(location, "Location is required");
+    Validate.notNull(voyage, "Voyage is required");
 
     if (type.prohibitsVoyage()) {
       throw new IllegalArgumentException("Voyage is not allowed with event type " + type);
@@ -135,9 +138,11 @@ public final class HandlingEvent implements DomainEvent<HandlingEvent> {
                        final Date registrationTime,
                        final Type type,
                        final Location location) {
-    Validate.noNullElements(new Object[]
-      {cargo, completionTime, registrationTime, type, location}
-    );
+    Validate.notNull(cargo, "Cargo is required");
+    Validate.notNull(completionTime, "Completion time is required");
+    Validate.notNull(registrationTime, "Registration time is required");
+    Validate.notNull(type, "Handling event type is required");
+    Validate.notNull(location, "Location is required");
 
     if (type.requiresVoyage()) {
       throw new IllegalArgumentException("Voyage is required for event type " + type);

dddsample/src/main/java/se/citerus/dddsample/domain/model/handling/HandlingEventFactory.java

@@ -1,6 +1,5 @@
 package se.citerus.dddsample.domain.model.handling;
 
-import org.apache.commons.lang.Validate;
 import se.citerus.dddsample.domain.model.cargo.Cargo;
 import se.citerus.dddsample.domain.model.cargo.CargoRepository;
 import se.citerus.dddsample.domain.model.cargo.TrackingId;
@@ -44,12 +43,6 @@ public class HandlingEventFactory {
    */
   public HandlingEvent createHandlingEvent(Date registrationTime, Date completionTime, TrackingId trackingId, VoyageNumber voyageNumber, UnLocode unlocode, HandlingEvent.Type type)
     throws CannotCreateHandlingEventException {
-
-    // Voyage number may be null for certain event types
-    Validate.noNullElements(new Object[]
-      {registrationTime, completionTime, trackingId, unlocode, type}
-    );
-
     final Cargo cargo = findCargo(trackingId);
     final Voyage voyage = findVoyage(voyageNumber);
     final Location location = findLocation(unlocode);

dddsample/src/main/webapp/WEB-INF/jsp/admin/selectItinerary.jsp

@@ -21,7 +21,7 @@
   </table>
   <c:url value="/admin/assignItinerary.html" var="postUrl"/>
 
-  <c:forEach items="${itineraryCandidates}" var="it" varStatus="itStatus">
+  <c:forEach items="${routeCandidates}" var="it" varStatus="itStatus">
       <form action="${postUrl}" method="post">
         <input type="hidden" name="trackingId" value="${cargo.trackingId}"/>
         <table>

dddsample/src/test/java/se/citerus/dddsample/domain/model/cargo/CargoTest.java

@@ -118,7 +118,7 @@ public class CargoTest extends TestCase {
     // Adding an event unrelated to unloading at final destination
     events.add(
       new HandlingEvent(cargo, new Date(10), new Date(), HandlingEvent.Type.RECEIVE, HANGZOU));
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
     assertFalse(cargo.isUnloadedAtDestination());
 
     Voyage voyage = new Voyage.Builder(new VoyageNumber("0123"), HANGZOU).
@@ -128,19 +128,19 @@ public class CargoTest extends TestCase {
     // Adding an unload event, but not at the final destination
     events.add(
       new HandlingEvent(cargo, new Date(20), new Date(), HandlingEvent.Type.UNLOAD, TOKYO, voyage));
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
     assertFalse(cargo.isUnloadedAtDestination());
 
     // Adding an event in the final destination, but not unload
     events.add(
       new HandlingEvent(cargo, new Date(30), new Date(), HandlingEvent.Type.CUSTOMS, NEWYORK));
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
     assertFalse(cargo.isUnloadedAtDestination());
 
     // Finally, cargo is unloaded at final destination
     events.add(
       new HandlingEvent(cargo, new Date(40), new Date(), HandlingEvent.Type.UNLOAD, NEWYORK, voyage));
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
     assertTrue(cargo.isUnloadedAtDestination());
   }
 
@@ -150,7 +150,7 @@ public class CargoTest extends TestCase {
 
     HandlingEvent he = new HandlingEvent(cargo, getDate("2007-12-01"), new Date(), HandlingEvent.Type.RECEIVE, STOCKHOLM);
     events.add(he);
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
 
     return cargo;
   }
@@ -159,7 +159,7 @@ public class CargoTest extends TestCase {
     final Cargo cargo = populateCargoOffMelbourne();
 
     events.add(new HandlingEvent(cargo, getDate("2007-12-09"), new Date(), HandlingEvent.Type.CLAIM, MELBOURNE));
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
 
     return cargo;
   }
@@ -174,7 +174,7 @@ public class CargoTest extends TestCase {
     events.add(new HandlingEvent(cargo, getDate("2007-12-03"), new Date(), HandlingEvent.Type.LOAD, HAMBURG, voyage));
     events.add(new HandlingEvent(cargo, getDate("2007-12-04"), new Date(), HandlingEvent.Type.UNLOAD, HONGKONG, voyage));
 
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
     return cargo;
   }
 
@@ -185,7 +185,7 @@ public class CargoTest extends TestCase {
     events.add(new HandlingEvent(cargo, getDate("2007-12-02"), new Date(), HandlingEvent.Type.UNLOAD, HAMBURG, voyage));
     events.add(new HandlingEvent(cargo, getDate("2007-12-03"), new Date(), HandlingEvent.Type.LOAD, HAMBURG, voyage));
 
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
     return cargo;
   }
 
@@ -201,7 +201,7 @@ public class CargoTest extends TestCase {
     events.add(new HandlingEvent(cargo, getDate("2007-12-05"), new Date(), HandlingEvent.Type.LOAD, HONGKONG, voyage));
     events.add(new HandlingEvent(cargo, getDate("2007-12-07"), new Date(), HandlingEvent.Type.UNLOAD, MELBOURNE, voyage));
 
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
     return cargo;
   }
 
@@ -216,7 +216,7 @@ public class CargoTest extends TestCase {
 
     events.add(new HandlingEvent(cargo, getDate("2007-12-05"), new Date(), HandlingEvent.Type.LOAD, HONGKONG, voyage));
 
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
     return cargo;
   }
 
@@ -242,7 +242,7 @@ public class CargoTest extends TestCase {
     handlingEvents.add(new HandlingEvent(cargo, new Date(130), new Date(140), HandlingEvent.Type.CUSTOMS, GOTHENBURG));
 
     events.addAll(handlingEvents);
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
     assertFalse(cargo.isMisdirected());
 
     //Try a couple of failing ones
@@ -252,7 +252,7 @@ public class CargoTest extends TestCase {
 
     handlingEvents.add(new HandlingEvent(cargo, new Date(), new Date(), HandlingEvent.Type.RECEIVE, HANGZOU));
     events.addAll(handlingEvents);
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
 
     assertTrue(cargo.isMisdirected());
 
@@ -266,7 +266,7 @@ public class CargoTest extends TestCase {
     handlingEvents.add(new HandlingEvent(cargo, new Date(70), new Date(80), HandlingEvent.Type.LOAD, ROTTERDAM, voyage));
 
     events.addAll(handlingEvents);
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
 
     assertTrue(cargo.isMisdirected());
 
@@ -280,7 +280,7 @@ public class CargoTest extends TestCase {
     handlingEvents.add(new HandlingEvent(cargo, new Date(), new Date(), HandlingEvent.Type.CLAIM, ROTTERDAM));
 
     events.addAll(handlingEvents);
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
 
     assertTrue(cargo.isMisdirected());
   }

dddsample/src/test/java/se/citerus/dddsample/infrastructure/persistence/inmemory/CargoRepositoryInMem.java

@@ -89,7 +89,7 @@ public class CargoRepositoryInMem implements CargoRepository {
 
     final RouteSpecification routeSpecification = new RouteSpecification(origin, destination, new Date());
     final Cargo cargo = new Cargo(trackingId, origin, routeSpecification);
-    cargo.deriveStatusFromHandling(new ArrayList<HandlingEvent>(events));
+    cargo.deriveDeliveryProgress(new ArrayList<HandlingEvent>(events));
 
     return cargo;
   }

dddsample/src/test/java/se/citerus/dddsample/interfaces/tracking/CargoTrackingViewAdapterTest.java

@@ -23,7 +23,7 @@ public class CargoTrackingViewAdapterTest extends TestCase {
     events.add(new HandlingEvent(cargo, new Date(3), new Date(4), HandlingEvent.Type.LOAD, HANGZOU, CM001));
     events.add(new HandlingEvent(cargo, new Date(5), new Date(6), HandlingEvent.Type.UNLOAD, HELSINKI, CM001));
 
-    cargo.deriveStatusFromHandling(events);
+    cargo.deriveDeliveryProgress(events);
 
     StaticApplicationContext applicationContext = new StaticApplicationContext();
     applicationContext.addMessage("cargo.status.IN_PORT", Locale.GERMAN, "In port {0}");