com.airs.platform

Class EventComponent

java.lang.Object

com.airs.platform.EventComponent

All Implemented Interfaces:

Runnable

public class EventComponent
extends Object
implements Runnable

Class that handles all incoming Method types

Field Summary

Fields

Modifier and Type	Field and Description
AIRS_remote	airs Reference to AIRS_remote service
boolean	connected Flag if connected (true) or not (false)

Constructor Summary

Constructors

Constructor and Description
EventComponent()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	Bye(com.airs.platform.DIALOG_INFO dialog, Callback callback) Terminates existing dialog
boolean	Confirm(com.airs.platform.DIALOG_INFO dialog_info, String ret_code) sends confirmation within existing dialog
boolean	Confirm(com.airs.platform.Method method, String ret_code) sends confirmation outside of any existing dialog, using the information from the old method
boolean	Notify(short dialog_id, byte[] event_body, Callback callback) Sends notification in subscription dialog
com.airs.platform.DIALOG_INFO	Publish(byte[] TO, byte[] event_name, byte[] event_body, int Expires, Callback callback) Establishes a new PUBLISH dialog
boolean	Publish(com.airs.platform.DIALOG_INFO dialog, byte[] TO, byte[] event_name, byte[] event_body, int Expires) Sends a PUBLISH method in an existing dialog
boolean	registerEventServer(Callback callback, String event_name_string) Register an event server with a given Callback for a given event name
void	run() Runnable thread of this class for receiving methods from remote application server
boolean	startEC(AIRS_remote airs, String IPAddress, String IPPort) Start the EventComponent after being instantiated
void	stop() Stop the EventComponent
com.airs.platform.DIALOG_INFO	Subscribe(byte[] TO, byte[] event_name, byte[] event_body, int body_length, int Expires, Callback callback) Establishes a SUBSCRIBE dialog

Methods inherited from class java.lang.Object

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

Field Detail

airs

public AIRS_remote airs

Reference to AIRS_remote service

connected

public boolean connected

Flag if connected (true) or not (false)

Constructor Detail

EventComponent

public EventComponent()

Method Detail

startEC

public boolean startEC(AIRS_remote airs,
              String IPAddress,
              String IPPort)

Start the EventComponent after being instantiated

Parameters:

airs - Reference to the AIRS_remote service which started this component

IPAddress - String with the IP address to connect to

IPPort - Port to connect to at the given IP address

run

public void run()

Runnable thread of this class for receiving methods from remote application server

Specified by:

run in interface Runnable

stop

public void stop()

Stop the EventComponent

registerEventServer

public boolean registerEventServer(Callback callback,
                          String event_name_string)

Register an event server with a given Callback for a given event name

Parameters:

callback - Reference to the Callback for this event

event_name_string - String for the event name being registered

Returns:

true, if successful

Subscribe

public com.airs.platform.DIALOG_INFO Subscribe(byte[] TO,
                                      byte[] event_name,
                                      byte[] event_body,
                                      int body_length,
                                      int Expires,
                                      Callback callback)

Establishes a SUBSCRIBE dialog

Parameters:

TO - byte array with the name to send this to (usually 'application server')

event_name - byte array with the event name being subscribed to

event_body - byte array with the event body

body_length - length of the event body array

Expires - time to expire in milliseconds

callback - Reference to the Callback for this dialog

Returns:

DIALOG_INFO of the established dialog

Notify

public boolean Notify(short dialog_id,
             byte[] event_body,
             Callback callback)

Sends notification in subscription dialog

Parameters:

dialog_id - identifier for the dialog being used

event_body - byte array with the event body being sent

callback - Reference to the Callback being notified upon completion

Returns:

true, if successful

Publish

public com.airs.platform.DIALOG_INFO Publish(byte[] TO,
                                    byte[] event_name,
                                    byte[] event_body,
                                    int Expires,
                                    Callback callback)

Establishes a new PUBLISH dialog

Parameters:

TO - byte array with the name to send this to (usually 'application server')

event_name - byte array with the event name being subscribed to

event_body - byte array with the event body

Expires - time to expire in milliseconds

callback - Reference to the Callback for this dialog

Returns:

DIALOG_INFO of the established dialog

Publish

public boolean Publish(com.airs.platform.DIALOG_INFO dialog,
              byte[] TO,
              byte[] event_name,
              byte[] event_body,
              int Expires)

Sends a PUBLISH method in an existing dialog

Parameters:

dialog - Reference to the DIALOG_INFO that holds the dialog information to be used

TO - byte array with the name to send this to (usually 'application server')

event_name - byte array with the event name being subscribed to

event_body - byte array with the event body

Expires - time to expire in milliseconds

Returns:

true, if successful

Confirm

public boolean Confirm(com.airs.platform.Method method,
              String ret_code)

sends confirmation outside of any existing dialog, using the information from the old method

Parameters:

method - Reference to the Method being re-used

ret_code - Return code being inserted into the CONFIRM method

Returns:

true, if successful

Confirm

public boolean Confirm(com.airs.platform.DIALOG_INFO dialog_info,
              String ret_code)

sends confirmation within existing dialog

Parameters:

dialog_info - Reference to the DIALOG_INFO of the dialog being used

ret_code - Return code being inserted into the CONFIRM method

Returns:

true, if successful

Bye

public boolean Bye(com.airs.platform.DIALOG_INFO dialog,
          Callback callback)

Terminates existing dialog

Parameters:

dialog - Reference to the DIALOG_INFO of the dialog to be terminated

callback - Reference to the Callback of this dialog

Returns:

true, if successful