blob: 7b6d94edf014a2119bfaa739a3ac368a823c9478 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2007, 2016 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* Google Inc - add support for accepting multiple connections
*******************************************************************************/
package org.eclipse.jdt.internal.launching;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Status;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.jdi.Bootstrap;
import org.eclipse.jdt.launching.IJavaLaunchConfigurationConstants;
import org.eclipse.jdt.launching.IVMConnector;
import org.eclipse.osgi.util.NLS;
import com.sun.jdi.connect.Connector;
import com.sun.jdi.connect.IllegalConnectorArgumentsException;
import com.sun.jdi.connect.ListeningConnector;
/**
* A standard socket listening connector.
* Starts a launch that waits for a VM to connect at a specific port.
* @since 3.4
* @see SocketListenConnectorProcess
*/
public class SocketListenConnector implements IVMConnector {
/**
* Return the socket transport listening connector
*
* @return the new {@link ListeningConnector}
* @exception CoreException if unable to locate the connector
*/
protected static ListeningConnector getListeningConnector() throws CoreException {
ListeningConnector connector= null;
Iterator<ListeningConnector> iter= Bootstrap.virtualMachineManager().listeningConnectors().iterator();
while (iter.hasNext()) {
ListeningConnector lc= iter.next();
if (lc.name().equals("com.sun.jdi.SocketListen")) { //$NON-NLS-1$
connector= lc;
break;
}
}
if (connector == null) {
abort(LaunchingMessages.SocketListenConnector_0, null, IJavaLaunchConfigurationConstants.ERR_SHARED_MEMORY_CONNECTOR_UNAVAILABLE);
}
return connector;
}
/* (non-Javadoc)
* @see org.eclipse.jdt.launching.IVMConnector#getIdentifier()
*/
@Override
public String getIdentifier() {
return IJavaLaunchConfigurationConstants.ID_SOCKET_LISTEN_VM_CONNECTOR;
}
/* (non-Javadoc)
* @see org.eclipse.jdt.launching.IVMConnector#getName()
*/
@Override
public String getName() {
return LaunchingMessages.SocketListenConnector_1;
}
/* (non-Javadoc)
* @see org.eclipse.jdt.launching.IVMConnector#connect(java.util.Map, org.eclipse.core.runtime.IProgressMonitor, org.eclipse.debug.core.ILaunch)
*/
@Override
public void connect(Map<String, String> arguments, IProgressMonitor monitor, ILaunch launch) throws CoreException {
if (monitor == null) {
monitor = new NullProgressMonitor();
}
monitor.subTask(LaunchingMessages.SocketListenConnector_2);
ListeningConnector connector= getListeningConnector();
String portNumberString = arguments.get("port"); //$NON-NLS-1$
if (portNumberString == null) {
abort(LaunchingMessages.SocketAttachConnector_Port_unspecified_for_remote_connection__2, null, IJavaLaunchConfigurationConstants.ERR_UNSPECIFIED_PORT);
}
Map<String, Connector.Argument> acceptArguments = connector.defaultArguments();
Connector.Argument param= acceptArguments.get("port"); //$NON-NLS-1$
param.setValue(portNumberString);
// retain default behaviour to accept 1 connection only
int connectionLimit = 1;
if (arguments.containsKey("connectionLimit")) { //$NON-NLS-1$
connectionLimit = Integer.valueOf(arguments.get("connectionLimit")); //$NON-NLS-1$
}
try {
monitor.subTask(NLS.bind(LaunchingMessages.SocketListenConnector_3, new String[]{portNumberString}));
connector.startListening(acceptArguments);
SocketListenConnectorProcess process = new SocketListenConnectorProcess(launch, portNumberString, connectionLimit);
process.waitForConnection(connector, acceptArguments);
} catch (IOException e) {
abort(LaunchingMessages.SocketListenConnector_4, e, IJavaLaunchConfigurationConstants.ERR_REMOTE_VM_CONNECTION_FAILED);
} catch (IllegalConnectorArgumentsException e) {
abort(LaunchingMessages.SocketListenConnector_4, e, IJavaLaunchConfigurationConstants.ERR_REMOTE_VM_CONNECTION_FAILED);
}
}
/* (non-Javadoc)
* @see org.eclipse.jdt.launching.IVMConnector#getDefaultArguments()
*/
@Override
public Map<String, Connector.Argument> getDefaultArguments() throws CoreException {
Map<String, Connector.Argument> def = getListeningConnector().defaultArguments();
Connector.IntegerArgument arg = (Connector.IntegerArgument)def.get("port"); //$NON-NLS-1$
arg.setValue(8000);
return def;
}
/* (non-Javadoc)
* @see org.eclipse.jdt.launching.IVMConnector#getArgumentOrder()
*/
@Override
public List<String> getArgumentOrder() {
List<String> list = new ArrayList<>(1);
list.add("port"); //$NON-NLS-1$
list.add("connectionLimit"); //$NON-NLS-1$
return list;
}
/**
* Throws a core exception with an error status object built from
* the given message, lower level exception, and error code.
*
* @param message the status message
* @param exception lower level exception associated with the
* error, or <code>null</code> if none
* @param code error code
* @throws CoreException if an error occurs
*/
protected static void abort(String message, Throwable exception, int code) throws CoreException {
throw new CoreException(new Status(IStatus.ERROR, LaunchingPlugin.getUniqueIdentifier(), code, message, exception));
}
}