2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
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 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 * The Jalview Authors are detailed in the 'AUTHORS' file.
19 package jalview.ws.rest.params;
21 import jalview.ws.params.OptionI;
22 import jalview.ws.rest.InputType;
23 import jalview.ws.rest.NoValidInputDataException;
24 import jalview.ws.rest.RestJob;
26 import java.io.UnsupportedEncodingException;
27 import java.net.URLEncoder;
28 import java.util.ArrayList;
29 import java.util.List;
31 import org.apache.http.entity.mime.content.ContentBody;
32 import org.apache.http.entity.mime.content.StringBody;
35 * defines a constant value always provided as a parameter.
40 public class JobConstant extends InputType
52 public JobConstant(String param, String val)
54 // needs no data from the restJob
61 public ContentBody formatForInput(RestJob rj)
62 throws UnsupportedEncodingException, NoValidInputDataException
65 return new StringBody(value);
69 public List<String> getURLEncodedParameter()
71 ArrayList<String> prm = new ArrayList<String>();
73 if (value != null && value.length() > 0)
77 prm.add(URLEncoder.encode(value, "UTF-8"));
78 } catch (UnsupportedEncodingException ex)
80 throw new Error("Couldn't encode '" + value + "' as UTF-8.", ex);
88 public String getURLtokenPrefix()
94 public boolean configureFromURLtokenString(List<String> tokenstring,
95 StringBuffer warnings)
97 if (tokenstring.size() > 1)
99 warnings.append("IMPLEMENTATION ERROR: Constant POST parameters cannot have more than one value.");
102 if (tokenstring.size() == 1)
104 value = tokenstring.get(0);
110 public boolean configureProperty(String tok, String val,
111 StringBuffer warnings)
113 warnings.append("IMPLEMENTATION ERROR: No Properties to configure for a Constant parameter.");
118 public List<OptionI> getOptions()
120 // empty list - this parameter isn't configurable, so don't try.
121 return new ArrayList<OptionI>();