+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.ext.rbvi.chimera;
+import jalview.httpserver.AbstractRequestHandler;
+import jalview.structure.SelectionSource;
+
import java.net.BindException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
-import jalview.httpserver.AbstractRequestHandler;
-import jalview.httpserver.HttpServer;
-import jalview.structure.SelectionSource;
-
/**
* This is a simple Http handler that can listen for selections in Chimera.
* <p/>
* <li>Start the Chimera process</li>
* <li>Start the REST service on Chimera, get the port number it is listening on
* </li>
- * <li>Start the ChimeraListener, get the port number it is listening on</li>
+ * <li>Start the ChimeraListener, get the URL it is listening on</li>
+ * <li>The first listener started will start the singleton HttpServer</li>
* <li>Send a 'listen' command to Chimera with the URL of the listener</li>
+ * <li>When Jalview's Chimera window is closed, shut down the
+ * ChimeraListener</li>
+ * <li>Multiple linked Chimera instances will each have a separate listener (but
+ * share one Http server)</li>
* </ul>
*
* @author gmcarstairs
*
*/
-public class ChimeraListener extends AbstractRequestHandler implements
- SelectionSource
+public class ChimeraListener extends AbstractRequestHandler
+ implements SelectionSource
{
/*
+ * Chimera notification parameter name
+ */
+ private static final String CHIMERA_NOTIFICATION = "chimeraNotification";
+
+ /*
+ * Chimera model changed notifications start with this
+ */
+ private static final String MODEL_CHANGED = "ModelChanged: ";
+
+ /*
+ * Chimera selection changed notification message
+ */
+ private static final String SELECTION_CHANGED = "SelectionChanged: selection changed\n";
+
+ /*
* A static counter so each listener can be associated with a distinct context
* root (/chimera0,1,2,3...). This is needed so we can fetch selections from
* multiple Chimera instances without confusion.
private static int chimeraId = 0;
/*
- * Path below context root that identifies this handler
+ * Prefix for path below context root (myChimeraId is appended)
*/
- private static final String LISTENER_PATH = "chimera";
+ private static final String PATH_PREFIX = "chimera";
/*
* Value of chimeraId (0, 1, 2...) for this instance
*/
private JalviewChimeraBinding chimeraBinding;
- /*
- * The URI of this listener
- */
- private String uri;
-
/**
- * Constructor that also registers this as an Http request handler on path
+ * Constructor that registers this as an Http request handler on path
* /chimeraN, where N is incremented for each instance. Call getUri to get the
* resulting URI for this handler.
*
* @throws BindException
* if no free port can be assigned
*/
- public ChimeraListener(JalviewChimeraBinding binding)
- throws BindException
+ public ChimeraListener(JalviewChimeraBinding binding) throws BindException
{
myChimeraId = chimeraId++;
this.chimeraBinding = binding;
- final String path = LISTENER_PATH + myChimeraId;
- this.uri = HttpServer.getInstance().registerHandler(path, this);
- }
-
- /**
- * Returns the URI on which we are listening
- *
- * @return
- */
- public String getUri()
- {
- return this.uri;
+ setPath(PATH_PREFIX + myChimeraId);
+ registerHandler();
}
/**
HttpServletResponse response)
{
// dumpRequest(request);
- String message = request.getParameter("chimeraNotification");
- if ("selection changed".equals(message))
+ String message = request.getParameter(CHIMERA_NOTIFICATION);
+ if (message == null)
{
- this.chimeraBinding.highlightChimeraSelection();
+ message = request.getParameter("chimerax_notification");
}
- else
+ if (message != null)
{
- System.err.println("Unexpected chimeraNotification: " + message);
- // do it anyway for now!
- this.chimeraBinding.highlightChimeraSelection();
+ if (message.startsWith("SelectionChanged"))
+ {
+ this.chimeraBinding.highlightChimeraSelection();
+ }
+ else if (message.startsWith(MODEL_CHANGED))
+ {
+ jalview.bin.Console.errPrintln(message);
+ processModelChanged(message.substring(MODEL_CHANGED.length()));
+ }
+ else
+ {
+ jalview.bin.Console
+ .errPrintln("Unexpected chimeraNotification: " + message);
+ }
}
}
/**
- * Deregister this listener and close it down
+ * Handle a ModelChanged notification from Chimera
*
- * @throws Exception
+ * @param substring
*/
- public void shutdown()
+ protected void processModelChanged(String message)
{
- try
- {
- HttpServer.getInstance().removeHandler(this);
- stop();
- } catch (Exception e)
- {
- System.err.println("Error stopping chimera listener: "
- + e.getMessage());
- }
+ // jalview.bin.Console.outPrintln(message + " (not implemented in
+ // Jalview)");
+ }
+
+ /**
+ * Returns a display name for this service
+ */
+ @Override
+ public String getName()
+ {
+ return "ChimeraListener";
}
}