Synergy source documentation: Class BDirectMessageSvr

Overview

Package

Class

Tree

Deprecated

Index

Synergy Documentation

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

au.edu.swin.synergy.plugin.directsvr
Class BDirectMessageSvr

java.lang.Object
  |
  +--au.edu.swin.synergy.kernel.BPlugin
        |
        +--au.edu.swin.synergy.plugin.directsvr.BDirectMessageSvr

public class BDirectMessageSvr
extends BPlugin

BDirectMessageSvr acts as the server for internal direct mail distribution fro cohesion clients

Author:: Matthew Evans Please complete these missing tags
Copyright Belongs To:

Fields inherited from class au.edu.swin.synergy.kernel.BPlugin

kernel

Constructor Summary
`BDirectMessageSvr()`

Method Summary
`void`	`onBCommandEvent(Object source, BCommandEvent event)` Listens for mail events, and if one is detected, the event is forwarded to the sendMessage()
`void`	`sendMessage(String user, int sessionID)` Send the message to any email receivers in te mail event
`void`	`setDirectRecipients(BStringList allReceivers)` Obtains a sub-list of the receivers list in a BMessage object, which contains only direct message receipients
`void`	`setup(BStringList params)` setup the DirectMessageSvr Please complete the missing tags for setup

Methods inherited from class au.edu.swin.synergy.kernel.BPlugin

dispatchEvent, 
dispatchEventAndWait, 
dispatchEventServer, 
dispatchEventServerAndWait, 
dispatchEventTo, 
dispatchEventToAndWait, 
getDependancies, 
getKernel, 
setKernel, 
setup, 
unload

Methods inherited from class java.lang.Object

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

Constructor Detail

BDirectMessageSvr

public BDirectMessageSvr()

Method Detail

setup

public void setup(BStringList params)

setup the DirectMessageSvr Please complete the missing tags for setup

Parameters:: -
Returns:
Overrides:: setup in class BPlugin
Pre Condition:
Post Condition:

setDirectRecipients

public void setDirectRecipients(BStringList allReceivers)

Obtains a sub-list of the receivers list in a BMessage object, which contains only direct message receipients

Parameters:: allReceivers - the original list of receivers in a BMessage object Please complete the missing tags for setDirectRecipients
Returns:
Pre Condition:
Post Condition:

onBCommandEvent

public void onBCommandEvent(Object source,
                            BCommandEvent event)

Listens for mail events, and if one is detected, the event is forwarded to the sendMessage()

Parameters:: the - source of the command event; the - event Please complete the missing tags for onBCommandEvent
Returns:
Overrides:: onBCommandEvent in class BPlugin
Pre Condition:
Post Condition:

sendMessage

public void sendMessage(String user,
                        int sessionID)

Send the message to any email receivers in te mail event

Parameters:: the - session ID of an intended reciepient of the message Please complete the missing tags for sendMessage
Returns:
Pre Condition:
Post Condition: