Introduced BookingServiceFacade as an application service, on top of the domain layer's BookingService and the repositories, as a DTO assembly point and remoting exposure layer (currently configured in context-remote.xml, but only used as local reference).

CargoAdminController now sits on top on this facade. If time permits, the booking part of the application can be moved to another virtual machine at this point.

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

@@ -0,0 +1,30 @@
+package se.citerus.dddsample.service;
+
+import se.citerus.dddsample.service.dto.CargoRoutingDTO;
+import se.citerus.dddsample.service.dto.ItineraryCandidateDTO;
+import se.citerus.dddsample.service.dto.LocationDTO;
+
+import java.rmi.Remote;
+import java.rmi.RemoteException;
+import java.util.List;
+
+/**
+ * This facade shields the domain layer - model, services, repositories -
+ * from concerns about such things as the user interface and remoting.
+ * It is an application service.
+ */
+public interface BookingServiceFacade extends Remote {
+
+  String registerNewCargo(String origin, String destination) throws RemoteException;
+
+  CargoRoutingDTO loadCargoForRouting(String trackingId) throws RemoteException;
+
+  void assignCargoToRoute(String trackingId, ItineraryCandidateDTO itinerary) throws RemoteException;
+
+  List<ItineraryCandidateDTO> requestPossibleRoutesForCargo(String trackingId) throws RemoteException;
+
+  List<LocationDTO> listShippingLocations() throws RemoteException;
+
+  List<CargoRoutingDTO> listAllCargos() throws RemoteException;
+
+}

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

@@ -0,0 +1,92 @@
+package se.citerus.dddsample.service;
+
+import se.citerus.dddsample.domain.*;
+import se.citerus.dddsample.repository.CargoRepository;
+import se.citerus.dddsample.repository.CarrierMovementRepository;
+import se.citerus.dddsample.repository.LocationRepository;
+import se.citerus.dddsample.service.dto.CargoRoutingDTO;
+import se.citerus.dddsample.service.dto.ItineraryCandidateDTO;
+import se.citerus.dddsample.service.dto.LocationDTO;
+import se.citerus.dddsample.service.dto.assembler.CargoRoutingDTOAssembler;
+import se.citerus.dddsample.service.dto.assembler.ItineraryCandidateDTOAssembler;
+import se.citerus.dddsample.service.dto.assembler.LocationDTOAssembler;
+
+import java.rmi.RemoteException;
+import java.util.ArrayList;
+import java.util.List;
+
+
+/**
+ * This implementation has additional support from the infrastructure, for exposing as an RMI
+ * service and for keeping the OR-mapper unit-of-work open during DTO assembly,
+ * analogous to the view rendering for web interfaces.
+ *
+ * See context-remote.xml.  
+ */
+public class BookingServiceFacadeImpl implements BookingServiceFacade {
+
+  private BookingService bookingService;
+  private LocationRepository locationRepository;
+  private CargoRepository cargoRepository;
+  private CarrierMovementRepository carrierMovementRepository;
+
+  public List<LocationDTO> listShippingLocations() {
+    final List<Location> allLocations = locationRepository.findAll();
+    final LocationDTOAssembler assembler = new LocationDTOAssembler();
+    return assembler.toDTOList(allLocations);
+  }
+
+  public String registerNewCargo(String origin, String destination) {
+    TrackingId trackingId = bookingService.registerNewCargo(new UnLocode(origin), new UnLocode(destination));
+    return trackingId.idString();
+  }
+
+  public CargoRoutingDTO loadCargoForRouting(String trackingId) {
+    final Cargo cargo = bookingService.loadCargoForRouting(new TrackingId(trackingId));
+    final CargoRoutingDTOAssembler assembler = new CargoRoutingDTOAssembler();
+    return assembler.toDTO(cargo);
+  }
+
+  public void assignCargoToRoute(String trackingId, ItineraryCandidateDTO itineraryCandidateDTO) {
+    final Itinerary itinerary = new ItineraryCandidateDTOAssembler().fromDTO(itineraryCandidateDTO, carrierMovementRepository, locationRepository);
+    bookingService.assignCargoToRoute(new TrackingId(trackingId), itinerary);
+  }
+
+  public List<CargoRoutingDTO> listAllCargos() {
+    final List<Cargo> cargoList = cargoRepository.findAll();
+    final List<CargoRoutingDTO> dtoList = new ArrayList<CargoRoutingDTO>(cargoList.size());
+    final CargoRoutingDTOAssembler assembler = new CargoRoutingDTOAssembler();
+    for (Cargo cargo : cargoList) {
+      dtoList.add(assembler.toDTO(cargo));
+    }
+    return dtoList;
+  }
+
+  public List<ItineraryCandidateDTO> requestPossibleRoutesForCargo(String trackingId) throws RemoteException {
+    final List<Itinerary> itineraries = bookingService.requestPossibleRoutesForCargo(new TrackingId(trackingId));
+
+    final List<ItineraryCandidateDTO> itineraryCandidates = new ArrayList<ItineraryCandidateDTO>(itineraries.size());
+    final ItineraryCandidateDTOAssembler dtoAssembler = new ItineraryCandidateDTOAssembler();
+    for (Itinerary itinerary : itineraries) {
+      itineraryCandidates.add(dtoAssembler.toDTO(itinerary));
+    }
+
+    return itineraryCandidates;
+  }
+
+  public void setBookingService(BookingService bookingService) {
+    this.bookingService = bookingService;
+  }
+
+  public void setLocationRepository(LocationRepository locationRepository) {
+    this.locationRepository = locationRepository;
+  }
+
+  public void setCargoRepository(CargoRepository cargoRepository) {
+    this.cargoRepository = cargoRepository;
+  }
+
+  public void setCarrierMovementRepository(CarrierMovementRepository carrierMovementRepository) {
+    this.carrierMovementRepository = carrierMovementRepository;
+  }
+}

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

@@ -1,21 +1,19 @@
 package se.citerus.dddsample.web;
 
 import org.springframework.web.servlet.mvc.multiaction.MultiActionController;
-import se.citerus.dddsample.domain.*;
-import se.citerus.dddsample.repository.CarrierMovementRepository;
-import se.citerus.dddsample.repository.LocationRepository;
-import se.citerus.dddsample.service.BookingService;
-import se.citerus.dddsample.service.RoutingService;
+import se.citerus.dddsample.service.BookingServiceFacade;
 import se.citerus.dddsample.service.dto.CargoRoutingDTO;
 import se.citerus.dddsample.service.dto.ItineraryCandidateDTO;
 import se.citerus.dddsample.service.dto.LegDTO;
-import se.citerus.dddsample.service.dto.assembler.CargoRoutingDTOAssembler;
-import se.citerus.dddsample.service.dto.assembler.ItineraryCandidateDTOAssembler;
+import se.citerus.dddsample.service.dto.LocationDTO;
 import se.citerus.dddsample.web.command.RegistrationCommand;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 /**
  * Handles cargo routing and administration.
@@ -23,21 +21,16 @@ import java.util.*;
  */
 public final class CargoAdminController extends MultiActionController {
 
-  private BookingService bookingService;
-  private RoutingService routingService;
-  private LocationRepository locationRepository;
-  private CarrierMovementRepository carrierMovementRepository;
-
-  // DTO conversion is pushed out to above the service layer for the time being,
-  // pending a dedicated DTO remoting layer  
+  private BookingServiceFacade bookingServiceFacade;
 
   public Map registrationForm(final HttpServletRequest request, final HttpServletResponse response) throws Exception {
     final Map<String, Object> map = new HashMap<String, Object>();
-    final List<UnLocode> unLocodes = bookingService.listShippingLocations();
+    final List<LocationDTO> dtoList = bookingServiceFacade.listShippingLocations();
+
     final List<String> unLocodeStrings = new ArrayList<String>();
 
-    for (UnLocode unLocode : unLocodes) {
-      unLocodeStrings.add(unLocode.idString());
+    for (LocationDTO dto : dtoList) {
+      unLocodeStrings.add(dto.getUnLocode());
     }
 
     map.put("unlocodes", unLocodeStrings);
@@ -47,58 +40,40 @@ public final class CargoAdminController extends MultiActionController {
   public void register(final HttpServletRequest request, final HttpServletResponse response,
                        final RegistrationCommand command) throws Exception {
 
-    final TrackingId trackingId = bookingService.registerNewCargo(
-      new UnLocode(command.getOriginUnlocode()),
-      new UnLocode(command.getDestinationUnlocode())
+    final String trackingId = bookingServiceFacade.registerNewCargo(
+      command.getOriginUnlocode(), command.getDestinationUnlocode()
     );
-    response.sendRedirect("show.html?trackingId=" + trackingId.idString());
+    response.sendRedirect("show.html?trackingId=" + trackingId);
   }
 
-  public Map list(HttpServletRequest request, HttpServletResponse response) {
+  public Map list(HttpServletRequest request, HttpServletResponse response) throws Exception {
     final Map<String, Object> map = new HashMap<String, Object>();
-    final List<Cargo> allCargos = bookingService.listAllCargos();
+    final List<CargoRoutingDTO> cargoList = bookingServiceFacade.listAllCargos();
 
-    final CargoRoutingDTOAssembler assembler = new CargoRoutingDTOAssembler();
-    final List<CargoRoutingDTO> dtoList = new ArrayList<CargoRoutingDTO>(allCargos.size());
-
-    for (Cargo cargo : allCargos) {
-      dtoList.add(assembler.toDTO(cargo));
-    }
-
-    map.put("cargoList", dtoList);
+    map.put("cargoList", cargoList);
     return map;
   }
 
-  public Map show(final HttpServletRequest request, final HttpServletResponse response) {
+  public Map show(final HttpServletRequest request, final HttpServletResponse response) throws Exception {
     final Map<String, Object> map = new HashMap<String, Object>();
-    final TrackingId trackingId = new TrackingId(request.getParameter("trackingId"));
-    final Cargo cargo = bookingService.loadCargoForRouting(trackingId);
-    final CargoRoutingDTO dto = new CargoRoutingDTOAssembler().toDTO(cargo);
+    final String trackingId = request.getParameter("trackingId");
+    final CargoRoutingDTO dto = bookingServiceFacade.loadCargoForRouting(trackingId);
     map.put("cargo", dto);
     return map;
   }
 
-  public Map selectItinerary(final HttpServletRequest request, final HttpServletResponse response) {
+  public Map selectItinerary(final HttpServletRequest request, final HttpServletResponse response) throws Exception {
     final Map<String, Object> map = new HashMap<String, Object>();
-    final TrackingId trackingId = new TrackingId(request.getParameter("trackingId"));
-
-    final Cargo cargo = bookingService.loadCargoForRouting(trackingId);
-    final RouteSpecification routeSpecification = RouteSpecification.forCargo(cargo, new Date());
-    final List<Itinerary> itineraries = routingService.requestPossibleRoutes(routeSpecification);
-
-    final List<ItineraryCandidateDTO> itineraryCandidates = new ArrayList<ItineraryCandidateDTO>(itineraries.size());
-    final ItineraryCandidateDTOAssembler dtoAssembler = new ItineraryCandidateDTOAssembler();
-    for (Itinerary itinerary : itineraries) {
-      itineraryCandidates.add(dtoAssembler.toDTO(itinerary));
-    }
+    final String trackingId = request.getParameter("trackingId");
+    final List<ItineraryCandidateDTO> itineraryCandidates = bookingServiceFacade.requestPossibleRoutesForCargo(trackingId);
 
     map.put("itineraryCandidates", itineraryCandidates);
-    map.put("trackingId", trackingId.idString());
+    map.put("trackingId", trackingId);
     return map;
   }
 
   public void assignItinerary(final HttpServletRequest request, final HttpServletResponse response) throws Exception {
-    final TrackingId trackingId = new TrackingId(request.getParameter("trackingId"));
+    final String trackingId = request.getParameter("trackingId");
 
     // TODO:  gah, stuck on indexoutofbounds (legs[0].fromUnlocode etc) when trying to bind...
     // Revisit and fix this with a proper command object, this is just hideous
@@ -112,26 +87,13 @@ public final class CargoAdminController extends MultiActionController {
     }
 
     final ItineraryCandidateDTO selectedItinerary = new ItineraryCandidateDTO(legDTOs);
-    final Itinerary itinerary = new ItineraryCandidateDTOAssembler().fromDTO(selectedItinerary, carrierMovementRepository, locationRepository);
 
-    bookingService.assignCargoToRoute(trackingId, itinerary);
+    bookingServiceFacade.assignCargoToRoute(trackingId, selectedItinerary);
 
     response.sendRedirect("list.html");
   }
 
-  public void setBookingService(final BookingService bookingService) {
-    this.bookingService = bookingService;
-  }
-
-  public void setRoutingService(final RoutingService routingService) {
-    this.routingService = routingService;
-  }
-
-  public void setLocationRepository(LocationRepository locationRepository) {
-    this.locationRepository = locationRepository;
-  }
-
-  public void setCarrierMovementRepository(CarrierMovementRepository carrierMovementRepository) {
-    this.carrierMovementRepository = carrierMovementRepository;
+  public void setBookingServiceFacade(BookingServiceFacade bookingServiceFacade) {
+    this.bookingServiceFacade = bookingServiceFacade;
   }
 }

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

@@ -4,12 +4,17 @@
        xmlns:ws="http://jax-ws.dev.java.net/spring/core"
        xmlns:wss="http://jax-ws.dev.java.net/spring/servlet"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns:aop="http://www.springframework.org/schema/aop"
        xsi:schemaLocation="
         http://jax-ws.dev.java.net/spring/core https://jax-ws.dev.java.net/spring/core.xsd
         http://jax-ws.dev.java.net/spring/servlet https://jax-ws.dev.java.net/spring/servlet.xsd
+        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
 
 
+  <!-- Handling event registration web service -->
+
+  
   <wss:bindings id="jax-ws.http">
     <wss:bindings>
       <wss:binding url="/ws/RegisterEvent">
@@ -20,9 +25,57 @@
     </wss:bindings>
   </wss:bindings>
 
-
   <bean id="handlingEventServiceEndpoint" class="se.citerus.dddsample.ws.HandlingEventServiceEndpointImpl">
     <property name="handlingEventService" ref="handlingEventService"/>
   </bean>
 
+
+  <!-- Booking service facade -->
+
+  
+  <!-- Hibernate interceptor -->
+  <bean id="hibernateInterceptor" class="org.springframework.orm.hibernate3.HibernateInterceptor">
+    <property name="sessionFactory" ref="sessionFactory"/>
+  </bean>
+
+  <!-- Facade wrapped with Hibernate interceptor -->
+  <bean id="bookingServiceFacade" class="org.springframework.aop.framework.ProxyFactoryBean">
+    <property name="interceptorNames">
+      <list>
+        <value>hibernateInterceptor</value>
+      </list>
+    </property>
+    <property name="target">
+      <bean class="se.citerus.dddsample.service.BookingServiceFacadeImpl">
+        <property name="bookingService" ref="bookingService"/>
+        <property name="cargoRepository" ref="cargoRepository"/>
+        <property name="locationRepository" ref="locationRepository"/>
+        <property name="carrierMovementRepository" ref="carrierMovementRepository"/>
+      </bean>
+    </property>
+  </bean>
+
+  <!-- Wrap all methods with Hibernate interceptor
+  TODO: add necessary aspectj deps and replace config above with this
+  
+  <bean id="bookingServiceFacade" class="se.citerus.dddsample.service.BookingServiceFacadeImpl">
+    <property name="bookingService" ref="bookingService"/>
+    <property name="cargoRepository" ref="cargoRepository"/>
+    <property name="locationRepository" ref="locationRepository"/>
+    <property name="carrierMovementRepository" ref="carrierMovementRepository"/>
+  </bean>
+
+  <aop:config>
+    <aop:advisor advice-ref="hibernateInterceptor"
+                 pointcut="execution (* se.citerus.dddsample.service.BookingServiceFacadeImpl(..))"/>
+  </aop:config>
+  -->
+
+  <!-- RMI exposure -->
+  <bean id="rmiBookingServiceFacade" class="org.springframework.remoting.rmi.RmiServiceExporter">
+    <property name="serviceInterface" value="se.citerus.dddsample.service.BookingServiceFacade"/>
+    <property name="service" ref="bookingServiceFacade"/>
+    <property name="serviceName" value="BookingService"/>
+  </bean>
+
 </beans>

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

@@ -12,6 +12,7 @@
   <bean id="bookingService" class="se.citerus.dddsample.service.BookingServiceImpl">
     <property name="cargoRepository" ref="cargoRepository"/>
     <property name="locationRepository" ref="locationRepository"/>
+    <property name="routingService" ref="routingService"/>
   </bean>
 
   <bean id="trackingService" class="se.citerus.dddsample.service.TrackingServiceImpl">

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

@@ -23,10 +23,7 @@
   <bean id="trackCommandValidator" class="se.citerus.dddsample.web.command.TrackCommandValidator"/>
 
   <bean name="/admin/*" class="se.citerus.dddsample.web.CargoAdminController">
-    <property name="routingService" ref="routingService"/>
-    <property name="bookingService" ref="bookingService"/>
-    <property name="carrierMovementRepository" ref="carrierMovementRepository"/>
-    <property name="locationRepository" ref="locationRepository"/>
+    <property name="bookingServiceFacade" ref="bookingServiceFacade"/>
   </bean>
 
 </beans>