Behavior Client

The behavior client is a java class which implements the behavior client server network protocol. It provides a complete high level API for controlling the behavior server. The client class can upload (java code) classes to the server, can cause the server to create instances of these classes, can send commands to the server to start, stop or delete instances. All classes uploaded to the server must be derived from Behavior (except the assistant classes). The server implements 'online authoring' this means a client can upload an other (newer) version of a class. In this case the instances of the replaced class (and the instances of the subclasses) will by restarted automatically.

The class provides two interfaces: The class can be used in other java programs and it provides a main method which implements a simple command line interface.

Command line options

The client class can be used as standalone program. It provides a simple command line interface for controlling the behavior server. The interface is very simple and slow because for each command the program is starting up, a connection will be established, the command will be sent and the program terminates.

Client <host> <port> upload <classname>

Uploads the specified class to the behavior server. The class file must be available locally and must be reachable within the java classpath. Client <host> <port> redefine <classname>

Causes the behavior server to redefine an uploaded behavior class. Sometimes redefining is necessary because if the class uses other classes references are stored internally in the class. The only way to update this references is to redefine the class. Client <host> <port> delclass <classname>

Deletes an uploaded behavior class. Client <host> <port> classlist

Requests a list of the names of all classes currently uploaded at the server. Client <host> <port> setclassparam <classname> <parameter>

Used for setting specific static parameters of a behavior class. The server uses the java reflection api to find out if the specified class has a public static method void setClassParam with one string parameter. If the server has found such a method it will be called with the specified parameter. The method [class].setClassParam can be used to initialize static variables. The effect of the method depends entirely on the implementation in a behavior class. Client <host> <port> getclassparam <classname>

Used for getting specific static parameters of a behavior class. The server uses the java reflection api to find out if the specified class has a method public static String getClassParam with no parameters. If the server has found such a method it will be called and the result will be sent back. The effect of the method [class].getClassParam depends entirely on the implementation in a class. Client <host> <port> new <classname> <restart> <parameter>*

Used to construct a new instance of a class which was uploaded previously to the server. If the operation succeeds the the id of the new instance will be shown. Client <host> <port> start <id>

Starts the specified instance of an uploaded behavior class. Client <host> <port> startall <classname> <subclasses>

Starts all instances of an uploaded behavior class. If <subclasses> is "true" all instances of all subclasses of the specified class will also be started. Client <host> <port> stop <id>

Stops the specified instance of an uploaded behavior class. Client <host> <port> stopall <classname> <subclasses>

Stops all instances of an uploaded behavior class. If <subclasses> is "true" all instances of all subclasses of the specified class will also be started. Client <host> <port> del <id>

Deletes the specified instance of an uploaded behavior class. Client <host> <port> delall <classname> <subclasses>

Deletes all instances of an uploaded behavior class. If <subclasses> is "true" all instances of all subclasses of the specified class will also be deleted. Client <host> <port> status <id>

Queries information about an instance at the server. This information includes the status, the parameters and the restart flag. Client <host> <port> statusall <classname> <subclasses>

Queries information about all instances of an uploaded behavior class. If the subclasses flag is "true" the server returns information about all instances of all subclasses too. The server returns a list with the identifiers and the corresponding stati of all found instances. Client <host> <port> shutdown

Shuts down the server. Legend:

`<host>`	The host name where the behavior server is running
`<port>`	The port where the behavior server is listening
`<classname>`	A fully qualified class name. E.g. mypackage.mysubpackage.Myclass
`<restart>`	A restart flag. Must be "true" or "false". This flag determines whether an instance of an uploaded class should be restarted if the corresponding class (or super class) has changed.
`<parameter>`	A parameter of an instance or a class. All parameters are handled as strings.
`<subclasses>`	Must be "true" or "false". This flag determines whether a operation should include subclasses.
`<id>`	A unique identifier of an instance (a number).

API

Because the command line interface is slow and not very comfortable a shell which provides a graphical interface was implemented. It uses the client class for communicating with the server.

Take a look at the API of the Client class.

Behavior Client

Command line options

API

Related Topics