org.provarules.api2

Class ProvaCommunicatorImpl

java.lang.Object

org.provarules.api2.ProvaCommunicatorImpl

All Implemented Interfaces:

ProvaCommunicator

public class ProvaCommunicatorImpl
extends java.lang.Object
implements ProvaCommunicator

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ASYNC
static boolean	SYNC

Constructor Summary

Constructors

Constructor and Description
ProvaCommunicatorImpl(ProvaMiniService service, java.lang.String agent, java.lang.String port, java.lang.Object rules, boolean async, java.util.Map<java.lang.String,java.lang.Object> globals)
ProvaCommunicatorImpl(java.lang.String agent, java.lang.Object rules, boolean async)
ProvaCommunicatorImpl(java.lang.String agent, java.lang.String port, java.lang.Object rules, boolean async)
ProvaCommunicatorImpl(java.lang.String agent, java.lang.String port, java.lang.Object rules, boolean async, java.util.Map<java.lang.String,java.lang.Object> globals) A preferred constructor for a Communicator.
ProvaCommunicatorImpl(java.lang.String agent, java.lang.String port, java.lang.Object rules, boolean async, ProvaAgent esb, java.util.Map<java.lang.String,java.lang.Object> globals)

Method Summary

Modifier and Type	Method and Description
void	addMsg(ProvaList terms)
void	addMsg(java.lang.String xid, java.util.Map<java.lang.String,java.lang.Object> msg)
void	addMsg(java.lang.String xid, java.lang.String agent, java.lang.String verb, java.lang.Object payload)
void	consultAsync(java.io.BufferedReader in, java.lang.String key, java.lang.Object[] objects) A wrapper for an asynchronous query to the rulebase
void	consultAsync(java.lang.String src, java.lang.String key, java.lang.Object[] objects) A wrapper for an asynchronous query to the rulebase
java.util.List<ProvaSolution[]>	consultSync(java.io.BufferedReader in, java.lang.String key, java.lang.Object[] objects) A wrapper for a synchronous query to the rulebase
java.util.List<ProvaSolution[]>	consultSync(java.lang.String src, java.lang.String key, java.lang.Object[] objects) A wrapper for a synchronous query to the rulebase
java.util.List<ProvaSolution[]>	getInitializationSolutions()
ProvaReagent	getReagent()
static void	main(java.lang.String[] args) The main Prova Reloaded runner.
java.lang.Object	sendMsg(java.lang.String xid, java.lang.String protocol, java.lang.Object obj_receiver, java.lang.String perf, java.lang.String term, java.lang.Object[] objs) Send a message to an asynchronous Prova agent (inluding a local Communicator created in asynchronous mode)
void	setGlobalConstant(java.lang.String name, java.lang.Object value)
void	setMessenger(ProvaMessenger messenger)
void	setPrintWriter(java.io.PrintWriter printWriter)
void	shutdown()
void	stop()
void	unconsultSync(java.lang.String src)

Methods inherited from class java.lang.Object

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

Field Detail

ASYNC

public static final boolean ASYNC

See Also:

Constant Field Values

SYNC

public static final boolean SYNC

See Also:

Constant Field Values

Constructor Detail

ProvaCommunicatorImpl

public ProvaCommunicatorImpl(java.lang.String agent,
                             java.lang.String port,
                             java.lang.Object rules,
                             boolean async)

Parameters:

agent - A logical name of the Prova agent (must be unique on each machine)

port - An external port used for JADE communications. If port is null, JADE communication is not used

rules - There are three options to use here:
if the Object is a String, it must be a filename of the file to be consulted.
otherwise, it must be either a StringBuffer or a BufferedReader, from which the initial rulebase will be consulted.

async - If it is ProvaCommunicator.ASYNC, the Communicator is started in a separate thread.
If it is ProvaCommunicator.SYNC, it is started in the current thread.

ProvaCommunicatorImpl

public ProvaCommunicatorImpl(java.lang.String agent,
                             java.lang.String port,
                             java.lang.Object rules,
                             boolean async,
                             java.util.Map<java.lang.String,java.lang.Object> globals)

A preferred constructor for a Communicator.

Parameters:

agent - A logical name of the Prova agent (must be unique on each machine)

port - An external port used for JADE communications. If port is null, JADE communication is not used

rules - There are three options to use here:
if the Object is a String, it must be a filename of the file to be consulted.
otherwise, it must be either a StringBuffer or a BufferedReader, from which the initial rulebase will be consulted.

async - If it is ProvaCommunicator.ASYNC, the Communicator is started in a separate thread.
If it is ProvaCommunicator.SYNC, it is started in the current thread.

globals - map of arguments passed to the initialisation rulebase

ProvaCommunicatorImpl

public ProvaCommunicatorImpl(java.lang.String agent,
                             java.lang.String port,
                             java.lang.Object rules,
                             boolean async,
                             ProvaAgent esb,
                             java.util.Map<java.lang.String,java.lang.Object> globals)

ProvaCommunicatorImpl

public ProvaCommunicatorImpl(java.lang.String agent,
                             java.lang.Object rules,
                             boolean async)

ProvaCommunicatorImpl

public ProvaCommunicatorImpl(ProvaMiniService service,
                             java.lang.String agent,
                             java.lang.String port,
                             java.lang.Object rules,
                             boolean async,
                             java.util.Map<java.lang.String,java.lang.Object> globals)

Method Detail

stop

public void stop()

Specified by:

stop in interface ProvaCommunicator

getInitializationSolutions

public java.util.List<ProvaSolution[]> getInitializationSolutions()

Specified by:

getInitializationSolutions in interface ProvaCommunicator

consultSync

public java.util.List<ProvaSolution[]> consultSync(java.lang.String src,
                                                   java.lang.String key,
                                                   java.lang.Object[] objects)
                                            throws java.lang.Exception

A wrapper for a synchronous query to the rulebase

Specified by:

consultSync in interface ProvaCommunicator

Parameters:

src - File name or URL with a rulebase to be consulted.
Special constructs _N (e.g., _0) may be embedded in the code to represent Java objects used in goals, facts, and rules.

key - Unique key identifying the consulted code (useful in interactive environments)

objects - Java objects embedded into the input parameter.

Returns:

A list of org.provarules.kernel.ProvaResultSet objects, where each result set corresponds to one goal in the consulted code. For one goal, each resultset contains zero or more solutions with instantiations of all free variables in that goal.

Throws:

java.lang.Exception - Any exception from running the rulebase

consultSync

public java.util.List<ProvaSolution[]> consultSync(java.io.BufferedReader in,
                                                   java.lang.String key,
                                                   java.lang.Object[] objects)

A wrapper for a synchronous query to the rulebase

Specified by:

consultSync in interface ProvaCommunicator

Parameters:

in - BufferedReader wrapping access to the rulebase to be consulted.
Special constructs _N (e.g., _0) may be embedded in the code to represent Java objects used in goals, facts, and rules.

key - Unique key identifying the consulted code (useful in interactive environments)

objects - Java objects embedded into the input parameter.

Returns:

A list of org.provarules.kernel.ProvaResultSet objects, where each result set corresponds to one goal in the consulted code. For one goal, each resultset contains zero or more solutions with instantiations of all free variables in that goal.

consultAsync

public void consultAsync(java.lang.String src,
                         java.lang.String key,
                         java.lang.Object[] objects)
                  throws java.lang.Exception

A wrapper for an asynchronous query to the rulebase

Specified by:

consultAsync in interface ProvaCommunicator

Parameters:

src - File name or URL with a rulebase to be consulted.
Special constructs _N (e.g., _0) may be embedded in the code to represent Java objects used in goals, facts, and rules.

key - Unique key identifying the consulted code (useful in interactive environments)

objects - Java objects embedded into the input parameter.

Throws:

java.lang.Exception - Any exception from running the rulebase

consultAsync

public void consultAsync(java.io.BufferedReader in,
                         java.lang.String key,
                         java.lang.Object[] objects)
                  throws java.lang.Exception

A wrapper for an asynchronous query to the rulebase

Specified by:

consultAsync in interface ProvaCommunicator

Parameters:

in - BufferedReader wrapping access to the rulebase to be consulted.
Special constructs _N (e.g., _0) may be embedded in the code to represent Java objects used in goals, facts, and rules.

key - Unique key identifying the consulted code (useful in interactive environments)

objects - Java objects embedded into the input parameter.

Throws:

java.lang.Exception - Any exception from running the rulebase

setPrintWriter

public void setPrintWriter(java.io.PrintWriter printWriter)

Specified by:

setPrintWriter in interface ProvaCommunicator

sendMsg

public java.lang.Object sendMsg(java.lang.String xid,
                                java.lang.String protocol,
                                java.lang.Object obj_receiver,
                                java.lang.String perf,
                                java.lang.String term,
                                java.lang.Object[] objs)

Send a message to an asynchronous Prova agent (inluding a local Communicator created in asynchronous mode)

Parameters:

xid - Conversation-id for the message. Specifying null starts a new conversation. Otherwise, it is assumed that the message is a follow-up to the conversation with the specified conversation-id. Use %0 to pass an object here.

protocol - Currently, "self", "jade", or "jms". For sending messages to the Prova engine in this Communicator, specify "self".

obj_receiver - The logical name of the target agent. Specifying "0" here results in sending this message to the Prova agent in this Communicator (it is) equivalent to specifying the protocol as "self".

perf - Performative, i.e., speech act communicated by the message. Broadly speaking, it is the "type" of the message. Examples include standard FIPA performatives such as query-ref, ask-if, or inform.

term - The message contents as a String. It is assumed to be a comma-separated list with various tags and parameters to the message. Java objects may be embedded by using placeholders in the format %N with N corresponding to an index into the array with objects in objs.

objs - Array with Java objects to be embedded in the locations specified by placeholders in the message contents term.

Returns:

Conversation-id of the sent message. This id may be useful when a new conversation is initiated. In this case, possible follow-up messages must be sent with the conversation-id returned here.

main

public static void main(java.lang.String[] args)

The main Prova Reloaded runner.

Example: prova3[.bat|.sh] agent password rules/rules/test001_args.prova anticoagulant

Parameters:

args - String[]

shutdown

public void shutdown()

Specified by:

shutdown in interface ProvaCommunicator

getReagent

public ProvaReagent getReagent()

Specified by:

getReagent in interface ProvaCommunicator

addMsg

public void addMsg(ProvaList terms)

Specified by:

addMsg in interface ProvaCommunicator

addMsg

public void addMsg(java.lang.String xid,
                   java.util.Map<java.lang.String,java.lang.Object> msg)

Specified by:

addMsg in interface ProvaCommunicator

addMsg

public void addMsg(java.lang.String xid,
                   java.lang.String agent,
                   java.lang.String verb,
                   java.lang.Object payload)

Specified by:

addMsg in interface ProvaCommunicator

unconsultSync

public void unconsultSync(java.lang.String src)

Specified by:

unconsultSync in interface ProvaCommunicator

setGlobalConstant

public void setGlobalConstant(java.lang.String name,
                              java.lang.Object value)

Specified by:

setGlobalConstant in interface ProvaCommunicator

setMessenger

public void setMessenger(ProvaMessenger messenger)

Specified by:

setMessenger in interface ProvaCommunicator