fixed issue #39

Continue connectionhandler

client/src/main/java/ch/zhaw/pm2/multichat/client/ChatWindowController.java

@@ -1,9 +1,10 @@
 package ch.zhaw.pm2.multichat.client;
 
-import ch.zhaw.pm2.multichat.client.ClientConnectionHandler.State;
+import ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State;
 import ch.zhaw.pm2.multichat.protocol.ChatProtocolException;
-import ch.zhaw.pm2.multichat.protocol.NetworkHandler;
 import javafx.application.Platform;
+import javafx.beans.value.ChangeListener;
+import javafx.beans.value.ObservableValue;
 import javafx.event.EventHandler;
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
@@ -13,10 +14,8 @@ import javafx.scene.layout.Pane;
 import javafx.stage.WindowEvent;
 
 import java.io.IOException;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
-import static ch.zhaw.pm2.multichat.client.ClientConnectionHandler.State.*;
+import static ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State.*;
 
 public class ChatWindowController {
     private ClientConnectionHandler connectionHandler;
@@ -35,24 +34,25 @@ public class ChatWindowController {
     @FXML private TextField filterValue;
 
 
-    @FXML
-    public void initialize() {
-        serverAddressField.setText(NetworkHandler.DEFAULT_ADDRESS.getCanonicalHostName());
-        serverPortField.setText(String.valueOf(NetworkHandler.DEFAULT_PORT));
-        stateChanged(NEW);
-    }
-
     public void setMessages(ClientMessageList messages) {
         this.messages = messages;
+        messageListener();
+    }
+
+    public void setConnectionHandler(ClientConnectionHandler connectionHandler){
+        this.connectionHandler = connectionHandler;
+        startConnectionHandlerListener();
+        serverAddressField.setText(connectionHandler.getServerAddressProperty().get());
+        serverPortField.setText(String.valueOf(connectionHandler.getServerPortProperty().get()));
     }
 
     private void applicationClose() {
-        connectionHandler.setState(DISCONNECTED);
+        disconnect();
     }
 
     @FXML
     private void toggleConnection () {
-        if (connectionHandler == null || connectionHandler.getState() != CONNECTED) {
+        if (connectionHandler == null || connectionHandler.getStateProperty().get() != CONNECTED) {
             connect();
         } else {
             disconnect();
@@ -62,7 +62,6 @@ public class ChatWindowController {
     private void connect() {
         try {
             messages.clear(); // clear message list
-            redrawMessageList();
             startConnectionHandler();
             connectionHandler.connect();
         } catch(ChatProtocolException | IOException e) {
@@ -100,28 +99,24 @@ public class ChatWindowController {
 
     @FXML
     private void applyFilter( ) {
-    	this.redrawMessageList();
+        Platform.runLater(() -> this.messageArea.setText(messages.getFilteredMessages(filterValue.getText().strip())));
     }
 
     private void startConnectionHandler() throws IOException {
         String userName = userNameField.getText();
-        String serverAddress = serverAddressField.getText();
-        int serverPort = Integer.parseInt(serverPortField.getText());
-        connectionHandler = new ClientConnectionHandler(
-            NetworkHandler.openConnection(serverAddress, serverPort), userName,
-            this);
-        new Thread(connectionHandler).start();
+        if(!userName.contains(" ")) {
+            String serverAddress = serverAddressField.getText();
+            int serverPort = Integer.parseInt(serverPortField.getText());
+            connectionHandler.initialize(serverAddress, serverPort, userName);
+            new Thread(connectionHandler).start();
 
-        // register window close handler
-        rootPane.getScene().getWindow().addEventHandler(WindowEvent.WINDOW_CLOSE_REQUEST, windowCloseHandler);
-    }
+            //register Listener
+            //startConnectionHandlerListener();
 
-    private void terminateConnectionHandler() {
-        // unregister window close handler
-        rootPane.getScene().getWindow().removeEventHandler(WindowEvent.WINDOW_CLOSE_REQUEST, windowCloseHandler);
-        if (connectionHandler != null) {
-            connectionHandler.stopReceiving();
-            connectionHandler = null;
+            // register window close handler
+            rootPane.getScene().getWindow().addEventHandler(WindowEvent.WINDOW_CLOSE_REQUEST, windowCloseHandler);
+        } else {
+            addError("It is not allowed to have spaces in username!");
         }
     }
 
@@ -133,8 +128,8 @@ public class ChatWindowController {
                 connectButton.setText((newState == CONNECTED || newState == CONFIRM_DISCONNECT) ? "Disconnect" : "Connect");
             }
         });
-        if (newState == DISCONNECTED) {
-            terminateConnectionHandler();
+        if(newState == DISCONNECTED){
+            connectionHandler.stopReceiving();
         }
     }
 
@@ -165,31 +160,53 @@ public class ChatWindowController {
         });
     }
 
-    public void addMessage(String sender, String receiver, String message) {
-        messages.addMessage(new Message(Message.MessageType.MESSAGE, sender, receiver, message));
-        this.redrawMessageList();
-    }
-
-    public void addInfo(String message) {
-        messages.addMessage(new Message(Message.MessageType.INFO, null, null, message));
-        this.redrawMessageList();
-    }
-
     public void addError(String message) {
         messages.addMessage(new Message(Message.MessageType.ERROR, null, null, message));
-        this.redrawMessageList();
-    }
-
-    private void redrawMessageList() {
-        this.messageArea.clear();
-        Platform.runLater(() -> this.messageArea.setText(messages.getFilteredMessages(filterValue.getText().strip())));
     }
 
     class WindowCloseHandler implements EventHandler<WindowEvent> {
         public void handle(WindowEvent event) {
             applicationClose();
         }
+    }
 
+    public void startConnectionHandlerListener() {
+        connectionHandler.getStateProperty().addListener(new ChangeListener<State>() {
+            @Override
+            public void changed(ObservableValue<? extends State> observable, State oldValue, State newValue) {
+                stateChanged(newValue);
+            }
+        });
+
+        connectionHandler.getUserNameProperty().addListener(new ChangeListener<String>() {
+            @Override
+            public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
+                setUserName(newValue);
+            }
+        });
+
+        connectionHandler.getServerAddressProperty().addListener(new ChangeListener<String>() {
+            @Override
+            public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
+                setServerAddress(newValue);
+            }
+        });
+
+        connectionHandler.getServerPortProperty().addListener(new ChangeListener<Number>() {
+            @Override
+            public void changed(ObservableValue<? extends Number> observable, Number oldValue, Number newValue) {
+                setServerPort(newValue.intValue());
+            }
+        });
+    }
+
+    private void messageListener() {
+        messages.getChangedProperty().addListener(new ChangeListener<Boolean>() {
+            @Override
+            public void changed(ObservableValue<? extends Boolean> observable, Boolean oldValue, Boolean newValue) {
+                Platform.runLater(() -> messageArea.setText(messages.getFilteredMessages(filterValue.getText().strip())));
+            }
+        });
     }
 
 }

client/src/main/java/ch/zhaw/pm2/multichat/client/ClientConnectionHandler.java

@@ -1,7 +1,11 @@
 package ch.zhaw.pm2.multichat.client;
 
 import ch.zhaw.pm2.multichat.protocol.ChatProtocolException;
+import ch.zhaw.pm2.multichat.protocol.ConnectionHandler;
 import ch.zhaw.pm2.multichat.protocol.NetworkHandler;
+import javafx.beans.property.SimpleIntegerProperty;
+import javafx.beans.property.SimpleObjectProperty;
+import javafx.beans.property.SimpleStringProperty;
 
 import java.io.EOFException;
 import java.io.IOException;
@@ -9,59 +13,59 @@ import java.net.SocketException;
 import java.util.Scanner;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import static ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State.*;
 
-import static ch.zhaw.pm2.multichat.client.ClientConnectionHandler.State.*;
+public class ClientConnectionHandler extends ConnectionHandler implements Runnable {
 
-public class ClientConnectionHandler implements Runnable {
-    private final NetworkHandler.NetworkConnection<String> connection;
-    private final ChatWindowController controller;
+    private final Pattern messagePattern = Pattern.compile( "^(?:@(\\S*))?\\s*(.*)$" );
 
-    // Data types used for the Chat Protocol
-    private static final String DATA_TYPE_CONNECT = "CONNECT";
-    private static final String DATA_TYPE_CONFIRM = "CONFIRM";
-    private static final String DATA_TYPE_DISCONNECT = "DISCONNECT";
-    private static final String DATA_TYPE_MESSAGE = "MESSAGE";
-    private static final String DATA_TYPE_ERROR = "ERROR";
+    private SimpleStringProperty userName;
+    private SimpleObjectProperty<State> state;
+    private ClientMessageList messages;
+    private SimpleStringProperty serverAddress;
+    private SimpleIntegerProperty serverPort;
 
-    public static final String USER_NONE = "";
-    public static final String USER_ALL = "*";
-
-    private final Pattern messagePattern = Pattern.compile( "^(?:@(\\w*))?\\s*(.*)$" );
-
-    private String userName = USER_NONE;
-    private State state = NEW;
-
-    enum State {
-        NEW, CONFIRM_CONNECT, CONNECTED, CONFIRM_DISCONNECT, DISCONNECTED;
+    public ClientConnectionHandler(ClientMessageList messages)  {
+        super();
+        this.messages = messages;
+        state = new SimpleObjectProperty<>(State.NEW);
+        serverAddress = new SimpleStringProperty(NetworkHandler.DEFAULT_ADDRESS.getCanonicalHostName());
+        serverPort = new SimpleIntegerProperty(NetworkHandler.DEFAULT_PORT);
+        this.userName = new SimpleStringProperty(null);
     }
 
-    public ClientConnectionHandler(NetworkHandler.NetworkConnection<String> connection,
-                                   String userName,
-                                   ChatWindowController controller)  {
-        this.connection = connection;
-        this.userName = (userName == null || userName.isBlank())? USER_NONE : userName;
-        this.controller = controller;
+    public void initialize(String serverAddress, int serverPort, String userName) throws IOException {
+        state.set(NEW);
+        this.serverAddress.set(serverAddress);
+        this.serverPort.set(serverPort);
+        setConnection(NetworkHandler.openConnection(serverAddress, serverPort));
+        this.userName = new SimpleStringProperty((userName == null || userName.isBlank())? USER_NONE : userName);
     }
 
-    public State getState() {
+    public SimpleStringProperty getServerAddressProperty() { return serverAddress; }
+
+    public SimpleIntegerProperty getServerPortProperty() { return serverPort; }
+
+    public SimpleObjectProperty<State> getStateProperty() {
         return this.state;
     }
 
+    public SimpleStringProperty getUserNameProperty() { return userName; }
+
     public void setState (State newState) {
-        this.state = newState;
-        controller.stateChanged(newState);
+        state.set(newState);
     }
 
     public void run () {
         startReceiving();
     }
 
-    public void startReceiving() {
+    private void startReceiving() {
         System.out.println("Starting Connection Handler");
         try {
             System.out.println("Start receiving data...");
-            while (connection.isAvailable()) {
-                String data = connection.receive();
+            while (getConnection().isAvailable()) {
+                String data = getConnection().receive();
                 processData(data);
             }
             System.out.println("Stopped recieving data");
@@ -85,7 +89,7 @@ public class ClientConnectionHandler implements Runnable {
         System.out.println("Closing Connection Handler to Server");
         try {
             System.out.println("Stop receiving data...");
-            connection.close();
+            getConnection().close();
             System.out.println("Stopped receiving data.");
         } catch (IOException e) {
             System.err.println("Failed to close connection." + e.getMessage());
@@ -95,111 +99,88 @@ public class ClientConnectionHandler implements Runnable {
 
     private void processData(String data) {
         try {
-            // parse data content
             Scanner scanner = new Scanner(data);
-            String sender = null;
-            String reciever = null;
-            String type = null;
-            String payload = null;
-            if (scanner.hasNextLine()) {
-                sender = scanner.nextLine();
-            } else {
-                throw new ChatProtocolException("No Sender found");
-            }
-            if (scanner.hasNextLine()) {
-                reciever = scanner.nextLine();
-            } else {
-                throw new ChatProtocolException("No Reciever found");
-            }
-            if (scanner.hasNextLine()) {
-                type = scanner.nextLine();
-            } else {
-                throw new ChatProtocolException("No Type found");
-            }
-            if (scanner.hasNextLine()) {
-                payload = scanner.nextLine();
-            }
+            StringBuilder sender = new StringBuilder();
+            StringBuilder reciever = new StringBuilder();
+            StringBuilder type = new StringBuilder();
+            StringBuilder payload = new StringBuilder();
+            super.processData(scanner,sender,reciever,type,payload);
+
             // dispatch operation based on type parameter
-            if (type.equals(DATA_TYPE_CONNECT)) {
+            if (type.toString().equals(getDataTypeConnect())) {
                 System.err.println("Illegal connect request from server");
-            } else if (type.equals(DATA_TYPE_CONFIRM)) {
-                if (state == CONFIRM_CONNECT) {
-                    this.userName = reciever;
-                    controller.setUserName(userName);
-                    controller.setServerPort(connection.getRemotePort());
-                    controller.setServerAddress(connection.getRemoteHost());
-                    controller.addInfo(payload);
-                    System.out.println("CONFIRM: " + payload);
-                    this.setState(CONNECTED);
-                } else if (state == CONFIRM_DISCONNECT) {
-                    controller.addInfo(payload);
-                    System.out.println("CONFIRM: " + payload);
-                    this.setState(DISCONNECTED);
-                } else {
-                    System.err.println("Got unexpected confirm message: " + payload);
-                }
-            } else if (type.equals(DATA_TYPE_DISCONNECT)) {
-                if (state == DISCONNECTED) {
-                    System.out.println("DISCONNECT: Already in disconnected: " + payload);
-                    return;
-                }
-                controller.addInfo(payload);
-                System.out.println("DISCONNECT: " + payload);
-                this.setState(DISCONNECTED);
-            } else if (type.equals(DATA_TYPE_MESSAGE)) {
-                if (state != CONNECTED) {
-                    System.out.println("MESSAGE: Illegal state " + state + " for message: " + payload);
-                    return;
-                }
-                controller.addMessage(sender, reciever, payload);
-                System.out.println("MESSAGE: From " + sender + " to " + reciever + ": "+  payload);
-            } else if (type.equals(DATA_TYPE_ERROR)) {
-                controller.addError(payload);
-                System.out.println("ERROR: " + payload);
+            } else if (type.toString().equals(getDataTypeConfirm())) {
+                caseConfirm(sender.toString(), reciever.toString(), payload.toString());
+            } else if (type.toString().equals(getDataTypeDisconnect())) {
+                caseDisconnect(sender.toString(),reciever.toString(),payload.toString());
+            } else if (type.toString().equals(getDataTypeMessage())) {
+                caseMessage(sender.toString(),reciever.toString(),payload.toString());
+            } else if (type.toString().equals(getDataTypeError())) {
+                caseError(sender.toString(), reciever.toString(), payload.toString());
             } else {
                 System.out.println("Unknown data type received: " + type);
             }
         } catch (ChatProtocolException e) {
             System.err.println("Error while processing data: " + e.getMessage());
-            sendData(USER_NONE, userName, DATA_TYPE_ERROR, e.getMessage());
+            sendData(USER_NONE, userName.get(), getDataTypeError(), e.getMessage());
         }
     }
 
-    public void sendData(String sender, String receiver, String type, String payload) {
-        if (connection.isAvailable()) {
-            new StringBuilder();
-            String data = new StringBuilder()
-                .append(sender+"\n")
-                .append(receiver+"\n")
-                .append(type+"\n")
-                .append(payload+"\n")
-                .toString();
-            try {
-                connection.send(data);
-            } catch (SocketException e) {
-                System.err.println("Connection closed: " + e.getMessage());
-            } catch (EOFException e) {
-                System.out.println("Connection terminated by remote");
-            } catch(IOException e) {
-                System.err.println("Communication error: " + e.getMessage());
-            }
+    private void caseConfirm(String sender, String reciever, String payload) {
+        if (state.get() == CONFIRM_CONNECT) {
+            this.userName.set(reciever);
+            this.serverPort.set(getConnection().getRemotePort());
+            this.serverAddress.set(getConnection().getRemoteHost());
+            messages.addMessage(new Message(Message.MessageType.INFO,sender,reciever,payload));
+            System.out.println("CONFIRM: " + payload);
+            this.setState(CONNECTED);
+        } else if (state.get() == CONFIRM_DISCONNECT) {
+            messages.addMessage(new Message(Message.MessageType.INFO,sender,reciever,payload));
+            System.out.println("CONFIRM: " + payload);
+            this.setState(DISCONNECTED);
+        } else {
+            System.err.println("Got unexpected confirm message: " + payload);
         }
     }
 
+    private void caseDisconnect(String sender, String reciever, String payload) {
+        if (state.get() == DISCONNECTED) {
+            System.out.println("DISCONNECT: Already in disconnected: " + payload);
+            return;
+        }
+        messages.addMessage(new Message(Message.MessageType.INFO,sender,reciever,payload));
+        System.out.println("DISCONNECT: " + payload);
+        this.setState(DISCONNECTED);
+    }
+
+    private void caseMessage(String sender, String reciever, String payload) {
+        if (state.get() != CONNECTED) {
+            System.out.println("MESSAGE: Illegal state " + state + " for message: " + payload);
+            return;
+        }
+        messages.addMessage(new Message(Message.MessageType.MESSAGE,sender,reciever,payload));
+        System.out.println("MESSAGE: From " + sender + " to " + reciever + ": "+  payload);
+    }
+
+    private void caseError(String sender, String reciever, String payload) {
+        messages.addMessage(new Message(Message.MessageType.ERROR,sender,reciever,payload));
+        System.out.println("ERROR: " + payload);
+    }
+
     public void connect() throws ChatProtocolException {
-        if (state != NEW) throw new ChatProtocolException("Illegal state for connect: " + state);
-        this.sendData(userName, USER_NONE, DATA_TYPE_CONNECT,null);
+        if (state.get() != NEW) throw new ChatProtocolException("Illegal state for connect: " + state);
+        this.sendData(userName.get(), USER_NONE, getDataTypeConnect(),null);
         this.setState(CONFIRM_CONNECT);
     }
 
     public void disconnect() throws ChatProtocolException {
-        if (state != NEW && state != CONNECTED) throw new ChatProtocolException("Illegal state for disconnect: " + state);
-        this.sendData(userName, USER_NONE, DATA_TYPE_DISCONNECT,null);
+        if (state.get() != NEW && state.get() != CONNECTED) throw new ChatProtocolException("Illegal state for disconnect: " + state);
+        this.sendData(userName.get(), USER_NONE, getDataTypeDisconnect(),null);
         this.setState(CONFIRM_DISCONNECT);
     }
 
     public boolean message(String messageString) throws ChatProtocolException {
-        if (state != CONNECTED) throw new ChatProtocolException("Illegal state for message: " + state);
+        if (state.get() != CONNECTED) throw new ChatProtocolException("Illegal state for message: " + state);
 
         Matcher matcher = messagePattern.matcher(messageString);
         if (matcher.find()) {
@@ -209,11 +190,10 @@ public class ClientConnectionHandler implements Runnable {
                 return false;
             }
             if (receiver == null || receiver.isBlank()) receiver = ClientConnectionHandler.USER_ALL;
-            this.sendData(userName, receiver, DATA_TYPE_MESSAGE,message);
+            this.sendData(userName.get(), receiver, getDataTypeMessage(),message);
             return true;
         } else {
             return false;
         }
     }
-
 }

client/src/main/java/ch/zhaw/pm2/multichat/client/ClientMessageList.java

@@ -1,14 +1,17 @@
 package ch.zhaw.pm2.multichat.client;
 
+import javafx.beans.property.SimpleBooleanProperty;
+
 import java.util.ArrayList;
 import java.util.List;
 
 public class ClientMessageList {
     private List<Message> messages = new ArrayList<>();
-
+    private SimpleBooleanProperty changed = new SimpleBooleanProperty(false);
 
     public void addMessage(Message message) {
 	    messages.add(message);
+	    changed.set(!changed.get());
     }
 
 	public String getFilteredMessages(String filter) {
@@ -30,6 +33,9 @@ public class ClientMessageList {
 
     public void clear() {
         messages = new ArrayList<>();
+        changed.set(!changed.get());
     }
 
+    public SimpleBooleanProperty getChangedProperty() { return changed; }
+
 }

client/src/main/java/ch/zhaw/pm2/multichat/client/ClientUI.java

@@ -8,6 +8,7 @@ import javafx.stage.Stage;
 
 public class ClientUI extends Application {
     private ClientMessageList clientMessageList = new ClientMessageList();
+    private ClientConnectionHandler connectionHandler = new ClientConnectionHandler(clientMessageList);
 
     @Override
     public void start(Stage primaryStage) {
@@ -21,6 +22,7 @@ public class ClientUI extends Application {
 
             ChatWindowController chatWindowController = loader.getController();
             chatWindowController.setMessages(clientMessageList);
+            chatWindowController.setConnectionHandler(connectionHandler);
 
             // fill in scene and stage setup
             Scene scene = new Scene(rootPane);

protocol/src/main/java/ch/zhaw/pm2/multichat/protocol/ConnectionHandler.java

@@ -0,0 +1,95 @@
+package ch.zhaw.pm2.multichat.protocol;
+
+import java.io.EOFException;
+import java.io.IOException;
+import java.net.SocketException;
+import java.util.Scanner;
+
+public abstract class ConnectionHandler {
+    private NetworkHandler.NetworkConnection<String> connection;
+
+    // Data types used for the Chat Protocol
+    private static final String DATA_TYPE_CONNECT = "CONNECT";
+    private static final String DATA_TYPE_CONFIRM = "CONFIRM";
+    private static final String DATA_TYPE_DISCONNECT = "DISCONNECT";
+    private static final String DATA_TYPE_MESSAGE = "MESSAGE";
+    private static final String DATA_TYPE_ERROR = "ERROR";
+
+    public static final String USER_NONE = "";
+    public static final String USER_ALL = "*";
+
+    public enum State {
+        NEW, CONFIRM_CONNECT, CONNECTED, CONFIRM_DISCONNECT, DISCONNECTED, ERROR;
+    }
+
+    public static String getDataTypeConnect() {
+        return DATA_TYPE_CONNECT;
+    }
+
+    public static String getDataTypeConfirm() {
+        return DATA_TYPE_CONFIRM;
+    }
+
+    public static String getDataTypeDisconnect() {
+        return DATA_TYPE_DISCONNECT;
+    }
+
+    public static String getDataTypeMessage() {
+        return DATA_TYPE_MESSAGE;
+    }
+
+    public static String getDataTypeError() {
+        return DATA_TYPE_ERROR;
+    }
+
+    public NetworkHandler.NetworkConnection<String> getConnection() {
+        return connection;
+    }
+
+    protected void setConnection(NetworkHandler.NetworkConnection<String> connection) {
+        this.connection = connection;
+    }
+
+    protected void processData(Scanner scanner, StringBuilder sender, StringBuilder reciever, StringBuilder type, StringBuilder payload) throws ChatProtocolException {
+        // parse data content
+        if (scanner.hasNextLine()) {
+            sender.append(scanner.nextLine());
+        } else {
+            throw new ChatProtocolException("No Sender found");
+        }
+        if (scanner.hasNextLine()) {
+            reciever.append(scanner.nextLine());
+        } else {
+            throw new ChatProtocolException("No Reciever found");
+        }
+        if (scanner.hasNextLine()) {
+            type.append(scanner.nextLine());
+        } else {
+            throw new ChatProtocolException("No Type found");
+        }
+        if (scanner.hasNextLine()) {
+            payload.append(scanner.nextLine());
+        }
+    }
+
+    protected void sendData(String sender, String receiver, String type, String payload) {
+        if (connection.isAvailable()) {
+            new StringBuilder();
+            String data = new StringBuilder()
+                    .append(sender+"\n")
+                    .append(receiver+"\n")
+                    .append(type+"\n")
+                    .append(payload+"\n")
+                    .toString();
+            try {
+                getConnection().send(data);
+            } catch (SocketException e) {
+                System.err.println("Connection closed: " + e.getMessage());
+            } catch (EOFException e) {
+                System.out.println("Connection terminated by remote");
+            } catch(IOException e) {
+                System.err.println("Communication error: " + e.getMessage());
+            }
+        }
+    }
+}

server/src/main/java/ch/zhaw/pm2/multichat/server/Server.java

@@ -1,13 +1,24 @@
 package ch.zhaw.pm2.multichat.server;
 
+import ch.zhaw.pm2.multichat.protocol.ConnectionHandler;
 import ch.zhaw.pm2.multichat.protocol.NetworkHandler;
 
 import java.io.IOException;
 import java.net.SocketException;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
 
-
+/**
+ * This Class represents a Server. The user can start the programm with the port number as a argument.
+ * If no argument has been set the {@link NetworkHandler#DEFAULT_PORT} is used as port number.
+ * After initialising the server:
+ * 1. Starts a Socketserver using the logic given in {@link NetworkHandler.NetworkServer#createServer()}
+ * 2. The server starts to listen for incoming connection using the Logic given in {@link NetworkHandler.NetworkServer#waitForConnection()}
+ * 3. New conections will be atached to a Connectionhandler: {@link ServerConnectionHandler} and placed in a Map containing all active connections {@link Server#connections}
+ *
+ */
 public class Server {
 
     // Server connection
@@ -54,6 +65,11 @@ public class Server {
         }
     }
 
+    /**
+     * The Constructor to create a new instance.
+     * @param serverPort to listen for incoming connections.
+     * @throws IOException thrown if an I/O error occurs when opening the socket.
+     */
     public Server(int serverPort) throws IOException {
         // Open server connection
         System.out.println("Create server connection");
@@ -61,29 +77,32 @@ public class Server {
         System.out.println("Listening on " + networkServer.getHostAddress() + ":" + networkServer.getHostPort());
     }
 
+    /**
+     * With this methode the instance waits for incoming connections. If a client tries to connect to the server.
+     * The connection will be registered in the connection registry if successful.
+     */
     private void start() {
+        ReentrantLock mutex = new ReentrantLock();
+        Condition nameComplete = mutex.newCondition();
         System.out.println("Server started.");
         try {
             while (true) {
                  NetworkHandler.NetworkConnection<String> connection = networkServer.waitForConnection();
-                 ServerConnectionHandler connectionHandler = new ServerConnectionHandler(connection, connections);
+                 ServerConnectionHandler connectionHandler = new ServerConnectionHandler(connection, connections, mutex, nameComplete);
                  new Thread(connectionHandler).start();
-                 System.out.println(String.format("Connected new Client %s with IP:Port <%s:%d>",
-                     connectionHandler.getUserName(),
-                     connection.getRemoteHost(),
-                     connection.getRemotePort()
-                 ));
             }
         } catch(SocketException e) {
             System.out.println("Server connection terminated");
-        }
-        catch (IOException e) {
+        } catch (IOException e) {
             System.err.println("Communication error " + e);
         }
         // close server
         System.out.println("Server Stopped.");
     }
 
+    /**
+     * This method will stop the serversocket.
+     */
     public void terminate() {
         try {
             System.out.println("Close server port.");

server/src/main/java/ch/zhaw/pm2/multichat/server/ServerConnectionHandler.java

@@ -1,187 +1,258 @@
 package ch.zhaw.pm2.multichat.server;
 
 import ch.zhaw.pm2.multichat.protocol.ChatProtocolException;
+import ch.zhaw.pm2.multichat.protocol.ConnectionHandler;
+import static ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State.*;
 import ch.zhaw.pm2.multichat.protocol.NetworkHandler;
 
 import java.io.EOFException;
 import java.io.IOException;
 import java.net.SocketException;
-import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Scanner;
 import java.util.concurrent.atomic.AtomicInteger;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
 
-import static ch.zhaw.pm2.multichat.server.ServerConnectionHandler.State.*;
 
-public class ServerConnectionHandler implements Runnable{
+/**
+ * This class represents the connection between the server and a client and offers the serverside logic.
+ * The ServerConnectionHandler receives data send from the client aswell as sends data to the client.
+ *
+ * The ServeConnectionHandler offers following functionality:
+ *
+ * Evaluating connection attempts from a client by:
+ * 1. Checks if Username is valid (Not used)
+ * 2. Saves Username in {@link ServerConnectionHandler#userName}
+ * 3. Saves the connection in the {@link ServerConnectionHandler#connectionRegistry}
+ *
+ * Processes disconnections from a client by:
+ * 1. Removing the connection from the {@link ServerConnectionHandler#connectionRegistry}
+ * 2. Terminates the socket by calling {@link NetworkHandler.NetworkConnection#close()}
+ *
+ * Processes Messages send from a client by:
+ * 1. Evaluating the reciever by differentiating between broadcast or unicast.
+ * 2. Sending the message accordingly.
+ *
+ * To use this class, start a new instance and start it in a thread.
+ * To constructor needs following parameter:
+ * 1. {@link ch.zhaw.pm2.multichat.protocol.NetworkHandler.NetworkConnection} representing the socket connection between server and client
+ * 2. {@link Map<String,ServerConnectionHandler>} registry to check for all active connections
+ * 3. {@link ReentrantLock @link Condition} to lock server thread to evaluate connection.
+ * */
+public class ServerConnectionHandler extends ConnectionHandler implements Runnable{
     private static final AtomicInteger connectionCounter = new AtomicInteger(0);
     private final int connectionId = connectionCounter.incrementAndGet();
-    private final NetworkHandler.NetworkConnection<String> connection;
     private final Map<String,ServerConnectionHandler> connectionRegistry;
 
-    // Data types used for the Chat Protocol
-    private static final String DATA_TYPE_CONNECT = "CONNECT";
-    private static final String DATA_TYPE_CONFIRM = "CONFIRM";
-    private static final String DATA_TYPE_DISCONNECT = "DISCONNECT";
-    private static final String DATA_TYPE_MESSAGE = "MESSAGE";
-    private static final String DATA_TYPE_ERROR = "ERROR";
+    private ReentrantLock mutex;
 
-    private static final String USER_NONE = "";
-    private static final String USER_ALL = "*";
+    private Condition nameComplete;
 
     private String userName = "Anonymous-"+connectionId;
     private State state = NEW;
 
+    /**
+     * Called when runnable gets started in a thread.
+     */
     @Override
     public void run() {
         startReceiving();
     }
 
-    enum State {
-        NEW, CONNECTED, DISCONNECTED;
-    }
-
+    /**
+     * Constructor to intitialize the connection
+     * @param connection representing the socket connection between server and clinet
+     * @param registry map containing all active connections between server and clients
+     * @param mutex to lock thread
+     * @param nameComplete condition to call threads
+     */
     public ServerConnectionHandler(NetworkHandler.NetworkConnection<String> connection,
-                                   Map<String,ServerConnectionHandler> registry) {
+                                   Map<String,ServerConnectionHandler> registry, ReentrantLock mutex, Condition nameComplete) {
+        super();
+        setConnection(connection);
         Objects.requireNonNull(connection, "Connection must not be null");
         Objects.requireNonNull(registry, "Registry must not be null");
-        this.connection = connection;
         this.connectionRegistry = registry;
+        this.mutex = mutex;
+        this.nameComplete = nameComplete;
     }
 
+    /**
+     *
+     * @return the username of the connected client
+     */
     public String getUserName() {
         return this.userName;
     }
 
-    public void startReceiving() {
-        System.out.println("Starting Connection Handler for " + userName);
-        try {
-            System.out.println("Start receiving data...");
-            while (connection.isAvailable()) {
-                String data = connection.receive();
-                processData(data);
-            }
-            System.out.println("Stopped recieving data");
-        } catch (SocketException e) {
-            System.out.println("Connection terminated locally");
-            connectionRegistry.remove(userName);
-            System.out.println("Unregistered because client connection terminated: " + userName + " " + e.getMessage());
-        } catch (EOFException e) {
-            System.out.println("Connection terminated by remote");
-            connectionRegistry.remove(userName);
-            System.out.println("Unregistered because client connection terminated: " + userName + " " + e.getMessage());
-        } catch(IOException e) {
-            System.err.println("Communication error: " + e);
-        } catch(ClassNotFoundException e) {
-            System.err.println("Received object of unknown type: " + e.getMessage());
-        }
-        System.out.println("Stopping Connection Handler for " + userName);
+    /**
+     *
+     * @return state of the connection. Poosible states are see {@link ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State}
+     */
+    public State getState() {
+        return state;
     }
 
-    public void stopReceiving() {
+    /**
+     * This methods runs in a whileloop as long as the socket between server and client is available
+     * and the connection State is not ERROR.
+     */
+    private void startReceiving() {
+            System.out.println("Starting Connection Handler for new User");
+            try {
+                System.out.println("Start receiving data...");
+                while (getConnection().isAvailable() && !(state == ERROR)) {
+                    String data = getConnection().receive();
+                    processData(data);
+                }
+                System.out.println("Stopped recieving data");
+            } catch (SocketException e) {
+                System.out.println("Connection terminated locally");
+                connectionRegistry.remove(userName);
+                System.out.println("Unregistered because client connection terminated: " + userName + " " + e.getMessage());
+            } catch (EOFException e) {
+                System.out.println("Connection terminated by remote");
+                connectionRegistry.remove(userName);
+                System.out.println("Unregistered because client connection terminated: " + userName + " " + e.getMessage());
+            } catch (IOException e) {
+                System.err.println("Communication error: " + e);
+            } catch (ClassNotFoundException e) {
+                System.err.println("Received object of unknown type: " + e.getMessage());
+            }
+        if (state == ERROR) {
+            System.out.println("Stopping Connection Handler for Rejected Client");
+        } else {
+            System.out.println("Stopping Connection Handler for " + userName);
+        }
+
+    }
+
+    /**
+     * This method will call {@link NetworkHandler.NetworkConnection#close()} to close the Socket.
+     */
+    private void stopReceiving() {
         System.out.println("Closing Connection Handler for " + userName);
         try {
             System.out.println("Stop receiving data...");
-            connection.close();
+            getConnection().close();
             System.out.println("Stopped receiving data.");
         } catch (IOException e) {
-            System.err.println("Failed to close connection." + e);
+            System.err.println("Failed to close connection." + e.getMessage());
         }
         System.out.println("Closed Connection Handler for " + userName);
     }
 
+    /**
+     * This method gets called when socket recieves data. The method checks for the data type and reacts accordingly
+     * If data type:
+     * 1. Connect => checks if username is valid. if valid sends response to client with confirmation.
+     *  If username not valid quits connection by changing status to ERROR.
+     * 2. Confirm => Server should not recieve this kind of message. STDOUT informs about it.
+     * 3. Disconnect => Disconnects connection by removing connection from registry and calling method to terminate socket.
+     * 4. Message => Checks if broadcast or unicast. Sends data accordingly
+     * 5. Error => STDERR message
+     * @param data recieved by the server
+     */
     private void processData(String data)  {
         try {
-            // parse data content
             Scanner scanner = new Scanner(data);
-            String sender = null;
-            String reciever = null;
-            String type = null;
-            String payload = null;
-            if (scanner.hasNextLine()) {
-                sender = scanner.nextLine();
-            } else {
-                throw new ChatProtocolException("No Sender found");
-            }
-            if (scanner.hasNextLine()) {
-                reciever = scanner.nextLine();
-            } else {
-                throw new ChatProtocolException("No Reciever found");
-            }
-            if (scanner.hasNextLine()) {
-                type = scanner.nextLine();
-            } else {
-                throw new ChatProtocolException("No Type found");
-            }
-            if (scanner.hasNextLine()) {
-                payload = scanner.nextLine();
-            }
+            StringBuilder sender = new StringBuilder();
+            StringBuilder reciever = new StringBuilder();
+            StringBuilder type = new StringBuilder();
+            StringBuilder payload = new StringBuilder();
+            super.processData(scanner,sender,reciever,type,payload);
 
             // dispatch operation based on type parameter
-            if (type.equals(DATA_TYPE_CONNECT)) {
-                if (this.state != NEW) throw new ChatProtocolException("Illegal state for connect request: " + state);
-                if (sender == null || sender.isBlank()) sender = this.userName;
-                if (connectionRegistry.containsKey(sender))
-                    throw new ChatProtocolException("User name already taken: " + sender);
-                this.userName = sender;
-                connectionRegistry.put(userName, this);
-                sendData(USER_NONE, userName, DATA_TYPE_CONFIRM, "Registration successfull for " + userName);
-                this.state = CONNECTED;
-            } else if (type.equals(DATA_TYPE_CONFIRM)) {
+            if (type.toString().equals(getDataTypeConnect())) {
+                caseConnect(sender.toString());
+            } else if (type.toString().equals(getDataTypeConfirm())) {
                 System.out.println("Not expecting to receive a CONFIRM request from client");
-            } else if (type.equals(DATA_TYPE_DISCONNECT)) {
-                if (state == DISCONNECTED)
-                    throw new ChatProtocolException("Illegal state for disconnect request: " + state);
-                if (state == CONNECTED) {
-                    connectionRegistry.remove(this.userName);
-                }
-                sendData(USER_NONE, userName, DATA_TYPE_CONFIRM, "Confirm disconnect of " + userName);
-                this.state = DISCONNECTED;
-                this.stopReceiving();
-            } else if (type.equals(DATA_TYPE_MESSAGE)) {
-                if (state != CONNECTED) throw new ChatProtocolException("Illegal state for message request: " + state);
-                if (USER_ALL.equals(reciever)) {
-                    for (ServerConnectionHandler handler : connectionRegistry.values()) {
-                        handler.sendData(sender, reciever, type, payload);
-                    }
-                } else {
-                    ServerConnectionHandler handler = connectionRegistry.get(reciever);
-                    if (handler != null) {
-                        handler.sendData(sender, reciever, type, payload);
-                    } else {
-                        this.sendData(USER_NONE, userName, DATA_TYPE_ERROR, "Unknown User: " + reciever);
-                    }
-                }
-            } else if (type.equals(DATA_TYPE_ERROR)) {
+            } else if (type.toString().equals(getDataTypeDisconnect())) {
+                caseDisconnect();
+            } else if (type.toString().equals(getDataTypeMessage())) {
+                caseMessage(sender.toString(), reciever.toString(), type.toString(), payload.toString());
+            } else if (type.toString().equals(getDataTypeError())) {
                 System.err.println("Received error from client (" + sender + "): " + payload);
             } else {
                 System.err.println("Unknown data type received: " + type);
 
             }
         } catch(ChatProtocolException e) {
-            System.out.println("Error while processing data" + e.getMessage());
-            sendData(USER_NONE, userName, DATA_TYPE_ERROR, e.getMessage());
+            System.out.println("Error while processing data " + e.getMessage());
+            sendData(USER_NONE, userName, getDataTypeError(), e.getMessage());
         }
     }
 
-    public void sendData(String sender, String receiver, String type, String payload) {
-        if (connection.isAvailable()) {
-            new StringBuilder();
-            String data = new StringBuilder()
-                .append(sender+"\n")
-                .append(receiver+"\n")
-                .append(type+"\n")
-                .append(payload+"\n")
-                .toString();
-            try {
-                connection.send(data);
-            } catch (SocketException e) {
-                System.out.println("Connection closed: " + e.getMessage());
-            } catch (EOFException e) {
-                System.out.println("Connection terminated by remote");
-            } catch(IOException e) {
-                System.out.println("Communication error: " + e.getMessage());
+    /**
+     * This method is called by method {@link ServerConnectionHandler#processData(String)}
+     * Checks if username is valid. if valid sends response to client with confirmation.
+     * @param sender of the payload
+     * @throws ChatProtocolException if username not valid
+     */
+    private void caseConnect(String sender) throws ChatProtocolException {
+        if (this.state != NEW) throw new ChatProtocolException("Illegal state for connect request: " + state);
+        if (sender.isBlank()) sender = this.userName;
+        //if username not valid
+        if (connectionRegistry.containsKey(sender)) {
+            state = ERROR;
+            System.out.println(String.format("Connecting failed for new Client with IP:Port <%s:%d>.\nReason: Name already taken.",
+                    getConnection().getRemoteHost(),
+                    getConnection().getRemotePort()));
+            throw new ChatProtocolException("User name already taken: " + sender);
+        }
+        //if username valid
+        this.userName = sender;
+        connectionRegistry.put(userName, this);
+        sendData(USER_NONE, userName, getDataTypeConfirm(), "Registration successfull for " + userName);
+        this.state = CONNECTED;
+        System.out.println(String.format("Connected new Client %s with IP:Port <%s:%d>",
+                userName,
+                getConnection().getRemoteHost(),
+                getConnection().getRemotePort()));
+    }
+
+    /**
+     * This method is called by method {@link ServerConnectionHandler#processData(String)}
+     * Disconnects connection by removing connection from registry and calling method {@link ServerConnectionHandler#stopReceiving()} to terminate socket.
+     * @throws ChatProtocolException if state allready DISCONNECTED.
+     */
+    private void caseDisconnect() throws ChatProtocolException {
+        if (state == DISCONNECTED)
+            throw new ChatProtocolException("Illegal state for disconnect request: " + state);
+        if (state == CONNECTED) {
+            connectionRegistry.remove(this.userName);
+        }
+        sendData(USER_NONE, userName, getDataTypeConfirm(), "Confirm disconnect of " + userName);
+        this.state = DISCONNECTED;
+        this.stopReceiving();
+    }
+
+    /**
+     * This method is called by method {@link ServerConnectionHandler#processData(String)}
+     * Checks if broadcast or unicast. Sends data accordingly
+     * @param sender who sent data
+     * @param reciever to recieve data
+     * @param type of message
+     * @param payload data to transmit
+     * @throws ChatProtocolException if state not equal to CONNECT
+     */
+    private void caseMessage(String sender, String reciever, String type, String payload) throws ChatProtocolException{
+        if (state != CONNECTED) throw new ChatProtocolException("Illegal state for message request: " + state);
+        if (USER_ALL.equals(reciever)) {
+            for (ServerConnectionHandler handler : connectionRegistry.values()) {
+                handler.sendData(sender, reciever, type, payload);
+            }
+        } else {
+            ServerConnectionHandler handler = connectionRegistry.get(reciever);
+            if (handler != null) {
+                handler.sendData(sender, reciever, type, payload);
+                if(!reciever.equals(sender)){
+                    sendData(sender, reciever, type, payload); //send message to sender if it's a direct message and sender is not receiver.
+                }
+            } else {
+                this.sendData(USER_NONE, userName, getDataTypeError(), "Unknown User: " + reciever);
             }
         }
     }