org.netbeans.api.debugger.jpda

Class ListeningDICookie

java.lang.Object

org.netbeans.api.debugger.jpda.AbstractDICookie

org.netbeans.api.debugger.jpda.ListeningDICookie

public final class ListeningDICookie
extends AbstractDICookie

Listens on given port for some connection of remotely running JDK and returns VirtualMachine for it.

How to use it:

private static final Executor LISTENING = new RequestProcessor("Listening");

int startListening() throws Exception {
    ListeningDICookie config = ListeningDICookie.create(-1);
    DebuggerInfo info = DebuggerInfo.create(ListeningDICookie.ID, config);
    LISTENING.execute(() -> {
        DebuggerManager.getDebuggerManager().startDebugging(info);
    });
    int port = config.getPortNumber();
    assertNotSame("Listening on a real port", -1, port);
    return port;
}

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID Public ID used for registration in Meta-inf/debugger.

Method Summary

Modifier and Type	Method and Description
static ListeningDICookie	create(int portNumber) Creates a new instance of ListeningDICookie for given parameters.
static ListeningDICookie	create(com.sun.jdi.connect.ListeningConnector listeningConnector, Map<String,? extends com.sun.jdi.connect.Connector.Argument> args) Creates a new instance of ListeningDICookie for given parameters.
static ListeningDICookie	create(String name) Creates a new instance of ListeningDICookie for given parameters.
Map<String,? extends com.sun.jdi.connect.Connector.Argument>	getArgs() Returns map of arguments to be used.
com.sun.jdi.connect.ListeningConnector	getListeningConnector() Returns instance of ListeningConnector.
int	getPortNumber() Returns port number.
String	getSharedMemoryName() Returns shared memory block name.
com.sun.jdi.VirtualMachine	getVirtualMachine() Creates a new instance of VirtualMachine for this DebuggerInfo Cookie.

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

Public ID used for registration in Meta-inf/debugger.

See Also:

Constant Field Values

Method Detail

create

public static ListeningDICookie create(com.sun.jdi.connect.ListeningConnector listeningConnector,
                                       Map<String,? extends com.sun.jdi.connect.Connector.Argument> args)

Creates a new instance of ListeningDICookie for given parameters.

Parameters:

listeningConnector - a instance of ListeningConnector

args - arguments to be used

Returns:

a new instance of ListeningDICookie for given parameters

create

public static ListeningDICookie create(int portNumber)

Creates a new instance of ListeningDICookie for given parameters. Example showing how to tell the IDE to start listening on a random port:

private static final Executor LISTENING = new RequestProcessor("Listening");

int startListening() throws Exception {
    ListeningDICookie config = ListeningDICookie.create(-1);
    DebuggerInfo info = DebuggerInfo.create(ListeningDICookie.ID, config);
    LISTENING.execute(() -> {
        DebuggerManager.getDebuggerManager().startDebugging(info);
    });
    int port = config.getPortNumber();
    assertNotSame("Listening on a real port", -1, port);
    return port;
}

Parameters:

portNumber - a number of port to listen on, use -1 to let the system select a random port since 3.12

Returns:

a new instance of ListeningDICookie for given parameters

create

public static ListeningDICookie create(String name)

Creates a new instance of ListeningDICookie for given parameters.

Parameters:

name - a name of shared memory block to listen on

Returns:

a new instance of ListeningDICookie for given parameters

getListeningConnector

public com.sun.jdi.connect.ListeningConnector getListeningConnector()

Returns instance of ListeningConnector.

Returns:

instance of ListeningConnector

getArgs

public Map<String,? extends com.sun.jdi.connect.Connector.Argument> getArgs()

Returns map of arguments to be used.

Returns:

map of arguments to be used

getPortNumber

public int getPortNumber()

Returns port number.

Returns:

port number

getSharedMemoryName

public String getSharedMemoryName()

Returns shared memory block name.

Returns:

shared memory block name

getVirtualMachine

public com.sun.jdi.VirtualMachine getVirtualMachine()
                                             throws IOException,
                                                    com.sun.jdi.connect.IllegalConnectorArgumentsException

Creates a new instance of VirtualMachine for this DebuggerInfo Cookie.

Specified by:

getVirtualMachine in class AbstractDICookie

Returns:

a new instance of VirtualMachine for this DebuggerInfo Cookie

Throws:

ConnectException - When a connection is refused

IOException

com.sun.jdi.connect.IllegalConnectorArgumentsException