com.putable.server

Class NetPuzlClientProxy

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.putable.xmlhandler.XMLHandler

com.putable.xmlhandler.ServerXMLHandler

com.putable.server.NetPuzlClientProxy

All Implemented Interfaces:

ServerTagParser, java.lang.Runnable, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class NetPuzlClientProxy
extends ServerXMLHandler
implements java.lang.Runnable

NetPuzlClientProxy handles all of the communication between client and a server by using the XML tags. Implements cache of the matrix status on a client side so it eliminates unnecessary tags being send to the client to save the bandwidth.

Version:

1.0

Author:

Heineken

See Also:

ServerXMLHandler

Field Summary

Fields

Modifier and Type	Field and Description
private Agent	agent Agent object of the client connected
private java.lang.Thread	agentThread Thread for the parser
private boolean	canKillThread A flag if we can kill this thread.
private java.util.Map<ObjID,NetPuzlObject>	clientCache The client's cache of NetPuzlObjects and their associated object IDs
private java.net.Socket	clientSocket Client Socket to communicate with the clients
private org.xml.sax.InputSource	input input source for the parser
private SoftCloseInputStream	is Data stream from server
private boolean	isLoggedin Once the tags come in to check if the client is logged in
private NetPuzlServer	netPuzlServer The NetPuzlServer of this client proxy
private java.io.DataOutputStream	os Data Stream to send tags to server
private org.xml.sax.XMLReader	parser The Server XML Parser
private java.lang.String	username The received username of the Agent

Fields inherited from class com.putable.xmlhandler.XMLHandler

attr

Constructor Summary

Constructors

Constructor and Description
NetPuzlClientProxy(java.net.Socket s, NetPuzlServer nps) Starts up a new client proxy

Method Summary

Modifier and Type	Method and Description
boolean	canKill() Returns true if the thread is ready to be killed
private void	disconnectProcess(java.lang.String msg) Attempts to close the connection properly, by sending a logged-in, logged-out tag and the closing server tag.
protected void	endOfXMLDocument() Shuts down the input since the end of XML document have been reached or closes the socket if the output have already been shutdown
private void	flushOutput() Flushes the output stream on a client socket
Agent	getAgent() Returns the agent
NetPuzlServer	getNetPuzlServer() Gets the NetPuzlServer of this NetPuzl client proxy
java.lang.String	getUserName() Returns the username
private void	initAgentThread()
boolean	isLoggedIn() Returns true if is logged-in, false otherwise
void	killThread()
protected void	receivedCmd(TCmd tag) Called by XMLHandler when cmd tag received.
protected void	receivedLogin(TLogin tag) Called by XMLHandler when login tag received.
protected void	receivedLogout(TLogout logoutTag) Called by XMLHandler when logout tag received.
protected void	receivedXrequest(TXrequest tag) Method is called when Tag type XREQUEST is received from the client.
void	run() Runs the parser
private boolean	sendToClient(java.lang.String msg) Sends the actual string to the client, also appends it to the log of send XML Document
boolean	sendToClient(Tag tag) Method designed to send XML tags over the network to the client Checks the cache if the client knows about the change in his matrix
java.lang.String	toString() Client Proxy to string

Methods inherited from class com.putable.xmlhandler.ServerXMLHandler

endElement, getHeader, parseClientTag, parseCmdTag, parseLoginTag, parseLogoutTag, parseTag, parseXrequestTag

Methods inherited from class com.putable.xmlhandler.XMLHandler

characters, convertToColor, endDocument, getData, getType, getVersion, parseHexImage, startElement

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Detail

netPuzlServer

private NetPuzlServer netPuzlServer

The NetPuzlServer of this client proxy

clientCache

private java.util.Map<ObjID,NetPuzlObject> clientCache

The client's cache of NetPuzlObjects and their associated object IDs

parser

private org.xml.sax.XMLReader parser

The Server XML Parser

os

private java.io.DataOutputStream os

Data Stream to send tags to server

is

private SoftCloseInputStream is

Data stream from server

clientSocket

private java.net.Socket clientSocket

Client Socket to communicate with the clients

input

private org.xml.sax.InputSource input

input source for the parser

agentThread

private java.lang.Thread agentThread

Thread for the parser

isLoggedin

private boolean isLoggedin

Once the tags come in to check if the client is logged in

username

private java.lang.String username

The received username of the Agent

agent

private Agent agent

Agent object of the client connected

canKillThread

private boolean canKillThread

A flag if we can kill this thread.

Constructor Detail

NetPuzlClientProxy

public NetPuzlClientProxy(java.net.Socket s,
                          NetPuzlServer nps)

Starts up a new client proxy

Parameters:

s - the socket of the end point the client is connecting to

nps - the server state

Method Detail

initAgentThread

private void initAgentThread()

disconnectProcess

private void disconnectProcess(java.lang.String msg)

Attempts to close the connection properly, by sending a logged-in, logged-out tag and the closing server tag. Shuts down the output, since thats the last possible tag that can be send in the XML document, or closes the socket if the input is already is shutdown.

Parameters:

msg - message that will be included in the logged-out tag

endOfXMLDocument

protected void endOfXMLDocument()

Shuts down the input since the end of XML document have been reached or closes the socket if the output have already been shutdown

Specified by:

endOfXMLDocument in class XMLHandler

flushOutput

private void flushOutput()

Flushes the output stream on a client socket

getAgent

public Agent getAgent()

Returns the agent

Returns:

the agent

getNetPuzlServer

public NetPuzlServer getNetPuzlServer()

Gets the NetPuzlServer of this NetPuzl client proxy

Returns:

The NetPuzlServer of this NetPuzl client proxy

getUserName

public java.lang.String getUserName()

Returns the username

Returns:

the username

isLoggedIn

public boolean isLoggedIn()

Returns true if is logged-in, false otherwise

Returns:

logged in status

canKill

public boolean canKill()

Returns true if the thread is ready to be killed

Returns:

true if we can kill the thread false otherwise

killThread

public void killThread()

receivedCmd

protected void receivedCmd(TCmd tag)
                    throws org.xml.sax.SAXException

Called by XMLHandler when cmd tag received. Creates a request to the matrix to adjust it appropriately

Specified by:

receivedCmd in class ServerXMLHandler

Parameters:

tag - Tag that was received

Throws:

org.xml.sax.SAXException

See Also:

TCmd

receivedLogin

protected void receivedLogin(TLogin tag)
                      throws org.xml.sax.SAXException

Called by XMLHandler when login tag received. Creates a request to the matrix to adjust it appropriately. Ends the connection if the tag is out of place or if server is not open

Specified by:

receivedLogin in class ServerXMLHandler

Parameters:

tag - Tag that was received

Throws:

org.xml.sax.SAXException - if agent is already logged-in

See Also:

TLogin

receivedLogout

protected void receivedLogout(TLogout logoutTag)
                       throws org.xml.sax.SAXException

Called by XMLHandler when logout tag received. Creates a request to the matrix to adjust it appropriately. Calls disconnect routine.

Specified by:

receivedLogout in class ServerXMLHandler

Parameters:

logoutTag - Tag that was received

Throws:

org.xml.sax.SAXException - if agent is not logged-in

See Also:

TLogout

receivedXrequest

protected void receivedXrequest(TXrequest tag)
                         throws org.xml.sax.SAXException

Description copied from class: ServerXMLHandler

Method is called when Tag type XREQUEST is received from the client. Tag is parsed and created, after that it needs to be handled according to the specs for NetPuzl.

Specified by:

receivedXrequest in class ServerXMLHandler

Parameters:

tag - Tag that was received

Throws:

org.xml.sax.SAXException - if problem with parsing a tag has occurred

See Also:

TXrequest

run

public void run()

Runs the parser

Specified by:

run in interface java.lang.Runnable

sendToClient

private boolean sendToClient(java.lang.String msg)

Sends the actual string to the client, also appends it to the log of send XML Document

Parameters:

msg - tag to be send.

Returns:

true in case of success, false otherwise.

sendToClient

public boolean sendToClient(Tag tag)

Method designed to send XML tags over the network to the client Checks the cache if the client knows about the change in his matrix

Parameters:

tag - to be send

Returns:

true in case of success, false otherwise

toString

public java.lang.String toString()

Client Proxy to string

Overrides:

toString in class java.lang.Object

Returns:

the String representation of client i.e. Client Proxy: 1,2... etc...