Added limitation properties such as deadline date to graph traversal service API.

GraphDAO no longer uses the database, simply hardcoded for simplicity.

dddsample/src/main/java/com/partner/pathfinder/api/GraphTraversalService.java

@@ -1,6 +1,7 @@
 package com.partner.pathfinder.api;
 
 import java.util.List;
+import java.util.Properties;
 
 /**
  * Part of the external graph traversal API exposed by the routing team
@@ -9,6 +10,6 @@ import java.util.List;
  */
 public interface GraphTraversalService {
 
-  List<TransitPath> findShortestPath(String originUnLocode, String destinationUnLocode);
+  List<TransitPath> findShortestPath(String originUnLocode, String destinationUnLocode, Properties limitations);
 
 }

dddsample/src/main/java/com/partner/pathfinder/internal/GraphDAO.java

@@ -1,44 +1,23 @@
 package com.partner.pathfinder.internal;
 
-import org.springframework.jdbc.core.JdbcTemplate;
-import org.springframework.jdbc.core.RowCallbackHandler;
-
-import javax.sql.DataSource;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
+import java.util.UUID;
 
 public class GraphDAO {
 
-  private final JdbcTemplate jt;
-
-  public GraphDAO(DataSource dataSource) {
-    jt = new JdbcTemplate(dataSource);
-  }
-
   public List<String> listLocations() {
-    final List<String> result = new ArrayList();
-
-    jt.query("select unlocode from location", new RowCallbackHandler() {
-      public void processRow(ResultSet resultSet) throws SQLException {
-        result.add(resultSet.getString("unlocode"));
-      }
-    });
-
-    return result;
+    return Arrays.asList(
+      "CNHKG", "AUMEL", "SESTO", "FIHEL", "USCHI", "JNTKO", "DEHAM",
+      "CNSHA", "NLRTM", "SEGOT", "CNHGH", "USNYC", "USDAL"
+    );
   }
 
-  // TODO adapt to Voyage
-  public void storeCarrierMovementId(String cmId, String from, String to) {
-    final String locationSql = "select id from location where unlocode = ?";
-
-    final Long fromId = jt.queryForLong(locationSql, new Object[]{ from });
-    final Long toId = jt.queryForLong(locationSql, new Object[]{ to });
-
-    final Object[] params = {cmId, fromId, toId};
-    jt.update(
-      "insert into CarrierMovement (carrier_movement_id,from_id,to_id) " +
-      "values (?,?,?)", params);
+  public String getVoyageNumber(String from, String to) {
+    // TODO return only those that are in the database
+    final String random = UUID.randomUUID().toString().toUpperCase();
+    final String cmId =  random.substring(0, 4);
+    //dao.storeCarrierMovementId(cmId, from, to);
+    return cmId;
   }
 }

dddsample/src/main/java/com/partner/pathfinder/internal/GraphTraversalServiceImpl.java

@@ -3,7 +3,6 @@ package com.partner.pathfinder.internal;
 import com.partner.pathfinder.api.GraphTraversalService;
 import com.partner.pathfinder.api.TransitEdge;
 import com.partner.pathfinder.api.TransitPath;
-import org.springframework.transaction.annotation.Transactional;
 
 import java.util.*;
 
@@ -17,8 +16,9 @@ public class GraphTraversalServiceImpl implements GraphTraversalService {
     this.random = new Random();
   }
 
-  @Transactional(readOnly = true)
-  public List<TransitPath> findShortestPath(String originUnLocode, String destinationUnLocode) {
+  public List<TransitPath> findShortestPath(final String originUnLocode,
+                                            final String destinationUnLocode,
+                                            final Properties limitations) {
     List<String> allVertices = dao.listLocations();
     allVertices.remove(originUnLocode);
     allVertices.remove(destinationUnLocode);
@@ -32,18 +32,18 @@ public class GraphTraversalServiceImpl implements GraphTraversalService {
       final String firstLegTo = allVertices.get(0);
 
       transitEdges.add(new TransitEdge(
-        getRandomCarrierMovementId(originUnLocode, firstLegTo),
+        dao.getVoyageNumber(originUnLocode, firstLegTo),
         originUnLocode, firstLegTo));
 
       for (int j = 0; j < allVertices.size() - 1; j++) {
         final String curr = allVertices.get(j);
         final String next = allVertices.get(j + 1);
-        transitEdges.add(new TransitEdge(getRandomCarrierMovementId(curr, next), curr, next));
+        transitEdges.add(new TransitEdge(dao.getVoyageNumber(curr, next), curr, next));
       }
 
       final String lastLegFrom = allVertices.get(allVertices.size() - 1);
       transitEdges.add(new TransitEdge(
-        getRandomCarrierMovementId(lastLegFrom, destinationUnLocode),
+        dao.getVoyageNumber(lastLegFrom, destinationUnLocode),
         lastLegFrom, destinationUnLocode));
 
       candidates.add(new TransitPath(transitEdges));
@@ -52,13 +52,6 @@ public class GraphTraversalServiceImpl implements GraphTraversalService {
     return candidates;
   }
 
-  private String getRandomCarrierMovementId(String from, String to) {
-    final String random = UUID.randomUUID().toString().toUpperCase();
-    final String cmId =  random.substring(0, 4);
-    dao.storeCarrierMovementId(cmId, from, to);
-    return cmId;
-  }
-
   private int getRandomNumberOfCandidates() {
     return 1 + random.nextInt(4);
   }

dddsample/src/main/java/se/citerus/dddsample/infrastructure/routing/ExternalRoutingService.java

@@ -3,6 +3,8 @@ package se.citerus.dddsample.infrastructure.routing;
 import com.partner.pathfinder.api.GraphTraversalService;
 import com.partner.pathfinder.api.TransitEdge;
 import com.partner.pathfinder.api.TransitPath;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import se.citerus.dddsample.domain.model.cargo.Itinerary;
 import se.citerus.dddsample.domain.model.cargo.Leg;
 import se.citerus.dddsample.domain.model.cargo.RouteSpecification;
@@ -16,6 +18,7 @@ import se.citerus.dddsample.domain.service.RoutingService;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
+import java.util.Properties;
 
 /**
  * Our end of the routing service. This is basically a data model
@@ -28,18 +31,27 @@ public class ExternalRoutingService implements RoutingService {
   private GraphTraversalService graphTraversalService;
   private LocationRepository locationRepository;
   private VoyageRepository voyageRepository;
+  private static final Log log = LogFactory.getLog(ExternalRoutingService.class);
 
   public List<Itinerary> fetchRoutesForSpecification(RouteSpecification routeSpecification) {
+    /*
+      The RouteSpecification is picked apart and adapted to the external API.
+     */
     final Location origin = routeSpecification.origin();
     final Location destination = routeSpecification.destination();
 
-    // TODO send arrival deadline too
+    final Properties limitations = new Properties();
+    limitations.setProperty("DEADLINE", routeSpecification.arrivalDeadline().toString());
 
     final List<TransitPath> transitPaths = graphTraversalService.findShortestPath(
       origin.unLocode().idString(),
-      destination.unLocode().idString()
+      destination.unLocode().idString(),
+      limitations
     );
     
+    /*
+      The returned result is then translated back into our domain model.
+     */
     final List<Itinerary> itineraries = new ArrayList<Itinerary>();
 
     for (TransitPath transitPath : transitPaths) {
@@ -48,7 +60,7 @@ public class ExternalRoutingService implements RoutingService {
       if (routeSpecification.isSatisfiedBy(itinerary)) {
         itineraries.add(itinerary);
       } else {
-        // TODO log warning/error? Fail?
+        log.warn("Received itinerary that did not satisfy the route specification");
       }
     }
 

dddsample/src/main/resources/com/partner/pathfinder/internal/applicationContext.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+
+<beans xmlns="http://www.springframework.org/schema/beans"
+       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.5.xsd">
+
+  <bean id="graphTraversalService" class="com.partner.pathfinder.internal.GraphTraversalServiceImpl">
+    <constructor-arg ref="graphDAO"/>
+  </bean>
+
+  <bean id="graphDAO" class="com.partner.pathfinder.internal.GraphDAO"/>
+
+  <bean id="rmiGraphTraversalService" class="org.springframework.remoting.rmi.RmiServiceExporter">
+    <property name="serviceInterface" value="com.partner.pathfinder.api.GraphTraversalService"/>
+    <property name="service" ref="graphTraversalService"/>
+    <property name="serviceName" value="PathFinder"/>
+  </bean>
+
+</beans>

dddsample/src/test/java/se/citerus/dddsample/infrastructure/routing/ExternalRoutingServiceTest.java

@@ -14,7 +14,6 @@ import se.citerus.dddsample.domain.model.location.LocationRepository;
 import static se.citerus.dddsample.domain.model.location.SampleLocations.*;
 import se.citerus.dddsample.infrastructure.persistence.inmemory.LocationRepositoryInMem;
 
-import javax.sql.DataSource;
 import java.util.Arrays;
 import java.util.Date;
 import java.util.List;
@@ -32,7 +31,7 @@ public class ExternalRoutingServiceTest extends TestCase {
     voyageRepository = createMock(VoyageRepository.class);
     externalRoutingService.setVoyageRepository(voyageRepository);
 
-    GraphTraversalService graphTraversalService = new GraphTraversalServiceImpl(new GraphDAO(createMock(DataSource.class)) {
+    GraphTraversalService graphTraversalService = new GraphTraversalServiceImpl(new GraphDAO() {
       public List<String> listLocations() {
         return Arrays.asList(TOKYO.unLocode().idString(), STOCKHOLM.unLocode().idString(), GOTHENBURG.unLocode().idString());
       }