Added CSV file upload directory scanning and parsing for registering handling events, and introduced the HandlingReport concept for the web service to receive. It's all a bit sketchy atm.

dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/HandlingEventServiceEndpoint.java

@@ -1,25 +0,0 @@
-package se.citerus.dddsample.interfaces.handling;
-
-import javax.jws.WebService;
-
-/**
- * Web service endpoint for handling event registration.
- */
-@WebService
-public interface HandlingEventServiceEndpoint {
-
-  /**
-   * Register an cargo handling event.
-   *
-   * @param completionTime    time when event occured, for example a the loading of cargo was completed
-   * @param trackingId        tracking id of the cargo
-   * @param carrierMovementId carrier movement id, if applicable
-   * @param unlocode          United Nations Location Code for the location where the event occured
-   * @param eventType         type of event
-   */
-  void register(String completionTime, String trackingId, String carrierMovementId, String unlocode, String eventType) throws RegistrationFailure;
-
-  // TODO structured class that holds these fields, and/or a batching method that accepts a list of those
-  // TODO contract-first instead of code-first (?)
-  
-}

dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/RegistrationFailure.java

@@ -6,7 +6,7 @@ import java.util.List;
 public class RegistrationFailure extends Exception {
   private final String[] errors;
 
-  RegistrationFailure(final List<String> errors) {
+  public RegistrationFailure(final List<String> errors) {
     this.errors = errors.toArray(new String[errors.size()]);
   }
 

dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/HandlingEventServiceEndpointImpl.java → dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/RegistrationParser.java

@@ -1,108 +1,99 @@
-package se.citerus.dddsample.interfaces.handling;
-
-import org.apache.commons.lang.StringUtils;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-import se.citerus.dddsample.application.HandlingEventRegistrationAttempt;
-import se.citerus.dddsample.application.SystemEvents;
-import se.citerus.dddsample.domain.model.cargo.TrackingId;
-import se.citerus.dddsample.domain.model.carrier.VoyageNumber;
-import se.citerus.dddsample.domain.model.handling.HandlingEvent;
-import se.citerus.dddsample.domain.model.location.UnLocode;
-
-import javax.jws.WebService;
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Date;
-import java.util.List;
-
-/**
- * This web service endpoint implementation performs basic validation and parsing
- * of incoming data, and in case of a valid registration attempt, sends an asynchronous message
- * with the informtion to the handling event registration system for proper registration.
- *  
- */
-@WebService(endpointInterface = "se.citerus.dddsample.interfaces.handling.HandlingEventServiceEndpoint")
-public class HandlingEventServiceEndpointImpl implements HandlingEventServiceEndpoint {
-
-  private SystemEvents systemEvents;
-  private static final Log logger = LogFactory.getLog(HandlingEventServiceEndpointImpl.class);
-  
-  public static final String ISO_8601_FORMAT = "yyyy-mm-dd HH:MM:SS.SSS";
-
-  public void register(final String completionTime, final String trackingId, final String voyageNumberString,
-                       final String unlocode, final String eventType) throws RegistrationFailure {
-    final List<String> errors = new ArrayList<String>();
-
-    final Date date = parseDate(completionTime, errors);
-    final TrackingId tid = parseTrackingId(trackingId, errors);
-    final VoyageNumber voyageNumber = parseVoyageNumber(voyageNumberString, errors);
-    final HandlingEvent.Type type = parseEventType(eventType, errors);
-    final UnLocode ul = parseUnLocode(unlocode, errors);
-
-    if (errors.isEmpty()) {
-      final HandlingEventRegistrationAttempt attempt = new HandlingEventRegistrationAttempt(new Date(), date, tid, voyageNumber, type, ul);
-      systemEvents.receivedHandlingEventRegistrationAttempt(attempt);
-    } else {
-      logger.warn("Handling event registration attempt failed: " + errors);
-      throw new RegistrationFailure(errors);
-    }
-  }
-
-  private UnLocode parseUnLocode(final String unlocode, final List<String> errors) {
-    try {
-      return new UnLocode(unlocode);
-    } catch (IllegalArgumentException e) {
-      errors.add(e.getMessage());
-      return null;
-    }
-  }
-
-  private TrackingId parseTrackingId(final String trackingId, final List<String> errors) {
-    try {
-      return new TrackingId(trackingId);
-    } catch (IllegalArgumentException e) {
-      errors.add(e.getMessage());
-      return null;
-    }
-  }
-
-  private VoyageNumber parseVoyageNumber(final String voyageNumber, final List<String> errors) {
-    if (StringUtils.isNotEmpty(voyageNumber)) {
-      try {
-        return new VoyageNumber(voyageNumber);
-      } catch (IllegalArgumentException e) {
-        errors.add(e.getMessage());
-        return null;
-      }
-    } else {
-      return null;
-    }
-  }
-
-  private Date parseDate(final String completionTime, final List<String> errors) {
-    Date date;
-    try {
-      date = new SimpleDateFormat(ISO_8601_FORMAT).parse(completionTime);
-    } catch (ParseException e) {
-      errors.add("Invalid date format: " + completionTime + ", must be on ISO 8601 format: " + ISO_8601_FORMAT);
-      date = null;
-    }
-    return date;
-  }
-
-  private HandlingEvent.Type parseEventType(final String eventType, final List<String> errors) {
-    try {
-      return HandlingEvent.Type.valueOf(eventType);
-    } catch (IllegalArgumentException e) {
-      errors.add(eventType + " is not a valid handling event type. Valid types are: " + Arrays.toString(HandlingEvent.Type.values()));
-      return null;      
-    }
-  }
-
-  public void setSystemEvents(SystemEvents systemEvents) {
-    this.systemEvents = systemEvents;
-  }
-}
+package se.citerus.dddsample.interfaces.handling;
+
+import org.apache.commons.lang.StringUtils;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import se.citerus.dddsample.application.HandlingEventRegistrationAttempt;
+import se.citerus.dddsample.application.SystemEvents;
+import se.citerus.dddsample.domain.model.cargo.TrackingId;
+import se.citerus.dddsample.domain.model.carrier.VoyageNumber;
+import se.citerus.dddsample.domain.model.handling.HandlingEvent;
+import se.citerus.dddsample.domain.model.location.UnLocode;
+import se.citerus.dddsample.interfaces.handling.ws.HandlingReportServiceImpl;
+
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Date;
+import java.util.List;
+
+public class RegistrationParser {
+
+  private SystemEvents systemEvents;
+  
+  private static final Log logger = LogFactory.getLog(RegistrationParser.class);
+
+  public void convertAndSend(String completionTime, String trackingId, String voyageNumberString, String unlocode, String eventType) throws RegistrationFailure {
+    final List<String> errors = new ArrayList<String>();
+
+    final Date date = parseDate(completionTime, errors);
+    final TrackingId tid = parseTrackingId(trackingId, errors);
+    final VoyageNumber voyageNumber = parseVoyageNumber(voyageNumberString, errors);
+    final HandlingEvent.Type type = parseEventType(eventType, errors);
+    final UnLocode ul = parseUnLocode(unlocode, errors);
+
+    if (errors.isEmpty()) {
+      final HandlingEventRegistrationAttempt attempt = new HandlingEventRegistrationAttempt(new Date(), date, tid, voyageNumber, type, ul);
+      systemEvents.receivedHandlingEventRegistrationAttempt(attempt);
+    } else {
+      logger.warn("Handling event registration attempt failed: " + errors);
+      throw new RegistrationFailure(errors);
+    }
+  }
+
+  private UnLocode parseUnLocode(final String unlocode, final List<String> errors) {
+    try {
+      return new UnLocode(unlocode);
+    } catch (IllegalArgumentException e) {
+      errors.add(e.getMessage());
+      return null;
+    }
+  }
+
+  private TrackingId parseTrackingId(final String trackingId, final List<String> errors) {
+    try {
+      return new TrackingId(trackingId);
+    } catch (IllegalArgumentException e) {
+      errors.add(e.getMessage());
+      return null;
+    }
+  }
+
+  private VoyageNumber parseVoyageNumber(final String voyageNumber, final List<String> errors) {
+    if (StringUtils.isNotEmpty(voyageNumber)) {
+      try {
+        return new VoyageNumber(voyageNumber);
+      } catch (IllegalArgumentException e) {
+        errors.add(e.getMessage());
+        return null;
+      }
+    } else {
+      return null;
+    }
+  }
+
+  private Date parseDate(final String completionTime, final List<String> errors) {
+    Date date;
+    try {
+      date = new SimpleDateFormat(HandlingReportServiceImpl.ISO_8601_FORMAT).parse(completionTime);
+    } catch (ParseException e) {
+      errors.add("Invalid date format: " + completionTime + ", must be on ISO 8601 format: " + HandlingReportServiceImpl.ISO_8601_FORMAT);
+      date = null;
+    }
+    return date;
+  }
+
+  private HandlingEvent.Type parseEventType(final String eventType, final List<String> errors) {
+    try {
+      return HandlingEvent.Type.valueOf(eventType);
+    } catch (IllegalArgumentException e) {
+      errors.add(eventType + " is not a valid handling event type. Valid types are: " + Arrays.toString(HandlingEvent.Type.values()));
+      return null;
+    }
+  }
+
+  public void setSystemEvents(SystemEvents systemEvents) {
+    this.systemEvents = systemEvents;
+  }
+}

dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/file/PartialRegistrationFailureException.java

@@ -0,0 +1,17 @@
+package se.citerus.dddsample.interfaces.handling.file;
+
+import java.util.List;
+
+public class PartialRegistrationFailureException extends Exception {
+
+  private final List<String> rejectedLines;
+
+  public PartialRegistrationFailureException(List<String> rejectedLines) {
+    this.rejectedLines = rejectedLines;
+  }
+
+  public List<String> getRejectedLines() {
+    return rejectedLines;
+  }
+  
+}

dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/file/UploadDirectoryScanner.java

@@ -0,0 +1,125 @@
+package se.citerus.dddsample.interfaces.handling.file;
+
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.springframework.beans.factory.InitializingBean;
+import se.citerus.dddsample.interfaces.handling.RegistrationFailure;
+import se.citerus.dddsample.interfaces.handling.RegistrationParser;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.TimerTask;
+
+/**
+ * Periodically scans a certain directory for files and attempts
+ * to parse handling event registrations from the contents.
+ *
+ * Files that fail to parse are moved into a separate directory,
+ * succesful files are deleted.
+ */
+public class UploadDirectoryScanner extends TimerTask implements InitializingBean {
+
+  private File uploadDirectory;
+  private File parseFailureDirectory;
+  private RegistrationParser registrationParser;
+
+  private final static Log logger = LogFactory.getLog(UploadDirectoryScanner.class);
+
+  @Override
+  public void run() {
+    for (File file : uploadDirectory.listFiles()) {
+      try {
+        parse(file);
+        delete(file);
+        logger.info("Import of " + file.getName() + " complete");
+      } catch (Exception e) {
+        logger.error(e, e);
+        move(file);
+      }
+    }
+  }
+
+  private void parse(final File file) throws IOException, RegistrationFailure {
+    final List<String> lines = FileUtils.readLines(file);
+    final List<String> rejectedLines = new ArrayList<String>();
+    for (String line : lines) {
+      try {
+        parseLine(line);
+      } catch (Exception e) {
+        logger.error("Rejected line '" + line + "'. Reason is: " + e, e);
+        rejectedLines.add(line);
+      }
+    }
+    if (!rejectedLines.isEmpty()) {
+      writeRejectedLinesToFile(toRejectedFilename(file), rejectedLines);
+    }
+  }
+
+  private String toRejectedFilename(File file) {
+    return file.getName() + ".reject";
+  }
+
+  private void writeRejectedLinesToFile(String filename, List<String> rejectedLines) throws IOException {
+    FileUtils.writeLines(
+        new File(parseFailureDirectory, filename), rejectedLines
+    );
+  }
+
+  private void parseLine(final String line) throws RegistrationFailure {
+    final String[] columns = line.split("\t");
+    if (columns.length == 5) {
+      registrationParser.convertAndSend(
+        columns[0],
+        columns[1],
+        columns[2],
+        columns[3],
+        columns[4]
+      );
+    } else if (columns.length == 4) {
+      registrationParser.convertAndSend(
+        columns[0],
+        columns[1],
+        "",
+        columns[2],
+        columns[3]
+      );
+    } else {
+      throw new IllegalArgumentException("Format error on line: " + line);
+    }
+  }
+
+  private void delete(File file) {
+    if (!file.delete()) {
+      logger.error("Could not delete " + file.getName());  
+    }
+  }
+
+  private void move(File file) {
+    final File destination = new File(parseFailureDirectory, file.getName());
+    final boolean result = file.renameTo(destination);
+    if (!result) {
+      logger.error("Could not move " + file.getName() + " to " + destination.getAbsolutePath());
+    }
+  }
+
+  public void setUploadDirectory(File uploadDirectory) {
+    this.uploadDirectory = uploadDirectory;
+  }
+
+  public void setParseFailureDirectory(File parseFailureDirectory) {
+    this.parseFailureDirectory = parseFailureDirectory;
+  }
+
+  public void setRegistrationParser(RegistrationParser registrationParser) {
+    this.registrationParser = registrationParser;
+  }
+
+  public void afterPropertiesSet() throws Exception {
+    if (uploadDirectory.equals(parseFailureDirectory)) {
+      throw new Exception("Upload and parse failed directories must not be the same directory: " + uploadDirectory);
+    }
+  }
+}

dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/ws/HandlingReport.java

@@ -0,0 +1,91 @@
+package se.citerus.dddsample.interfaces.handling.ws;
+
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlSchemaType;
+import javax.xml.datatype.XMLGregorianCalendar;
+
+/**
+ * Data type for registering handling events
+ * using the web service api. Focus here is interoperability
+ * and maintaining a stable api, and possibly things like
+ * backwards compatibility with a system that's being replaced,
+ * or adhering to an industry standard.
+ *
+ * We do not want this to constrain our modeling in any way.
+ * 
+ */
+public class HandlingReport {
+
+  @XmlElement(required = true)
+  private String[] trackingIds;
+
+  @XmlElement(required = true)
+  private String unLocode;
+
+  @XmlElement(required = false)
+  private String voyageNumber;
+
+  @XmlSchemaType(name="dateTime")
+  @XmlElement(required = true)
+  private XMLGregorianCalendar completionTime;
+
+  @XmlElement(required = true)
+  private String type;
+
+  /**
+   * @return tracking ids of cargos that have been handled (the same way)
+   */
+  public String[] getTrackingIds() {
+    return trackingIds;
+  }
+
+  public void setTrackingIds(String[] trackingIds) {
+    this.trackingIds = trackingIds;
+  }
+
+  /**
+   * @return United Nations Location Code for the location where the event occured
+   */
+  public String getUnLocode() {
+    return unLocode;
+  }
+
+  public void setUnLocode(String unLocode) {
+    this.unLocode = unLocode;
+  }
+
+  /**
+   * Not all events are associated with a voyage (customs handling etc).
+   * 
+   * @return voyage number, if applicable
+   */
+  public String getVoyageNumber() {
+    return voyageNumber;
+  }
+
+  public void setVoyageNumber(String voyageNumber) {
+    this.voyageNumber = voyageNumber;
+  }
+
+  /**
+   * @return time when event occured, for example a the loading of cargo was completed
+   */
+  public XMLGregorianCalendar getCompletionTime() {
+    return completionTime;
+  }
+
+  public void setCompletionTime(XMLGregorianCalendar completionTime) {
+    this.completionTime = completionTime;
+  }
+
+  /**
+   * @return type of event
+   */
+  public String getType() {
+    return type;
+  }
+
+  public void setType(String type) {
+    this.type = type;
+  }
+}

dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/ws/HandlingReportService.java

@@ -0,0 +1,21 @@
+package se.citerus.dddsample.interfaces.handling.ws;
+
+import se.citerus.dddsample.interfaces.handling.RegistrationFailure;
+
+import javax.jws.WebService;
+
+/**
+ * Web service endpoint for handling event registration.
+ */
+@WebService
+public interface HandlingReportService {
+
+  /**
+   * Submits a report of handled cargos.
+   *
+   * @param handlingReport
+   * @throws se.citerus.dddsample.interfaces.handling.RegistrationFailure
+   */
+  void submitReport(HandlingReport handlingReport) throws RegistrationFailure;
+
+}

dddsample/src/main/java/se/citerus/dddsample/interfaces/handling/ws/HandlingReportServiceImpl.java

@@ -0,0 +1,39 @@
+package se.citerus.dddsample.interfaces.handling.ws;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import se.citerus.dddsample.interfaces.handling.RegistrationFailure;
+import se.citerus.dddsample.interfaces.handling.RegistrationParser;
+
+import javax.jws.WebService;
+import java.util.Date;
+
+/**
+ * This web service endpoint implementation performs basic validation and parsing
+ * of incoming data, and in case of a valid registration attempt, sends an asynchronous message
+ * with the informtion to the handling event registration system for proper registration.
+ *  
+ */
+@WebService(endpointInterface = "se.citerus.dddsample.interfaces.handling.ws.HandlingReportService")
+public class HandlingReportServiceImpl implements HandlingReportService {
+
+  private RegistrationParser registrationParser;
+  private static final Log logger = LogFactory.getLog(HandlingReportServiceImpl.class);
+  
+  public static final String ISO_8601_FORMAT = "yyyy-mm-dd HH:MM:SS.SSS";
+
+  @Override
+  public void submitReport(HandlingReport handlingReport) throws RegistrationFailure {
+    Date date = handlingReport.getCompletionTime().toGregorianCalendar().getTime();
+    for (String trackingId : handlingReport.getTrackingIds()) {
+      registrationParser.convertAndSend(
+        "", trackingId, handlingReport.getVoyageNumber(), handlingReport.getUnLocode(), handlingReport.getType()
+      );
+    }
+  }
+
+  public void setRegistrationParser(RegistrationParser registrationParser) {
+    this.registrationParser = registrationParser;
+  }
+
+}

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

@@ -10,7 +10,7 @@
         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">
@@ -21,12 +21,39 @@
     </wss:bindings>
   </wss:bindings>
 
-  <bean id="handlingEventServiceEndpoint" class="se.citerus.dddsample.interfaces.handling.HandlingEventServiceEndpointImpl">
+  <bean id="handlingEventServiceEndpoint" class="se.citerus.dddsample.interfaces.handling.ws.HandlingReportServiceImpl">
+    <property name="registrationParser" ref="registrationParser"/>
+  </bean>
+
+  <!-- File upload directory scanner -->
+
+  <bean id="scheduledTask" class="org.springframework.scheduling.timer.ScheduledTimerTask">
+    <property name="period" value="5000"/>
+    <property name="delay" value="3000"/>
+    <property name="timerTask" ref="uploadDirectoryScanner"/>
+  </bean>
+
+  <bean id="uploadDirectoryScanner" class="se.citerus.dddsample.interfaces.handling.file.UploadDirectoryScanner">
+    <property name="uploadDirectory" value="/tmp/upload"/>
+    <property name="parseFailureDirectory" value="/tmp/failed"/>
+    <property name="registrationParser" ref="registrationParser"/>
+  </bean>
+
+  <bean id="registrationParser" class="se.citerus.dddsample.interfaces.handling.RegistrationParser">
     <property name="systemEvents" ref="systemEvents"/>
   </bean>
 
-  <!-- RMI exposed booking service facade -->
+
+  <bean id="timerFactory" class="org.springframework.scheduling.timer.TimerFactoryBean">
+    <property name="scheduledTimerTasks">
+      <list>
+        <ref bean="scheduledTask"/>
+      </list>
+    </property>
+  </bean>
   
+  <!-- RMI exposed booking service facade -->
+
   <bean id="rmiBookingServiceFacade" class="org.springframework.remoting.rmi.RmiServiceExporter">
     <property name="serviceInterface" value="se.citerus.dddsample.interfaces.booking.facade.BookingServiceFacade"/>
     <property name="service" ref="bookingServiceFacade"/>