org.jlab.coda.cMsg.common

Interface cMsgSubdomainInterface

All Known Implementing Classes:

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

public interface cMsgSubdomainInterface

This interface is an API for an object that a cMsg domain server uses to respond to client demands. An implementation of this interface handles all communication with a particular subdomain (such as SmartSockets or JADE agents). Implementors of this interface must understand that each client using cMsg will have its own handler object from a class implementing this interface. Several clients may concurrently use objects of the same class. Thus implementations must be thread-safe. Furthermore, when the name server shuts down, the method handleServerShutdown may be executed more than once for the same reason.

Version:

1.0

Author:

Carl Timmer

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.

Method Detail

setUDLRemainder

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.

Parameters:

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

Throws:

cMsgException - if cMsg error.

registerClient

void registerClient(cMsgClientInfo info)
             throws cMsgException

Method to register a domain client.

Parameters:

info - information about client

Throws:

cMsgException - if cMsg error.

handleSendRequest

void handleSendRequest(cMsgMessageFull message)
                throws cMsgException

Method to handle a message sent by a domain client.

Parameters:

message - message from sender

Throws:

cMsgException - if cMsg error.

handleSyncSendRequest

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.

Parameters:

message - message from sender

Returns:

response from subdomain handler

Throws:

cMsgException - if cMsg error.

handleSubscribeAndGetRequest

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.

Parameters:

subject - subject subscribed to

type - type subscribed to

id - unique id

Throws:

cMsgException - if cMsg error.

handleUnsubscribeAndGetRequest

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.

Parameters:

subject - subject subscribed to

type - type subscribed to

id - unique id

Throws:

cMsgException - if cMsg error.

handleSendAndGetRequest

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).

Parameters:

message - message requesting a response message

Throws:

cMsgException - if cMsg error.

handleUnSendAndGetRequest

void handleUnSendAndGetRequest(int id)
                        throws cMsgException

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

Parameters:

id - unique (senderToken) id refering to specific sendAndGet

Throws:

cMsgException - if cMsg error.

handleSubscribeRequest

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.

Parameters:

subject - subject subscribed to

type - type subscribed to

id - unique id

Throws:

cMsgException - if cMsg error.

handleUnsubscribeRequest

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.

Parameters:

subject - subject of subscription

type - type of subscription

id - unique id

Throws:

cMsgException - if cMsg error.

handleShutdownClientsRequest

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

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

Parameters:

client - client(s) to be shutdown

includeMe - if true, this client may be shutdown too

Throws:

cMsgException - if cMsg error.

handleClientShutdown

void handleClientShutdown()
                   throws cMsgException

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

Throws:

cMsgException - if cMsg error.

hasSend

boolean hasSend()

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

Returns:

true if send implemented in "handleSendRequest"

hasSyncSend

boolean hasSyncSend()

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

Returns:

true if send implemented in "handleSyncSendRequest"

hasSubscribeAndGet

boolean hasSubscribeAndGet()

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

Returns:

true if subscribeAndGet implemented in "handleSubscribeAndGetRequest"

hasSendAndGet

boolean hasSendAndGet()

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

Returns:

true if sendAndGet implemented in "handleSendAndGetRequest"

hasSubscribe

boolean hasSubscribe()

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

Returns:

true if subscribe implemented in "handleSubscribeRequest"

hasUnsubscribe

boolean hasUnsubscribe()

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

Returns:

true if unsubscribe implemented in "handleUnsubscribeRequest"

hasShutdown

boolean hasShutdown()

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

Returns:

true if shutdown implemented in "handleShutdownClientsRequest"