Compare commits

...
Author SHA1 Message Date
schrom01 e53a751081 fixed Problem setting Username in ClientConnectionHandler
#42
2022-04-15 21:20:03 +02:00
Roman SchenkandGitHub Enterprise 64a6137372 Merge pull request #45 from PM2-IT21bWIN-ruiz-mach-krea/remove_server_lock
fixed issue #39
2022-04-15 21:18:13 +02:00
Andrin Fassbind 5257195d82 fixed issue #39 2022-04-15 21:13:28 +02:00
Andrin Fassbind 73dcfb5058 Java Doc Server && ServerConnectionHandler 2022-04-15 19:41:43 +02:00
Roman SchenkandGitHub Enterprise 84e59effec Merge pull request #44 from PM2-IT21bWIN-ruiz-mach-krea/continue_connectionhandler
Continue connectionhandler
2022-04-15 17:41:12 +02:00
Andrin Fassbind 9a534b2465 Shrink code in the ConnectionHandlers 2022-04-15 16:39:52 +02:00
Andrin Fassbind 37045ade15 Shrink code in the ConnectionHandlers 2022-04-15 16:25:45 +02:00
Leonardo BrandenbergerandGitHub Enterprise 313a4f5861 Merge pull request #43 from PM2-IT21bWIN-ruiz-mach-krea/refactoring_chatwindowcontroller
Refactoring chatwindowcontroller to improve MVC
2022-04-15 15:39:47 +02:00
schrom01 2b70299507 removed Method initialize because it's not used anymore. 2022-04-15 15:35:04 +02:00
schrom01 2b01e92e8d sovled #42 2022-04-15 15:34:03 +02:00
Roman SchenkandGitHub Enterprise a75d3466ef Merge pull request #41 from PM2-IT21bWIN-ruiz-mach-krea/Server_Console_Display
Fixes issue #37
2022-04-15 01:07:22 +02:00
Leonardo Brandenberger 97b6fff82e fixes #37 2022-04-15 00:14:22 +02:00
fassbandandGitHub Enterprise 2a8b701f48 Merge pull request #40 from PM2-IT21bWIN-ruiz-mach-krea/Refactoring_ClientConnectionHandler
Refactoring client connection handler
2022-04-14 22:24:13 +02:00
schrom01 86aa801b34 removed Enum State from ServerConnectionHandler.java because it's in ConnectionHandler.java now. 2022-04-14 22:23:49 +02:00
schrom01 2277fee73a merging 2022-04-14 22:12:35 +02:00
schrom01 d8dbd93c15 Merge branch 'main' into Refactoring_ClientConnectionHandler
# Conflicts:
#	client/src/main/java/ch/zhaw/pm2/multichat/client/ChatWindowController.java
#	client/src/main/java/ch/zhaw/pm2/multichat/client/ClientConnectionHandler.java
2022-04-14 22:02:39 +02:00
Roman SchenkandGitHub Enterprise 6e8e560d73 Merge pull request #38 from PM2-IT21bWIN-ruiz-mach-krea/ConnectionHandlerClass
Connection handler class
2022-04-14 21:51:59 +02:00
schrom01 615b3844e3 refactoring of ClientConnectionHandler
Instance is now created in ClientUI.java
solved #24 and #15
2022-04-14 21:13:36 +02:00
Roman SchenkandGitHub Enterprise 4a998b0f61 Merge pull request #36 from PM2-IT21bWIN-ruiz-mach-krea/SpecialCharacterUsername
Special character username
2022-04-14 20:39:05 +02:00
Andrin Fassbind b6fd5b569d fixed Issue #28 by checking if username contains space before starting connection 2022-04-14 19:33:18 +02:00
Andrin Fassbind b47d98b960 fixed Issue #19 by changing messagePattern 2022-04-14 12:11:03 +02:00
6 changed files with 322 additions and 240 deletions
@@ -2,8 +2,6 @@ package ch.zhaw.pm2.multichat.client;
import ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State; import ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State;
import ch.zhaw.pm2.multichat.protocol.ChatProtocolException; import ch.zhaw.pm2.multichat.protocol.ChatProtocolException;
import ch.zhaw.pm2.multichat.protocol.ConnectionHandler;
import ch.zhaw.pm2.multichat.protocol.NetworkHandler;
import javafx.application.Platform; import javafx.application.Platform;
import javafx.beans.value.ChangeListener; import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue; import javafx.beans.value.ObservableValue;
@@ -36,17 +34,18 @@ public class ChatWindowController {
@FXML private TextField filterValue; @FXML private TextField filterValue;
@FXML
public void initialize() {
serverAddressField.setText(NetworkHandler.DEFAULT_ADDRESS.getCanonicalHostName());
serverPortField.setText(String.valueOf(NetworkHandler.DEFAULT_PORT));
}
public void setMessages(ClientMessageList messages) { public void setMessages(ClientMessageList messages) {
this.messages = messages; this.messages = messages;
messageListener(); 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() { private void applicationClose() {
disconnect(); disconnect();
} }
@@ -100,35 +99,28 @@ public class ChatWindowController {
@FXML @FXML
private void applyFilter( ) { private void applyFilter( ) {
this.redrawMessageList(); Platform.runLater(() -> this.messageArea.setText(messages.getFilteredMessages(filterValue.getText().strip())));
} }
private void startConnectionHandler() throws IOException { private void startConnectionHandler() throws IOException {
String userName = userNameField.getText(); String userName = userNameField.getText();
String serverAddress = serverAddressField.getText(); if(!userName.contains(" ")) {
int serverPort = Integer.parseInt(serverPortField.getText()); String serverAddress = serverAddressField.getText();
connectionHandler = new ClientConnectionHandler( int serverPort = Integer.parseInt(serverPortField.getText());
NetworkHandler.openConnection(serverAddress, serverPort), userName, connectionHandler.initialize(serverAddress, serverPort, userName);
messages); new Thread(connectionHandler).start();
new Thread(connectionHandler).start();
//register Listener //register Listener
startListener(); //startConnectionHandlerListener();
// register window close handler // register window close handler
rootPane.getScene().getWindow().addEventHandler(WindowEvent.WINDOW_CLOSE_REQUEST, windowCloseHandler); rootPane.getScene().getWindow().addEventHandler(WindowEvent.WINDOW_CLOSE_REQUEST, windowCloseHandler);
} } else {
addError("It is not allowed to have spaces in username!");
private void terminateConnectionHandler() {
// unregister window close handler
rootPane.getScene().getWindow().removeEventHandler(WindowEvent.WINDOW_CLOSE_REQUEST, windowCloseHandler);
if (connectionHandler != null) {
connectionHandler.stopReceiving();
connectionHandler = null;
} }
} }
public void stateChanged(ConnectionHandler.State newState) { public void stateChanged(State newState) {
// update UI (need to be run in UI thread: see Platform.runLater()) // update UI (need to be run in UI thread: see Platform.runLater())
Platform.runLater(new Runnable() { Platform.runLater(new Runnable() {
@Override @Override
@@ -136,8 +128,8 @@ public class ChatWindowController {
connectButton.setText((newState == CONNECTED || newState == CONFIRM_DISCONNECT) ? "Disconnect" : "Connect"); connectButton.setText((newState == CONNECTED || newState == CONFIRM_DISCONNECT) ? "Disconnect" : "Connect");
} }
}); });
if (newState == DISCONNECTED) { if(newState == DISCONNECTED){
terminateConnectionHandler(); connectionHandler.stopReceiving();
} }
} }
@@ -172,19 +164,13 @@ public class ChatWindowController {
messages.addMessage(new Message(Message.MessageType.ERROR, null, null, message)); messages.addMessage(new Message(Message.MessageType.ERROR, null, null, message));
} }
private void redrawMessageList() {
this.messageArea.clear();
Platform.runLater(() -> this.messageArea.setText(messages.getFilteredMessages(filterValue.getText().strip())));
}
class WindowCloseHandler implements EventHandler<WindowEvent> { class WindowCloseHandler implements EventHandler<WindowEvent> {
public void handle(WindowEvent event) { public void handle(WindowEvent event) {
applicationClose(); applicationClose();
} }
} }
public void startListener() { public void startConnectionHandlerListener() {
connectionHandler.getStateProperty().addListener(new ChangeListener<State>() { connectionHandler.getStateProperty().addListener(new ChangeListener<State>() {
@Override @Override
public void changed(ObservableValue<? extends State> observable, State oldValue, State newValue) { public void changed(ObservableValue<? extends State> observable, State oldValue, State newValue) {
@@ -218,7 +204,7 @@ public class ChatWindowController {
messages.getChangedProperty().addListener(new ChangeListener<Boolean>() { messages.getChangedProperty().addListener(new ChangeListener<Boolean>() {
@Override @Override
public void changed(ObservableValue<? extends Boolean> observable, Boolean oldValue, Boolean newValue) { public void changed(ObservableValue<? extends Boolean> observable, Boolean oldValue, Boolean newValue) {
redrawMessageList(); Platform.runLater(() -> messageArea.setText(messages.getFilteredMessages(filterValue.getText().strip())));
} }
}); });
} }
@@ -17,7 +17,7 @@ import static ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State.*;
public class ClientConnectionHandler extends ConnectionHandler implements Runnable { public class ClientConnectionHandler extends ConnectionHandler implements Runnable {
private final Pattern messagePattern = Pattern.compile( "^(?:@(\\w*))?\\s*(.*)$" ); private final Pattern messagePattern = Pattern.compile( "^(?:@(\\S*))?\\s*(.*)$" );
private SimpleStringProperty userName; private SimpleStringProperty userName;
private SimpleObjectProperty<State> state; private SimpleObjectProperty<State> state;
@@ -25,15 +25,21 @@ public class ClientConnectionHandler extends ConnectionHandler implements Runnab
private SimpleStringProperty serverAddress; private SimpleStringProperty serverAddress;
private SimpleIntegerProperty serverPort; private SimpleIntegerProperty serverPort;
public ClientConnectionHandler(NetworkHandler.NetworkConnection<String> connection, public ClientConnectionHandler(ClientMessageList messages) {
String userName, super();
ClientMessageList messages) {
super(connection);
this.userName = new SimpleStringProperty((userName == null || userName.isBlank())? USER_NONE : userName);
this.messages = messages; this.messages = messages;
state = new SimpleObjectProperty<>(State.NEW); state = new SimpleObjectProperty<>(State.NEW);
serverAddress = new SimpleStringProperty(); serverAddress = new SimpleStringProperty(NetworkHandler.DEFAULT_ADDRESS.getCanonicalHostName());
serverPort = new SimpleIntegerProperty(); serverPort = new SimpleIntegerProperty(NetworkHandler.DEFAULT_PORT);
this.userName = new SimpleStringProperty(null);
}
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.set((userName == null || userName.isBlank())? USER_NONE : userName);
} }
public SimpleStringProperty getServerAddressProperty() { return serverAddress; } public SimpleStringProperty getServerAddressProperty() { return serverAddress; }
@@ -48,7 +54,6 @@ public class ClientConnectionHandler extends ConnectionHandler implements Runnab
public void setState (State newState) { public void setState (State newState) {
state.set(newState); state.set(newState);
} }
public void run () { public void run () {
@@ -94,66 +99,24 @@ public class ClientConnectionHandler extends ConnectionHandler implements Runnab
private void processData(String data) { private void processData(String data) {
try { try {
// parse data content
Scanner scanner = new Scanner(data); Scanner scanner = new Scanner(data);
String sender = null; StringBuilder sender = new StringBuilder();
String reciever = null; StringBuilder reciever = new StringBuilder();
String type = null; StringBuilder type = new StringBuilder();
String payload = null; StringBuilder payload = new StringBuilder();
if (scanner.hasNextLine()) { super.processData(scanner,sender,reciever,type,payload);
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();
}
// dispatch operation based on type parameter // dispatch operation based on type parameter
if (type.equals(getDataTypeConnect())) { if (type.toString().equals(getDataTypeConnect())) {
System.err.println("Illegal connect request from server"); System.err.println("Illegal connect request from server");
} else if (type.equals(getDataTypeConfirm())) { } else if (type.toString().equals(getDataTypeConfirm())) {
if (state.get() == CONFIRM_CONNECT) { caseConfirm(sender.toString(), reciever.toString(), payload.toString());
this.userName.set(reciever); } else if (type.toString().equals(getDataTypeDisconnect())) {
this.serverPort.set(getConnection().getRemotePort()); caseDisconnect(sender.toString(),reciever.toString(),payload.toString());
this.serverAddress.set(getConnection().getRemoteHost()); } else if (type.toString().equals(getDataTypeMessage())) {
messages.addMessage(new Message(Message.MessageType.INFO,sender,reciever,payload)); caseMessage(sender.toString(),reciever.toString(),payload.toString());
System.out.println("CONFIRM: " + payload); } else if (type.toString().equals(getDataTypeError())) {
this.setState(CONNECTED); caseError(sender.toString(), reciever.toString(), payload.toString());
} 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);
}
} else if (type.equals(getDataTypeDisconnect())) {
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);
} else if (type.equals(getDataTypeMessage())) {
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);
} else if (type.equals(getDataTypeError())) {
messages.addMessage(new Message(Message.MessageType.ERROR,sender,reciever,payload));
System.out.println("ERROR: " + payload);
} else { } else {
System.out.println("Unknown data type received: " + type); System.out.println("Unknown data type received: " + type);
} }
@@ -163,27 +126,47 @@ public class ClientConnectionHandler extends ConnectionHandler implements Runnab
} }
} }
private void sendData(String sender, String receiver, String type, String payload) { private void caseConfirm(String sender, String reciever, String payload) {
if (getConnection().isAvailable()) { if (state.get() == CONFIRM_CONNECT) {
new StringBuilder(); this.userName.set(reciever);
String data = new StringBuilder() this.serverPort.set(getConnection().getRemotePort());
.append(sender+"\n") this.serverAddress.set(getConnection().getRemoteHost());
.append(receiver+"\n") messages.addMessage(new Message(Message.MessageType.INFO,sender,reciever,payload));
.append(type+"\n") System.out.println("CONFIRM: " + payload);
.append(payload+"\n") this.setState(CONNECTED);
.toString(); } else if (state.get() == CONFIRM_DISCONNECT) {
try { messages.addMessage(new Message(Message.MessageType.INFO,sender,reciever,payload));
getConnection().send(data); System.out.println("CONFIRM: " + payload);
} catch (SocketException e) { this.setState(DISCONNECTED);
System.err.println("Connection closed: " + e.getMessage()); } else {
} catch (EOFException e) { System.err.println("Got unexpected confirm message: " + payload);
System.out.println("Connection terminated by remote");
} catch(IOException e) {
System.err.println("Communication error: " + e.getMessage());
}
} }
} }
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 { public void connect() throws ChatProtocolException {
if (state.get() != NEW) throw new ChatProtocolException("Illegal state for connect: " + state); if (state.get() != NEW) throw new ChatProtocolException("Illegal state for connect: " + state);
this.sendData(userName.get(), USER_NONE, getDataTypeConnect(),null); this.sendData(userName.get(), USER_NONE, getDataTypeConnect(),null);
@@ -213,5 +196,4 @@ public class ClientConnectionHandler extends ConnectionHandler implements Runnab
return false; return false;
} }
} }
} }
@@ -8,6 +8,7 @@ import javafx.stage.Stage;
public class ClientUI extends Application { public class ClientUI extends Application {
private ClientMessageList clientMessageList = new ClientMessageList(); private ClientMessageList clientMessageList = new ClientMessageList();
private ClientConnectionHandler connectionHandler = new ClientConnectionHandler(clientMessageList);
@Override @Override
public void start(Stage primaryStage) { public void start(Stage primaryStage) {
@@ -21,6 +22,7 @@ public class ClientUI extends Application {
ChatWindowController chatWindowController = loader.getController(); ChatWindowController chatWindowController = loader.getController();
chatWindowController.setMessages(clientMessageList); chatWindowController.setMessages(clientMessageList);
chatWindowController.setConnectionHandler(connectionHandler);
// fill in scene and stage setup // fill in scene and stage setup
Scene scene = new Scene(rootPane); Scene scene = new Scene(rootPane);
@@ -1,5 +1,10 @@
package ch.zhaw.pm2.multichat.protocol; 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 { public abstract class ConnectionHandler {
private NetworkHandler.NetworkConnection<String> connection; private NetworkHandler.NetworkConnection<String> connection;
@@ -14,11 +19,7 @@ public abstract class ConnectionHandler {
public static final String USER_ALL = "*"; public static final String USER_ALL = "*";
public enum State { public enum State {
NEW, CONFIRM_CONNECT, CONNECTED, CONFIRM_DISCONNECT, DISCONNECTED; NEW, CONFIRM_CONNECT, CONNECTED, CONFIRM_DISCONNECT, DISCONNECTED, ERROR;
}
public ConnectionHandler(NetworkHandler.NetworkConnection<String> connection) {
this.connection = connection;
} }
public static String getDataTypeConnect() { public static String getDataTypeConnect() {
@@ -45,7 +46,50 @@ public abstract class ConnectionHandler {
return connection; return connection;
} }
protected void setConnection() { protected void setConnection(NetworkHandler.NetworkConnection<String> connection) {
this.connection = 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());
}
}
}
} }
@@ -1,5 +1,6 @@
package ch.zhaw.pm2.multichat.server; package ch.zhaw.pm2.multichat.server;
import ch.zhaw.pm2.multichat.protocol.ConnectionHandler;
import ch.zhaw.pm2.multichat.protocol.NetworkHandler; import ch.zhaw.pm2.multichat.protocol.NetworkHandler;
import java.io.IOException; import java.io.IOException;
@@ -9,7 +10,15 @@ import java.util.Map;
import java.util.concurrent.locks.Condition; import java.util.concurrent.locks.Condition;
import java.util.concurrent.locks.ReentrantLock; 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 { public class Server {
// Server connection // Server connection
@@ -56,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 { public Server(int serverPort) throws IOException {
// Open server connection // Open server connection
System.out.println("Create server connection"); System.out.println("Create server connection");
@@ -63,6 +77,10 @@ public class Server {
System.out.println("Listening on " + networkServer.getHostAddress() + ":" + networkServer.getHostPort()); 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() { private void start() {
ReentrantLock mutex = new ReentrantLock(); ReentrantLock mutex = new ReentrantLock();
Condition nameComplete = mutex.newCondition(); Condition nameComplete = mutex.newCondition();
@@ -72,31 +90,19 @@ public class Server {
NetworkHandler.NetworkConnection<String> connection = networkServer.waitForConnection(); NetworkHandler.NetworkConnection<String> connection = networkServer.waitForConnection();
ServerConnectionHandler connectionHandler = new ServerConnectionHandler(connection, connections, mutex, nameComplete); ServerConnectionHandler connectionHandler = new ServerConnectionHandler(connection, connections, mutex, nameComplete);
new Thread(connectionHandler).start(); new Thread(connectionHandler).start();
mutex.lock();
try {
nameComplete.await();
System.out.println(String.format("Connected new Client %s with IP:Port <%s:%d>",
connectionHandler.getUserName(),
connection.getRemoteHost(),
connection.getRemotePort()
));
}
finally {
mutex.unlock();
}
} }
} catch(SocketException e) { } catch(SocketException e) {
System.out.println("Server connection terminated"); System.out.println("Server connection terminated");
} } catch (IOException e) {
catch (IOException e) {
System.err.println("Communication error " + e); System.err.println("Communication error " + e);
} catch (InterruptedException e) {
throw new RuntimeException(e);
} }
// close server // close server
System.out.println("Server Stopped."); System.out.println("Server Stopped.");
} }
/**
* This method will stop the serversocket.
*/
public void terminate() { public void terminate() {
try { try {
System.out.println("Close server port."); System.out.println("Close server port.");
@@ -2,12 +2,12 @@ package ch.zhaw.pm2.multichat.server;
import ch.zhaw.pm2.multichat.protocol.ChatProtocolException; import ch.zhaw.pm2.multichat.protocol.ChatProtocolException;
import ch.zhaw.pm2.multichat.protocol.ConnectionHandler; import ch.zhaw.pm2.multichat.protocol.ConnectionHandler;
import static ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State.*;
import ch.zhaw.pm2.multichat.protocol.NetworkHandler; import ch.zhaw.pm2.multichat.protocol.NetworkHandler;
import java.io.EOFException; import java.io.EOFException;
import java.io.IOException; import java.io.IOException;
import java.net.SocketException; import java.net.SocketException;
import java.util.HashMap;
import java.util.Map; import java.util.Map;
import java.util.Objects; import java.util.Objects;
import java.util.Scanner; import java.util.Scanner;
@@ -15,8 +15,32 @@ import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.locks.Condition; import java.util.concurrent.locks.Condition;
import java.util.concurrent.locks.ReentrantLock; import java.util.concurrent.locks.ReentrantLock;
import static ch.zhaw.pm2.multichat.server.ServerConnectionHandler.State.*;
/**
* 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{ public class ServerConnectionHandler extends ConnectionHandler implements Runnable{
private static final AtomicInteger connectionCounter = new AtomicInteger(0); private static final AtomicInteger connectionCounter = new AtomicInteger(0);
private final int connectionId = connectionCounter.incrementAndGet(); private final int connectionId = connectionCounter.incrementAndGet();
@@ -29,18 +53,25 @@ public class ServerConnectionHandler extends ConnectionHandler implements Runnab
private String userName = "Anonymous-"+connectionId; private String userName = "Anonymous-"+connectionId;
private State state = NEW; private State state = NEW;
/**
* Called when runnable gets started in a thread.
*/
@Override @Override
public void run() { public void run() {
startReceiving(); 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, public ServerConnectionHandler(NetworkHandler.NetworkConnection<String> connection,
Map<String,ServerConnectionHandler> registry, ReentrantLock mutex, Condition nameComplete) { Map<String,ServerConnectionHandler> registry, ReentrantLock mutex, Condition nameComplete) {
super(connection); super();
setConnection(connection);
Objects.requireNonNull(connection, "Connection must not be null"); Objects.requireNonNull(connection, "Connection must not be null");
Objects.requireNonNull(registry, "Registry must not be null"); Objects.requireNonNull(registry, "Registry must not be null");
this.connectionRegistry = registry; this.connectionRegistry = registry;
@@ -48,15 +79,31 @@ public class ServerConnectionHandler extends ConnectionHandler implements Runnab
this.nameComplete = nameComplete; this.nameComplete = nameComplete;
} }
/**
*
* @return the username of the connected client
*/
public String getUserName() { public String getUserName() {
return this.userName; return this.userName;
} }
/**
*
* @return state of the connection. Poosible states are see {@link ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State}
*/
public State getState() {
return state;
}
/**
* 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() { private void startReceiving() {
System.out.println("Starting Connection Handler for new User"); System.out.println("Starting Connection Handler for new User");
try { try {
System.out.println("Start receiving data..."); System.out.println("Start receiving data...");
while (getConnection().isAvailable()) { while (getConnection().isAvailable() && !(state == ERROR)) {
String data = getConnection().receive(); String data = getConnection().receive();
processData(data); processData(data);
} }
@@ -74,10 +121,17 @@ public class ServerConnectionHandler extends ConnectionHandler implements Runnab
} catch (ClassNotFoundException e) { } catch (ClassNotFoundException e) {
System.err.println("Received object of unknown type: " + e.getMessage()); 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); System.out.println("Stopping Connection Handler for " + userName);
}
} }
/**
* This method will call {@link NetworkHandler.NetworkConnection#close()} to close the Socket.
*/
private void stopReceiving() { private void stopReceiving() {
System.out.println("Closing Connection Handler for " + userName); System.out.println("Closing Connection Handler for " + userName);
try { try {
@@ -85,112 +139,120 @@ public class ServerConnectionHandler extends ConnectionHandler implements Runnab
getConnection().close(); getConnection().close();
System.out.println("Stopped receiving data."); System.out.println("Stopped receiving data.");
} catch (IOException e) { } 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); 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) { private void processData(String data) {
try { try {
// parse data content
Scanner scanner = new Scanner(data); Scanner scanner = new Scanner(data);
String sender = null; StringBuilder sender = new StringBuilder();
String reciever = null; StringBuilder reciever = new StringBuilder();
String type = null; StringBuilder type = new StringBuilder();
String payload = null; StringBuilder payload = new StringBuilder();
if (scanner.hasNextLine()) { super.processData(scanner,sender,reciever,type,payload);
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();
}
// dispatch operation based on type parameter // dispatch operation based on type parameter
if (type.equals(getDataTypeConnect())) { if (type.toString().equals(getDataTypeConnect())) {
if (this.state != NEW) throw new ChatProtocolException("Illegal state for connect request: " + state); caseConnect(sender.toString());
if (sender == null || sender.isBlank()) sender = this.userName; } else if (type.toString().equals(getDataTypeConfirm())) {
if (connectionRegistry.containsKey(sender))
throw new ChatProtocolException("User name already taken: " + sender);
mutex.lock();
try {
this.userName = sender;
nameComplete.signal();
}
finally {
mutex.unlock();
}
connectionRegistry.put(userName, this);
sendData(USER_NONE, userName, getDataTypeConfirm(), "Registration successfull for " + userName);
this.state = CONNECTED;
} else if (type.equals(getDataTypeConfirm())) {
System.out.println("Not expecting to receive a CONFIRM request from client"); System.out.println("Not expecting to receive a CONFIRM request from client");
} else if (type.equals(getDataTypeDisconnect())) { } else if (type.toString().equals(getDataTypeDisconnect())) {
if (state == DISCONNECTED) caseDisconnect();
throw new ChatProtocolException("Illegal state for disconnect request: " + state); } else if (type.toString().equals(getDataTypeMessage())) {
if (state == CONNECTED) { caseMessage(sender.toString(), reciever.toString(), type.toString(), payload.toString());
connectionRegistry.remove(this.userName); } else if (type.toString().equals(getDataTypeError())) {
}
sendData(USER_NONE, userName, getDataTypeConfirm(), "Confirm disconnect of " + userName);
this.state = DISCONNECTED;
this.stopReceiving();
} else if (type.equals(getDataTypeMessage())) {
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);
}
}
} else if (type.equals(getDataTypeError())) {
System.err.println("Received error from client (" + sender + "): " + payload); System.err.println("Received error from client (" + sender + "): " + payload);
} else { } else {
System.err.println("Unknown data type received: " + type); System.err.println("Unknown data type received: " + type);
} }
} catch(ChatProtocolException e) { } catch(ChatProtocolException e) {
System.out.println("Error while processing data" + e.getMessage()); System.out.println("Error while processing data " + e.getMessage());
sendData(USER_NONE, userName, getDataTypeError(), e.getMessage()); sendData(USER_NONE, userName, getDataTypeError(), e.getMessage());
} }
} }
private void sendData(String sender, String receiver, String type, String payload) { /**
if (getConnection().isAvailable()) { * This method is called by method {@link ServerConnectionHandler#processData(String)}
new StringBuilder(); * Checks if username is valid. if valid sends response to client with confirmation.
String data = new StringBuilder() * @param sender of the payload
.append(sender+"\n") * @throws ChatProtocolException if username not valid
.append(receiver+"\n") */
.append(type+"\n") private void caseConnect(String sender) throws ChatProtocolException {
.append(payload+"\n") if (this.state != NEW) throw new ChatProtocolException("Illegal state for connect request: " + state);
.toString(); if (sender.isBlank()) sender = this.userName;
try { //if username not valid
getConnection().send(data); if (connectionRegistry.containsKey(sender)) {
} catch (SocketException e) { state = ERROR;
System.out.println("Connection closed: " + e.getMessage()); System.out.println(String.format("Connecting failed for new Client with IP:Port <%s:%d>.\nReason: Name already taken.",
} catch (EOFException e) { getConnection().getRemoteHost(),
System.out.println("Connection terminated by remote"); getConnection().getRemotePort()));
} catch(IOException e) { throw new ChatProtocolException("User name already taken: " + sender);
System.out.println("Communication error: " + e.getMessage()); }
//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);
} }
} }
} }