gate.plugin.python

Class PythonSlaveRunner

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.gui.ResourceHelper

gate.plugin.python.PythonSlaveRunner

All Implemented Interfaces:

gate.event.CreoleListener, gate.Resource, gate.util.FeatureBearer, gate.util.NameBearer, Serializable, EventListener

@CreoleResource(name="PythonSlaveRunner",
                tool=true,
                comment="Language Resource to represent a Python slave process.",
                helpURL="")
public class PythonSlaveRunner
extends gate.gui.ResourceHelper

Resource Helper for running the Python slave process. This is meant to get used by a python process that starts the GATE process in order to use the gate slave. It differs from the PythonSlaveLr in that it uses standard output to communicate success/failure of starting the Gateway to Python and in that it will immediately terminate the Java process if something goes wrong or after a shutdown.

Author:

Johann Petrak

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authToken
protected String	host
protected Boolean	keep
protected Boolean	logActions
org.apache.log4j.Logger	LOGGER Our logger instance.
protected Integer	port

Fields inherited from class gate.creole.AbstractResource

name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Constructor Summary

Constructors

Constructor and Description
PythonSlaveRunner()

Method Summary

Modifier and Type	Method and Description
protected List<Action>	buildActions(gate.gui.NameBearerHandle nbh)
Object	call(String action, gate.Resource resource, Object... params)
String	getAuthToken() Get auth Token.
String	getHost() Get the host address.
Boolean	getKeep()
Boolean	getLogActions() Get if actions get logged.
Integer	getPort() Get the port number.
gate.Resource	init() Initialize the resource
void	setAuthToken(String value) Set auth token to use.
void	setHost(String value) Set host.
void	setKeep(Boolean val)
void	setLogActions(Boolean val) Set whether or not to log actions.
void	setPort(Integer value) Set port.
void	startServer(PythonSlave pslave) Start the server.

Methods inherited from class gate.gui.ResourceHelper

cleanup, datastoreClosed, datastoreCreated, datastoreOpened, getActions, resourceLoaded, resourceRenamed, resourceUnloaded

Methods inherited from class gate.creole.AbstractResource

checkParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toString

Methods inherited from class gate.util.AbstractFeatureBearer

getFeatures, setFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Field Detail

LOGGER

public transient org.apache.log4j.Logger LOGGER

Our logger instance.

port

protected Integer port

host

protected String host

authToken

protected String authToken

logActions

protected Boolean logActions

keep

protected Boolean keep

Constructor Detail

PythonSlaveRunner

public PythonSlaveRunner()

Method Detail

setPort

@Optional
 @CreoleParameter(comment="Port number to use.",
                 defaultValue="25333")
public void setPort(Integer value)

Set port.

Parameters:

value - port number

getPort

public Integer getPort()

Get the port number.

Returns:

port

setHost

@Optional
 @CreoleParameter(comment="Host address",
                 defaultValue="127.0.0.1")
public void setHost(String value)

Set host.

Parameters:

value - host address to bind to

getHost

public String getHost()

Get the host address.

Returns:

host address

setAuthToken

@Optional
 @CreoleParameter(comment="Auth Token",
                 defaultValue="")
public void setAuthToken(String value)

Set auth token to use.

Parameters:

value: - the auth token to use or an empty String to use none.

getAuthToken

public String getAuthToken()

Get auth Token.

Returns:

the auth token

setLogActions

@CreoleParameter(comment="If actions should get logged",
                 defaultValue="false")
public void setLogActions(Boolean val)

Set whether or not to log actions.

Parameters:

val - flag

getLogActions

public Boolean getLogActions()

Get if actions get logged.

Returns:

flag

setKeep

@Optional
 @CreoleParameter(comment="Keep running",
                 defaultValue="false")
public void setKeep(Boolean val)

getKeep

public Boolean getKeep()

call

public Object call(String action,
                   gate.Resource resource,
                   Object... params)

Overrides:

call in class gate.gui.ResourceHelper

init

public gate.Resource init()

Initialize the resource

Specified by:

init in interface gate.Resource

Overrides:

init in class gate.gui.ResourceHelper

Returns:

the resource

startServer

public void startServer(PythonSlave pslave)

Start the server. This writes a special string to stdout indicating if the server has been started or not which is used by the starting process to wait until the server is ready.

Parameters:

pslave - the python slave instance that owns the server

buildActions

protected List<Action> buildActions(gate.gui.NameBearerHandle nbh)

Specified by:

buildActions in class gate.gui.ResourceHelper