Class JdiExecutionControlProvider

java.lang.Object
jdk.jshell.execution.JdiExecutionControlProvider
All Implemented Interfaces:
ExecutionControlProvider
public class JdiExecutionControlProvider extends Object implements ExecutionControlProvider
A provider of remote JDI-controlled execution engines.
Since:
9

Field Summary

Modifier and Type Field Description
static final String PARAM_HOST_NAME
The local hostname to connect to.
static final String PARAM_LAUNCH
Should JDI-controlled launching be used?
static final String PARAM_REMOTE_AGENT
The remote agent to launch.
static final String PARAM_TIMEOUT
Milliseconds before connect timeout.

Constructor Summary

Constructor Description
JdiExecutionControlProvider()
Create an instance.

Method Summary

Modifier and Type Method Description
Map<String,String> defaultParameters()
Create and return the default parameter map for this ExecutionControlProvider.
ExecutionControl generate(ExecutionEnv env, Map<String,String> parameters)
Create and return the ExecutionControl instance.
String name()
The unique name of this ExecutionControlProvider.

Methods declared in class java.lang.Object

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

Field Details

PARAM_REMOTE_AGENT

public static final String PARAM_REMOTE_AGENT
The remote agent to launch.
See Also:

PARAM_TIMEOUT

public static final String PARAM_TIMEOUT
Milliseconds before connect timeout.
See Also:

PARAM_HOST_NAME

public static final String PARAM_HOST_NAME
The local hostname to connect to.
See Also:

PARAM_LAUNCH

public static final String PARAM_LAUNCH
Should JDI-controlled launching be used?
See Also:

Constructor Details

JdiExecutionControlProvider

public JdiExecutionControlProvider()
Create an instance. An instance can be used to generate an ExecutionControl instance that uses the Java Debug Interface as part of the control of a remote process.

Method Details

name

public String name()
The unique name of this ExecutionControlProvider.
Specified by:
name in interface ExecutionControlProvider
Returns:
"jdi"

defaultParameters

public Map<String,String> defaultParameters()
Create and return the default parameter map for this ExecutionControlProvider. The map can optionally be modified; Modified or unmodified it can be passed to generate(jdk.jshell.spi.ExecutionEnv, java.util.Map).
Parameters
Parameter Description Constant Field
remoteAgent the remote agent to launch PARAM_REMOTE_AGENT
timeout milliseconds before connect timeout PARAM_TIMEOUT
launch "true" for JDI controlled launch PARAM_LAUNCH
hostname connect to the named of the local host ("" for discovered) PARAM_HOST_NAME
Specified by:
defaultParameters in interface ExecutionControlProvider
Returns:
the default parameter map

generate

public ExecutionControl generate(ExecutionEnv env, Map<String,String> parameters) throws IOException
Description copied from interface: ExecutionControlProvider
Create and return the ExecutionControl instance.
Specified by:
generate in interface ExecutionControlProvider
Parameters:
env - the execution environment, provided by JShell
parameters - the default or modified parameter map.
Returns:
the execution engine
Throws:
IOException

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/jdk.jshell/jdk/jshell/execution/JdiExecutionControlProvider.html