org.jlab.coda.cMsg.cMsgDomain.server

Class cMsgServerBridge

java.lang.Object

org.jlab.coda.cMsg.cMsgDomain.server.cMsgServerBridge

class cMsgServerBridge
extends java.lang.Object

This class acts to bridge two cMsg domain servers by existing in one server and becoming a client of another cMsg domain server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	cMsgServerBridge.SendAndGetCallback This class defines the callback to be run when a sendAndGet response message arrives from a bridge connection and must be passed on to a client(s).
(package private) static class	cMsgServerBridge.SubscribeCallback This class defines the callback to be run when a message matching our subscription arrives from a bridge connection and must be passed on to a client(s).

Field Summary

Fields

Modifier and Type	Field and Description
(package private) cMsgServerClient	client Client of cMsg server this object is a bridge to.
(package private) java.lang.String	serverName Name of cMsg server ("host:port") this server is connected to.

Constructor Summary

Constructors

Constructor and Description
cMsgServerBridge(cMsgNameServer nameServer, java.lang.String serverName, int thisNsTcpPort, int thisNsUdpPort) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	cloudLock(int delay) This method grabs the cloud lock of a connected server in order to add this server to the cMsg domain server cloud.
(package private) void	cloudUnlock() This method releases the cloud lock of a connected server when adding this server to the cMsg domain server cloud.
java.util.Set<java.lang.String>	connect(boolean isOriginator, java.lang.String cloudPassword, java.lang.String clientPassword, boolean multicasting) Method to connect to server.
(package private) java.lang.String[]	getClientNamesAndNamespaces() This method gets the names of all the local clients (not servers) of another cMsg domain server.
(package private) int	getCloudStatus() This method gets the cloud status of the server this server is connected to.
static cMsgCallbackAdapter	getSendAndGetCallback(int id, int sysMsgId) Get a callback for a sendAndGet call.
static cMsgCallbackAdapter	getSubAndGetCallback() This method returns a reference to the one callback needed for subscribes and subAndGets to propogate messages back to original client.
void	printSizes() This method prints sizes of maps for debugging purposes.
(package private) boolean	registrationLock(int delay) This method grabs the registration lock (for adding a client) of another cMsg domain server.
(package private) void	registrationUnlock() This method releases the registration lock (when adding a client) of another cMsg domain server.
void	sendAndGet(cMsgMessage msg, java.lang.String namespace, cMsgCallbackInterface cb) Method to do a sendAndGet of a message of subject and type to another cMsg server.
(package private) void	setCloudStatus(int cloudStatus) This method locally sets the cloud status of the server this server is connected to through this bridge.
void	setServerName(java.lang.String serverName) Sets the name of the server this bridge's client is connected to.
void	shutdownClients(java.lang.String clientName, boolean includeMe) Method to shutdown the given clients.
void	shutdownServer() Method to shutdown the given server this client is connected to.
void	subscribe(java.lang.String subject, java.lang.String type, java.lang.String namespace) Method for a server to subscribe to receive messages of a subject and type from another cMsg server.
void	subscribeAndGet(java.lang.String subject, java.lang.String type, java.lang.String namespace, cMsgCallbackInterface cb) Method for a subscribeAndGet (a one-time subscribe) on another cMsg server.
(package private) void	thisServerCloudStatus(int status) This method tells the server this server is connected to, what cloud status this server has.
void	unSendAndGet(int id) Method to remove a previous sendAndGet to receive a message of a subject and type from the domain server.
void	unsubscribe(java.lang.String subject, java.lang.String type, java.lang.String namespace) Method for a server to unsubscribe for messages of a subject and type from another cMsg server.
void	unsubscribeAndGet(java.lang.String subject, java.lang.String type, java.lang.String namespace, cMsgCallbackInterface cb) Method to remove a previous subscribeAndGet on another cMsg server.

Methods inherited from class java.lang.Object

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

Field Detail

client

cMsgServerClient client

Client of cMsg server this object is a bridge to. It is the means of connection.

serverName

java.lang.String serverName

Name of cMsg server ("host:port") this server is connected to.

Constructor Detail

cMsgServerBridge

public cMsgServerBridge(cMsgNameServer nameServer,
                        java.lang.String serverName,
                        int thisNsTcpPort,
                        int thisNsUdpPort)
                 throws cMsgException

Constructor.

Parameters:

nameServer - THIS name server (the one using this object)

serverName - name of server to connect to in the form "host:port"

thisNsTcpPort - the TCP port THIS name server is listening on

thisNsUdpPort - the Udp multicast port THIS name server is listening on

Throws:

cMsgException - if local host name cannot be found

Method Detail

printSizes

public void printSizes()

This method prints sizes of maps for debugging purposes.

getSubAndGetCallback

public static cMsgCallbackAdapter getSubAndGetCallback()

This method returns a reference to the one callback needed for subscribes and subAndGets to propogate messages back to original client.

Returns:

callback object for propogating messages back to original client

getSendAndGetCallback

public static cMsgCallbackAdapter getSendAndGetCallback(int id,
                                                        int sysMsgId)

Get a callback for a sendAndGet call.

Parameters:

id - incoming message's senderToken needs to be changed to this value

sysMsgId - incoming message's sysMsgId needs to be changed to this value

Returns:

sendAndGet callback

connect

public java.util.Set<java.lang.String> connect(boolean isOriginator,
                                               java.lang.String cloudPassword,
                                               java.lang.String clientPassword,
                                               boolean multicasting)
                                        throws cMsgException

Method to connect to server.

Parameters:

isOriginator - true if originating the connection between the 2 servers and false if this is the response or reciprocal connection

cloudPassword - password for connecting to a server in a particular cloud

clientPassword - password for a client connecting to this server

multicasting - true if multicasting to find server since host unknown

Returns:

set of servers (names of form "host:port") that the server we're connecting to is already connected with

Throws:

cMsgException - if there are problems parsing the UDL or communication problems with the server

setServerName

public void setServerName(java.lang.String serverName)

Sets the name of the server this bridge's client is connected to. This is used when multicasting to find the server and the host is not immediately known in order to construct the name (as host:port).

Parameters:

serverName - name of the server this bridge's client is connected to.

getCloudStatus

int getCloudStatus()

This method gets the cloud status of the server this server is connected to. Possible values are cMsgNameServer.INCLOUD, cMsgNameServer.NONCLOUD, orcMsgNameServer.BECOMINGCLOUD.

Returns:

cloud status

setCloudStatus

void setCloudStatus(int cloudStatus)

This method locally sets the cloud status of the server this server is connected to through this bridge. Possible values are cMsgNameServer.INCLOUD, cMsgNameServer.NONCLOUD, orcMsgNameServer.BECOMINGCLOUD.

Parameters:

cloudStatus - cloud status of the server this is a bridge to

thisServerCloudStatus

void thisServerCloudStatus(int status)
                    throws java.io.IOException

This method tells the server this server is connected to, what cloud status this server has.

Parameters:

status - cMsgNameServer.INCLOUD, .NONCLOUD, or .BECOMINGCLOUD

Throws:

java.io.IOException - if communication error with server

cloudLock

boolean cloudLock(int delay)
           throws java.io.IOException

This method grabs the cloud lock of a connected server in order to add this server to the cMsg domain server cloud.

Parameters:

delay - time in milliseconds to wait for the lock before timing out

Returns:

true if lock was obtained, else false

Throws:

java.io.IOException - if communication error with server

cloudUnlock

void cloudUnlock()
          throws java.io.IOException

This method releases the cloud lock of a connected server when adding this server to the cMsg domain server cloud.

Throws:

java.io.IOException - if communication error with server

registrationLock

boolean registrationLock(int delay)
                  throws java.io.IOException

This method grabs the registration lock (for adding a client) of another cMsg domain server.

Parameters:

delay - time in milliseconds to wait for the lock before timing out

Returns:

true if lock was obtained, else false

Throws:

java.io.IOException - if communication error with server

registrationUnlock

void registrationUnlock()
                 throws java.io.IOException

This method releases the registration lock (when adding a client) of another cMsg domain server.

Throws:

java.io.IOException - if communication error with server

getClientNamesAndNamespaces

java.lang.String[] getClientNamesAndNamespaces()
                                        throws java.io.IOException

This method gets the names of all the local clients (not servers) of another cMsg domain server.

Returns:

array of client names

Throws:

java.io.IOException - if communication error with server

subscribe

public void subscribe(java.lang.String subject,
                      java.lang.String type,
                      java.lang.String namespace)
               throws java.io.IOException

Method for a server to subscribe to receive messages of a subject and type from another cMsg server. The combination of arguments must be unique. In other words, only 1 subscription is allowed for a given set of subject, type, callback, and userObj.

Parameters:

subject - message subject

type - message type

namespace - message namespace

Throws:

java.io.IOException - there are communication problems with the server

unsubscribe

public void unsubscribe(java.lang.String subject,
                        java.lang.String type,
                        java.lang.String namespace)
                 throws java.io.IOException

Method for a server to unsubscribe for messages of a subject and type from another cMsg server.

Parameters:

subject - message subject

type - message type

namespace - message namespace

Throws:

java.io.IOException - there are communication problems with the server

sendAndGet

public void sendAndGet(cMsgMessage msg,
                       java.lang.String namespace,
                       cMsgCallbackInterface cb)
                throws java.io.IOException

Method to do a sendAndGet of a message of subject and type to another cMsg server.

Parameters:

msg - message sent to server

namespace - message namespace

cb - callback for response to sendAndGet request

Throws:

java.io.IOException - if there are communication problems with the server

unSendAndGet

public void unSendAndGet(int id)
                  throws java.io.IOException

Method to remove a previous sendAndGet to receive a message of a subject and type from the domain server. This method is only called when a sendAndGet times out and the server must be told to forget about the get.

Parameters:

id - receiverSubscribeId of original message sent in sendAndGet

Throws:

java.io.IOException - if there are communication problems with the server

subscribeAndGet

public void subscribeAndGet(java.lang.String subject,
                            java.lang.String type,
                            java.lang.String namespace,
                            cMsgCallbackInterface cb)
                     throws java.io.IOException

Method for a subscribeAndGet (a one-time subscribe) on another cMsg server.

Parameters:

subject - subject of message desired from server

type - type of message desired from server

namespace - message namespace

cb - callback

Throws:

java.io.IOException - there are communication problems with the server

unsubscribeAndGet

public void unsubscribeAndGet(java.lang.String subject,
                              java.lang.String type,
                              java.lang.String namespace,
                              cMsgCallbackInterface cb)
                       throws java.io.IOException

Method to remove a previous subscribeAndGet on another cMsg server. This method is only called when a subscribeAndGet times out and the server must be told to forget about the subscribeAndGet call.

Parameters:

subject - subject of message desired from server

type - type of message desired from server

namespace - message namespace

cb - callback

Throws:

java.io.IOException - there are communication problems with the server

shutdownClients

public void shutdownClients(java.lang.String clientName,
                            boolean includeMe)
                     throws java.io.IOException

Method to shutdown the given clients. Wildcards used to match client names with the given string.

Parameters:

clientName - client(s) to be shutdown

includeMe - if true, it is permissible to shutdown calling client

Throws:

java.io.IOException - if there are communication problems with the server

shutdownServer

public void shutdownServer()
                    throws java.io.IOException

Method to shutdown the given server this client is connected to.

Throws:

java.io.IOException - if there are communication problems with the server