org.jlab.coda.cMsg.common

Class cMsgSubdomainAdapter

java.lang.Object

org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

All Implemented Interfaces:

cMsgSubdomainInterface

Direct Known Subclasses:

CA, cMsg, Database, Dummy, Et, FileQueue, LogFile, Queue, SmartSockets, TcpServer

public class cMsgSubdomainAdapter
extends java.lang.Object
implements cMsgSubdomainInterface

This class provides a very basic (non-functional/dummy) implementation of the cMsgSubdomainInterface interface. This class is used by a cMsg domain server to respond to client demands. It contains some methods that hide the details of communication with the client. A fully implementated subclass of this class must handle all communication with a particular subdomain (such as SmartSockets or JADE agents).

Understand that each client using cMsg will have its own handler object from either an implemenation of the cMsgSubdomainInterface interface or a subclass of this class. One client may concurrently use the same cMsgHandleRequest object; thus, implementations must be thread-safe. Furthermore, when the name server shuts dowm, the method handleServerShutdown may be executed more than once for the same reason.

Version:

1.0

Author:

Carl Timmer

Constructor Summary

Constructors

Constructor and Description
cMsgSubdomainAdapter()

Method Summary

Modifier and Type	Method and Description
void	handleClientShutdown() Method to handle a client or domain server (and therefore subdomain handler) shutdown.
void	handleSendAndGetRequest(cMsgMessageFull message) Method to synchronously get a single message by sending out a message which is responded to by its receiver(s).
void	handleSendRequest(cMsgMessageFull message) Method to handle a message sent by a domain client.
void	handleShutdownClientsRequest(java.lang.String client, boolean includeMe) Method to handle a request to shutdown clients sent by a domain client.
void	handleSubscribeAndGetRequest(java.lang.String subject, java.lang.String type, int id) Method to synchronously get a single message from the server for a one-time subscription of a subject and type.
void	handleSubscribeRequest(java.lang.String subject, java.lang.String type, int id) Method to handle a subscribe request sent by a domain client.
int	handleSyncSendRequest(cMsgMessageFull message) Method to handle a message sent by a domain client in synchronous mode.
void	handleUnSendAndGetRequest(int id) Method to remove a sendAndGet request previously sent by a domain client.
void	handleUnsubscribeAndGetRequest(java.lang.String subject, java.lang.String type, int id) Method to remove a subscribeAndGet request previously sent by a domain client.
void	handleUnsubscribeRequest(java.lang.String subject, java.lang.String type, int id) Method to handle an unsubscribe request sent by a domain client.
boolean	hasSend() Method to tell if the "send" cMsg API function is implemented by this interface implementation in the "handleSendRequest" method.
boolean	hasSendAndGet() Method to tell if the "sendAndGet" cMsg API function is implemented by this interface implementation in the "handleSendAndGetRequest" method.
boolean	hasShutdown() Method to tell if the "shutdown" cMsg API function is implemented by this interface implementation in the "handleShutdownClientsRequest" method.
boolean	hasSubscribe() Method to tell if the "subscribe" cMsg API function is implemented by this interface implementation in the "handleSubscribeRequest" method.
boolean	hasSubscribeAndGet() Method to tell if the "subscribeAndGet" cMsg API function is implemented by this interface implementation in the "handleSubscribeAndGetRequest" method.
boolean	hasSyncSend() Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the "handleSyncSendRequest" method.
boolean	hasUnsubscribe() Method to tell if the "unsubscribe" cMsg API function is implemented by this interface implementation in the "handleUnsubscribeRequest" method.
void	registerClient(cMsgClientInfo info) Method to register a domain client.
void	setUDLRemainder(java.lang.String UDLRemainder) Method to give the subdomain handler the appropriate part of the UDL the client used to talk to the domain server.

Methods inherited from class java.lang.Object

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

Constructor Detail

cMsgSubdomainAdapter

public cMsgSubdomainAdapter()

Method Detail

setUDLRemainder

public void setUDLRemainder(java.lang.String UDLRemainder)
                     throws cMsgException

Method to give the subdomain handler the appropriate part of the UDL the client used to talk to the domain server.

Specified by:

setUDLRemainder in interface cMsgSubdomainInterface

Parameters:

UDLRemainder - last part of the UDL appropriate to the subdomain handler

Throws:

cMsgException - always throws an exception since this is a dummy implementation

registerClient

public void registerClient(cMsgClientInfo info)
                    throws cMsgException

Method to register a domain client.

Specified by:

registerClient in interface cMsgSubdomainInterface

Parameters:

info - information about client

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleSendRequest

public void handleSendRequest(cMsgMessageFull message)
                       throws cMsgException

Method to handle a message sent by a domain client.

Specified by:

handleSendRequest in interface cMsgSubdomainInterface

Parameters:

message - message from sender

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleSyncSendRequest

public int handleSyncSendRequest(cMsgMessageFull message)
                          throws cMsgException

Method to handle a message sent by a domain client in synchronous mode. It requries an integer response from the subdomain handler.

Specified by:

handleSyncSendRequest in interface cMsgSubdomainInterface

Parameters:

message - message from sender

Returns:

response from subdomain handler

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleSubscribeAndGetRequest

public void handleSubscribeAndGetRequest(java.lang.String subject,
                                         java.lang.String type,
                                         int id)
                                  throws cMsgException

Method to synchronously get a single message from the server for a one-time subscription of a subject and type.

Specified by:

handleSubscribeAndGetRequest in interface cMsgSubdomainInterface

Parameters:

subject - subject subscribed to

type - type subscribed to

id - unique id

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleSendAndGetRequest

public void handleSendAndGetRequest(cMsgMessageFull message)
                             throws cMsgException

Method to synchronously get a single message by sending out a message which is responded to by its receiver(s).

Specified by:

handleSendAndGetRequest in interface cMsgSubdomainInterface

Parameters:

message - message requesting a response message

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleUnSendAndGetRequest

public void handleUnSendAndGetRequest(int id)
                               throws cMsgException

Method to remove a sendAndGet request previously sent by a domain client.

Specified by:

handleUnSendAndGetRequest in interface cMsgSubdomainInterface

Parameters:

id - unique (senderToken) id refering to specific sendAndGet

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleUnsubscribeAndGetRequest

public void handleUnsubscribeAndGetRequest(java.lang.String subject,
                                           java.lang.String type,
                                           int id)
                                    throws cMsgException

Method to remove a subscribeAndGet request previously sent by a domain client.

Specified by:

handleUnsubscribeAndGetRequest in interface cMsgSubdomainInterface

Parameters:

subject - subject subscribed to

type - type subscribed to

id - unique id

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleSubscribeRequest

public void handleSubscribeRequest(java.lang.String subject,
                                   java.lang.String type,
                                   int id)
                            throws cMsgException

Method to handle a subscribe request sent by a domain client.

Specified by:

handleSubscribeRequest in interface cMsgSubdomainInterface

Parameters:

subject - subject subscribed to

type - type subscribed to

id - unique id

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleUnsubscribeRequest

public void handleUnsubscribeRequest(java.lang.String subject,
                                     java.lang.String type,
                                     int id)
                              throws cMsgException

Method to handle an unsubscribe request sent by a domain client.

Specified by:

handleUnsubscribeRequest in interface cMsgSubdomainInterface

Parameters:

subject - subject of subscription

type - type of subscription

id - unique id

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleShutdownClientsRequest

public void handleShutdownClientsRequest(java.lang.String client,
                                         boolean includeMe)
                                  throws cMsgException

Method to handle a request to shutdown clients sent by a domain client.

Specified by:

handleShutdownClientsRequest in interface cMsgSubdomainInterface

Parameters:

client - client(s) to be shutdown

includeMe - if true, this client may be shutdown too

Throws:

cMsgException - always throws an exception since this is a dummy implementation

handleClientShutdown

public void handleClientShutdown()
                          throws cMsgException

Method to handle a client or domain server (and therefore subdomain handler) shutdown.

Specified by:

handleClientShutdown in interface cMsgSubdomainInterface

Throws:

cMsgException - always throws an exception since this is a dummy implementation

hasSend

public boolean hasSend()

Method to tell if the "send" cMsg API function is implemented by this interface implementation in the "handleSendRequest" method.

Specified by:

hasSend in interface cMsgSubdomainInterface

Returns:

true if send implemented in "handleSendRequest"

hasSyncSend

public boolean hasSyncSend()

Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the "handleSyncSendRequest" method.

Specified by:

hasSyncSend in interface cMsgSubdomainInterface

Returns:

true if send implemented in "handleSyncSendRequest"

hasSubscribeAndGet

public boolean hasSubscribeAndGet()

Method to tell if the "subscribeAndGet" cMsg API function is implemented by this interface implementation in the "handleSubscribeAndGetRequest" method.

Specified by:

hasSubscribeAndGet in interface cMsgSubdomainInterface

Returns:

true if subscribeAndGet implemented in "handleSubscribeAndGetRequest"

hasSendAndGet

public boolean hasSendAndGet()

Method to tell if the "sendAndGet" cMsg API function is implemented by this interface implementation in the "handleSendAndGetRequest" method.

Specified by:

hasSendAndGet in interface cMsgSubdomainInterface

Returns:

true if sendAndGet implemented in "handleSendAndGetRequest"

hasSubscribe

public boolean hasSubscribe()

Method to tell if the "subscribe" cMsg API function is implemented by this interface implementation in the "handleSubscribeRequest" method.

Specified by:

hasSubscribe in interface cMsgSubdomainInterface

Returns:

true if subscribe implemented in "handleSubscribeRequest"

hasUnsubscribe

public boolean hasUnsubscribe()

Method to tell if the "unsubscribe" cMsg API function is implemented by this interface implementation in the "handleUnsubscribeRequest" method.

Specified by:

hasUnsubscribe in interface cMsgSubdomainInterface

Returns:

true if unsubscribe implemented in "handleUnsubscribeRequest"

hasShutdown

public boolean hasShutdown()

Method to tell if the "shutdown" cMsg API function is implemented by this interface implementation in the "handleShutdownClientsRequest" method.

Specified by:

hasShutdown in interface cMsgSubdomainInterface

Returns:

true if shutdown implemented in "handleShutdownClientsRequest"