org.jlab.coda.cMsg.cMsgDomain.subdomains

Class Database

java.lang.Object

org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

org.jlab.coda.cMsg.cMsgDomain.subdomains.Database

All Implemented Interfaces:

cMsgSubdomainInterface

public class Database
extends cMsgSubdomainAdapter

cMsg subdomain handler for database subdomain. Executes insert,update,delete sql statement from msg payload. Select not supported as there is no mechanism to respond. Gets database parameters from UDL.

UDL:

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

Version:

1.0

Author:

Elliott Wolin

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.sql.Connection	myCon database access objects.
(package private) java.sql.Statement	myStmt

Constructor Summary

Constructors

Constructor and Description
Database()

Method Summary

Modifier and Type	Method and Description
void	addArrayListToPayload(java.lang.String name, int type, java.util.ArrayList al, cMsgMessageFull msg) Adds ArrayList to message payload.
void	addDataToArrayList(java.sql.ResultSet rs, int col, int type, java.util.ArrayList al) Adds query result data to ArrayList.
void	handleClientShutdown() Method to handle a client or domain server (and therefore subdomain handler) shutdown.
void	handleSendAndGetRequest(cMsgMessageFull msg) Executes sql statement in message text field, returns resultset as payload arrays.
int	handleSyncSendRequest(cMsgMessageFull msg) Executes sql statement in message text field.
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

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

Methods inherited from class java.lang.Object

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

Field Detail

myCon

java.sql.Connection myCon

database access objects.

myStmt

java.sql.Statement myStmt

Constructor Detail

Database

public Database()

Method Detail

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

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

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, and password Column names are fixed (domain, sender, subject, etc.).

Specified by:

registerClient in interface cMsgSubdomainInterface

Overrides:

registerClient in class cMsgSubdomainAdapter

Parameters:

info - information about client

Throws:

cMsgException - upon error

handleSyncSendRequest

public int handleSyncSendRequest(cMsgMessageFull msg)
                          throws cMsgException

Executes sql statement in message text field.

Specified by:

handleSyncSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSyncSendRequest in class cMsgSubdomainAdapter

Parameters:

msg - message from sender

Returns:

zero on success, non-zero on error

Throws:

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

handleSendAndGetRequest

public void handleSendAndGetRequest(cMsgMessageFull msg)
                             throws cMsgException

Executes sql statement in message text field, returns resultset as payload arrays.

Specified by:

handleSendAndGetRequest in interface cMsgSubdomainInterface

Overrides:

handleSendAndGetRequest in class cMsgSubdomainAdapter

Parameters:

msg - Message to respond to

Throws:

cMsgException - if error reading database or delivering message to client

addDataToArrayList

public void addDataToArrayList(java.sql.ResultSet rs,
                               int col,
                               int type,
                               java.util.ArrayList al)

Adds query result data to ArrayList.

Parameters:

rs - ResultSet containing results

col - Column number

type - JDBC data type

al - ArrayList to add to

addArrayListToPayload

public void addArrayListToPayload(java.lang.String name,
                                  int type,
                                  java.util.ArrayList al,
                                  cMsgMessageFull msg)

Adds ArrayList to message payload.

Parameters:

name - Column name

type - JDBC data type

al - ArrayList containing results

msg - Message

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

Overrides:

handleClientShutdown in class cMsgSubdomainAdapter

Throws:

cMsgException - if sql error