Changeset 3976

Timestamp:

03/06/08 14:00:00 (12 years ago)

Author:

cbyrom

Message:

Improve error handling, work flow and logging + move constant strings
into static constants to allow reference elsewhere - e.g. by testcases
+ fix daterange checking.

Location:

TI01-discovery/branches/ws-Discovery2-upgrade/src/ndg/services/discovery

Files:

• DiscoveryServiceSkeleton.java (modified) (12 diffs)
• PostgresDBClient.java (modified) (1 diff)

TI01-discovery/branches/ws-Discovery2-upgrade/src/ndg/services/discovery/DiscoveryServiceSkeleton.java

@@ -16 +16 @@
   * @author Matt Pritchard
 */
-public class DiscoveryServiceSkeleton{
-
+public class DiscoveryServiceSkeleton
+{
         // Obtain a suitable logger.
     private static Logger logger = Logger.getLogger(DiscoveryServiceSkeleton.class.getName());
@@ -33 +33 @@
         
         public static final String DELIMITER = "-------------------------------------";
+
+        public static final String ORIGINAL_FORMAT = "original";
+        public static final String DC_FORMAT = "DC";
+        public static final String DIF_FORMAT = "DIF";
+        public static final String MDIP_FORMAT = "MDIP";
+        public static final String ISO19115_FORMAT = "ISO19115";
+        
+        // to_tsvector ignores the '_' character; as a work around replace this with the following string
+        // - primarily for use in the scope field
+        public static final String UNDERSCORE_REPLACEMENT = "UNDERSCORE";
+
+        public static final String INVALID_LIST_NAME_MESSAGE = 
+                "Invalid list name: please use getListNames to get the valid list names";
+        
+        /**
+         * Helper method for checking validity of a format
+         * @param format
+         * @return true if format if valid, false otherwise
+         */
+        public static boolean isValidFormat(String format)
+        {
+                String[] allFormats = {ORIGINAL_FORMAT, DC_FORMAT, DIF_FORMAT, MDIP_FORMAT, ISO19115_FORMAT};
+                for (int i = 0; i < allFormats.length; i++)
+                {
+                        if (allFormats[i].equals(format))
+                                return true;
+                }
+                return false;
+        }
         /**
          * Performs the doFullTextSearch operation 
@@ -65 +94 @@
                 catch (Exception e)
                 {
-                        String errorMessage = "Unable to retrieve result - reason : " + e.toString(); 
+                        String errorMessage = "Unable to retrieve result - reason : " + e.getMessage(); 
                         logger.severe(errorMessage);
                         responseContent.setStatus( false );
                         responseContent.setStatusMessage(errorMessage);
+                        return response;
                 }
 
@@ -203 +233 @@
                 }
 
-                if ( requestContent.isSetDateRange() )
+                // Generated code is a little ropey atm; if a start date is not defined, this date range is automatically
+                // not set - however if it is it will be - i.e. the end date is not consulted when setting up this object
+                // - this makes it currently impossible to recognise the case where a start date is null and the end date
+                // is set
+                // - NB, would be better to tighten up WSDL definition so that you can/cannot set things up wrongly
+                if (requestContent.isSetDateRange())
                 {
                         logger.info("Adding temporal range");
-                        agent.setDateRangeStart( requestContent.getDateRange().getDateRangeStart() );
-                        agent.setDateRangeEnd( requestContent.getDateRange().getDateRangeEnd() );
-                }
+                        // NB, need to check that both end and start dates are set; if these are accessed via the daterange object
+                        // and are nulls, an exception is thrown
+                        try
+                        {
+                                agent.setDateRangeStart( requestContent.getDateRange().getDateRangeStart() );
+                                agent.setDateRangeEnd( requestContent.getDateRange().getDateRangeEnd() );
+                        }
+                        catch (Exception e) 
+                        {
+                                String errorMessage = "Invalid time range specified - detail: " + e.getMessage(); 
+                                logger.warning(errorMessage);
+                                throw new DiscoveryWSException(errorMessage);
+                        }
+                }
+                
                 logger.info("Search agent ready for searching");
                 return agent;
@@ -218 +265 @@
          * @param discoveryserviceapi.DoPresentDocument containing search request
          * @return discoveryserviceapi.DoPresentReturnDocument containing search result
+         * @throws DiscoveryWSException 
          */
          public  discoveryserviceapi.DoPresentReturnDocument doPresent
-                 (discoveryserviceapi.DoPresentDocument request )
+                 (discoveryserviceapi.DoPresentDocument request ) throws DiscoveryWSException
         {
-                 logger.info("doPresent() invoked");
-                discoveryserviceapi.DoPresentReturnDocument response = discoveryserviceapi.DoPresentReturnDocument.Factory.newInstance();
+                logger.info(DELIMITER);
+                logger.info("doPresent() invoked");
+                logger.info(DELIMITER);
+                
+                discoveryserviceapi.DoPresentReturnDocument response = 
+                        discoveryserviceapi.DoPresentReturnDocument.Factory.newInstance();
                 discoveryserviceapi.PresentReturnType responseContent = response.addNewDoPresentReturn();
 
@@ -239 +291 @@
                 discoveryserviceapi.DocumentsType documents = requestContent.getDocuments();
                 String[] documentsString = documents.getDocumentArray();
-                System.out.println("Building list of " + documentsString.length + " documents for present");
-                Vector documentsVector = new Vector();
+                logger.info("Building list of " + documentsString.length + " documents for present");
+                Vector<String> documentsVector = new Vector<String>();
                 for (int i=0; i<documentsString.length; i++ )
                 {
-                        documentsVector.add( documentsString[i] );
+                        documentsVector.add(documentsString[i]);
                 }
                 agent.setDocumentNames( documentsVector );
@@ -249 +301 @@
                 try
                 {
+                        logger.info("Running doPresent() to retrieve documents");
                         PresentSummary summary = agent.doPresent();
                         responseContent.setStatus( summary.getStatus() );
                         responseContent.setStatusMessage( summary.getStatusMessage() );
-                        if ( summary.getStatus() )
-                        {
+                        // NB, if no results are returned, the status is false
+                        if (summary.getStatus())
+                        {
+                                logger.info("doPresent completed successfully - preparing results for return");
                                 Vector resultDocuments = summary.getDocuments();
                                 Iterator it = resultDocuments.iterator();
@@ -261 +316 @@
                                         returnDocuments.addDocument( (String)it.next() );
                                 }
-                                
                         }
                 }
@@ -268 +322 @@
                         responseContent.setStatusMessage("Error creating doPresentReturnDocument : " + e.toString() );
                 }
-                logger.info("doPresent() completed successfully");
+                logger.info("doPresent() completed - returning response");
 
                 return response;
@@ -298 +352 @@
          * @param discoveryserviceapi.GetListDocument containing request
          * @return discoveryserviceapi.GetListReturnDocument containing result
+     * @throws DiscoveryWSException 
          */
          public  discoveryserviceapi.GetListReturnDocument getList
-                 (discoveryserviceapi.GetListDocument request )
+                 (discoveryserviceapi.GetListDocument request ) throws DiscoveryWSException
         {
                  logger.info("getList() invoked");
@@ -314 +369 @@
                 if ( listName.equals("presentFormatList") )
                 {
-                        list.addListMember("original");
-                        list.addListMember("DC");
-                        list.addListMember("DIF");
-                        list.addListMember("MDIP");
-                        list.addListMember("ISO19115");
+                        list.addListMember(ORIGINAL_FORMAT);
+                        list.addListMember(DC_FORMAT);
+                        list.addListMember(DIF_FORMAT);
+                        list.addListMember(MDIP_FORMAT);
+                        list.addListMember(ISO19115_FORMAT);
                         //list.addListMember("moles");
                 }
@@ -347 +402 @@
                 else 
                 {
-                        String errorMessage = "Invalid list name: please use getListNames to get the valid list names";
-                        logger.warning(errorMessage);
-                        throw new UnsupportedOperationException(errorMessage);
+                        logger.warning(INVALID_LIST_NAME_MESSAGE);
+                        throw new DiscoveryWSException(INVALID_LIST_NAME_MESSAGE);
                 }
                 

TI01-discovery/branches/ws-Discovery2-upgrade/src/ndg/services/discovery/PostgresDBClient.java

@@ -159 +159 @@
         private void handleSQLException(SQLException e) throws DiscoveryDBException 
         {
-        String errorMessage = 
-                "SQLException thrown whilst interacting with postgres DB - detail: " + 
-                e.getLocalizedMessage();
-        logger.severe(errorMessage);
-        throw new DiscoveryDBException(errorMessage);
+        throw new DiscoveryDBException("SQLException thrown whilst interacting with postgres DB - detail: " + 
+                        e.getLocalizedMessage());
         }