WSTester updated to work plus hopefully all the other changes that need to go into...
[jabaws.git] / webservices / compbio / ws / client / Jws2Client.java
index c18f100..ae38d9f 100644 (file)
@@ -1,6 +1,6 @@
-/* Copyright (c) 2009 Peter Troshin\r
+/* Copyright (c) 2011 Peter Troshin\r
  *  \r
- *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 1.0     \r
+ *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.0     \r
  * \r
  *  This library is free software; you can redistribute it and/or modify it under the terms of the\r
  *  Apache License version 2 as published by the Apache Software Foundation\r
@@ -28,9 +28,11 @@ import java.io.FileInputStream;
 import java.io.IOException;\r
 import java.io.PrintWriter;\r
 import java.io.Writer;\r
+import java.net.ConnectException;\r
 import java.net.MalformedURLException;\r
 import java.net.URL;\r
 import java.util.Arrays;\r
+import java.util.Collections;\r
 import java.util.List;\r
 import java.util.Set;\r
 import java.util.logging.Level;\r
@@ -41,6 +43,7 @@ import javax.xml.ws.Service;
 import javax.xml.ws.WebServiceException;\r
 \r
 import compbio.data.msa.JABAService;\r
+import compbio.data.msa.FoldWS;\r
 import compbio.data.msa.Metadata;\r
 import compbio.data.msa.MsaWS;\r
 import compbio.data.msa.RegistryWS;\r
@@ -48,6 +51,7 @@ import compbio.data.msa.SequenceAnnotation;
 import compbio.data.sequence.Alignment;\r
 import compbio.data.sequence.FastaSequence;\r
 import compbio.data.sequence.ScoreManager;\r
+import compbio.data.sequence.ClustalAlignmentUtil;\r
 import compbio.data.sequence.SequenceUtil;\r
 import compbio.data.sequence.UnknownFileFormatException;\r
 import compbio.metadata.JobSubmissionException;\r
@@ -55,6 +59,7 @@ import compbio.metadata.Option;
 import compbio.metadata.Preset;\r
 import compbio.metadata.ResultNotAvailableException;\r
 import compbio.metadata.WrongParameterException;\r
+import compbio.util.FileUtil;\r
 \r
 /**\r
  * A command line client for JAva Bioinformatics Analysis Web Services\r
@@ -71,12 +76,6 @@ public class Jws2Client {
        private static final Logger log = Logger.getLogger(Jws2Client.class\r
                        .getCanonicalName());\r
 \r
-       // JABAWS version 1.0 service name\r
-       static final String QUALIFIED_SERVICE_NAME = "http://msa.data.compbio/01/01/2010/";\r
-\r
-       // JABAWS version 2.0 service name\r
-       static final String V2_QUALIFIED_SERVICE_NAME = "http://msa.data.compbio/01/12/2010/";\r
-\r
        /**\r
         * Attempt to construct the URL object from the string\r
         * \r
@@ -106,6 +105,7 @@ public class Jws2Client {
         * @throws IOException\r
         */\r
        <T> Jws2Client(String[] cmd) throws IOException {\r
+               \r
 \r
                String hostname = CmdHelper.getHost(cmd);\r
                if (hostname == null) {\r
@@ -139,7 +139,7 @@ public class Jws2Client {
                // Test service and quit\r
                boolean testService = CmdHelper.testService(cmd);\r
                if (testService) {\r
-                       testService(hostname, service);\r
+                       testService(hostname, service, new PrintWriter(System.out, true));\r
                        System.exit(0);\r
                }\r
 \r
@@ -159,6 +159,8 @@ public class Jws2Client {
                        customOptions = MetadataHelper.processParameters(prms,\r
                                        msaws.getRunnerOptions());\r
                }\r
+//             System.out.println("The Options read from the command line: " + customOptions);\r
+               \r
                Alignment alignment = null;\r
                if (inputFile != null) {\r
                        Writer writer = null;\r
@@ -173,8 +175,11 @@ public class Jws2Client {
                                ScoreManager result = analize(inputFile,\r
                                                ((SequenceAnnotation<T>) msaws), preset, customOptions);\r
 \r
+                               // A System.out.println just for testing!\r
+                               System.out.println(result.toString());\r
+                               \r
                                IOHelper.writeOut(writer, result);\r
-                       } else {\r
+                       } else if (service.getServiceType() == MsaWS.class) {\r
                                alignment = align(inputFile, (MsaWS<T>) msaws, preset,\r
                                                customOptions);\r
                                IOHelper.writeOut(writer, alignment);\r
@@ -199,24 +204,44 @@ public class Jws2Client {
                log.fine("Disconnected successfully!");\r
        }\r
 \r
-       private void testService(String hostname, Services service)\r
-                       throws IOException {\r
+       /**\r
+        * Asks registry to test the service on the host hostname\r
+        * \r
+        * @param hostname\r
+        * @param service\r
+        * @param writer\r
+        * @throws ConnectException\r
+        * @throws WebServiceException\r
+        */\r
+       public static void testService(String hostname, Services service,\r
+                       PrintWriter writer) throws ConnectException, WebServiceException {\r
                RegistryWS registry = connectToRegistry(hostname);\r
                if (registry != null) {\r
                        String message = registry.testService(service);\r
-                       System.out.println("Service " + service + " testing results: ");\r
-                       System.out.println(message);\r
-                       ((Closeable) registry).close();\r
+                       writer.println("Service " + service + " testing results: ");\r
+                       writer.println(message);\r
+                       FileUtil.closeSilently(((Closeable) registry));\r
                }\r
+               writer.flush();\r
        }\r
 \r
-       private void listServices(String hostname) throws IOException {\r
+       public static Set<Services> getServices(String hostname)\r
+                       throws WebServiceException, ConnectException {\r
                RegistryWS registry = connectToRegistry(hostname);\r
+               Set<Services> services = Collections.EMPTY_SET;\r
                if (registry != null) {\r
-                       Set<Services> services = registry.getSupportedServices();\r
+                       services = registry.getSupportedServices();\r
+                       FileUtil.closeSilently(((Closeable) registry));\r
+               }\r
+               return services;\r
+       }\r
+\r
+       private static void listServices(String hostname)\r
+                       throws WebServiceException, IOException {\r
+               Set<Services> services = Jws2Client.getServices(hostname);\r
+               if (!services.isEmpty()) {\r
                        System.out.println("Supported services are: "\r
                                        + Services.toString(services));\r
-                       ((Closeable) registry).close();\r
                } else {\r
                        System.out.println("Failed to connect to the registry! ");\r
                }\r
@@ -320,17 +345,22 @@ public class Jws2Client {
                return analize(fastalist, wsproxy, preset, customOptions);\r
        }\r
        /**\r
-        * Connects to a web service by the host and the service name\r
+        * Connects to a web service by the host and the service name web service\r
+        * type\r
         * \r
-        * @param T\r
-        *            web service type\r
         * @param host\r
+        *            the fully qualified name of JABAWS server including JABAWS\r
+        *            context name e.g\r
+        *            http://nanna.cluster.lifesci.dundee.ac.uk:8080/jaba\r
         * @param service\r
-        * @return MsaWS<T>\r
+        *            the name of the JABAWS service to connect to\r
+        * @return JABAService<T>\r
         * @throws WebServiceException\r
+        * @throws ConnectException\r
+        *             if fails to connect to the service on the host\r
         */\r
        public static JABAService connect(String host, Services service)\r
-                       throws WebServiceException {\r
+                       throws WebServiceException, ConnectException {\r
                URL url = null;\r
                log.log(Level.FINE, "Attempting to connect...");\r
                try {\r
@@ -341,17 +371,17 @@ public class Jws2Client {
                }\r
                Service serv = null;\r
                try {\r
-                       serv = service.getService(url, QUALIFIED_SERVICE_NAME);\r
+                       serv = service.getService(url, JABAService.SERVICE_NAMESPACE);\r
                } catch (WebServiceException wse) {\r
                        System.out.println("Connecting to JABAWS version 2 service");\r
                        if (isV2service(wse)) {\r
-                               serv = service.getService(url, V2_QUALIFIED_SERVICE_NAME);\r
+                               serv = service\r
+                                               .getService(url, JABAService.V2_SERVICE_NAMESPACE);\r
                        }\r
                }\r
                if (serv == null) {\r
-                       System.err.println("Could not connect to " + url\r
+                       throw new ConnectException("Could not connect to " + url\r
                                        + " the server is down?");\r
-                       // FIXME\r
                }\r
                JABAService serviceIF = service.getInterface(serv);\r
                log.log(Level.INFO, "Connected successfully!");\r
@@ -363,15 +393,28 @@ public class Jws2Client {
                String message = wse.getMessage();\r
                int idx = message.indexOf("not a valid service");\r
                if (idx > 0) {\r
-                       if (message.substring(idx).contains(V2_QUALIFIED_SERVICE_NAME)) {\r
+                       if (message.substring(idx).contains(\r
+                                       JABAService.V2_SERVICE_NAMESPACE)) {\r
                                return true;\r
                        }\r
                }\r
                return false;\r
        }\r
 \r
+       /**\r
+        * Get a connection of JABAWS registry\r
+        * \r
+        * @param host\r
+        *            the fully qualified name of JABAWS server including JABAWS\r
+        *            context name e.g\r
+        *            http://nanna.cluster.lifesci.dundee.ac.uk:8080/jaba\r
+        * @return compbio.data.msa.RegistryWS - instance of a RegistryWS web\r
+        *         service\r
+        * @throws WebServiceException\r
+        * @throws ConnectException\r
+        */\r
        public static compbio.data.msa.RegistryWS connectToRegistry(String host)\r
-                       throws WebServiceException {\r
+                       throws WebServiceException, ConnectException {\r
                URL url = null;\r
                String service = "RegistryWS";\r
                log.log(Level.FINE, "Attempting to connect...");\r
@@ -382,11 +425,11 @@ public class Jws2Client {
                        e.printStackTrace();\r
                        // ignore as the host name is already verified\r
                }\r
-               QName qname = new QName(V2_QUALIFIED_SERVICE_NAME, service);\r
+               QName qname = new QName(JABAService.V2_SERVICE_NAMESPACE, service);\r
                Service serv = Service.create(url, qname);\r
 \r
                if (serv == null) {\r
-                       System.err.println("Could not connect to " + url\r
+                       throw new ConnectException("Could not connect to " + url\r
                                        + " the server is down?");\r
                }\r
 \r
@@ -471,7 +514,77 @@ public class Jws2Client {
                }\r
                return alignment;\r
        }\r
-\r
+       \r
+       /**\r
+        * Return RNA secondary structure from a file using FoldWS\r
+        * \r
+        * @param <T>\r
+        *            web service type e.g. Clustal\r
+        * @param file\r
+        *            to read the results from\r
+        * @param foldws\r
+        *            FoldWS required\r
+        * @param preset\r
+        *            Preset to use optional\r
+        * @param customOptions\r
+        *            file which contains new line separated list of options\r
+        * @return String\r
+        */\r
+       \r
+//     static <T> String fold(File file, FoldWS<T> foldws, Preset<T> preset,\r
+//                     List<Option<T>> customOptions) {\r
+//             FileInputStream instream = null;\r
+//             Alignment alignment = null;\r
+//             String rnastruct = null;\r
+//             try {\r
+//                     instream = new FileInputStream(file);\r
+//                     alignment = ClustalAlignmentUtil.readClustalFile(instream);\r
+//                     instream.close();\r
+//                     String jobId = null;\r
+//                     if (customOptions != null && preset != null) {\r
+//                             System.out.println("WARN: Parameters (-f) are defined together"\r
+//                                             + "with a preset (-r), ignoring preset! ");\r
+//                     }\r
+//                     if (customOptions != null) {\r
+//                             jobId = foldws.customFold(alignment, customOptions);\r
+//                     } else if (preset != null) {\r
+//                             jobId = foldws.presetFold(alignment, preset);\r
+//                     } else {\r
+//                             jobId = foldws.fold(alignment);\r
+//                     }\r
+//                     System.out.println("\n\ncalling fold.........");\r
+//                     Thread.sleep(1000);\r
+//                     rnastruct = foldws.getResult(jobId);\r
+//                             \r
+//             } catch (IOException e) {\r
+//                     System.err.println("Exception while reading the input file. Exception details: ");\r
+//                     e.printStackTrace();\r
+//             } catch (UnknownFileFormatException e) {\r
+//                     System.err.println("Exception while reading input file. Doesnt look like a Clustal format file");\r
+//                     e.printStackTrace();\r
+//             } catch (JobSubmissionException e) {\r
+//                     System.err.println("Exception while submitting job to the web server. ");\r
+//                     e.printStackTrace();\r
+//             } catch (ResultNotAvailableException e) {\r
+//                     System.err.println("Exception while waiting for results. Exception details: ");\r
+//                     e.printStackTrace();\r
+//             } catch (InterruptedException ignored) {\r
+//                     // ignore and propagate an interruption\r
+//                     Thread.currentThread().interrupt();\r
+//             } catch (WrongParameterException e) {\r
+//                     e.printStackTrace();\r
+//             } finally {\r
+//                     if (instream != null) {\r
+//                             try {\r
+//                                     instream.close();\r
+//                             } catch (IOException ignored) {\r
+//                                     // ignore\r
+//                             }\r
+//                     }\r
+//             }\r
+//             return rnastruct;\r
+//     }\r
+//             \r
        /**\r
         * Prints Jws2Client usage information to standard out\r
         * \r