jadex.bdi.runtime.interpreter

Class MessageEventRules

java.lang.Object

jadex.bdi.runtime.interpreter.MessageEventRules

public class MessageEventRules
extends Object

Rules for handling message events. The following rules are present: - message arrived: When there is a new message in the inbox then finding matching message event (and original), create message event and add it to the capability's message events. - message to send: When there is a message in the outbox then transform message to map (encode content) and call sendMessage on message adapter.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGEEVENTS_MAX The maximum number of outstanding messages.
static Class	TYPE The Class object representing the class corresponding to the this Class.

Constructor Summary

Constructors

Constructor and Description
MessageEventRules()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	containsRegisteredMessageEvents(jadex.rules.state.IOAVState state, Object rcapa, Object rmevent) Test if a message has been registered.
static Object	createReceivedMessageEvent(jadex.rules.state.IOAVState state, Object mevent, IMessageAdapter msg, Object scope, Object original) Fill parameters of a message event from a native one.
static void	deregisterMessageEvent(jadex.rules.state.IOAVState state, Object rmevent, Object rscope) Remove a registered message event.
static boolean	evaluateMatchExpression(jadex.rules.state.IOAVState state, Object rcapa, IMessageAdapter rawmsg, Object matchexp) Evaluate a match expression of a message event template.
static IContentCodec[]	getContentCodecs(Object rcapa, jadex.rules.state.IOAVState state) Get a matching content codec.
static Object	getInReplyMessageEvent(jadex.rules.state.IOAVState state, IMessageAdapter rawmessage, Object rscope) Find a message event that the given native message is a reply to.
static MessageType	getMessageEventType(jadex.rules.state.IOAVState state, Object mme) Get the message event type of a message event.
static Object	getValue(IMessageAdapter message, String name, Object scope) Get the value for a parameter, or the values for a parameter set from a native message.
static Object	initializeReply(jadex.rules.state.IOAVState state, Object rcapa, Object revent, Object rreply) Create a reply to this message event.
static Object	instantiateMessageEvent(jadex.rules.state.IOAVState state, Object rcapa, Object mevent, Object cevent, Map bindings, OAVBDIFetcher fetcher, OAVBDIFetcher configfetcher) Instantiate an message event.
static boolean	match(jadex.rules.state.IOAVState state, IMessageAdapter message, Object mevent, Object scope) Match a message with a message event.
static void	registerMessageEvent(jadex.rules.state.IOAVState state, Object rmevent, Object rcapa) Register a conversation or reply_with to be able to send back answers to the source capability.
static IFuture	sendMessage(jadex.rules.state.IOAVState state, Object rcapa, Object rmessageevent, byte[] codecids) Send a message after some delay.
static boolean	unequalParameterSetValues(jadex.rules.state.IOAVState state, String paramsetname, Object mevent, IMessageAdapter rawmsg, Object rcapa) Test if two parameter values are equal.
static boolean	unequalParameterValues(jadex.rules.state.IOAVState state, String paramname, Object mevent, IMessageAdapter rawmsg, Object rcapa) Test if two parameter values are equal.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGEEVENTS_MAX

public static String MESSAGEEVENTS_MAX

The maximum number of outstanding messages.

TYPE

public static final Class TYPE

The Class object representing the class corresponding to the this Class. Need due to JavaFlow Bug: http://issues.apache.org/jira/browse/SANDBOX-111

Constructor Detail

MessageEventRules

public MessageEventRules()

Method Detail

instantiateMessageEvent

public static Object instantiateMessageEvent(jadex.rules.state.IOAVState state,
                             Object rcapa,
                             Object mevent,
                             Object cevent,
                             Map bindings,
                             OAVBDIFetcher fetcher,
                             OAVBDIFetcher configfetcher)

Instantiate an message event.

Parameters:

state - The state

rcapa - The capability.

mevent - The event model.

cevent - The event configuration (if any).

Returns:

The event instance.

sendMessage

public static IFuture sendMessage(jadex.rules.state.IOAVState state,
                  Object rcapa,
                  Object rmessageevent,
                  byte[] codecids)

Send a message after some delay.

Parameters:

me - The message event.

Returns:

The filter to wait for an answer.

unequalParameterValues

public static boolean unequalParameterValues(jadex.rules.state.IOAVState state,
                             String paramname,
                             Object mevent,
                             IMessageAdapter rawmsg,
                             Object rcapa)

Test if two parameter values are equal.

Parameters:

state - The state.

paramname - The parameter name.

mevent - The message event.

rawmsg - The message adapter.

rcapa - The capability.

Returns:

True, if values are not equal.

unequalParameterSetValues

public static boolean unequalParameterSetValues(jadex.rules.state.IOAVState state,
                                String paramsetname,
                                Object mevent,
                                IMessageAdapter rawmsg,
                                Object rcapa)

Test if two parameter values are equal.

Parameters:

state - The state.

paramname - The parameter name.

mevent - The message event.

rawmsg - The message adapter.

rcapa - The capability.

Returns:

True, if values are not equal.

evaluateMatchExpression

public static boolean evaluateMatchExpression(jadex.rules.state.IOAVState state,
                              Object rcapa,
                              IMessageAdapter rawmsg,
                              Object matchexp)

Evaluate a match expression of a message event template.

Parameters:

state - The state.

rcapa - The capability.

rawmsg - The message adapter.

matchexp - The match expression.

Returns:

True, if match expression is valid.

match

public static boolean match(jadex.rules.state.IOAVState state,
            IMessageAdapter message,
            Object mevent,
            Object scope)

Match a message with a message event.

Parameters:

mevent - The message event.

Returns:

True, if message matches the message event.

getValue

public static Object getValue(IMessageAdapter message,
              String name,
              Object scope)

Get the value for a parameter, or the values for a parameter set from a native message. Parameter set values can be provided as array, collection, iterator or enumeration.

createReceivedMessageEvent

public static Object createReceivedMessageEvent(jadex.rules.state.IOAVState state,
                                Object mevent,
                                IMessageAdapter msg,
                                Object scope,
                                Object original)

Fill parameters of a message event from a native one. Uses the abstract method getParameterOrSetValue to retrieve the values from the native message.

registerMessageEvent

public static void registerMessageEvent(jadex.rules.state.IOAVState state,
                        Object rmevent,
                        Object rcapa)

Register a conversation or reply_with to be able to send back answers to the source capability.

Parameters:

msgevent - The message event. todo: indexing for msgevents for speed.

deregisterMessageEvent

public static void deregisterMessageEvent(jadex.rules.state.IOAVState state,
                          Object rmevent,
                          Object rscope)

Remove a registered message event.

Parameters:

msgevent - The message event.

containsRegisteredMessageEvents

public static boolean containsRegisteredMessageEvents(jadex.rules.state.IOAVState state,
                                      Object rcapa,
                                      Object rmevent)

Test if a message has been registered.

getInReplyMessageEvent

public static Object getInReplyMessageEvent(jadex.rules.state.IOAVState state,
                            IMessageAdapter rawmessage,
                            Object rscope)

Find a message event that the given native message is a reply to.

Parameters:

message - The (native) message.

initializeReply

public static Object initializeReply(jadex.rules.state.IOAVState state,
                     Object rcapa,
                     Object revent,
                     Object rreply)

Create a reply to this message event.

Parameters:

msgeventtype - The message event type.

Returns:

The reply event.

getContentCodecs

public static IContentCodec[] getContentCodecs(Object rcapa,
                               jadex.rules.state.IOAVState state)

Get a matching content codec.

Parameters:

props - The properties.

Returns:

The content codec.

getMessageEventType

public static MessageType getMessageEventType(jadex.rules.state.IOAVState state,
                              Object mme)

Get the message event type of a message event.