org.arl.fjage.shell

Class ShellAgent

java.lang.Object

org.arl.fjage.Agent

org.arl.fjage.shell.ShellAgent

All Implemented Interfaces:

java.lang.Runnable, Messenger, TimestampProvider

public class ShellAgent
extends Agent

Shell agent runs in a container and allows execution of shell commands and scripts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ShellAgent.InitScript
protected class	ShellAgent.InputStreamCacheEntry

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABORT
protected java.lang.Thread	consoleThread
protected boolean	enabled
protected ScriptEngine	engine
protected boolean	ephemeral
protected java.util.concurrent.Callable<java.lang.Void>	exec
protected CyclicBehavior	executor
protected java.util.List<ShellAgent.InitScript>	initScripts
protected java.util.Map<java.lang.String,ShellAgent.InputStreamCacheEntry>	isCache
protected java.util.List<MessageListener>	listeners
protected boolean	quit
protected Shell	shell

Fields inherited from class org.arl.fjage.Agent

ALL, BLOCKING, FINE, FINER, FINEST, ignoreExceptions, INFO, log, NON_BLOCKING, OFF, SEVERE, thread, tid, WARNING

Constructor Summary

Constructors

Constructor and Description
ShellAgent(ScriptEngine engine) Create a shell agent without a user console.
ShellAgent(ScriptEngine engine, boolean ephemeral) Create a transient shell agent without a user console.
ShellAgent(Shell shell, ScriptEngine engine) Create a shell for user interaction.

Method Summary

Modifier and Type	Method and Description
void	addInitrc(java.io.File script) Adds a initialization script file to setup the console environment.
void	addInitrc(java.lang.String script) Adds a name of the initialization script to setup the console environment.
void	addInitrc(java.lang.String name, java.io.Reader reader) Adds a initialization script from a reader to setup the console environment.
void	addMessageListener(MessageListener ml) Adds a message listener for incoming notifications.
void	clearMessageListeners() Removes all message listeners.
void	enable(boolean b) Enable/disable user interaction in shell.
java.lang.String	getDescription() Get description of the shell agent.
java.lang.String	getLanguage() Get supported script language.
java.lang.String	getTitle() Get title of the shell agent.
void	init() Called by the container when the agent is started.
boolean	isEnabled() Checks if user interaction in shell is enabled.
void	removeMessageListener(MessageListener ml) Removes a message listener.
void	setInitrc(java.io.File script) Sets the initialization script file to setup the console environment.
void	setInitrc(java.lang.String script) Sets the name of the initialization script to setup the console environment.
void	setInitrc(java.lang.String name, java.io.Reader reader) Sets the initialization script from a reader to setup the console environment.
void	shutdown() Called by the container when the agent is terminated.
java.lang.String	toString() Gets a string representation of the agent.

Methods inherited from class org.arl.fjage.Agent

add, agent, agentForService, agentForService, agentsForService, agentsForService, block, block, clone, currentTimeMillis, delay, deregister, deregister, die, getAgentID, getContainer, getName, getPlatform, getState, getStore, getType, getYieldDuringReceive, nanoTime, platformSend, prepareRequest, println, receive, receive, receive, receive, receive, receive, receive, receive, register, register, request, request, run, send, setLogLevel, setQueueSize, setYieldDuringReceive, stop, subscribe, topic, topic, topic, topic, topic, topic, unsubscribe, wake

Methods inherited from class java.lang.Object

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

Field Detail

ABORT

public static final java.lang.String ABORT

See Also:

Constant Field Values

shell

protected Shell shell

consoleThread

protected java.lang.Thread consoleThread

engine

protected ScriptEngine engine

exec

protected java.util.concurrent.Callable<java.lang.Void> exec

executor

protected CyclicBehavior executor

listeners

protected java.util.List<MessageListener> listeners

initScripts

protected java.util.List<ShellAgent.InitScript> initScripts

isCache

protected java.util.Map<java.lang.String,ShellAgent.InputStreamCacheEntry> isCache

quit

protected boolean quit

ephemeral

protected boolean ephemeral

enabled

protected boolean enabled

Constructor Detail

ShellAgent

public ShellAgent(ScriptEngine engine)

Create a shell agent without a user console. This is typically useful for provinding shell services to other agents.

Parameters:

engine - script engine to use

ShellAgent

public ShellAgent(ScriptEngine engine,
                  boolean ephemeral)

Create a transient shell agent without a user console. This is typically used for initialization or short-lived scripts. This shell automatically terminates when all initrc scripts are executed.

Parameters:

engine - script engine to use

ephemeral - true for transient shell, false for long-lived shell

ShellAgent

public ShellAgent(Shell shell,
                  ScriptEngine engine)

Create a shell for user interaction.

Parameters:

shell - user console

engine - script engine to use

Method Detail

init

public void init()

Description copied from class: Agent

Called by the container when the agent is started. This method is usually overridden by a class implementing an agent to initialize the agent and its behaviors.

Overrides:

init in class Agent

shutdown

public void shutdown()

Description copied from class: Agent

Called by the container when the agent is terminated. This method may optionally be overridden to provide a clean up before termination.

Overrides:

shutdown in class Agent

setInitrc

public void setInitrc(java.lang.String script)

Sets the name of the initialization script to setup the console environment. This method should only be called before the agent is added to a running container.

Parameters:

script - script name.

setInitrc

public void setInitrc(java.io.File script)

Sets the initialization script file to setup the console environment. This method should only be called before the agent is added to a running container.

Parameters:

script - script file.

setInitrc

public void setInitrc(java.lang.String name,
                      java.io.Reader reader)

Sets the initialization script from a reader to setup the console environment. This method should only be called before the agent is added to a running container.

Parameters:

name - name of the reader.

reader - script reader.

addInitrc

public void addInitrc(java.lang.String script)

Adds a name of the initialization script to setup the console environment. This method should only be called before the agent is added to a running container.

Parameters:

script - script name.

addInitrc

public void addInitrc(java.io.File script)

Adds a initialization script file to setup the console environment. This method should only be called before the agent is added to a running container.

Parameters:

script - script file.

addInitrc

public void addInitrc(java.lang.String name,
                      java.io.Reader reader)

Adds a initialization script from a reader to setup the console environment. This method should only be called before the agent is added to a running container.

Parameters:

name - name of the reader.

reader - script reader.

addMessageListener

public void addMessageListener(MessageListener ml)

Adds a message listener for incoming notifications.

Parameters:

ml - message listener.

removeMessageListener

public void removeMessageListener(MessageListener ml)

Removes a message listener.

Parameters:

ml - message listener.

clearMessageListeners

public void clearMessageListeners()

Removes all message listeners.

enable

public void enable(boolean b)

Enable/disable user interaction in shell.

Parameters:

b - true to enable, false to disable.

isEnabled

public boolean isEnabled()

Checks if user interaction in shell is enabled.

Returns:

true if enabled, false if disabled.

getLanguage

public java.lang.String getLanguage()

Get supported script language.

Returns:

supported language, or null if unknown.

getTitle

public java.lang.String getTitle()

Get title of the shell agent.

Returns:

title.

getDescription

public java.lang.String getDescription()

Get description of the shell agent.

Returns:

description.

toString

public java.lang.String toString()

Description copied from class: Agent

Gets a string representation of the agent.

Overrides:

toString in class Agent

Returns:

string representation of the agent.

See Also:

Object.toString()