gate.plugin.python

Class PythonSlaveLr

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.creole.AbstractLanguageResource

gate.plugin.python.PythonSlaveLr

All Implemented Interfaces:

gate.LanguageResource, gate.Resource, gate.util.FeatureBearer, gate.util.NameBearer, Serializable

@CreoleResource(name="PythonSlaveLr",
                comment="Language Resource to represent a Python slave process.",
                helpURL="")
public class PythonSlaveLr
extends gate.creole.AbstractLanguageResource

Language Resource for running the Python slave process. This is a language resource so we can interact with the initialized resource easier.

Author:

Johann Petrak

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class gate.creole.AbstractLanguageResource

dataStore, lrPersistentId

Fields inherited from class gate.creole.AbstractResource

name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Constructor Summary

Constructors

Constructor and Description
PythonSlaveLr()

Method Summary

Modifier and Type	Method and Description
void	cleanup()
String	getAuthToken() Get the auth token.
String	getHost() Get the host
Boolean	getLogActions() Get if actions get logged.
Integer	getPort() Get the port number.
Boolean	getUseAuthToken() Should we use an auth token.
gate.Resource	init()
void	setAuthToken(String value) Set auth token
void	setHost(String value) Set binding host name or address
void	setLogActions(Boolean val) Set whether or not to log actions.
void	setPort(Integer value) Set port.
void	setUseAuthToken(Boolean value) Set if we want to use an auth token.
void	startServer(PythonSlave pslave) Start the server.
void	stopServer(PythonSlave pslave) Stop the server.

Methods inherited from class gate.creole.AbstractLanguageResource

getDataStore, getLRPersistenceId, getParent, isModified, setDataStore, setLRPersistenceId, setParent, sync

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.Resource

getParameterValue, setParameterValue, setParameterValues

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Methods inherited from interface gate.util.NameBearer

getName, setName

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

useAuthToken

protected Boolean useAuthToken

pythonSlave

protected transient PythonSlave pythonSlave

Constructor Detail

PythonSlaveLr

public PythonSlaveLr()

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="Binding host name or address",
                 defaultValue="127.0.0.1")
public void setHost(String value)

Set binding host name or address

Parameters:

value - host

getHost

public String getHost()

Get the host

Returns:

host

setAuthToken

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

Set auth token

Parameters:

value - auth token

getAuthToken

public String getAuthToken()

Get the auth token.

Returns:

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

setUseAuthToken

@CreoleParameter(comment="Whether to use an auth token",
                 defaultValue="true")
public void setUseAuthToken(Boolean value)

Set if we want to use an auth token.

Parameters:

value - flag

getUseAuthToken

public Boolean getUseAuthToken()

Should we use an auth token.

Returns:

flag

init

public gate.Resource init()
                   throws gate.creole.ResourceInstantiationException

Specified by:

init in interface gate.Resource

Overrides:

init in class gate.creole.AbstractResource

Throws:

gate.creole.ResourceInstantiationException

cleanup

public void cleanup()

Specified by:

cleanup in interface gate.Resource

Overrides:

cleanup in class gate.creole.AbstractLanguageResource

startServer

public void startServer(PythonSlave pslave)

Start the server.

Parameters:

pslave - the python slave instance that owns the server

stopServer

public void stopServer(PythonSlave pslave)

Stop the server.

Parameters:

pslave - the PythonSlave instance that owns the server.