2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 The Jalview Authors
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
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
21 package jalview.ws.rest.params;
23 import jalview.ws.params.OptionI;
24 import jalview.ws.rest.InputType;
25 import jalview.ws.rest.NoValidInputDataException;
26 import jalview.ws.rest.RestJob;
28 import java.io.UnsupportedEncodingException;
29 import java.net.URLEncoder;
30 import java.util.ArrayList;
31 import java.util.List;
33 import org.apache.http.entity.mime.content.ContentBody;
34 import org.apache.http.entity.mime.content.StringBody;
37 * defines a constant value always provided as a parameter.
42 public class JobConstant extends InputType
54 public JobConstant(String param, String val)
56 // needs no data from the restJob
63 public ContentBody formatForInput(RestJob rj)
64 throws UnsupportedEncodingException, NoValidInputDataException
67 return new StringBody(value);
71 public List<String> getURLEncodedParameter()
73 ArrayList<String> prm = new ArrayList<String>();
75 if (value != null && value.length() > 0)
79 prm.add(URLEncoder.encode(value, "UTF-8"));
80 } catch (UnsupportedEncodingException ex)
82 throw new Error("Couldn't encode '" + value + "' as UTF-8.", ex);
90 public String getURLtokenPrefix()
96 public boolean configureFromURLtokenString(List<String> tokenstring,
97 StringBuffer warnings)
99 if (tokenstring.size() > 1)
101 warnings.append("IMPLEMENTATION ERROR: Constant POST parameters cannot have more than one value.");
104 if (tokenstring.size() == 1)
106 value = tokenstring.get(0);
112 public boolean configureProperty(String tok, String val,
113 StringBuffer warnings)
115 warnings.append("IMPLEMENTATION ERROR: No Properties to configure for a Constant parameter.");
120 public List<OptionI> getOptions()
122 // empty list - this parameter isn't configurable, so don't try.
123 return new ArrayList<OptionI>();