Added CargoService.registerNew, which assigns a tracking id to a cargo and stores it.

Reorganized JSP views slightly.

dddsample/src/main/java/se/citerus/dddsample/repository/CargoRepository.java

@@ -4,6 +4,11 @@ import se.citerus.dddsample.domain.Cargo;
 import se.citerus.dddsample.domain.TrackingId;
 
 public interface CargoRepository {
+
   Cargo find(TrackingId trackingId);
+
   void save(Cargo cargo);
+
+  TrackingId nextTrackingId();
+
 }

dddsample/src/main/java/se/citerus/dddsample/repository/CargoRepositoryHibernate.java

@@ -4,6 +4,8 @@ import org.springframework.stereotype.Repository;
 import se.citerus.dddsample.domain.Cargo;
 import se.citerus.dddsample.domain.TrackingId;
 
+import java.util.UUID;
+
 /**
  * Hibernate implementation of CargoRepository.
  */
@@ -34,6 +36,14 @@ public class CargoRepositoryHibernate extends HibernateRepository implements Car
     getSession().saveOrUpdate(cargo);
   }
 
+  public TrackingId nextTrackingId() {
+    // TODO:
+    // Could be an opportunity to maybe illustrate how to handle pessimistic locking
+    // and aggregate boundaries, and maybe problems with a distributed application
+    // sharing a database. For now it's simply random though.
+    return new TrackingId(UUID.randomUUID().toString());
+  }
+
   public void setHandlingEventRepository(HandlingEventRepository handlingEventRepository) {
     this.handlingEventRepository = handlingEventRepository;
   }

dddsample/src/main/java/se/citerus/dddsample/repository/CargoRepositoryInMem.java

@@ -6,6 +6,7 @@ import se.citerus.dddsample.domain.TrackingId;
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.UUID;
 
 /**
  * CargoRepositoryInMem implement the CargoRepository interface but is a test
@@ -37,6 +38,10 @@ public class CargoRepositoryInMem implements CargoRepository {
     //No need to save anything with InMem
   }
 
+  public TrackingId nextTrackingId() {
+    return new TrackingId(UUID.randomUUID().toString());
+  }
+
   /**
    * 
    * @throws Exception

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

@@ -1,7 +1,8 @@
 package se.citerus.dddsample.service;
 
+import se.citerus.dddsample.domain.Location;
 import se.citerus.dddsample.domain.TrackingId;
-import se.citerus.dddsample.service.dto.CargoWithHistoryDTO;
+import se.citerus.dddsample.service.dto.CargoTrackingDTO;
 
 /**
  * Cargo service.
@@ -10,10 +11,19 @@ import se.citerus.dddsample.service.dto.CargoWithHistoryDTO;
 public interface CargoService {
 
   /**
+   * Registers a new cargo in the tracking system, not yet routed.
+   *
+   * @param origin cargo origin
+   * @param destination cargo destination
+   * @return Cargo tracking id
+   */
+  TrackingId registerNew(Location origin, Location destination);
+
+  /**
    * @param trackingId tracking id
    * @return A cargo and its delivery history, or null if no cargo with given tracking id is found.
    */
-  CargoWithHistoryDTO track(TrackingId trackingId);
+  CargoTrackingDTO track(TrackingId trackingId);
 
   /**
    * Send relevant notifications to interested parties,

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

@@ -1,21 +1,37 @@
 package se.citerus.dddsample.service;
 
+import org.apache.commons.lang.Validate;
 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;
-import se.citerus.dddsample.service.dto.CargoWithHistoryDTO;
+import se.citerus.dddsample.service.dto.CargoTrackingDTO;
 import se.citerus.dddsample.service.dto.HandlingEventDTO;
 
 import java.util.List;
 
 public class CargoServiceImpl implements CargoService {
+
   private CargoRepository cargoRepository;
   private static final Log logger = LogFactory.getLog(CargoServiceImpl.class);
 
+  @Transactional(readOnly = false)
+  public TrackingId registerNew(Location origin, Location destination) {
+    Validate.notNull(origin);
+    Validate.notNull(destination);
+
+    TrackingId trackingId = cargoRepository.nextTrackingId();
+    Cargo cargo = new Cargo(trackingId, origin, destination);
+    cargoRepository.save(cargo);
+
+    logger.info("Registered new cargo with tracking id " + trackingId.idString());
+    
+    return trackingId;
+  }
+
   @Transactional(readOnly = true)
-  public CargoWithHistoryDTO track(TrackingId trackingId) {
+  public CargoTrackingDTO track(TrackingId trackingId) {
     final Cargo cargo = cargoRepository.find(trackingId);
     if (cargo == null) {
       return null;
@@ -23,11 +39,9 @@ public class CargoServiceImpl implements CargoService {
 
     DeliveryHistory deliveryHistory = cargo.deliveryHistory();
 
-    //CargoWithHistoryDTO
-
     Location currentLocation = deliveryHistory.currentLocation();
     CarrierMovement currentCarrierMovement = deliveryHistory.currentCarrierMovement();
-    final CargoWithHistoryDTO dto = new CargoWithHistoryDTO(
+    final CargoTrackingDTO dto = new CargoTrackingDTO(
       cargo.trackingId().idString(),
       cargo.origin().toString(),
       cargo.finalDestination().toString(),
@@ -53,6 +67,7 @@ public class CargoServiceImpl implements CargoService {
 
   }
 
+  // TODO: move this to another class?
   @Transactional(readOnly = true)
   public void notify(TrackingId trackingId) {
     Cargo cargo = cargoRepository.find(trackingId);

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

@@ -1,8 +1,8 @@
 package se.citerus.dddsample.service;
 
-import se.citerus.dddsample.domain.Cargo;
 import se.citerus.dddsample.domain.Itinerary;
 import se.citerus.dddsample.domain.Specification;
+import se.citerus.dddsample.domain.TrackingId;
 
 import java.util.Set;
 
@@ -11,6 +11,6 @@ import java.util.Set;
  */
 public interface RoutingService {
 
-  Set<Itinerary> calculatePossibleRoutes(Cargo cargo, Specification specification);
+  Set<Itinerary> calculatePossibleRoutes(TrackingId trackingId, Specification specification);
 
 }

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

@@ -2,6 +2,7 @@ package se.citerus.dddsample.service;
 
 import org.springframework.transaction.annotation.Transactional;
 import se.citerus.dddsample.domain.*;
+import se.citerus.dddsample.repository.CargoRepository;
 import se.citerus.dddsample.repository.LocationRepository;
 
 import java.util.*;
@@ -14,9 +15,14 @@ import java.util.*;
 public class RoutingServiceImpl implements RoutingService {
 
   LocationRepository locationRepository;
+  CargoRepository cargoRepository;
 
   @Transactional(readOnly = true)
-  public Set<Itinerary> calculatePossibleRoutes(Cargo cargo, Specification specification) {
+  public Set<Itinerary> calculatePossibleRoutes(TrackingId trackingId, Specification specification) {
+    Cargo cargo = cargoRepository.find(trackingId);
+    if (cargo == null) {
+      return Collections.emptySet();
+    }
     List<Location> allLocations = locationRepository.findAll();
 
     allLocations.remove(cargo.origin());
@@ -30,16 +36,19 @@ public class RoutingServiceImpl implements RoutingService {
       Collections.shuffle(allLocations);
       List<Leg> legs = new ArrayList<Leg>(allLocations.size() - 1);
 
-      legs.add(new Leg(new CarrierMovementId("CM000"), cargo.origin(), allLocations.get(0)));
+      Location firstLegTo = allLocations.get(0);
+      legs.add(new Leg(new CarrierMovementId("CM000"), cargo.origin(), firstLegTo));
+
       for (int j = 0; j < allLocations.size() - 1 ; j++) {
-        legs.add(new Leg(new CarrierMovementId("CM00" + j), 
+        legs.add(new Leg(
+          new CarrierMovementId("CM00" + j),
           allLocations.get(j), allLocations.get(j + 1)));
       }
-      legs.add(new Leg(new CarrierMovementId("CM999"), allLocations.get(allLocations.size() - 1), cargo.finalDestination()));
 
-      Itinerary itinerary = new Itinerary(legs);
+      Location lastLegFrom = allLocations.get(allLocations.size() - 1);
+      legs.add(new Leg(new CarrierMovementId("CM999"), lastLegFrom, cargo.finalDestination()));
 
-      candidates.add(itinerary);
+      candidates.add(new Itinerary(legs));
     }
 
     return candidates;
@@ -49,4 +58,8 @@ public class RoutingServiceImpl implements RoutingService {
     this.locationRepository = locationRepository;
   }
 
+  public void setCargoRepository(CargoRepository cargoRepository) {
+    this.cargoRepository = cargoRepository;
+  }
+
 }

dddsample/src/main/java/se/citerus/dddsample/service/dto/CargoWithHistoryDTO.java → dddsample/src/main/java/se/citerus/dddsample/service/dto/CargoTrackingDTO.java

@@ -11,7 +11,7 @@ import java.util.List;
  * DTO for a cargo and its delivery history.
  *
  */
-public class CargoWithHistoryDTO implements Serializable {
+public class CargoTrackingDTO implements Serializable {
 
   String trackingId;
   String origin;
@@ -22,7 +22,7 @@ public class CargoWithHistoryDTO implements Serializable {
   StatusCode statusCode;
   boolean misdirected;
 
-  public CargoWithHistoryDTO(String trackingId, String origin, String finalDestination,
+  public CargoTrackingDTO(String trackingId, String origin, String finalDestination,
                              StatusCode statusCode, String currentLocationId, String carrierMovementId,
                              boolean isMisdirected) {
     this.trackingId = trackingId;

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

@@ -5,7 +5,7 @@ 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.service.dto.CargoTrackingDTO;
 import se.citerus.dddsample.web.command.TrackCommand;
 
 import javax.servlet.http.HttpServletRequest;
@@ -31,9 +31,9 @@ public class CargoTrackingController extends SimpleFormController {
   protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors) throws Exception {
     final TrackCommand trackCommand = (TrackCommand) command;
     final String tidStr = trackCommand.getTrackingId();
-    final CargoWithHistoryDTO cargo = cargoService.track(new TrackingId(tidStr));
+    final CargoTrackingDTO cargo = cargoService.track(new TrackingId(tidStr));
 
-    final Map<String, Object> model = new HashMap<String, Object>();
+    final Map<String, CargoTrackingDTO> model = new HashMap<String, CargoTrackingDTO>();
     if (cargo != null) {
       model.put("cargo", cargo);
     } else {

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

@@ -32,6 +32,7 @@
 
   <bean id="routingService" class="se.citerus.dddsample.service.RoutingServiceImpl">
     <property name="locationRepository" ref="locationRepository"/>
+    <property name="cargoRepository" ref="cargoRepository"/>
   </bean>
 
   <!--

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

@@ -21,7 +21,7 @@
   <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
     <property name="exceptionMappings">
       <props>
-        <prop key="org.springframework.dao.DataAccessException">dataAccessFailure</prop>
+        <prop key="org.springframework.dao.DataAccessException">error/dataAccessFailure</prop>
       </props>
     </property>
   </bean>

dddsample/src/main/webapp/WEB-INF/dispatch-servlet.xml

@@ -3,10 +3,10 @@
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
 
-  <bean name="/start.html" class="se.citerus.dddsample.web.CargoTrackingController">
+  <bean name="/cargo/track.html" class="se.citerus.dddsample.web.CargoTrackingController">
     <property name="sessionForm" value="true"/>
     <property name="commandName" value="trackCommand"/>
-    <property name="formView" value="start"/>
+    <property name="formView" value="cargo/track"/>
     <property name="successView" value="start"/>
     <property name="cargoService" ref="cargoService"/>
     <property name="validator" ref="trackCommandValidator"/>

dddsample/src/main/webapp/index.jsp

@@ -1,3 +1,3 @@
 <%
-  response.sendRedirect("start.html");
+  response.sendRedirect("cargo/track.html");
 %>

dddsample/src/test/java/se/citerus/dddsample/domain/SampleLocations.java

@@ -13,7 +13,7 @@ public class SampleLocations {
   public static final Location HONGKONG = new Location(new UnLocode("CN", "HKG"), "Hongkong");
   public static final Location MELBOURNE = new Location(new UnLocode("AU","MEL"), "Melbourne");
   public static final Location STOCKHOLM = new Location(new UnLocode("SE","STO"), "Stockholm");
-  public static final Location HELSINKI = new Location(new UnLocode("Fi","HEL"), "Helsinki");
+  public static final Location HELSINKI = new Location(new UnLocode("FI","HEL"), "Helsinki");
   public static final Location CHICAGO = new Location(new UnLocode("US", "CHI"), "Chicago");
   public static final Location TOKYO = new Location(new UnLocode("JN","TKO"), "Tokyo");
   public static final Location HAMBURG = new Location(new UnLocode("DE", "HAM"), "Hamburg");

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

@@ -10,10 +10,11 @@ import org.springframework.test.AbstractDependencyInjectionSpringContextTests;
 import org.springframework.transaction.TransactionStatus;
 import org.springframework.transaction.interceptor.TransactionAspectSupport;
 import se.citerus.dddsample.domain.*;
-import static se.citerus.dddsample.domain.SampleLocations.*;
+import static se.citerus.dddsample.domain.SampleLocations.CHICAGO;
+import static se.citerus.dddsample.domain.SampleLocations.STOCKHOLM;
 import se.citerus.dddsample.repository.CargoRepository;
 import se.citerus.dddsample.repository.HandlingEventRepository;
-import se.citerus.dddsample.service.dto.CargoWithHistoryDTO;
+import se.citerus.dddsample.service.dto.CargoTrackingDTO;
 import se.citerus.dddsample.service.dto.HandlingEventDTO;
 
 import java.sql.Connection;
@@ -97,7 +98,7 @@ public class CargoServiceTest extends AbstractDependencyInjectionSpringContextTe
 
 
     // Tested call
-    CargoWithHistoryDTO cargoDTO = cargoService.track(new TrackingId("XYZ"));
+    CargoTrackingDTO cargoDTO = cargoService.track(new TrackingId("XYZ"));
 
 
     assertEquals("XYZ", cargoDTO.getTrackingId());
@@ -135,7 +136,7 @@ public class CargoServiceTest extends AbstractDependencyInjectionSpringContextTe
     replay(cargoRepository);
 
     // Tested call
-    CargoWithHistoryDTO cargoDTO = cargoService.track(new TrackingId("XYZ"));
+    CargoTrackingDTO cargoDTO = cargoService.track(new TrackingId("XYZ"));
     
     assertNull(cargoDTO);
   }

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

@@ -24,7 +24,7 @@ public class RoutingScenarioTest extends TestCase {
       satisfy the given specification (must arrive in three days, must not
       cost more than $10,000 etc).
      */
-    Set<Itinerary> itineraryCandidates = routingService.calculatePossibleRoutes(cargo, specification);
+    Set<Itinerary> itineraryCandidates = routingService.calculatePossibleRoutes(trackingId, specification);
 
     /*
       Someone, or something, selects the most appropriate itinerary and

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

@@ -5,6 +5,7 @@ import static org.easymock.EasyMock.*;
 import se.citerus.dddsample.domain.*;
 import static se.citerus.dddsample.domain.SampleLocations.HELSINKI;
 import static se.citerus.dddsample.domain.SampleLocations.HONGKONG;
+import se.citerus.dddsample.repository.CargoRepository;
 import se.citerus.dddsample.repository.LocationRepository;
 
 import java.util.List;
@@ -14,19 +15,25 @@ public class RoutingServiceTest extends TestCase {
 
   RoutingServiceImpl routingService;
   LocationRepository locationRepository;
+  CargoRepository cargoRepository;
 
   protected void setUp() throws Exception {
     routingService = new RoutingServiceImpl();
     locationRepository = createMock(LocationRepository.class);
     routingService.setLocationRepository(locationRepository);
+    cargoRepository = createMock(CargoRepository.class);
+    routingService.setCargoRepository(cargoRepository);
   }
 
   public void testCalculatePossibleRoutes() {
+    TrackingId trackingId = new TrackingId("ABC");
+    Cargo cargo = new Cargo(trackingId, HONGKONG, HELSINKI);
+
     expect(locationRepository.findAll()).andStubReturn(SampleLocations.getAll());
-    replay(locationRepository);
+    expect(cargoRepository.find(isA(TrackingId.class))).andReturn(cargo);
+    replay(locationRepository, cargoRepository);
 
-    Cargo cargo = new Cargo(new TrackingId("ABC"), HONGKONG, HELSINKI);
-    Set<Itinerary> candidates = routingService.calculatePossibleRoutes(cargo, null);
+    Set<Itinerary> candidates = routingService.calculatePossibleRoutes(trackingId, null);
     assertNotNull(candidates);
     
     for (Itinerary itinerary : candidates) {
@@ -48,8 +55,7 @@ public class RoutingServiceTest extends TestCase {
       }
     }
 
-
-    verify(locationRepository);
+    verify(locationRepository, cargoRepository);
   }
 
 }

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

@@ -10,9 +10,10 @@ import org.springframework.validation.Errors;
 import org.springframework.validation.FieldError;
 import org.springframework.web.servlet.ModelAndView;
 import se.citerus.dddsample.domain.*;
-import static se.citerus.dddsample.domain.SampleLocations.*;
+import static se.citerus.dddsample.domain.SampleLocations.HONGKONG;
+import static se.citerus.dddsample.domain.SampleLocations.TOKYO;
 import se.citerus.dddsample.service.CargoService;
-import se.citerus.dddsample.service.dto.CargoWithHistoryDTO;
+import se.citerus.dddsample.service.dto.CargoTrackingDTO;
 import se.citerus.dddsample.service.dto.HandlingEventDTO;
 import se.citerus.dddsample.web.command.TrackCommand;
 
@@ -40,12 +41,16 @@ public class CargoTrackingControllerTest extends TestCase {
 
   private CargoService getCargoServiceMock() {
     return new CargoService() {
-      public CargoWithHistoryDTO track(TrackingId trackingId) {
+      public TrackingId registerNew(Location origin, Location destination) {
+        return null;
+      }
+
+      public CargoTrackingDTO track(TrackingId trackingId) {
         Cargo cargo = new Cargo(trackingId, HONGKONG, TOKYO);
         HandlingEvent event = new HandlingEvent(cargo, new Date(10L), new Date(20L), HandlingEvent.Type.RECEIVE, HONGKONG, null);
 
         // TODO: use DTO assemblers
-        CargoWithHistoryDTO cargoDTO = new CargoWithHistoryDTO(
+        CargoTrackingDTO cargoDTO = new CargoTrackingDTO(
                 cargo.trackingId().idString(),
                 cargo.origin().unLocode().idString(),
                 cargo.finalDestination().unLocode().idString(),
@@ -69,7 +74,11 @@ public class CargoTrackingControllerTest extends TestCase {
   
   private CargoService getCargoServiceNullMock() {
     return new CargoService() {
-      public CargoWithHistoryDTO track(TrackingId trackingId) {
+      public TrackingId registerNew(Location origin, Location destination) {
+        return null;
+      }
+
+      public CargoTrackingDTO track(TrackingId trackingId) {
         return null;
       }
       public void notify(TrackingId trackingId) {}
@@ -97,7 +106,7 @@ public class CargoTrackingControllerTest extends TestCase {
     assertEquals("test-form", mav.getViewName());
     // Errors, command are two standard map attributes, the third should be the cargo object
     assertEquals(3, mav.getModel().size());
-    CargoWithHistoryDTO cargo = (CargoWithHistoryDTO) mav.getModel().get("cargo");
+    CargoTrackingDTO cargo = (CargoTrackingDTO) mav.getModel().get("cargo");
     assertEquals("AAAAA", cargo.getCurrentLocationId());
   }