NetPuzlClient

java.lang.Object
- org.xml.sax.helpers.DefaultHandler
- - com.putable.xmlhandler.XMLHandler
  - - com.putable.xmlhandler.ClientXMLHandler
    - - com.putable.client.NetPuzlClient

All Implemented Interfaces:

ClientTagParser, java.lang.Runnable, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
```
public class NetPuzlClient
extends ClientXMLHandler
implements java.lang.Runnable
```
NetPuzlClient is fully responsible for all of the communication with a server.

Version:

1.0

Author:

Heineken

See Also:

ClientXMLHandler

Field Summary

Fields
Modifier and Type	Field and Description
`private ObjID`	`agentId` The ObjID of the agent that is assiciated with this client
`private java.util.Map<ObjID,NetPuzlObject>`	`cache` The cache/symbol table of NetPuzlObjects and their associated object IDs
`private java.util.Calendar`	`cal` A Calender used for logs
`private java.lang.Thread`	`clientThread` New thread which fires up the XML Parser
`private ClientMatrix`	`currentMatrix` The matrix this client is connected to
`private java.lang.String`	`group` The group name whose sever you are connecting to
`private Gui`	`gui` A reference to the Gui that is displaying for this client
`private org.xml.sax.InputSource`	`input` InputStream for the parser
`private SoftCloseInputStream`	`is` Get input stream from server
`private boolean`	`isConnected` A boolean to tell if you are connected to the server
`private boolean`	`isLoggedIn` A boolean to tell if the client is logged in or not
`private java.io.FileOutputStream`	`logOS` Logs the document being send to the server
`private java.io.DataOutputStream`	`os` Write to the server
`private org.xml.sax.XMLReader`	`parser`
`private java.text.SimpleDateFormat`	`sdf` A SimpleDateFormat used for logs
`private java.net.Socket`	`serverSocket` Client socket used to communicate with server
`private TServer.SStatus`	`serverStatus` The connection status of the server

Fields inherited from class com.putable.xmlhandler.XMLHandler
attr

Constructor Summary

Constructors
Constructor and Description
`NetPuzlClient(java.lang.String serverAddress, int port)` Constructs the NetPuzlClient, by connecting to the NetPuzl server and starting the XML Parser for communication.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private Attributes`	`createAttributesFromSetTag(TSet tag)` This method creates a new Attributes used for when you receive a set tag for an object
`private void`	`createNetPuzlObjectFromTag(TSet tag, Attributes attributes)` This method creates a NetPuzlObject from a TSet tag and an Attributes.
`protected void`	`endOfXMLDocument()` Closes the socket, since server closing tag is the last piece of the communication.
`private void`	`errorDisconnect(java.lang.String msg)` Attempts to close the connection properly if the server status is opened, by sending a logout tag and the closing client tag ie.
`private void`	`flushOutput()` Flushes the server OuputStream os.
`ObjID`	`getAgentId()` Returns current agent
`java.util.Map<ObjID,NetPuzlObject>`	`getCache()` Returns the cache
`ClientMatrix`	`getCurrentMatrix()` Returns current matrix
`boolean`	`getLoggedIn()` Returns login status
`TServer.SStatus`	`getServerStatus()` Returns a status of the server
`private void`	`initThread()`
`boolean`	`isConnected()` Returns the connection status
`static void`	`main(java.lang.String[] args)` Starts the client
`protected void`	`receivedHearTag(THear tag)` Method is called when Tag type HEAR is received from the server.
`protected void`	`receivedLoggedInTag(TLoggedIn tag)` Method is called when Tag type LOGGED_IN is received from the server.
`protected void`	`receivedLoggedOutTag(TLoggedOut tag)` Method is called when Tag type LOGGED_OUT is received from the server.
`protected void`	`receivedServerTag(TServer tag)` Method is called when Tag type SERVER is received from the server.
`protected void`	`receivedSetTag(TSet tag)` Method is called when Tag type SET is received from the server.
`protected void`	`receivedXresponseTag(TXresponse tag)` Method is called when Tag type XRESPONSE is received from the server.
`void`	`run()` Runs the parser
`private boolean`	`sendToServer(java.lang.String msg)` Sends a string to the server
`boolean`	`sendToServer(Tag tag)` Send a tag to the server
`void`	`setCurrentMatrix(ClientMatrix currentMatrix)`
`private boolean`	`startConnection(java.lang.String _str_serverAddress, int port)` Start a connection to the server

Methods inherited from class com.putable.xmlhandler.ClientXMLHandler
endElement, getHeader, parseHearTag, parseLoggedInTag, parseLoggedOutTag, parseServerTag, parseSetTag, parseTag, parseXresponseTag

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, toString, wait, wait, wait

- Field Detail
  - clientThread
```
private java.lang.Thread clientThread
```
    New thread which fires up the XML Parser
  - os
```
private java.io.DataOutputStream os
```
    Write to the server
  - logOS
```
private java.io.FileOutputStream logOS
```
    Logs the document being send to the server
  - is
```
private SoftCloseInputStream is
```
    Get input stream from server
  - input
```
private org.xml.sax.InputSource input
```
    InputStream for the parser
  - serverSocket
```
private java.net.Socket serverSocket
```
    Client socket used to communicate with server
  - parser
```
private org.xml.sax.XMLReader parser
```
  - currentMatrix
```
private ClientMatrix currentMatrix
```
    The matrix this client is connected to
  - agentId
```
private ObjID agentId
```
    The ObjID of the agent that is assiciated with this client
  - isLoggedIn
```
private boolean isLoggedIn
```
    A boolean to tell if the client is logged in or not
  - serverStatus
```
private TServer.SStatus serverStatus
```
    The connection status of the server
  - isConnected
```
private boolean isConnected
```
    A boolean to tell if you are connected to the server
  - cache
```
private java.util.Map<ObjID,NetPuzlObject> cache
```
    The cache/symbol table of NetPuzlObjects and their associated object IDs
  - gui
```
private Gui gui
```
    A reference to the Gui that is displaying for this client
  - cal
```
private java.util.Calendar cal
```
    A Calender used for logs
  - sdf
```
private java.text.SimpleDateFormat sdf
```
    A SimpleDateFormat used for logs
  - group
```
private java.lang.String group
```
    The group name whose sever you are connecting to
- Constructor Detail
  - NetPuzlClient
```
public NetPuzlClient(java.lang.String serverAddress,
                     int port)
              throws java.io.IOException
```
    Constructs the NetPuzlClient, by connecting to the NetPuzl server and starting the XML Parser for communication.
    
    Parameters:
    
    serverAddress - address of the server
    
    port - server is listening on
    
    Throws:
    
    java.io.IOException - if cannot connect to the server
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
    Starts the client
    
    Parameters:
    
    args - Command like arguments are not used
  - initThread
```
private void initThread()
```
  - createAttributesFromSetTag
```
private Attributes createAttributesFromSetTag(TSet tag)
```
    This method creates a new Attributes used for when you receive a set tag for an object
    
    Parameters:
    
    tag - The TSet tag that is used for setting the attributes
    
    Returns:
    
    A new Attributes object based on the set tag.
  - createNetPuzlObjectFromTag
```
private void createNetPuzlObjectFromTag(TSet tag,
                                        Attributes attributes)
```
    This method creates a NetPuzlObject from a TSet tag and an Attributes. It also adds the NetPuzlObject to a list on the gui based on what type of NetPuzlObject it is
    
    Parameters:
    
    tag - The set tag used for creation
    
    attributes - The Attributes used for creation
  - endOfXMLDocument
```
protected void endOfXMLDocument()
```
    Closes the socket, since server closing tag is the last piece of the communication.
    
    Specified by:
    
    endOfXMLDocument in class XMLHandler
  - errorDisconnect
```
private void errorDisconnect(java.lang.String msg)
```
    Attempts to close the connection properly if the server status is opened, by sending a logout tag and the closing client tag ie. ending XML document properly. Closes the socket.
    
    Parameters:
    
    msg - message that will be included in the logout tag
  - flushOutput
```
private void flushOutput()
```
    Flushes the server OuputStream os. Should be call when output is required on the server side asap.
  - getAgentId
```
public ObjID getAgentId()
```
    Returns current agent
    
    Returns:
    
    current agent
  - getCache
```
public java.util.Map<ObjID,NetPuzlObject> getCache()
```
    Returns the cache
    
    Returns:
    
    the cache
  - getCurrentMatrix
```
public ClientMatrix getCurrentMatrix()
```
    Returns current matrix
    
    Returns:
    
    the currentMatrix
  - getLoggedIn
```
public boolean getLoggedIn()
```
    Returns login status
    
    Returns:
    
    true if logged-in, false otherwise
  - getServerStatus
```
public TServer.SStatus getServerStatus()
```
    Returns a status of the server
    
    Returns:
    
    SStatus server status
  - isConnected
```
public boolean isConnected()
```
    Returns the connection status
    
    Returns:
    
    true if connected
  - receivedHearTag
```
protected void receivedHearTag(THear tag)
```
    Description copied from class: ClientXMLHandler
    
    Method is called when Tag type HEAR is received from the server. Tag is parsed and created, after that it needs to be handled according to the specs for NetPuzl.
    
    Specified by:
    
    receivedHearTag in class ClientXMLHandler
    
    Parameters:
    
    tag - Tag that was received
    
    See Also:
    
    com.putable.xmlhandler.ClientXMLHandler#receiveHearTag
  - receivedLoggedInTag
```
protected void receivedLoggedInTag(TLoggedIn tag)
```
    Description copied from class: ClientXMLHandler
    
    Method is called when Tag type LOGGED_IN is received from the server. Tag is parsed and created, after that it needs to be handled according to the specs for NetPuzl.
    
    Specified by:
    
    receivedLoggedInTag in class ClientXMLHandler
    
    Parameters:
    
    tag - Tag that was received
    
    See Also:
    
    ClientXMLHandler.receivedLoggedInTag(com.putable.common.tags.TLoggedIn)
  - receivedLoggedOutTag
```
protected void receivedLoggedOutTag(TLoggedOut tag)
```
    Description copied from class: ClientXMLHandler
    
    Method is called when Tag type LOGGED_OUT is received from the server. Tag is parsed and created, after that it needs to be handled according to the specs for NetPuzl.
    
    Specified by:
    
    receivedLoggedOutTag in class ClientXMLHandler
    
    Parameters:
    
    tag - Tag that was received
    
    See Also:
    
    ClientXMLHandler.receivedLoggedOutTag(com.putable.common.tags.TLoggedOut)
  - receivedServerTag
```
protected void receivedServerTag(TServer tag)
```
    Description copied from class: ClientXMLHandler
    
    Method is called when Tag type SERVER is received from the server. Tag is parsed and created, after that it needs to be handled according to the specs for NetPuzl.
    
    Specified by:
    
    receivedServerTag in class ClientXMLHandler
    
    Parameters:
    
    tag - Tag that was received
    
    See Also:
    
    ClientXMLHandler.receivedServerTag(com.putable.common.tags.TServer)
  - receivedSetTag
```
protected void receivedSetTag(TSet tag)
```
    Description copied from class: ClientXMLHandler
    
    Method is called when Tag type SET is received from the server. Tag is parsed and created, after that it needs to be handled according to the specs for NetPuzl.
    
    Specified by:
    
    receivedSetTag in class ClientXMLHandler
    
    Parameters:
    
    tag - Tag that was received
    
    See Also:
    
    ClientXMLHandler.receivedSetTag(com.putable.common.tags.TSet)
  - receivedXresponseTag
```
protected void receivedXresponseTag(TXresponse tag)
```
    Description copied from class: ClientXMLHandler
    
    Method is called when Tag type XRESPONSE is received from the server. Tag is parsed and created, after that it needs to be handled according to the specs for NetPuzl.
    
    Specified by:
    
    receivedXresponseTag in class ClientXMLHandler
    
    Parameters:
    
    tag - Tag that was received
    
    See Also:
    
    ClientXMLHandler.receivedXresponseTag(com.putable.common.tags.TXresponse)
  - run
```
public void run()
```
    Runs the parser
    
    Specified by:
    
    run in interface java.lang.Runnable
  - sendToServer
```
private boolean sendToServer(java.lang.String msg)
```
    Sends a string to the server
  - sendToServer
```
public boolean sendToServer(Tag tag)
```
    Send a tag to the server
  - setCurrentMatrix
```
public void setCurrentMatrix(ClientMatrix currentMatrix)
```
    Parameters:
    
    currentMatrix - the currentMatrix to set
  - startConnection
```
private boolean startConnection(java.lang.String _str_serverAddress,
                                int port)
```
    Start a connection to the server

Class NetPuzlClient

Field Summary

Fields inherited from class com.putable.xmlhandler.XMLHandler

Constructor Summary

Method Summary

Methods inherited from class com.putable.xmlhandler.ClientXMLHandler

Methods inherited from class com.putable.xmlhandler.XMLHandler

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

Methods inherited from class java.lang.Object

Field Detail

clientThread

os

logOS

is

input

serverSocket

parser

currentMatrix

agentId

isLoggedIn

serverStatus

isConnected

cache

gui

cal

sdf

group

Constructor Detail

NetPuzlClient

Method Detail

main

initThread

createAttributesFromSetTag

createNetPuzlObjectFromTag

endOfXMLDocument

errorDisconnect

flushOutput

getAgentId

getCache

getCurrentMatrix

getLoggedIn

getServerStatus

isConnected

receivedHearTag

receivedLoggedInTag

receivedLoggedOutTag

receivedServerTag

receivedSetTag

receivedXresponseTag

run

sendToServer

sendToServer

setCurrentMatrix

startConnection