Jalview 2.8 Source Header

[jalview.git] / src / jalview / ws / rest / params / JobConstant.java

diff --git a/src/jalview/ws/rest/params/JobConstant.java b/src/jalview/ws/rest/params/JobConstant.java
index 01b54cb..cecf5e1 100644 (file)
--- a/src/jalview/ws/rest/params/JobConstant.java
+++ b/src/jalview/ws/rest/params/JobConstant.java
@@ -1,10 +1,29 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
+ * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ */
 package jalview.ws.rest.params;
 
+import jalview.ws.params.OptionI;
 import jalview.ws.rest.InputType;
 import jalview.ws.rest.NoValidInputDataException;
 import jalview.ws.rest.RestJob;
 
 import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -13,17 +32,21 @@ import org.apache.http.entity.mime.content.StringBody;
 
 /**
  * defines a constant value always provided as a parameter.
+ * 
  * @author JimP
- *
+ * 
  */
 public class JobConstant extends InputType
 {
 
   String value;
+
   /**
    * 
-   * @param param name of parameter
-   * @param val value of parameter
+   * @param param
+   *          name of parameter
+   * @param val
+   *          value of parameter
    */
   public JobConstant(String param, String val)
   {
@@ -37,7 +60,7 @@ public class JobConstant extends InputType
   public ContentBody formatForInput(RestJob rj)
           throws UnsupportedEncodingException, NoValidInputDataException
   {
-    
+
     return new StringBody(value);
   }
 
@@ -45,10 +68,17 @@ public class JobConstant extends InputType
   public List<String> getURLEncodedParameter()
   {
     ArrayList<String> prm = new ArrayList<String>();
-    
-    if (value!=null && value.length()>0)
+
+    if (value != null && value.length() > 0)
     {
-      prm.add(value);
+      try
+      {
+        prm.add(URLEncoder.encode(value, "UTF-8"));
+      } catch (UnsupportedEncodingException ex)
+      {
+        throw new Error("Couldn't encode '" + value + "' as UTF-8.", ex);
+
+      }
     }
     return prm;
   }
@@ -63,11 +93,13 @@ public class JobConstant extends InputType
   public boolean configureFromURLtokenString(List<String> tokenstring,
           StringBuffer warnings)
   {
-    if (tokenstring.size()>1) {
+    if (tokenstring.size() > 1)
+    {
       warnings.append("IMPLEMENTATION ERROR: Constant POST parameters cannot have more than one value.");
       return false;
     }
-    if (tokenstring.size()==1) {
+    if (tokenstring.size() == 1)
+    {
       value = tokenstring.get(0);
     }
     return true;
@@ -80,4 +112,11 @@ public class JobConstant extends InputType
     warnings.append("IMPLEMENTATION ERROR: No Properties to configure for a Constant parameter.");
     return false;
   }
+
+  @Override
+  public List<OptionI> getOptions()
+  {
+    // empty list - this parameter isn't configurable, so don't try.
+    return new ArrayList<OptionI>();
+  }
 }