org.jlab.coda.cMsg.cMsgDomain.subdomains

Class Queue

java.lang.Object

org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

org.jlab.coda.cMsg.cMsgDomain.subdomains.Queue

All Implemented Interfaces:

cMsgSubdomainInterface

public class Queue
extends cMsgSubdomainAdapter

cMsg subdomain handler for Queue subdomain.

UDL: cMsg://host:port/Queue/myQueueName?driver=myDriver&url=myURL&account=myAccount&password=myPassword

e.g. cMsg://localhost/Queue/ejw?driver=com.mysql.jdbc.Driver&url=jdbc:mysql://halldweb1/test&account=wolin

Stores/retrieves cMsgMessageFull messages from SQL database. Gets database parameters from UDL. Supported databases so far: mySQL, PostgreSQL (not tested yet...).

Version:

1.0

Author:

Elliiott Wolin

Constructor Summary

Constructors

Constructor and Description
Queue()

Method Summary

Modifier and Type	Method and Description
void	handleClientShutdown() Close connection to database.
void	handleSendAndGetRequest(cMsgMessageFull msg) Returns message at head of queue.
void	handleSendRequest(cMsgMessageFull msg) Inserts message into SQL database table via JDBC.
int	handleSyncSendRequest(cMsgMessageFull msg) Inserts message into SQL database table via JDBC.
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	hasSyncSend() Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the "handleSyncSendRequest" method.
void	registerClient(cMsgClientInfo info) Creates separate database connection for each client connection.
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 org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

handleShutdownClientsRequest, handleSubscribeAndGetRequest, handleSubscribeRequest, handleUnSendAndGetRequest, handleUnsubscribeAndGetRequest, handleUnsubscribeRequest, hasShutdown, hasSubscribe, hasSubscribeAndGet, hasUnsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

Queue

public Queue()

Method Detail

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

Overrides:

hasSend in class cMsgSubdomainAdapter

Returns:

true

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

Overrides:

hasSendAndGet in class cMsgSubdomainAdapter

Returns:

true

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

Overrides:

hasSyncSend in class cMsgSubdomainAdapter

Returns:

true

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

Overrides:

setUDLRemainder in class cMsgSubdomainAdapter

Parameters:

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

Throws:

cMsgException - never

registerClient

public void registerClient(cMsgClientInfo info)
                    throws cMsgException

Creates separate database connection for each client connection. UDL contains driver name, database JDBC URL, account, password, and table name to use.

Specified by:

registerClient in interface cMsgSubdomainInterface

Overrides:

registerClient in class cMsgSubdomainAdapter

Parameters:

info - information about client

Throws:

cMsgException - if improper UDL, cannot connect to database, cannot get database metadata

handleSendRequest

public void handleSendRequest(cMsgMessageFull msg)
                       throws cMsgException

Inserts message into SQL database table via JDBC.

Specified by:

handleSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSendRequest in class cMsgSubdomainAdapter

Parameters:

msg - message from sender

Throws:

cMsgException - if sql error

handleSyncSendRequest

public int handleSyncSendRequest(cMsgMessageFull msg)
                          throws cMsgException

Inserts message into SQL database table via JDBC.

Specified by:

handleSyncSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSyncSendRequest in class cMsgSubdomainAdapter

Parameters:

msg - message from sender

Returns:

0 if successful, else 1

Throws:

cMsgException - never

handleSendAndGetRequest

public void handleSendAndGetRequest(cMsgMessageFull msg)
                             throws cMsgException

Returns message at head of queue.

Specified by:

handleSendAndGetRequest in interface cMsgSubdomainInterface

Overrides:

handleSendAndGetRequest in class cMsgSubdomainAdapter

Parameters:

msg - message to generate sendAndGet response to (contents ignored)

Throws:

cMsgException - if error reading database or delivering message to client

handleClientShutdown

public void handleClientShutdown()
                          throws cMsgException

Close connection to database.

Specified by:

handleClientShutdown in interface cMsgSubdomainInterface

Overrides:

handleClientShutdown in class cMsgSubdomainAdapter

Throws:

cMsgException - if close fails.