JAL-3746 apply copyright to source
[jalview.git] / src / jalview / ext / rbvi / chimera / ChimeraXManager.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ 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
10  * of the License, or (at your option) any later version.
11  *  
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.
16  * 
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.
20  */
21 package jalview.ext.rbvi.chimera;
22
23 import java.util.List;
24
25 import ext.edu.ucsf.rbvi.strucviz2.ChimeraManager;
26 import ext.edu.ucsf.rbvi.strucviz2.StructureManager;
27
28 /**
29  * A class to help Jalview start, stop and send commands to ChimeraX.
30  * <p>
31  * Much of the functionality is common with Chimera, so for convenience we
32  * extend ChimeraManager, however note this class is <em>not</em> based on the
33  * Cytoscape class at
34  * {@code https://github.com/RBVI/structureVizX/blob/master/src/main/java/edu/ucsf/rbvi/structureVizX/internal/model/ChimeraManager.java}.
35  * 
36  * @author gmcarstairs
37  *
38  */
39 public class ChimeraXManager extends ChimeraManager
40 {
41
42   public ChimeraXManager(StructureManager structureManager)
43   {
44     super(structureManager);
45   }
46
47   public boolean isChimeraX()
48   {
49     return true;
50   }
51
52   /**
53    * Returns "POST" as the HTTP request method to use for REST service calls to
54    * ChimeraX
55    * 
56    * @return
57    */
58   protected String getHttpRequestMethod()
59   {
60     return "GET";
61   }
62
63   /**
64    * Adds command-line arguments to start the REST server
65    */
66   protected void addLaunchArguments(List<String> args)
67   {
68     args.add("--cmd");
69     args.add("remote rest start");
70   }
71
72 }