Module jdk.jshell

Package jdk.jshell.execution

Class JdiDefaultExecutionControl

java.lang.Object

jdk.jshell.execution.StreamingExecutionControl

jdk.jshell.execution.JdiExecutionControl

jdk.jshell.execution.JdiDefaultExecutionControl

All Implemented Interfaces:

AutoCloseable, ExecutionControl

public class JdiDefaultExecutionControl
extends JdiExecutionControl

The implementation of ExecutionControl that the JShell-core uses by default. Launches a remote process -- the "remote agent". Interfaces to the remote agent over a socket and via JDI. Designed to work with RemoteExecutionControl.

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.jshell.spi.ExecutionControl

ExecutionControl.ClassBytecodes, ExecutionControl.ClassInstallException, ExecutionControl.EngineTerminationException, ExecutionControl.ExecutionControlException, ExecutionControl.Generator, ExecutionControl.InternalException, ExecutionControl.NotImplementedException, ExecutionControl.ResolutionException, ExecutionControl.RunException, ExecutionControl.StoppedException, ExecutionControl.UserException

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the execution engine.
static ExecutionControl.Generator	create(String remoteAgent, boolean isLaunch, String host, int timeout)	Creates a JDI based ExecutionControl instance.
static String	defaultRemoteAgent()	Default remote agent.
static int	defaultTimeout()	Default remote connection time-out
String	invoke(String classname, String methodname)	Invokes an executable Snippet by calling a method on the specified wrapper class.
static ExecutionControl.Generator	launch()	Creates an ExecutionControl instance based on a JDI LaunchingConnector.
static ExecutionControl.Generator	listen(String host)	Creates an ExecutionControl instance based on a JDI ListeningConnector.
void	stop()	Interrupts a running remote invoke by manipulating remote variables and sending a stop via JDI.
protected com.sun.jdi.VirtualMachine	vm()	Returns the JDI VirtualMachine instance.

Methods inherited from interface jdk.jshell.spi.ExecutionControl

addToClasspath, extensionCommand, load, setClasspath, varValue

Methods inherited from class jdk.jshell.execution.JdiExecutionControl

redefine, referenceType

Methods inherited from class java.lang.Object

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

Methods inherited from class jdk.jshell.execution.StreamingExecutionControl

addToClasspath, extensionCommand, load, setClasspath, varValue

Method Detail

launch

public static ExecutionControl.Generator launch()

Creates an ExecutionControl instance based on a JDI LaunchingConnector. Same as JdiDefaultExecutionControl.create(defaultRemoteAgent(), true, null, defaultTimeout()).

Returns:

the generator

listen

public static ExecutionControl.Generator listen(String host)

Creates an ExecutionControl instance based on a JDI ListeningConnector. Same as JdiDefaultExecutionControl.create(defaultRemoteAgent(), false, host, defaultTimeout()).

Parameters:

host - explicit hostname to use, if null use discovered hostname, applies to listening only (!isLaunch)

Returns:

the generator

create

public static ExecutionControl.Generator create(String remoteAgent,
                                                boolean isLaunch,
                                                String host,
                                                int timeout)

Creates a JDI based ExecutionControl instance.

Parameters:

remoteAgent - the remote agent to launch

isLaunch - does JDI do the launch? That is, LaunchingConnector, otherwise we start explicitly and use ListeningConnector

host - explicit hostname to use, if null use discovered hostname, applies to listening only (!isLaunch)

timeout - the start-up time-out in milliseconds

Returns:

the generator

defaultRemoteAgent

public static String defaultRemoteAgent()

Default remote agent.

Returns:

the name of the standard remote agent

defaultTimeout

public static int defaultTimeout()

Default remote connection time-out

Returns:

time to wait for connection before failing, expressed in milliseconds.

invoke

public String invoke(String classname,
                     String methodname)
              throws ExecutionControl.RunException,
                     ExecutionControl.EngineTerminationException,
                     ExecutionControl.InternalException

Description copied from interface: ExecutionControl

Invokes an executable Snippet by calling a method on the specified wrapper class. The method must have no arguments and return String.

Specified by:

invoke in interface ExecutionControl

Overrides:

invoke in class StreamingExecutionControl

Parameters:

classname - the class whose method should be invoked

methodname - the name of method to invoke

Returns:

the result of the execution or null if no result

Throws:

ExecutionControl.UserException - the invoke raised a user exception

ExecutionControl.ResolutionException - the invoke attempted to directly or indirectly invoke an unresolved snippet

ExecutionControl.StoppedException - if the invoke() was canceled by ExecutionControl.stop()

ExecutionControl.EngineTerminationException - the execution engine has terminated

ExecutionControl.InternalException - an internal problem occurred

ExecutionControl.RunException

stop

public void stop()
          throws ExecutionControl.EngineTerminationException,
                 ExecutionControl.InternalException

Interrupts a running remote invoke by manipulating remote variables and sending a stop via JDI.

Specified by:

stop in interface ExecutionControl

Overrides:

stop in class StreamingExecutionControl

Throws:

ExecutionControl.EngineTerminationException - the execution engine has terminated

ExecutionControl.InternalException - an internal problem occurred

close

public void close()

Description copied from class: StreamingExecutionControl

Closes the execution engine. Send an exit command to the remote agent.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ExecutionControl

Overrides:

close in class StreamingExecutionControl

vm

protected com.sun.jdi.VirtualMachine vm()
                                 throws ExecutionControl.EngineTerminationException

Description copied from class: JdiExecutionControl

Returns the JDI VirtualMachine instance.

Specified by:

vm in class JdiExecutionControl

Returns:

the virtual machine

Throws:

ExecutionControl.EngineTerminationException - if the VM is dead/disconnected