src/jalview/ws/rest/params/JobConstant.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.ws.rest.params;
  20
  21 import jalview.ws.params.OptionI;
  22 import jalview.ws.rest.InputType;
  23 import jalview.ws.rest.NoValidInputDataException;
  24 import jalview.ws.rest.RestJob;
  25
  26 import java.io.UnsupportedEncodingException;
  27 import java.net.URLEncoder;
  28 import java.util.ArrayList;
  29 import java.util.List;
  30
  31 import org.apache.http.entity.mime.content.ContentBody;
  32 import org.apache.http.entity.mime.content.StringBody;
  33
  34 /**
  35  * defines a constant value always provided as a parameter.
  36  *
  37  * @author JimP
  38  *
  39  */
  40 public class JobConstant extends InputType
  41 {
  42
  43   String value;
  44
  45   /**
  46    *
  47    * @param param
  48    *          name of parameter
  49    * @param val
  50    *          value of parameter
  51    */
  52   public JobConstant(String param, String val)
  53   {
  54     // needs no data from the restJob
  55     super(null);
  56     this.token = param;
  57     value = val;
  58   }
  59
  60   @Override
  61   public ContentBody formatForInput(RestJob rj)
  62           throws UnsupportedEncodingException, NoValidInputDataException
  63   {
  64
  65     return new StringBody(value);
  66   }
  67
  68   @Override
  69   public List<String> getURLEncodedParameter()
  70   {
  71     ArrayList<String> prm = new ArrayList<String>();
  72
  73     if (value != null && value.length() > 0)
  74     {
  75       try
  76       {
  77         prm.add(URLEncoder.encode(value, "UTF-8"));
  78       } catch (UnsupportedEncodingException ex)
  79       {
  80         throw new Error("Couldn't encode '" + value + "' as UTF-8.", ex);
  81
  82       }
  83     }
  84     return prm;
  85   }
  86
  87   @Override
  88   public String getURLtokenPrefix()
  89   {
  90     return "";
  91   }
  92
  93   @Override
  94   public boolean configureFromURLtokenString(List<String> tokenstring,
  95           StringBuffer warnings)
  96   {
  97     if (tokenstring.size() > 1)
  98     {
  99       warnings.append("IMPLEMENTATION ERROR: Constant POST parameters cannot have more than one value.");
 100       return false;
 101     }
 102     if (tokenstring.size() == 1)
 103     {
 104       value = tokenstring.get(0);
 105     }
 106     return true;
 107   }
 108
 109   @Override
 110   public boolean configureProperty(String tok, String val,
 111           StringBuffer warnings)
 112   {
 113     warnings.append("IMPLEMENTATION ERROR: No Properties to configure for a Constant parameter.");
 114     return false;
 115   }
 116
 117   @Override
 118   public List<OptionI> getOptions()
 119   {
 120     // empty list - this parameter isn't configurable, so don't try.
 121     return new ArrayList<OptionI>();
 122   }
 123 }