Tightened the CargoTrackingController a bit, treating "no cargo found" same way as a binding error

Introduced a Spring context for the web layer, where all web support components go.

Introduced the RequestContext attribute as "rc" in views.

Removed unneeded "unknown cargo" JSP.

c:out not needed anymore.

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

@@ -56,6 +56,7 @@ public class HandlingEvent implements Comparable<HandlingEvent> {
     return HashCodeBuilder.reflectionHashCode(this);
   }
 
+  @Override
   public int compareTo(HandlingEvent o) {
     return time.compareTo(o.getTime());
   }

dddsample/src/main/java/se/citerus/dddsample/domain/Location.java

@@ -28,7 +28,5 @@ public class Location {
   public String toString() {
     return unlocode;
   }
-  
-  
 
 }

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

@@ -1,20 +1,17 @@
 package se.citerus.dddsample.web;
 
-import java.util.HashMap;
-import java.util.Map;
-
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-
 import org.springframework.validation.BindException;
 import org.springframework.web.servlet.ModelAndView;
 import org.springframework.web.servlet.mvc.SimpleFormController;
-
 import se.citerus.dddsample.domain.Cargo;
-import se.citerus.dddsample.domain.Location;
 import se.citerus.dddsample.service.CargoService;
 import se.citerus.dddsample.web.command.TrackCommand;
 
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.util.HashMap;
+import java.util.Map;
+
 /**
  * Controller for tracking cargo.
  */
@@ -24,34 +21,23 @@ public class CargoTrackingController extends SimpleFormController {
    * Service instance.
    */
   private CargoService cargoService;
-  private String unknownCargoView;
 
   public CargoTrackingController() {
     setCommandClass(TrackCommand.class);
   }
 
-  
   @Override
   protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors) throws Exception {
-    ModelAndView mav = null;
-    final Map<String, Object> model = new HashMap<String, Object>();
-
-    final TrackCommand trackCommand = (TrackCommand) command;   
-    logger.debug("Finding cargo by trackingId: " + trackCommand.getTrackingId());
+    final TrackCommand trackCommand = (TrackCommand) command;
     final Cargo cargo = cargoService.find(trackCommand.getTrackingId());
 
+    final Map<String, Cargo> model = new HashMap<String, Cargo>();
     if (cargo != null) {
       model.put("cargo", cargo);
-      
-      // Can't just return a new MaV instance when successView and FormView is the same. Binding will fail.
-      // showForm will append our command and model to the request so that the form will bind successfully.
-      mav = showForm(request, errors, getSuccessView(), model);
     } else {
-      model.put("trackingId", trackCommand.getTrackingId());
-      mav = new ModelAndView(getUnknownCargoView(), model);
+      errors.rejectValue("trackingId", "cargo.unknown_id", new Object[] {trackCommand.getTrackingId()}, "Unknown cargo id");
     }
-    
-    return mav;
+    return showForm(request, response, errors, model);
   }
    
 
@@ -64,24 +50,4 @@ public class CargoTrackingController extends SimpleFormController {
     this.cargoService = cargoService;
   }
   
-  /**
-   * Sets the view to show when an unknown tracking id is submitted.
-   *
-   * @param unknownCargoView The view.
-   */
-  public void setUnknownCargoView(final String unkownCargoView) {
-    this.unknownCargoView = unkownCargoView;
-  }
-
-  /**
-   * Gets the view to show when an unknown tracking id is submitted
-   * 
-   * @return The View
-   */
-  public String getUnknownCargoView() {
-    return unknownCargoView;
-  }
-
-
-  
 }

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

@@ -0,0 +1,28 @@
+<?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="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
+    <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
+    <property name="prefix" value="/WEB-INF/jsp/"/>
+    <property name="suffix" value=".jsp"/>
+    <property name="requestContextAttribute" value="rc"/>
+  </bean>
+
+  <!--
+    - This bean resolves specific types of exceptions to corresponding logical
+    - view names for error views. The default behaviour of DispatcherServlet
+    - is to propagate all exceptions to the servlet container: this will happen
+    - here with all other types of exceptions.
+  -->
+  <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
+    <property name="exceptionMappings">
+      <props>
+        <prop key="org.springframework.dao.DataAccessException">dataAccessFailure</prop>
+      </props>
+    </property>
+  </bean>
+
+</beans>

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

@@ -10,29 +10,8 @@
     <property name="successView" value="start"/>
     <property name="cargoService" ref="cargoService"/>
     <property name="validator" ref="trackCommandValidator"/>
-    <property name="unknownCargoView" value="unknownCargo"/>
   </bean>
 
   <bean id="trackCommandValidator" class="se.citerus.dddsample.web.command.TrackCommandValidator"/>
 
-  <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
-    <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
-    <property name="prefix" value="/WEB-INF/jsp/"/>
-    <property name="suffix" value=".jsp"/>
-  </bean>
-  
-  <!--
-    - This bean resolves specific types of exceptions to corresponding logical 
-    - view names for error views. The default behaviour of DispatcherServlet 
-    - is to propagate all exceptions to the servlet container: this will happen 
-    - here with all other types of exceptions.
-  -->
-  <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
-    <property name="exceptionMappings">
-      <props>
-        <prop key="org.springframework.dao.DataAccessException">dataAccessFailure</prop>
-      </props>
-    </property>
-  </bean>
-
 </beans>

dddsample/src/main/webapp/WEB-INF/jsp/dataAccessFailure.jsp

@@ -5,7 +5,7 @@
 	<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
 	<script type="text/javascript"></script>
 	<style type="text/css" title="style" media="screen">
-		@import "/dddsample/style.css";
+		@import "${rc.contextPath}/style.css";
 	</style>
 </head>
 <body>

dddsample/src/main/webapp/WEB-INF/jsp/start.jsp

@@ -2,11 +2,11 @@
 
 <html>
 <head>
-	<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
-	<script type="text/javascript"></script>
-	<style type="text/css" title="style" media="screen">
-		@import "/dddsample/style.css";
-	</style>
+  <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"/>
+  <script type="text/javascript"></script>
+  <style type="text/css" title="style" media="screen">
+    @import "${rc.contextPath}/style.css";
+  </style>
 </head>
 <body>
 <div id="form">
@@ -29,20 +29,31 @@
     </table>
   </form:form>
 </div>
-<div id="result">
-<c:choose>
-  <c:when test="${cargo ne null}">
-  	
+<c:if test="${cargo ne null}">
+  <div id="result">
+
     <p>Your cargo is currently at: <span id="currentLocation">${cargo.currentLocation}</span></p>
-    
-    <table>
-      <c:forEach var="event" items="${cargo.deliveryHistory.events}">
-        <tr><td><c:out value="${event.type}"/> &nbsp; on &nbsp;</td><td><c:out value="${event.location}"/>&nbsp; at &nbsp;</td><td><c:out value="${event.time}"/></td></tr>
-      </c:forEach>
+
+    <table cellspacing="4">
+      <thead>
+        <tr>
+          <td>Event</td>
+          <td>Location</td>
+          <td>Time</td>
+        </tr>
+      </thead>
+      <tbody>
+        <c:forEach var="event" items="${cargo.deliveryHistory.events}">
+          <tr>
+            <td>${event.type}</td>
+            <td>${event.location}</td>
+            <td>${event.time}</td>
+          </tr>
+        </c:forEach>
+      </tbody>
     </table>
-    
-  </c:when>
-</c:choose>
-</div>
+
+  </div>
+</c:if>
 </body>
 </html>

dddsample/src/main/webapp/WEB-INF/jsp/unknownCargo.jsp

@@ -1,19 +0,0 @@
-<%@ include file="/WEB-INF/jspf/include.jspf" %>
-
-<html>
-<head>
-	<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
-	<script type="text/javascript"></script>
-	<style type="text/css" title="style" media="screen">
-		@import "/dddsample/style.css";
-	</style>
-</head>
-<body>
-
-<p>Unknown tracking id ${trackingId}</p>
-
-<br/>
-<a href="start.html">Start page</a>
-
-</body>
-</html>

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

@@ -1,13 +1,14 @@
 package se.citerus.dddsample.web;
 
 import junit.framework.TestCase;
-
 import org.springframework.mock.web.MockHttpServletRequest;
 import org.springframework.mock.web.MockHttpServletResponse;
 import org.springframework.mock.web.MockHttpSession;
 import org.springframework.mock.web.MockServletContext;
+import org.springframework.validation.BindingResult;
+import org.springframework.validation.Errors;
+import org.springframework.validation.FieldError;
 import org.springframework.web.servlet.ModelAndView;
-
 import se.citerus.dddsample.domain.Cargo;
 import se.citerus.dddsample.domain.Location;
 import se.citerus.dddsample.domain.TrackingId;
@@ -31,9 +32,7 @@ public class CargoTrackingControllerTest extends TestCase {
     controller = new CargoTrackingController();
     controller.setFormView("test-form");
     controller.setSuccessView("test-success");
-    controller.setUnknownCargoView("test-unkownCargo");
     controller.setCommandName("test-command-name");
-    controller.setCargoService(getCargoServiceMock());
   }
 
   private CargoService getCargoServiceMock() {
@@ -57,6 +56,7 @@ public class CargoTrackingControllerTest extends TestCase {
   }
 
   public void testHandleGet() throws Exception {
+    controller.setCargoService(getCargoServiceMock());
     request.setMethod("GET");
 
     ModelAndView mav = controller.handleRequest(request, response);
@@ -67,11 +67,13 @@ public class CargoTrackingControllerTest extends TestCase {
   }
 
   public void testHandlePost() throws Exception {
+    controller.setCargoService(getCargoServiceMock());
     request.setMethod("POST");
 
     ModelAndView mav = controller.handleRequest(request, response);
 
-    assertEquals("test-success", mav.getViewName());
+    assertEquals("test-form", mav.getViewName());
+    // Errors, command are two standard map attributes, the third should be the cargo object
     assertEquals(3, mav.getModel().size());
     Cargo cargo = (Cargo) mav.getModel().get("cargo");
     assertEquals("AAA", cargo.getCurrentLocation().unlocode());
@@ -79,28 +81,22 @@ public class CargoTrackingControllerTest extends TestCase {
 
   public void testUnknownCargo() throws Exception {
     controller.setCargoService(getCargoServiceNullMock());
-    controller.setCommandClass(TrackCommandMock.class);
     request.setMethod("POST");
-
+    request.setParameter("trackingId", "unknown-id");
+    
     ModelAndView mav = controller.handleRequest(request, response);
 
-    assertEquals("test-unkownCargo", mav.getViewName());
-    assertEquals(1, mav.getModel().size());
-    String trackId = (String) mav.getModel().get("trackingId");
-    assertEquals("MOCK", trackId);
-  }
-  
-  
-  
-  
-  /**
-   * Mock track command.
-   * 
-   * Sets a default track id when constructed.
-   */
-  private static class TrackCommandMock extends TrackCommand {
-    public TrackCommandMock() {
-      setTrackingId("MOCK");
-    }
+    assertEquals("test-form", mav.getViewName());
+    assertEquals(2, mav.getModel().size());
+
+    TrackCommand command = (TrackCommand) mav.getModel().get(controller.getCommandName());
+    assertEquals("unknown-id", command.getTrackingId());
+
+    Errors errors = (Errors) mav.getModel().get(BindingResult.MODEL_KEY_PREFIX + controller.getCommandName());
+    FieldError fe = errors.getFieldError("trackingId");
+    assertEquals("cargo.unknown_id", fe.getCode());
+    assertEquals(1, fe.getArguments().length);
+    assertEquals(command.getTrackingId(), fe.getArguments()[0]);
   }
+
 }