1 /*******************************************************************************
2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
3 * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
5 * This file is part of Jalview.
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.
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.
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 *******************************************************************************/
18 package jalview.ws.rest.params;
20 import jalview.ws.params.OptionI;
21 import jalview.ws.rest.InputType;
22 import jalview.ws.rest.NoValidInputDataException;
23 import jalview.ws.rest.RestJob;
25 import java.io.UnsupportedEncodingException;
26 import java.net.URLEncoder;
27 import java.util.ArrayList;
28 import java.util.List;
30 import org.apache.http.entity.mime.content.ContentBody;
31 import org.apache.http.entity.mime.content.StringBody;
34 * defines a constant value always provided as a parameter.
38 public class JobConstant extends InputType
44 * @param param name of parameter
45 * @param val value of parameter
47 public JobConstant(String param, String val)
49 // needs no data from the restJob
56 public ContentBody formatForInput(RestJob rj)
57 throws UnsupportedEncodingException, NoValidInputDataException
60 return new StringBody(value);
64 public List<String> getURLEncodedParameter()
66 ArrayList<String> prm = new ArrayList<String>();
68 if (value!=null && value.length()>0)
71 prm.add(URLEncoder.encode(value,"UTF-8"));
72 } catch (UnsupportedEncodingException ex)
74 throw new Error("Couldn't encode '"+value+"' as UTF-8.",ex);
82 public String getURLtokenPrefix()
88 public boolean configureFromURLtokenString(List<String> tokenstring,
89 StringBuffer warnings)
91 if (tokenstring.size()>1) {
92 warnings.append("IMPLEMENTATION ERROR: Constant POST parameters cannot have more than one value.");
95 if (tokenstring.size()==1) {
96 value = tokenstring.get(0);
102 public boolean configureProperty(String tok, String val,
103 StringBuffer warnings)
105 warnings.append("IMPLEMENTATION ERROR: No Properties to configure for a Constant parameter.");
110 public List<OptionI> getOptions()
112 // empty list - this parameter isn't configurable, so don't try.
113 return new ArrayList<OptionI>();