org.openksavi.sponge.py4j

Class BasePy4JPlugin<T>

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.plugin.BasePlugin

org.openksavi.sponge.java.JPlugin

org.openksavi.sponge.py4j.BasePy4JPlugin<T>

All Implemented Interfaces:

org.openksavi.sponge.engine.EngineModule, org.openksavi.sponge.plugin.Plugin, org.openksavi.sponge.util.Descriptive, org.openksavi.sponge.util.HasEngine, org.openksavi.sponge.util.Manageable

Direct Known Subclasses:

ClientServerPy4JPlugin, GatewayServerPy4JPlugin

public abstract class BasePy4JPlugin<T>
extends org.openksavi.sponge.java.JPlugin

Base, abstract Sponge plugin that provides integration with CPython using Py4J.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME
static String	DEFAULT_PYTHON_EXECUTABLE
static String	ENV_PY4J_AUTH_TOKEN
static String	ENV_PY4J_JAVA_PORT
static String	ENV_PY4J_PYTHON_PORT
static String	TAG_AUTH_TOKEN
static String	TAG_FACADE_INTERFACE
static String	TAG_GENERATE_AUTH_TOKEN
static String	TAG_JAVA_PORT
static String	TAG_PYTHON_PORT
static String	TAG_PYTHON_SCRIPT
static String	TAG_PYTHON_SCRIPT_BEFORE_STARTUP
static String	TAG_RANDOM_PORTS
static String	TAG_SECURITY

Constructor Summary

Constructors

Constructor and Description
BasePy4JPlugin()
BasePy4JPlugin(String name)

Method Summary

Modifier and Type	Method and Description
protected SSLContext	createSslContext()
protected void	executePythonScript()
String	getAuthToken()
T	getFacade()
String	getFacadeInterfaceName()
int	getJavaPort()
int	getPythonPort()
org.openksavi.sponge.util.process.ProcessConfiguration	getPythonScriptConfiguration()
org.openksavi.sponge.util.process.ProcessInstance	getScriptProcess()
org.openksavi.sponge.core.util.SslConfiguration	getSecurity()
boolean	isGenerateAuthToken()
boolean	isPythonScriptBeforeStartup()
boolean	isRandomPorts()
void	killPythonScript()
void	onConfigure(org.openksavi.sponge.config.Configuration configuration)
void	onStartup()
void	setAuthToken(String authToken)
void	setFacade(T facade)
void	setFacadeInterfaceName(String facadeInterfaceName)
void	setGenerateAuthToken(boolean generateAuthToken)
void	setJavaPort(int javaPort)
void	setPythonPort(int pythonPort)
void	setPythonScriptBeforeStartup(boolean pythonScriptBeforeStartup)
void	setPythonScriptConfiguration(org.openksavi.sponge.util.process.ProcessConfiguration pythonScriptConfiguration)
void	setRandomPorts(boolean randomPorts)
void	setSecurity(org.openksavi.sponge.core.util.SslConfiguration security)

Methods inherited from class org.openksavi.sponge.core.plugin.BasePlugin

doShutdown, doStartup, getConfiguration, getEngineOperations, getKnowledgeBase, getLogger, getSponge, onAfterReload, onBeforeReload, onInit, onShutdown, setConfiguration, setKnowledgeBase, shutdown, startup, toString

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

getDescription, getDisplayName, getEngine, getInternalService, getName, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setDescription, setDisplayName, setEngine, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getDisplayName, getName, setDescription, setDisplayName, setName

Methods inherited from interface org.openksavi.sponge.util.HasEngine

getEngine, setEngine

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

Constant Field Values

TAG_FACADE_INTERFACE

public static final String TAG_FACADE_INTERFACE

See Also:

Constant Field Values

TAG_JAVA_PORT

public static final String TAG_JAVA_PORT

See Also:

Constant Field Values

TAG_PYTHON_PORT

public static final String TAG_PYTHON_PORT

See Also:

Constant Field Values

TAG_SECURITY

public static final String TAG_SECURITY

See Also:

Constant Field Values

TAG_PYTHON_SCRIPT

public static final String TAG_PYTHON_SCRIPT

See Also:

Constant Field Values

TAG_PYTHON_SCRIPT_BEFORE_STARTUP

public static final String TAG_PYTHON_SCRIPT_BEFORE_STARTUP

See Also:

Constant Field Values

TAG_GENERATE_AUTH_TOKEN

public static final String TAG_GENERATE_AUTH_TOKEN

See Also:

Constant Field Values

TAG_AUTH_TOKEN

public static final String TAG_AUTH_TOKEN

See Also:

Constant Field Values

TAG_RANDOM_PORTS

public static final String TAG_RANDOM_PORTS

See Also:

Constant Field Values

DEFAULT_PYTHON_EXECUTABLE

public static final String DEFAULT_PYTHON_EXECUTABLE

See Also:

Constant Field Values

ENV_PY4J_JAVA_PORT

public static final String ENV_PY4J_JAVA_PORT

See Also:

Constant Field Values

ENV_PY4J_PYTHON_PORT

public static final String ENV_PY4J_PYTHON_PORT

See Also:

Constant Field Values

ENV_PY4J_AUTH_TOKEN

public static final String ENV_PY4J_AUTH_TOKEN

See Also:

Constant Field Values

Constructor Detail

BasePy4JPlugin

public BasePy4JPlugin()

BasePy4JPlugin

public BasePy4JPlugin(String name)

Method Detail

onStartup

public void onStartup()

Specified by:

onStartup in interface org.openksavi.sponge.plugin.Plugin

Overrides:

onStartup in class org.openksavi.sponge.core.plugin.BasePlugin

executePythonScript

protected void executePythonScript()

killPythonScript

public void killPythonScript()

getScriptProcess

public org.openksavi.sponge.util.process.ProcessInstance getScriptProcess()

onConfigure

public void onConfigure(org.openksavi.sponge.config.Configuration configuration)

Specified by:

onConfigure in interface org.openksavi.sponge.plugin.Plugin

Overrides:

onConfigure in class org.openksavi.sponge.core.plugin.BasePlugin

getFacade

public T getFacade()

setFacade

public void setFacade(T facade)

getFacadeInterfaceName

public String getFacadeInterfaceName()

setFacadeInterfaceName

public void setFacadeInterfaceName(String facadeInterfaceName)

getPythonScriptConfiguration

public org.openksavi.sponge.util.process.ProcessConfiguration getPythonScriptConfiguration()

setPythonScriptConfiguration

public void setPythonScriptConfiguration(org.openksavi.sponge.util.process.ProcessConfiguration pythonScriptConfiguration)

isPythonScriptBeforeStartup

public boolean isPythonScriptBeforeStartup()

setPythonScriptBeforeStartup

public void setPythonScriptBeforeStartup(boolean pythonScriptBeforeStartup)

getJavaPort

public int getJavaPort()

setJavaPort

public void setJavaPort(int javaPort)

getPythonPort

public int getPythonPort()

setPythonPort

public void setPythonPort(int pythonPort)

getSecurity

public org.openksavi.sponge.core.util.SslConfiguration getSecurity()

setSecurity

public void setSecurity(org.openksavi.sponge.core.util.SslConfiguration security)

createSslContext

protected SSLContext createSslContext()

isGenerateAuthToken

public boolean isGenerateAuthToken()

setGenerateAuthToken

public void setGenerateAuthToken(boolean generateAuthToken)

getAuthToken

public String getAuthToken()

setAuthToken

public void setAuthToken(String authToken)

isRandomPorts

public boolean isRandomPorts()

setRandomPorts

public void setRandomPorts(boolean randomPorts)