cgl.narada.protocol
Class ClientConnectionHandler

java.lang.Object
  cgl.narada.protocol.ClientConnectionHandler

All Implemented Interfaces:

ProtocolDebugFlags

public class ClientConnectionHandler
extends Object
implements ProtocolDebugFlags

This class is responsible for dealing with clients which are connected to a server node. Specifically this class is responsible for

• The generation of client addresses (which include the servers address too).
• Deal with requests for interest in subscriptions
• Route relevant events to the clients, based on their profiles.

  Field Summary

  Fields inherited from interface cgl.narada.protocol.ProtocolDebugFlags

  BrokerLocatorCommunicator_Debug, ClientConnectionHandler_Debug, Connection_Debug, ConnectionPropagation_Debug, Destinations_Debug, DuplicateDetection_Debug, EventBuffer_Debug, EventRoutingProtocol_Debug, Gateway_Debug, GatewayInfo_Debug, GatewayPropagation_Debug, JmsProfilePropagation_Debug, LinkCostMatrix_Debug, NodeAdditionProtocol_Debug, NodeAddress_Debug, Path_Debug, PersistentEventRouting_Debug, ProfilePropagationProtocol_Debug, ProtocolException_Debug, ProtocolHandler_Debug, ProtocolID_Debug, ProtocolIDFactory_Debug, RoutingCache_Debug, RtpEventRoutingProtocol_Debug, RtpProfilePropagation_Debug, SecureMessageRouting_Debug, TagValueEventRoutingProtocol_Debug, TagValueProfilePropagation_Debug, XmlEventRoutingProtocol_Debug, XPathProfilePropagation_Debug

  Constructor Summary

  ClientConnectionHandler(ProtocolHandler protocolHandler, int connectionLimit)
  Constructor for the Client connection handler

  Method Summary

  void	connectionToClientLost(Object clientIdentifier)
  int	getConcurrentConnections() Returns the number of active concurrent connections
  int	getConcurrentConnectionsLimit() Returns the limit on the active concurrent connections
  static void	main(String[] args) Testing the application
  void	processClientAddressRequest(String clientNode, byte[] data) This method is responsible for handling client address requests and the creation of responses to these clients in response to their address requests
  void	processClientRegistration(byte[] registerBytes, String clientNode)
  void	routePayloadToEntity(Object clientKey, byte[] data)
  void	sendMessageToClient(int clientId, String clientNode, byte[] msg) Sends the message (msg) to the appropriate client identified by the clientId and clientNode combination
  void	sendToClientNode(byte[] data, int destination) This method provides for routing information for one client connected to the server node.
  void	sendToClientNodes(byte[] data, ArrayList destinations, int ignoreDestination) This method provides for routing information to clients that are connected to the server node.
  void	sendToClientNodes(byte[] data, Hashtable destinations) This method provides for routing information to clients that are connected to the server node.
  void	sendToClientNodes(byte[] data, Hashtable destinations, int ignoreDestination)
  void	setNodeDestination(Destinations destination) The invocation of this method implies that the node in question has been assigned a node address by the system, and also that this node is ready to process connection requests from clients and assign them addresses.
  void	setVertexNode(Gateway vertexNode) This method sets the vertex node for the node in question.

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  ClientConnectionHandler

  public ClientConnectionHandler(ProtocolHandler protocolHandler,
                                 int connectionLimit)

  Constructor for the Client connection handler

  Parameters:

  protocolHandler - Reference to the protocolHandler class

  Method Detail

  setNodeDestination

  public void setNodeDestination(Destinations destination)

  The invocation of this method implies that the node in question has been assigned a node address by the system, and also that this node is ready to process connection requests from clients and assign them addresses.

  Parameters:

  destination - The destination for the node in question

  setVertexNode

  public void setVertexNode(Gateway vertexNode)

  This method sets the vertex node for the node in question. We need this since we map the unassigned nodes to gateways within the transport layer. We thus need a handle to the vertexNode when we are re-mapping the client connections as gateways at level (-1).

  Parameters:

  vertexNode - The vertex Node of the connectivity graph at this node.

  getConcurrentConnections

  public int getConcurrentConnections()

  Returns the number of active concurrent connections

  Returns:

  Number of active connections

  getConcurrentConnectionsLimit

  public int getConcurrentConnectionsLimit()

  Returns the limit on the active concurrent connections

  processClientRegistration

  public void processClientRegistration(byte[] registerBytes,
                                        String clientNode)

  connectionToClientLost

  public void connectionToClientLost(Object clientIdentifier)

  sendMessageToClient

  public void sendMessageToClient(int clientId,
                                  String clientNode,
                                  byte[] msg)

  Sends the message (msg) to the appropriate client identified by the clientId and clientNode combination

  Parameters:

  clientId -

  clientNode -

  msg -

  processClientAddressRequest

  public void processClientAddressRequest(String clientNode,
                                          byte[] data)

  This method is responsible for handling client address requests and the creation of responses to these clients in response to their address requests

  Parameters:

  data - The address request format.

  sendToClientNodes

  public void sendToClientNodes(byte[] data,
                                Hashtable destinations)

  This method provides for routing information to clients that are connected to the server node. Given a list of clients to which data needs to be routed to, this method routes data to each client conatined within the encapsulated destination list.

  Parameters:

  data - The data that needs to be routed.

  destinations - The list of clients to which this information needs to be routed.

  sendToClientNodes

  public void sendToClientNodes(byte[] data,
                                Hashtable destinations,
                                int ignoreDestination)

  sendToClientNodes

  public void sendToClientNodes(byte[] data,
                                ArrayList destinations,
                                int ignoreDestination)

  This method provides for routing information to clients that are connected to the server node. Given a list of clients to which data needs to be routed to, this method routes data to each client conatined within the encapsulated destination list.

  Parameters:

  data - The data that needs to be routed.

  destinations - The list of clients to which this information needs to be routed.

  sendToClientNode

  public void sendToClientNode(byte[] data,
                               int destination)

  This method provides for routing information for one client connected to the server node. This method routes data to each the given client

  Parameters:

  data - The data that needs to be routed.

  destination - The clientID of the client to which this information needs to be routed.

  routePayloadToEntity

  public void routePayloadToEntity(Object clientKey,
                                   byte[] data)

  main

  public static void main(String[] args)

  Testing the application