com.bankframe.services.notification.notificationserver
Interface NotificationServer

All Known Subinterfaces:

NotificationServer, RMINotificationServer

All Known Implementing Classes:

NotificationServerBean, RMINotificationServerImpl, RMINotificationServerImpl_Stub

public interface NotificationServer

Remote interface for NotificationServer Session

Author:

ksmith

Method Summary

java.util.Vector	broadCast(Node sourceNode, java.lang.String action, java.lang.String date, java.lang.Object payload) This method sends a Notification message to all the RegisteredUsers
boolean	isIDRegistered(java.lang.String targetId) This method determines whether an ID has been registered already
java.util.Vector	notifyUser(Node sourceNode, Node targetNode, java.lang.String action, java.lang.String date, java.lang.Object payload, java.lang.String direction) This method is used to notify a user with a payload
java.util.Vector	notifyUser(java.lang.String sourceId, java.lang.String targetId, java.lang.String action, java.lang.String date, java.lang.Object payload) Deprecated.
java.util.Vector	registerUser(java.lang.String targetId, java.lang.String targetIp, java.lang.String targetPort) This method is used to register a user
java.util.Vector	unregisterUser(java.lang.String targetId) This method is used to un-register a user
java.util.Vector	unregisterUser(java.lang.String targetId, java.lang.String targetIp, java.lang.String targetPort) Deprecated.

Method Detail

registerUser

public java.util.Vector registerUser(java.lang.String targetId,
                                     java.lang.String targetIp,
                                     java.lang.String targetPort)
                              throws ProcessingErrorException,
                                     java.rmi.RemoteException

This method is used to register a user

Parameters:

targetId - String

targetIp - String

targetPort - String

Returns:

Vector

Throws:

ProcessingErrorException - This exception is thrown if processing fails

java.rmi.RemoteException - This exception is thrown if communication fails during the remote method call

unregisterUser

public java.util.Vector unregisterUser(java.lang.String targetId,
                                       java.lang.String targetIp,
                                       java.lang.String targetPort)
                                throws ProcessingErrorException,
                                       java.rmi.RemoteException

Deprecated.

This method is used to un-register a user

Parameters:

targetId - String

targetIp - String

targetPort - String

Returns:

Vector

Throws:

ProcessingErrorException - This exception is thrown if processing fails

java.rmi.RemoteException - This exception is thrown if communication fails during the remote method call

unregisterUser

public java.util.Vector unregisterUser(java.lang.String targetId)
                                throws ProcessingErrorException,
                                       java.rmi.RemoteException

This method is used to un-register a user

Parameters:

targetId - String

Returns:

Vector

Throws:

ProcessingErrorException - This exception is thrown if processing fails

java.rmi.RemoteException - This exception is thrown if communication fails during the remote method call

notifyUser

public java.util.Vector notifyUser(java.lang.String sourceId,
                                   java.lang.String targetId,
                                   java.lang.String action,
                                   java.lang.String date,
                                   java.lang.Object payload)
                            throws ProcessingErrorException,
                                   java.rmi.RemoteException

Deprecated.

This method is used to notify a user with a payload

Parameters:

sourceId - String

targetId - String

action - String

date - String

payload - Object

Returns:

Vector

Throws:

ProcessingErrorException - This exception is thrown if processing fails

ValidationException - This exception is thrown if validation fails

java.rmi.RemoteException - This exception is thrown if communication fails during the remote method call\

notifyUser

public java.util.Vector notifyUser(Node sourceNode,
                                   Node targetNode,
                                   java.lang.String action,
                                   java.lang.String date,
                                   java.lang.Object payload,
                                   java.lang.String direction)
                            throws ProcessingErrorException,
                                   java.rmi.RemoteException

This method is used to notify a user with a payload

Parameters:

sourceNode - Node

targetNode - Node

action - String

date - String

payload - Object

direction - String

Returns:

Vector containing the Targets response

Throws:

ProcessingErrorException

java.rmi.RemoteException

broadCast

public java.util.Vector broadCast(Node sourceNode,
                                  java.lang.String action,
                                  java.lang.String date,
                                  java.lang.Object payload)
                           throws ProcessingErrorException,
                                  java.rmi.RemoteException

This method sends a Notification message to all the RegisteredUsers

Parameters:

sourceNode - Node

action - String

date - String

payload - Object

Returns:

Vector containing the Targets response

Throws:

ProcessingErrorException

java.rmi.RemoteException

isIDRegistered

public boolean isIDRegistered(java.lang.String targetId)
                       throws ProcessingErrorException,
                              java.rmi.RemoteException

This method determines whether an ID has been registered already

Parameters:

targetId - String

Returns:

boolean

Throws:

ProcessingErrorException

java.rmi.RemoteException