org.eclipse.jdt.internal.launching

Class SocketAttachConnector

java.lang.Object

org.eclipse.jdt.internal.launching.SocketAttachConnector

All Implemented Interfaces:

IVMConnector

public class SocketAttachConnector
extends java.lang.Object
implements IVMConnector

A standard socket attaching connector

Constructor Summary

Constructors

Constructor and Description
SocketAttachConnector()

Method Summary

Modifier and Type	Method and Description
protected static void	abort(java.lang.String message, java.lang.Throwable exception, int code) Throws a core exception with an error status object built from the given message, lower level exception, and error code.
void	connect(java.util.Map<java.lang.String,java.lang.String> arguments, IProgressMonitor monitor, ILaunch launch) Establishes a JDI connection with a debuggable VM using the arguments specified in the given map, contributing results (debug targets and processes), to the given launch.
protected java.lang.String	constructVMLabel(VirtualMachine vm, java.lang.String host, java.lang.String port, ILaunchConfiguration configuration) Helper method that constructs a human-readable label for a remote VM.
java.util.List<java.lang.String>	getArgumentOrder() Returns a list of argument names found in this connector's default argument map, defining the order in which arguments should be presented to the user.
protected static AttachingConnector	getAttachingConnector() Return the socket transport attaching connector
java.util.Map<java.lang.String,Connector.Argument>	getDefaultArguments() Returns a map of default arguments used by this connector.
java.lang.String	getIdentifier() Returns a unique identifier for this kind of connector.
java.lang.String	getName() Returns the name of this connector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SocketAttachConnector

public SocketAttachConnector()

Method Detail

getAttachingConnector

protected static AttachingConnector getAttachingConnector()
                                                   throws CoreException

Return the socket transport attaching connector

Returns:

the AttachingConnector

Throws:

CoreException - if unable to locate the connector

getIdentifier

public java.lang.String getIdentifier()

Description copied from interface: IVMConnector

Returns a unique identifier for this kind of connector.

Specified by:

getIdentifier in interface IVMConnector

Returns:

a unique identifier for this kind of connector

See Also:

IVMConnector.getIdentifier()

getName

public java.lang.String getName()

Description copied from interface: IVMConnector

Returns the name of this connector.

Specified by:

getName in interface IVMConnector

Returns:

the name of this connector

See Also:

IVMConnector.getName()

abort

protected static void abort(java.lang.String message,
                            java.lang.Throwable exception,
                            int code)
                     throws CoreException

Throws a core exception with an error status object built from the given message, lower level exception, and error code.

Parameters:

message - the status message

exception - lower level exception associated with the error, or null if none

code - error code

Throws:

CoreException - if an error occurs

connect

public void connect(java.util.Map<java.lang.String,java.lang.String> arguments,
                    IProgressMonitor monitor,
                    ILaunch launch)
             throws CoreException

Description copied from interface: IVMConnector

Establishes a JDI connection with a debuggable VM using the arguments specified in the given map, contributing results (debug targets and processes), to the given launch.

Specified by:

connect in interface IVMConnector

Parameters:

arguments - Argument map to use in establishing a connection. The keys of the map are strings corresponding to the names of arguments returned by this connector's getDefaultAgruments() method. The values of the map are strings corresponding to the (String) values of the associated com.sun.jdi.connect.Connector.Arguments to use.

monitor - progress monitor

launch - launch to contribute debug target(s) and/or process(es) to

Throws:

CoreException - if unable to establish a connection with the target VM

constructVMLabel

protected java.lang.String constructVMLabel(VirtualMachine vm,
                                            java.lang.String host,
                                            java.lang.String port,
                                            ILaunchConfiguration configuration)

Helper method that constructs a human-readable label for a remote VM.

Parameters:

vm - the VM

host - the host name

port - the port number

configuration - the backing configuration

Returns:

the new label for the VM

getDefaultArguments

public java.util.Map<java.lang.String,Connector.Argument> getDefaultArguments()
                                                                       throws CoreException

Description copied from interface: IVMConnector

Returns a map of default arguments used by this connector. The keys of the map are names of arguments used by this connector, and the values are of type com.sun.jdi.connect.Connector.Argument.

Specified by:

getDefaultArguments in interface IVMConnector

Returns:

argument map with default values

Throws:

CoreException - if unable to retrieve a default argument map

getArgumentOrder

public java.util.List<java.lang.String> getArgumentOrder()

Description copied from interface: IVMConnector

Returns a list of argument names found in this connector's default argument map, defining the order in which arguments should be presented to the user. Since a map is not ordered, this provides control on how arguments will be presented to the user.

Specified by:

getArgumentOrder in interface IVMConnector

Returns:

list of argument names