Compare commits

..
Author SHA1 Message Date
Andrin Fassbind ad13445978 Start refactoring ClientConnectionHandler.java
ERROR UnsupportedOperationException in ClientMessageList
2022-04-12 21:11:35 +02:00
Andrin Fassbind 88d4493cfb Merge branch 'main' into State_Sync
# Conflicts:
#	client/src/main/java/ch/zhaw/pm2/multichat/client/ChatWindowController.java
#	client/src/main/java/ch/zhaw/pm2/multichat/client/ClientConnectionHandler.java
#	client/src/main/java/ch/zhaw/pm2/multichat/client/ClientMessageList.java
2022-04-12 19:29:11 +02:00
Andrin Fassbind f2fb32bbd4 Start refactoring ClientConnectionHandler.java 2022-04-12 19:22:13 +02:00
Andrin Fassbind f2945b3075 Make State SimpleObjectProperty in ClientConnectionHandler.java
Add changelistener to stateproperty in ChatWindowController.java

fixes Issue #21
2022-04-12 17:44:49 +02:00
13 changed files with 587 additions and 905 deletions
File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 133 KiB

@@ -1,12 +1,12 @@
package ch.zhaw.pm2.multichat.client; package ch.zhaw.pm2.multichat.client;
import ch.zhaw.pm2.multichat.protocol.ConnectionHandler; 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.ChatProtocolException;
import ch.zhaw.pm2.multichat.protocol.Message; 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;
import javafx.collections.ListChangeListener;
import javafx.event.EventHandler; import javafx.event.EventHandler;
import javafx.fxml.FXML; import javafx.fxml.FXML;
import javafx.scene.control.Button; import javafx.scene.control.Button;
@@ -16,162 +16,122 @@ import javafx.scene.layout.Pane;
import javafx.stage.WindowEvent; import javafx.stage.WindowEvent;
import java.io.IOException; import java.io.IOException;
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.*;
/**
* Class Representing the Controller Element of the Window, also Contains the Elements that contacts the View Elements via
* Listeners and Observable Objects.
* To Contact the Model Elements needed it also holds references to message and the Connectionhandler.
*/
public class ChatWindowController { public class ChatWindowController {
private ClientConnectionHandler connectionHandler; private ClientConnectionHandler connectionHandler;
private ClientMessageList messages; private ClientMessageList messages;
private final WindowCloseHandler windowCloseHandler = new WindowCloseHandler(); private final WindowCloseHandler windowCloseHandler = new WindowCloseHandler();
@FXML @FXML private Pane rootPane;
private Pane rootPane; @FXML private TextField serverAddressField;
@FXML @FXML private TextField serverPortField;
private TextField serverAddressField; @FXML private TextField userNameField;
@FXML @FXML private TextField messageField;
private TextField serverPortField; @FXML private TextArea messageArea;
@FXML @FXML private Button connectButton;
private TextField userNameField; @FXML private Button sendButton;
@FXML @FXML private TextField filterValue;
private TextField messageField;
@FXML
private TextArea messageArea;
@FXML
private Button connectButton;
@FXML
private TextField filterValue;
@FXML
private Button sendButton;
/** @FXML
* Takes a message object and stores it used as Model and also starts message Listener via messageListener method. public void initialize() {
* serverAddressField.setText(NetworkHandler.DEFAULT_ADDRESS.getCanonicalHostName());
* @param messages Object that will be set for use as Model serverPortField.setText(String.valueOf(NetworkHandler.DEFAULT_PORT));
*/ this.messages = new ClientMessageList();
public void setMessages(ClientMessageList messages) {
this.messages = messages; messages.getChangedProperty().addListener(new ChangeListener<Boolean>() {
messageListener(); @Override
public void changed(ObservableValue<? extends Boolean> observable, Boolean oldValue, Boolean newValue) {
setMessageField(messages.getMessages());
}
});
} }
/**
* Takes a Connection handler object and stores it used as Model and also starts a Listener for it.
*
* @param connectionHandler that will be set and used as Model.
*/
public void setConnectionHandler(ClientConnectionHandler connectionHandler) {
this.connectionHandler = connectionHandler;
startConnectionHandlerListener();
serverAddressField.setText(connectionHandler.getServerAddressProperty().get());
serverPortField.setText(String.valueOf(connectionHandler.getServerPortProperty().get()));
}
/**
* Method which closes the Application via use of the disconnect Method.
*/
private void applicationClose() { private void applicationClose() {
disconnect(); connectionHandler.setState(DISCONNECTED);
} }
/**
* Method that handles the Connect Button and Initiates connect when connectionHandler is not Connected or
* a disconnect when it is connected.
*/
@FXML @FXML
private void toggleConnection () { private void toggleConnection () {
if (connectionHandler == null || connectionHandler.getStateProperty().get() != CONNECTED) { if (connectionHandler == null || connectionHandler.getStateObjectProperty().get() != CONNECTED) {
connect(); connect();
} else { } else {
disconnect(); disconnect();
} }
} }
/**
* Initiates a connection by starting Connection Handler and telling, the Handler to start a connection.
*/
private void connect() { private void connect() {
try { try {
messages.clear(); // clear message list messages.clear(); // clear message list
startConnectionHandler(); startConnectionHandler();
connectionHandler.connect(); connectionHandler.connect();
} catch(ChatProtocolException | IOException e) { } catch(ChatProtocolException | IOException e) {
addError("Error while starting Connection Handler and connect" + e); messages.addMessage(null,null, e.getMessage(), Message.MessageType.ERROR);
} }
} }
/**
* Initiates disconnecting of the connectionHandler, also checks if connectionHandler is available.
*/
private void disconnect() { private void disconnect() {
if (connectionHandler == null) { if (connectionHandler == null) {
addError("No connection handler"); messages.addMessage(null,null,"No connection handler", Message.MessageType.ERROR);
return; return;
} }
try { try {
connectionHandler.disconnect(); connectionHandler.disconnect();
} catch (ChatProtocolException e) { } catch (ChatProtocolException e) {
addError(e.getMessage()); messages.addMessage(null,null, e.getMessage(), Message.MessageType.ERROR);
} }
} }
/**
* Method which is used when the send button is pressed and handing over a message to the Connection Handler
*/
@FXML @FXML
private void message() { private void message() {
String messageString = messageField.getText().strip(); String messageString = messageField.getText().strip();
try { try {
if (connectionHandler == null) { if (connectionHandler == null) {
addError("No connection handler"); messages.addMessage(null,null,"No connection handler", Message.MessageType.ERROR);
} else if (!connectionHandler.message(messageString)) { } else if (!connectionHandler.message(messageString)) {
addError("Not a valid message format."); messages.addMessage(null,null,"Not a valid message format.", Message.MessageType.ERROR);
} else { } else {
messageField.clear(); messageField.clear();
} }
} catch (ChatProtocolException e) { } catch (ChatProtocolException e) {
addError(e.getMessage()); messages.addMessage(null,null, e.getMessage(), Message.MessageType.ERROR);
} }
} }
/** //TODO: TEST
* Method which is used when a Filter is applied
* Setting the Text in the message area after sending it through the filter.
*/
@FXML @FXML
private void applyFilter( ) { private void applyFilter( ) {
Platform.runLater(() -> this.messageArea.setText(messages.getFilteredMessages(filterValue.getText().strip()))); messages.getFilteredMessages(filterValue.getText().strip());
} }
/**
* Starts the ConnectionHandler setting the username and Checking if the name follows the valid format of no spaces.
*
* @throws IOException for error that may occur during initialization of connectionHandler.
*/
private void startConnectionHandler() throws IOException { private void startConnectionHandler() throws IOException {
String userName = userNameField.getText(); String userName = userNameField.getText();
if (!userName.contains(" ")) {
String serverAddress = serverAddressField.getText(); String serverAddress = serverAddressField.getText();
int serverPort = Integer.parseInt(serverPortField.getText()); int serverPort = Integer.parseInt(serverPortField.getText());
connectionHandler.initialize(serverAddress, serverPort, userName); connectionHandler = new ClientConnectionHandler(messages,serverAddress,serverPort,userName);
new Thread(connectionHandler).start(); new Thread(connectionHandler).start();
//register changelistener
startChangeListener();
// 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;
} }
} }
/**
* Sets the state shown according to the state the method receives, if state indicates disconnected it will also inform the
* Connection Handler and tell it to stop Receiving more messages.
*
* @param newState is the state that it should be set to.
*/
public void stateChanged(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() {
@@ -181,15 +141,53 @@ public class ChatWindowController {
} }
}); });
if (newState == DISCONNECTED) { if (newState == DISCONNECTED) {
connectionHandler.stopReceiving(); terminateConnectionHandler();
} }
} }
/** private void startChangeListener() {
* Sets displayed username according to the String provided. //Listener for State
* connectionHandler.getStateObjectProperty().addListener(new ChangeListener<State>() {
* @param userName provided String that is set as name. @Override
*/ public void changed(ObservableValue<? extends State> observable, State oldValue, State newValue) {
stateChanged(newValue);
}
});
//Listener for Username
connectionHandler.getUserNameProperty().addListener(new ChangeListener<String>() {
@Override
public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
setUserName(newValue);
}
});
//Listener for Address
connectionHandler.getServerAddressProperty().addListener(new ChangeListener<String>() {
@Override
public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
setServerAddress(newValue);
}
});
//Listener for Port
connectionHandler.getServerPortProperty().addListener(new ChangeListener<Number>() {
@Override
public void changed(ObservableValue<? extends Number> observable, Number oldValue, Number newValue) {
setServerPort(newValue.intValue());
}
});
}
public void setMessageField(String message) {
Platform.runLater(new Runnable() {
@Override
public void run() {
messageField.setText(message);
}
});
}
public void setUserName(String userName) { public void setUserName(String userName) {
Platform.runLater(new Runnable() { Platform.runLater(new Runnable() {
@Override @Override
@@ -199,11 +197,6 @@ public class ChatWindowController {
}); });
} }
/**
* Sets displayed Server Address.
*
* @param serverAddress provided String that is set as server address.
*/
public void setServerAddress(String serverAddress) { public void setServerAddress(String serverAddress) {
Platform.runLater(new Runnable() { Platform.runLater(new Runnable() {
@Override @Override
@@ -213,11 +206,6 @@ public class ChatWindowController {
}); });
} }
/**
* Sets displayed Server port.
*
* @param serverPort provided String that is set as server port.
*/
public void setServerPort(int serverPort) { public void setServerPort(int serverPort) {
Platform.runLater(new Runnable() { Platform.runLater(new Runnable() {
@Override @Override
@@ -227,71 +215,17 @@ public class ChatWindowController {
}); });
} }
/** //TODO: MAKE ChangeListener
* Method which adds an incoming String as an Error Message. private void redrawMessageList() {
* this.messageArea.clear();
* @param message String to be added as Error Platform.runLater(() -> this.messageArea.setText(messages.getFilteredMessages(filterValue.getText().strip())));
*/
public void addError(String message) {
messages.addMessage(new Message(ConnectionHandler.DATA_TYPE.DATA_TYPE_ERROR, null, null, message));
} }
/**
* Nested Class in charge of Closing the window
*/
class WindowCloseHandler implements EventHandler<WindowEvent> { class WindowCloseHandler implements EventHandler<WindowEvent> {
/**
* @param event the event which occurred when Windows is closed
*/
public void handle(WindowEvent event) { public void handle(WindowEvent event) {
applicationClose(); applicationClose();
} }
}
/**
* Starts several new Listener for Connection Handler changes by using several observable properties.
*/
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());
}
});
}
/**
* Starts a new Listener for messages by using the observable Boolean.
*/
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())));
}
});
} }
} }
@@ -2,16 +2,8 @@ package ch.zhaw.pm2.multichat.client;
import javafx.application.Application; import javafx.application.Application;
/**
* Client Main Class in charge of starting the UI only contains main method.
*/
public class Client { public class Client {
/**
* Main method which launches the Client UI
*
* @param args no arguments needed
*/
public static void main(String[] args) { public static void main(String[] args) {
// Start UI // Start UI
System.out.println("Starting Client Application"); System.out.println("Starting Client Application");
@@ -1,9 +1,8 @@
package ch.zhaw.pm2.multichat.client; package ch.zhaw.pm2.multichat.client;
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.Message;
import ch.zhaw.pm2.multichat.protocol.NetworkHandler; import ch.zhaw.pm2.multichat.protocol.NetworkHandler;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleIntegerProperty; import javafx.beans.property.SimpleIntegerProperty;
import javafx.beans.property.SimpleObjectProperty; import javafx.beans.property.SimpleObjectProperty;
import javafx.beans.property.SimpleStringProperty; import javafx.beans.property.SimpleStringProperty;
@@ -15,118 +14,75 @@ import java.util.Scanner;
import java.util.regex.Matcher; import java.util.regex.Matcher;
import java.util.regex.Pattern; import java.util.regex.Pattern;
import static ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State.*; import static ch.zhaw.pm2.multichat.client.ClientConnectionHandler.State.*;
import static ch.zhaw.pm2.multichat.client.Message.MessageType.*;
/** public class ClientConnectionHandler implements Runnable {
* Client Connection Handler Class is used for the connection of the Client to a server private NetworkHandler.NetworkConnection<String> connection;
* it is used part as a Model storing properties like userName, state, serverAddress and Port.
* Also holds methods to
*/
public class ClientConnectionHandler extends ConnectionHandler implements Runnable {
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 final SimpleStringProperty userName; public static final String USER_NONE = "";
private final SimpleObjectProperty<State> state; public static final String USER_ALL = "*";
private final ClientMessageList messages;
private final SimpleStringProperty serverAddress;
private final SimpleIntegerProperty serverPort;
/** private SimpleStringProperty userName;
* Constructor initializes ConnectionHandler by Setting default values for the fields and stores the given messages itself. private SimpleIntegerProperty serverPort;
* private SimpleStringProperty serverAddress;
* @param messages private ObjectProperty<State> stateObjectProperty;
*/ private ClientMessageList messageList;
public ClientConnectionHandler(ClientMessageList messages) { private final Pattern messagePattern = Pattern.compile( "^(?:@(\\w*))?\\s*(.*)$" );
super();
this.messages = messages; enum State {
state = new SimpleObjectProperty<>(State.NEW); NEW, CONFIRM_CONNECT, CONNECTED, CONFIRM_DISCONNECT, DISCONNECTED;
serverAddress = new SimpleStringProperty(NetworkHandler.DEFAULT_ADDRESS.getCanonicalHostName());
serverPort = new SimpleIntegerProperty(NetworkHandler.DEFAULT_PORT);
this.userName = new SimpleStringProperty(null);
} }
/** public ClientConnectionHandler(ClientMessageList messageList,String serverAddress,int serverPort,String userName) throws IOException {
* Called to initialize the ClientConnectionHandler when trying to start a connection this.stateObjectProperty = new SimpleObjectProperty<>(NEW);
* this.userName = new SimpleStringProperty((userName == null || userName.isBlank())? USER_NONE : userName);
* @param serverAddress to connect to this.serverPort = new SimpleIntegerProperty();
* @param serverPort to connect to this.serverAddress = new SimpleStringProperty();
* @param userName to connect as this.messageList = messageList;
* @throws IOException if connection to Server not possible this.connection = NetworkHandler.openConnection(serverAddress,serverPort);
*/
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 ObjectProperty<State> getStateObjectProperty() {
* Observable getter Method for the stored serverAddress return stateObjectProperty;
*
* @return the stored serverAddress
*/
public SimpleStringProperty getServerAddressProperty() {
return serverAddress;
} }
/**
* Observable getter Method for the stored serverPort
*
* @return the stored serverPort
*/
public SimpleIntegerProperty getServerPortProperty() {
return serverPort;
}
/**
* Observable getter Method for the stored state
*
* @return the stored state
*/
public SimpleObjectProperty<State> getStateProperty() {
return this.state;
}
/**
* Observable getter Method for the stored userName
*
* @return the stored userName
*/
public SimpleStringProperty getUserNameProperty() { public SimpleStringProperty getUserNameProperty() {
return userName; return userName;
} }
/** public SimpleStringProperty getServerAddressProperty() {
* Method which sets a new State. return serverAddress;
* }
* @param newState the state that will be set
*/ public SimpleIntegerProperty getServerPortProperty() {
return serverPort;
}
public void setState (State newState) { public void setState (State newState) {
state.set(newState); this.stateObjectProperty.set(newState);
} }
/**
* Standard run method which will directly start the startReceiving method.
*/
public void run () { public void run () {
startReceiving(); startReceiving();
} }
/** public void startReceiving() {
* Method that is started by the run method, starts a connection handler.
* Figures out if connection is available if not determines the error cause and gives an error accordingly.
*/
private void startReceiving() {
System.out.println("Starting Connection Handler"); System.out.println("Starting Connection Handler");
try { try {
System.out.println("Start receiving data..."); System.out.println("Start receiving data...");
while (getConnection().isAvailable()) { while (connection.isAvailable()) {
Message data = getConnection().receive(); String data = connection.receive();
processData(data); processData(data);
} }
System.out.println("Stopped receiving data"); System.out.println("Stopped recieving data");
} catch (SocketException e) { } catch (SocketException e) {
System.out.println("Connection terminated locally"); System.out.println("Connection terminated locally");
this.setState(DISCONNECTED); this.setState(DISCONNECTED);
@@ -143,14 +99,11 @@ public class ClientConnectionHandler extends ConnectionHandler implements Runnab
System.out.println("Stopped Connection Handler"); System.out.println("Stopped Connection Handler");
} }
/**
* Method which is used to stop receiving data, gets the current connection and closes it.
*/
public void stopReceiving() { public void stopReceiving() {
System.out.println("Closing Connection Handler to Server"); System.out.println("Closing Connection Handler to Server");
try { try {
System.out.println("Stop receiving data..."); System.out.println("Stop receiving data...");
getConnection().close(); connection.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.getMessage()); System.err.println("Failed to close connection." + e.getMessage());
@@ -158,116 +111,113 @@ public class ClientConnectionHandler extends ConnectionHandler implements Runnab
System.out.println("Closed Connection Handler to Server"); System.out.println("Closed Connection Handler to Server");
} }
/**
* Method which processes data and determines its type then uses the corresponding method to process it. private void processData(String data) {
* try {
* @param data that is received in a form of a String and then used depending on its determined cause. // parse data content
*/ Scanner scanner = new Scanner(data);
private void processData(Message 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();
}
// dispatch operation based on type parameter // dispatch operation based on type parameter
if (data.getType() == DATA_TYPE.DATA_TYPE_CONNECT) { if (type.equals(DATA_TYPE_CONNECT)) {
System.err.println("Illegal connect request from server"); System.err.println("Illegal connect request from server");
} else if (data.getType() == DATA_TYPE.DATA_TYPE_CONFIRM) { } else if (type.equals(DATA_TYPE_CONFIRM)) {
caseConfirm(data); if (stateObjectProperty.get() == CONFIRM_CONNECT) {
} else if (data.getType() == DATA_TYPE.DATA_TYPE_DISCONNECT) { this.userName.set(reciever);
caseDisconnect(data); this.serverAddress.set(connection.getRemoteHost());
} else if (data.getType() == DATA_TYPE.DATA_TYPE_MESSAGE) { this.serverPort.set(connection.getRemotePort());
caseMessage(data); messageList.addMessage(sender,reciever,payload,INFO);
} else if (data.getType() == DATA_TYPE.DATA_TYPE_ERROR) { System.out.println("CONFIRM: " + payload);
caseError(data);
} else {
System.out.println("Unknown data type received: " + data.getType());
}
}
private void caseConfirm(Message data) {
if (state.get() == CONFIRM_CONNECT) {
this.userName.set(data.getReceiver());
this.serverPort.set(getConnection().getRemotePort());
this.serverAddress.set(getConnection().getRemoteHost());
messages.addMessage(data);
System.out.println("CONFIRM: " + data.getText());
this.setState(CONNECTED); this.setState(CONNECTED);
} else if (state.get() == CONFIRM_DISCONNECT) { } else if (stateObjectProperty.get() == CONFIRM_DISCONNECT) {
messages.addMessage(data); messageList.addMessage(sender,reciever,payload,INFO);
System.out.println("CONFIRM: " + data.getText()); System.out.println("CONFIRM: " + payload);
this.setState(DISCONNECTED); this.setState(DISCONNECTED);
} else { } else {
System.err.println("Got unexpected confirm message: " + data.getText()); System.err.println("Got unexpected confirm message: " + payload);
} }
} } else if (type.equals(DATA_TYPE_DISCONNECT)) {
if (stateObjectProperty.get() == DISCONNECTED) {
/** System.out.println("DISCONNECT: Already in disconnected: " + payload);
* Initiates the disconnect sequence and sends the message with all its info.
*
* @param data Data which has been transmitted
*/
private void caseDisconnect(Message data) {
if (state.get() == DISCONNECTED) {
System.out.println("DISCONNECT: Already in disconnected: " + data.getText());
return; return;
} }
messages.addMessage(data); messageList.addMessage(sender,reciever,payload,INFO);
System.out.println("DISCONNECT: " + data.getText()); System.out.println("DISCONNECT: " + payload);
this.setState(DISCONNECTED); this.setState(DISCONNECTED);
} } else if (type.equals(DATA_TYPE_MESSAGE)) {
if (stateObjectProperty.get() != CONNECTED) {
/** System.out.println("MESSAGE: Illegal state " + stateObjectProperty.get() + " for message: " + payload);
* Initiates the procedure to send a new message and sends one as such.
*
* @param data Data which has been transmitted
*/
private void caseMessage(Message data) {
if (state.get() != CONNECTED) {
System.out.println("MESSAGE: Illegal state " + state + " for message: " + data.getText());
return; return;
} }
messages.addMessage(data); messageList.addMessage(sender,reciever,payload,MESSAGE);
System.out.println("MESSAGE: From " + data.getSender() + " to " + data.getReceiver() + ": " + data.getText()); System.out.println("MESSAGE: From " + sender + " to " + reciever + ": "+ payload);
} else if (type.equals(DATA_TYPE_ERROR)) {
messageList.addMessage(sender,reciever,payload,ERROR);
System.out.println("ERROR: " + payload);
} 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.get(), DATA_TYPE_ERROR, e.getMessage());
}
} }
/** public void sendData(String sender, String receiver, String type, String payload) {
* Stores the message as an error message and displays it as such as well. if (connection.isAvailable()) {
* new StringBuilder();
* @param data Data which has been transmitted String data = new StringBuilder()
*/ .append(sender+"\n")
private void caseError(Message data) { .append(receiver+"\n")
messages.addMessage(data); .append(type+"\n")
System.out.println("ERROR: " + data.getText()); .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());
}
}
} }
/**
* Send connect attempt to Server
*
* @throws ChatProtocolException Error that is thrown if the state is not set to NEW
*/
public void connect() throws ChatProtocolException { public void connect() throws ChatProtocolException {
if (state.get() != NEW) throw new ChatProtocolException("Illegal state for connect: " + state); if (stateObjectProperty.get() != NEW) throw new ChatProtocolException("Illegal state for connect: " + stateObjectProperty.get());
this.sendData(userName.get(), USER_NONE, getDataTypeConnect(), null); this.sendData(userName.get(), USER_NONE, DATA_TYPE_CONNECT,null);
this.setState(CONFIRM_CONNECT); this.setState(CONFIRM_CONNECT);
} }
/**
* Send Disconnect attempt to server
*
* @throws ChatProtocolException Error tha si thrown if state is invalid
*/
public void disconnect() throws ChatProtocolException { public void disconnect() throws ChatProtocolException {
if (state.get() != NEW && state.get() != CONNECTED) if (stateObjectProperty.get() != NEW && stateObjectProperty.get() != CONNECTED) throw new ChatProtocolException("Illegal state for disconnect: " + stateObjectProperty.get());
throw new ChatProtocolException("Illegal state for disconnect: " + state); this.sendData(userName.get(), USER_NONE, DATA_TYPE_DISCONNECT,null);
this.sendData(userName.get(), USER_NONE, getDataTypeDisconnect(), null);
this.setState(CONFIRM_DISCONNECT); this.setState(CONFIRM_DISCONNECT);
} }
/**
* Sends message to Server
*
* @param messageString The message the user wants to send
* @return true if message is valid else false
* @throws ChatProtocolException if illegal connection state
*/
public boolean message(String messageString) throws ChatProtocolException { public boolean message(String messageString) throws ChatProtocolException {
if (state.get() != CONNECTED) throw new ChatProtocolException("Illegal state for message: " + state); if (stateObjectProperty.get() != CONNECTED) throw new ChatProtocolException("Illegal state for message: " + stateObjectProperty.get());
Matcher matcher = messagePattern.matcher(messageString); Matcher matcher = messagePattern.matcher(messageString);
if (matcher.find()) { if (matcher.find()) {
@@ -277,10 +227,11 @@ public class ClientConnectionHandler extends ConnectionHandler implements Runnab
return false; return false;
} }
if (receiver == null || receiver.isBlank()) receiver = ClientConnectionHandler.USER_ALL; if (receiver == null || receiver.isBlank()) receiver = ClientConnectionHandler.USER_ALL;
this.sendData(userName.get(), receiver, getDataTypeMessage(), message); this.sendData(userName.get(), receiver, DATA_TYPE_MESSAGE,message);
return true; return true;
} else { } else {
return false; return false;
} }
} }
} }
@@ -1,46 +1,46 @@
package ch.zhaw.pm2.multichat.client; package ch.zhaw.pm2.multichat.client;
import ch.zhaw.pm2.multichat.protocol.ConnectionHandler;
import ch.zhaw.pm2.multichat.protocol.Message;
import javafx.beans.property.SimpleBooleanProperty; import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.property.SimpleListProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
/** import static ch.zhaw.pm2.multichat.client.ClientConnectionHandler.USER_NONE;
* Class that is used to store the messages in an ArrayList
* And also as a Model that informs the controller via Listeners that can be initialized
*/
public class ClientMessageList {
private List<Message> messages = new ArrayList<>();
private final SimpleBooleanProperty changed = new SimpleBooleanProperty(false);
/** public class ClientMessageList {
* Adds a new message to ArrayList and also informs Listener. private List<Message> messages;
* private SimpleBooleanProperty changed;
* @param message that should be added
*/ public ClientMessageList() {
public void addMessage(Message message) { messages = new ArrayList<>();
messages.add(message); changed = new SimpleBooleanProperty(true);
}
public SimpleBooleanProperty getChangedProperty() {
return changed;
}
public void addMessage(String sender, String receiver, String message, Message.MessageType type) {
if(sender == null) {
sender = USER_NONE;
}
messages.add(new Message(type, sender, receiver, message));
changed.set(!changed.get()); changed.set(!changed.get());
} }
/**
* Applies a given filter over all messages and returns the result as a new String.
* Method is also in charge of applying the correct prefix to the message according to its type.
*
* @param filter is the applied filter on all the messages that are stored.
* @return String that matches the given filter.
*/
public String getFilteredMessages(String filter) { public String getFilteredMessages(String filter) {
StringBuilder result = new StringBuilder(); StringBuilder result = new StringBuilder();
boolean showAll = filter == null || filter.isBlank(); boolean showAll = filter == null || filter.isBlank();
for(Message message : messages) { for(Message message : messages) {
if (showAll || message.matchesFilter(filter)) { if(showAll || message.matchesFilter(filter))
{
switch (message.getType()) { switch (message.getType()) {
case DATA_TYPE_MESSAGE -> result.append(String.format("[%s -> %s] %s\n", message.getSender(), message.getReceiver(), message.getText())); case MESSAGE -> result.append(String.format("[%s -> %s] %s\n", message.getSender(), message.getReceiver(), message.getText()));
case DATA_TYPE_ERROR -> result.append(String.format("[ERROR] %s\n", message.getText())); case ERROR -> result.append(String.format("[ERROR] %s\n", message.getText()));
case DATA_TYPE_CONFIRM, DATA_TYPE_DISCONNECT, DATA_TYPE_CONNECT -> result.append(String.format("[INFO] %s\n", message.getText())); case INFO -> result.append(String.format("[INFO] %s\n", message.getText()));
default -> result.append(String.format("[ERROR] %s\n", "Unexpected message type: " + message.getType())); default -> result.append(String.format("[ERROR] %s\n", "Unexpected message type: " + message.getType()));
} }
} }
@@ -48,21 +48,21 @@ public class ClientMessageList {
return result.toString(); return result.toString();
} }
/** public String getMessages() {
* Overwrites the Arraylist of messages, clearing it, also informs all Listeners. StringBuilder result = new StringBuilder();
*/ for(Message message : messages) {
switch (message.getType()) {
case MESSAGE -> result.append(String.format("[%s -> %s] %s\n", message.getSender(), message.getReceiver(), message.getText()));
case ERROR -> result.append(String.format("[ERROR] %s\n", message.getText()));
case INFO -> result.append(String.format("[INFO] %s\n", message.getText()));
default -> result.append(String.format("[ERROR] %s\n", "Unexpected message type: " + message.getType()));
}
}
return result.toString();
}
public void clear() { public void clear() {
messages = new ArrayList<>(); messages = new SimpleListProperty<>();
changed.set(!changed.get());
}
/**
* Getter Method to check the current value of SimpleBooleanProperty changed.
*
* @return the current value of changed
*/
public SimpleBooleanProperty getChangedProperty() {
return changed;
} }
} }
@@ -6,40 +6,19 @@ import javafx.scene.Scene;
import javafx.scene.layout.Pane; import javafx.scene.layout.Pane;
import javafx.stage.Stage; import javafx.stage.Stage;
/**
* Class in charge of initializing and loading elements needed for the GUI.
* Also Launching the chat window with pre-given parameters
*/
public class ClientUI extends Application { public class ClientUI extends Application {
private final ClientMessageList clientMessageList = new ClientMessageList(); private ClientMessageList clientMessageList = new ClientMessageList();
private final ClientConnectionHandler connectionHandler = new ClientConnectionHandler(clientMessageList);
/**
* Start method will only run the chatWindow method.
*
* @param primaryStage the primary stage for this application, onto which
* the application scene can be set.
* Applications may create other stages, if needed, but they will not be
* primary stages.
*/
@Override @Override
public void start(Stage primaryStage) { public void start(Stage primaryStage) {
chatWindow(primaryStage); chatWindow(primaryStage);
} }
/**
* Method is in charge of loading the FXML file and then initializing the controllers and setting some parameters for the stage.
*
* @param primaryStage of the Application onto which the Scene is set.
*/
private void chatWindow(Stage primaryStage) { private void chatWindow(Stage primaryStage) {
try { try {
FXMLLoader loader = new FXMLLoader(getClass().getResource("ChatWindow.fxml")); FXMLLoader loader = new FXMLLoader(getClass().getResource("ChatWindow.fxml"));
Pane rootPane = loader.load();
ChatWindowController chatWindowController = loader.getController(); Pane rootPane = loader.load();
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);
@@ -0,0 +1,71 @@
package ch.zhaw.pm2.multichat.client;
/**
A Message object represents one Message of a client. Can be stored in ClientMessageList.
*/
public class Message {
private MessageType type;
private String sender;
private String receiver;
private String text;
/**
* Constructor of Message. Needs all Information about a Message to save them.
* @param type Message (if it's a message typed by a user), Error or Information (if it is generated automatically, in this case sender and reciever will be null)
* @param sender The User who has sent the message.
* @param receiver The User who should recieve the message.
* @param text The Text of the message.
*/
public Message(MessageType type, String sender, String receiver, String text) {
this.type = type;
this.sender = sender;
this.receiver = receiver;
this.text = text;
}
/**
* Checks if the Filter String is contained in one of the datafields sender, receiver or text
* @param filter The Filter String
* @return true if it the Filter String is contained in a datafield.
*/
public boolean matchesFilter(String filter){
return (sender != null && sender.contains(filter)) ||
(receiver != null && receiver.contains(filter)) ||
(text != null && text.contains(filter));
}
/**
* @return The type of the message.
*/
public MessageType getType() {
return type;
}
/**
* @return The User who has sent the Message.
*/
public String getSender() {
return sender;
}
/**
* @return The Reciever who recieves the Message.
*/
public String getReceiver() {
return receiver;
}
/**
* @return The Text of the Message.
*/
public String getText() {
return text;
}
/**
* Enummeration of Message Types.
*/
public enum MessageType {
INFO, MESSAGE, ERROR;
}
}
@@ -12,9 +12,7 @@
<?import javafx.scene.layout.HBox?> <?import javafx.scene.layout.HBox?>
<?import javafx.scene.layout.VBox?> <?import javafx.scene.layout.VBox?>
<BorderPane xmlns:fx="http://javafx.com/fxml/1" fx:id="rootPane" minWidth="-Infinity" prefHeight="500.0" <BorderPane fx:id="rootPane" minWidth="-Infinity" prefHeight="500.0" prefWidth="420.0" xmlns="http://javafx.com/javafx/18" xmlns:fx="http://javafx.com/fxml/1" fx:controller="ch.zhaw.pm2.multichat.client.ChatWindowController">
prefWidth="420.0" xmlns="http://javafx.com/javafx/18"
fx:controller="ch.zhaw.pm2.multichat.client.ChatWindowController">
<top> <top>
<VBox BorderPane.alignment="CENTER"> <VBox BorderPane.alignment="CENTER">
<children> <children>
@@ -33,25 +31,20 @@
</MenuBar> </MenuBar>
<HBox fillHeight="false" spacing="5.0"> <HBox fillHeight="false" spacing="5.0">
<children> <children>
<TextField fx:id="userNameField" alignment="CENTER_RIGHT" maxWidth="1.7976931348623157E308" <TextField fx:id="userNameField" alignment="CENTER_RIGHT" maxWidth="1.7976931348623157E308" minWidth="110.0" promptText="Username" HBox.hgrow="SOMETIMES" />
minWidth="110.0" promptText="Username" HBox.hgrow="SOMETIMES"/> <Label alignment="CENTER" contentDisplay="CENTER" text="\@" textAlignment="CENTER" textOverrun="CLIP" HBox.hgrow="NEVER">
<Label alignment="CENTER" contentDisplay="CENTER" text="\@" textAlignment="CENTER"
textOverrun="CLIP" HBox.hgrow="NEVER">
<HBox.margin> <HBox.margin>
<Insets bottom="5.0" top="5.0" /> <Insets bottom="5.0" top="5.0" />
</HBox.margin> </HBox.margin>
</Label> </Label>
<TextField fx:id="serverAddressField" alignment="CENTER_RIGHT" minWidth="110.0" <TextField fx:id="serverAddressField" alignment="CENTER_RIGHT" minWidth="110.0" promptText="Host" HBox.hgrow="SOMETIMES" />
promptText="Host" HBox.hgrow="SOMETIMES"/>
<Label text=":" HBox.hgrow="NEVER"> <Label text=":" HBox.hgrow="NEVER">
<HBox.margin> <HBox.margin>
<Insets bottom="5.0" top="5.0" /> <Insets bottom="5.0" top="5.0" />
</HBox.margin> </HBox.margin>
</Label> </Label>
<TextField fx:id="serverPortField" minWidth="-Infinity" prefWidth="60.0" promptText="Port" <TextField fx:id="serverPortField" minWidth="-Infinity" prefWidth="60.0" promptText="Port" HBox.hgrow="NEVER" />
HBox.hgrow="NEVER"/> <Button fx:id="connectButton" maxWidth="-Infinity" minWidth="-Infinity" mnemonicParsing="false" onAction="#toggleConnection" prefWidth="80.0" text="Connect" HBox.hgrow="NEVER">
<Button fx:id="connectButton" maxWidth="-Infinity" minWidth="-Infinity" mnemonicParsing="false"
onAction="#toggleConnection" prefWidth="80.0" text="Connect" HBox.hgrow="NEVER">
<HBox.margin> <HBox.margin>
<Insets left="5.0" /> <Insets left="5.0" />
</HBox.margin> </HBox.margin>
@@ -71,8 +64,7 @@
<HBox spacing="5.0"> <HBox spacing="5.0">
<children> <children>
<TextField fx:id="messageField" onAction="#message" HBox.hgrow="ALWAYS" /> <TextField fx:id="messageField" onAction="#message" HBox.hgrow="ALWAYS" />
<Button fx:id="sendButton" alignment="CENTER" maxWidth="-Infinity" minWidth="-Infinity" <Button fx:id="sendButton" alignment="CENTER" maxWidth="-Infinity" minWidth="-Infinity" mnemonicParsing="false" onAction="#message" prefWidth="50.0" text="Send" textAlignment="CENTER">
mnemonicParsing="false" onAction="#message" prefWidth="50.0" text="Send" textAlignment="CENTER">
<HBox.margin> <HBox.margin>
<Insets left="5.0" /> <Insets left="5.0" />
</HBox.margin> </HBox.margin>
@@ -1,101 +0,0 @@
package ch.zhaw.pm2.multichat.protocol;
import java.io.EOFException;
import java.io.IOException;
import java.net.SocketException;
/**
* This abstract class is the superclass for ClientConnectionHandler and ServerConnectionHandler
* It offers the DATA_TYPE for message and a {@link State} enum for all valid connection states.
* Shared methods are implemented in this class as well {@link ConnectionHandler#sendData(String, String, DATA_TYPE, String)}
*/
public abstract class ConnectionHandler {
private NetworkHandler.NetworkConnection<String> connection;
public static final String USER_NONE = "";
public static final String USER_ALL = "*";
// State of the connection
public enum State {
NEW, CONFIRM_CONNECT, CONNECTED, CONFIRM_DISCONNECT, DISCONNECTED, ERROR;
}
// DATA_TYPE of the messages
public enum DATA_TYPE {
DATA_TYPE_CONNECT, DATA_TYPE_CONFIRM, DATA_TYPE_DISCONNECT, DATA_TYPE_MESSAGE, DATA_TYPE_ERROR
}
/**
* @return {@link DATA_TYPE}
*/
public static DATA_TYPE getDataTypeConnect() {
return DATA_TYPE.DATA_TYPE_CONNECT;
}
/**
* @return {@link DATA_TYPE}
*/
public static DATA_TYPE getDataTypeConfirm() {
return DATA_TYPE.DATA_TYPE_CONFIRM;
}
/**
* @return {@link DATA_TYPE}
*/
public static DATA_TYPE getDataTypeDisconnect() {
return DATA_TYPE.DATA_TYPE_DISCONNECT;
}
/**
* @return {@link DATA_TYPE}
*/
public static DATA_TYPE getDataTypeMessage() {
return DATA_TYPE.DATA_TYPE_MESSAGE;
}
/**
* @return {@link DATA_TYPE}
*/
public static DATA_TYPE getDataTypeError() {
return DATA_TYPE.DATA_TYPE_ERROR;
}
/**
* @return {@link NetworkHandler.NetworkConnection}
*/
public NetworkHandler.NetworkConnection<String> getConnection() {
return connection;
}
/**
* This method sets the NetworkConnection used for the server <-> client connection
*
* @param connection NetworkConnection used for the server <-> client connection
*/
protected void setConnection(NetworkHandler.NetworkConnection<String> connection) {
this.connection = connection;
}
/**
* This method gets called to send data via the socket defined in the {@link NetworkHandler.NetworkConnection}
*
* @param sender of the data
* @param receiver of the data
* @param type of the data
* @param payload of the data
*/
protected void sendData(String sender, String receiver, DATA_TYPE type, String payload) {
if (connection.isAvailable()) {
try {
connection.send(new Message(type, sender, receiver, payload));
} 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,69 +0,0 @@
package ch.zhaw.pm2.multichat.protocol;
import java.io.Serializable;
/**
* A Message object represents one Message of a client. Can be stored in ClientMessageList.
*/
public class Message implements Serializable {
private final ConnectionHandler.DATA_TYPE type;
private final String sender;
private final String receiver;
private final String text;
/**
* Constructor of Message. Needs all Information about a Message to save them.
*
* @param type Message (if it's a message typed by a user), Error or Information (if it is generated automatically, in this case sender and receiver will be null)
* @param sender The User who has sent the message.
* @param receiver The User who should receive the message.
* @param text The Text of the message.
*/
public Message(ConnectionHandler.DATA_TYPE type, String sender, String receiver, String text) {
this.type = type;
this.sender = sender;
this.receiver = receiver;
this.text = text;
}
/**
* Checks if the Filter String is contained in one of the data fields sender, receiver or text
*
* @param filter The Filter String
* @return true if it is the Filter String is contained in a data field.
*/
public boolean matchesFilter(String filter) {
return (sender != null && sender.contains(filter)) ||
(receiver != null && receiver.contains(filter)) ||
(text != null && text.contains(filter));
}
/**
* @return The type of the message.
*/
public ConnectionHandler.DATA_TYPE getType() {
return type;
}
/**
* @return The User who has sent the Message.
*/
public String getSender() {
return sender;
}
/**
* @return The Receiver who receives the Message.
*/
public String getReceiver() {
return receiver;
}
/**
* @return The Text of the Message.
*/
public String getText() {
return text;
}
}
@@ -38,7 +38,7 @@ import java.util.Objects;
* on the client side, usually the result is displayed to the user). After processing is finished the * on the client side, usually the result is displayed to the user). After processing is finished the
* process calls {@link NetworkConnection#receive()} again to wait for the next request. * process calls {@link NetworkConnection#receive()} again to wait for the next request.
* </li> * </li>
* <li>sending data: call {@link NetworkConnection#send(Message)}, which sends the given data * <li>sending data: call {@link NetworkConnection#send(Serializable data)}, which sends the given data
* object to the remote side. The method returns as soon the object has been transmitted. * object to the remote side. The method returns as soon the object has been transmitted.
* <b>Important: {@link NetworkConnection} is not thread safe</b>, therefore make sure that only one thread * <b>Important: {@link NetworkConnection} is not thread safe</b>, therefore make sure that only one thread
* at a time is sending data.</li> * at a time is sending data.</li>
@@ -270,7 +270,7 @@ public class NetworkHandler {
* on the client side, usually the result is displayed to the user). After processing is finished the * on the client side, usually the result is displayed to the user). After processing is finished the
* process calls {@link NetworkConnection#receive()} again to wait for the next request. * process calls {@link NetworkConnection#receive()} again to wait for the next request.
* </li> * </li>
* <li>sending data: call {@link NetworkConnection#send(Message)}, which sends the given data * <li>sending data: call {@link NetworkConnection#send(Serializable data)}, which sends the given data
* object to the remote side. The method returns as soon the object has been transmitted. * object to the remote side. The method returns as soon the object has been transmitted.
* <b>Important: {@link NetworkConnection} is not thread safe</b>, therefore make sure that only one thread * <b>Important: {@link NetworkConnection} is not thread safe</b>, therefore make sure that only one thread
* at a time is sending data. * at a time is sending data.
@@ -305,7 +305,7 @@ public class NetworkHandler {
* @param data data object of type T to be submitted through the connection. * @param data data object of type T to be submitted through the connection.
* @throws IOException if an error occurs (e.g. connection interrupted while sending, ...) * @throws IOException if an error occurs (e.g. connection interrupted while sending, ...)
*/ */
public synchronized void send(Message data) throws IOException { public synchronized void send(T data) throws IOException {
ObjectOutputStream outputStream = new ObjectOutputStream(socket.getOutputStream()); ObjectOutputStream outputStream = new ObjectOutputStream(socket.getOutputStream());
outputStream.writeObject(data); outputStream.writeObject(data);
} }
@@ -320,9 +320,9 @@ public class NetworkHandler {
* @throws IOException if an error occours. (e.g. terminated locally/remotely) see above. * @throws IOException if an error occours. (e.g. terminated locally/remotely) see above.
* @throws ClassNotFoundException if the data object received does not match any class in the local classpath * @throws ClassNotFoundException if the data object received does not match any class in the local classpath
*/ */
public Message receive() throws IOException, ClassNotFoundException { public T receive() throws IOException, ClassNotFoundException {
ObjectInputStream inputStream = new ObjectInputStream(this.socket.getInputStream()); ObjectInputStream inputStream = new ObjectInputStream(this.socket.getInputStream());
return (Message) inputStream.readObject(); return (T) inputStream.readObject();
} }
/** /**
@@ -8,38 +8,14 @@ import java.util.HashMap;
import java.util.Map; import java.util.Map;
/**
* 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 connections will be attached to a Connection handler: {@link ServerConnectionHandler} and placed in a Map containing all active connections {@link Server#connections}
*/
public class Server { public class Server {
// Server connection // Server connection
private final NetworkHandler.NetworkServer<String> networkServer; private NetworkHandler.NetworkServer<String> networkServer;
// Connection registry // Connection registry
private final Map<String, ServerConnectionHandler> connections = new HashMap<>(); private Map<String,ServerConnectionHandler> connections = new HashMap<>();
/**
* 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");
networkServer = NetworkHandler.createServer(serverPort);
System.out.println("Listening on " + networkServer.getHostAddress() + ":" + networkServer.getHostPort());
}
/**
* @param args
*/
public static void main(String[] args) { public static void main(String[] args) {
// Parse arguments for server port. // Parse arguments for server port.
try { try {
@@ -78,30 +54,36 @@ public class Server {
} }
} }
/** public Server(int serverPort) throws IOException {
* With this methode the instance waits for incoming connections. If a client tries to connect to the server. // Open server connection
* The connection will be registered in the connection registry if successful. System.out.println("Create server connection");
*/ networkServer = NetworkHandler.createServer(serverPort);
System.out.println("Listening on " + networkServer.getHostAddress() + ":" + networkServer.getHostPort());
}
private void start() { private void start() {
System.out.println("Server started."); System.out.println("Server started.");
try { try {
while (networkServer.isAvailable()) { while (true) {
NetworkHandler.NetworkConnection<String> connection = networkServer.waitForConnection(); NetworkHandler.NetworkConnection<String> connection = networkServer.waitForConnection();
ServerConnectionHandler connectionHandler = new ServerConnectionHandler(connection, connections); ServerConnectionHandler connectionHandler = new ServerConnectionHandler(connection, connections);
new Thread(connectionHandler).start(); 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) { } 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);
} }
// 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.");
@@ -1,92 +1,68 @@
package ch.zhaw.pm2.multichat.server; 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 static ch.zhaw.pm2.multichat.protocol.ConnectionHandler.State.*;
import ch.zhaw.pm2.multichat.protocol.Message;
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;
import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicInteger;
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 as well as sends data to the client.
* <p>
* The ServeConnectionHandler offers following functionality:
* <p>
* 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}
* <p>
* 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()}
* <p>
* Process Messages send from a client by:
* 1. Evaluating the receiver by differentiating between broadcast or unicast.
* 2. Sending the message accordingly.
* <p>
* 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 static final AtomicInteger connectionCounter = new AtomicInteger(0);
private final int connectionId = connectionCounter.incrementAndGet(); private final int connectionId = connectionCounter.incrementAndGet();
private final NetworkHandler.NetworkConnection<String> connection;
private final Map<String,ServerConnectionHandler> connectionRegistry; 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 static final String USER_NONE = "";
private static final String USER_ALL = "*";
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 {
* Constructor to initialize the connection NEW, CONNECTED, DISCONNECTED;
* }
* @param connection representing the socket connection between server and client
* @param registry map containing all active connections between server and clients
*/
public ServerConnectionHandler(NetworkHandler.NetworkConnection<String> connection, public ServerConnectionHandler(NetworkHandler.NetworkConnection<String> connection,
Map<String,ServerConnectionHandler> registry) { Map<String,ServerConnectionHandler> registry) {
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.connection = connection;
this.connectionRegistry = registry; this.connectionRegistry = registry;
} }
/** public String getUserName() {
* These methods runs in a while-loop as long as the socket between server and client is available return this.userName;
* and the connection State is not ERROR. }
*/
private void startReceiving() { public void startReceiving() {
System.out.println("Starting Connection Handler for new User"); System.out.println("Starting Connection Handler for " + userName);
try { try {
System.out.println("Start receiving data..."); System.out.println("Start receiving data...");
while (getConnection().isAvailable() && !(state == ERROR)) { while (connection.isAvailable()) {
Message data = getConnection().receive(); String data = connection.receive();
processData(data); processData(data);
} }
System.out.println("Stopped receiving data"); System.out.println("Stopped recieving data");
} catch (SocketException e) { } catch (SocketException e) {
System.out.println("Connection terminated locally"); System.out.println("Connection terminated locally");
connectionRegistry.remove(userName); connectionRegistry.remove(userName);
@@ -100,133 +76,112 @@ 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);
} }
} public void stopReceiving() {
/**
* This method will call {@link NetworkHandler.NetworkConnection#close()} to close the Socket.
*/
private void stopReceiving() {
System.out.println("Closing Connection Handler for " + userName); System.out.println("Closing Connection Handler for " + userName);
try { try {
System.out.println("Stop receiving data..."); System.out.println("Stop receiving data...");
getConnection().close(); connection.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.getMessage()); System.err.println("Failed to close connection." + e);
} }
System.out.println("Closed Connection Handler for " + userName); System.out.println("Closed Connection Handler for " + userName);
} }
/** private void processData(String data) {
* This method gets called when socket receives 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 receive 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 received by the server
*/
private void processData(Message data) {
try { try {
// dispatch operation based on type parameter // parse data content
if (data.getType() == DATA_TYPE.DATA_TYPE_CONNECT) { Scanner scanner = new Scanner(data);
caseConnect(data); String sender = null;
} else if (data.getType() == DATA_TYPE.DATA_TYPE_CONFIRM) { String reciever = null;
System.out.println("Not expecting to receive a CONFIRM request from client"); String type = null;
} else if (data.getType() == DATA_TYPE.DATA_TYPE_DISCONNECT) { String payload = null;
caseDisconnect(); if (scanner.hasNextLine()) {
} else if (data.getType() == DATA_TYPE.DATA_TYPE_MESSAGE) { sender = scanner.nextLine();
caseMessage(data);
} else if (data.getType() == DATA_TYPE.DATA_TYPE_ERROR) {
System.err.println("Received error from client (" + data.getSender() + "): " + data.getText());
} else { } else {
System.err.println("Unknown data type received: " + data.getType()); throw new ChatProtocolException("No Sender found");
} }
} catch (ChatProtocolException e) { if (scanner.hasNextLine()) {
System.out.println("Error while processing data " + e.getMessage()); reciever = scanner.nextLine();
sendData(USER_NONE, userName, getDataTypeError(), e.getMessage()); } 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
* This method is called by method {@link ServerConnectionHandler#processData(Message)} if (type.equals(DATA_TYPE_CONNECT)) {
* Checks if username is valid. if valid sends response to client with confirmation.
*
* @param data sent
* @throws ChatProtocolException if username not valid
*/
private void caseConnect(Message data) throws ChatProtocolException {
if (this.state != NEW) throw new ChatProtocolException("Illegal state for connect request: " + state); if (this.state != NEW) throw new ChatProtocolException("Illegal state for connect request: " + state);
//if username not valid if (sender == null || sender.isBlank()) sender = this.userName;
if (connectionRegistry.containsKey(data.getSender())) { if (connectionRegistry.containsKey(sender))
state = ERROR; throw new ChatProtocolException("User name already taken: " + sender);
System.out.println(String.format("Connecting failed for new Client with IP:Port <%s:%d>.\nReason: Name already taken.", this.userName = sender;
getConnection().getRemoteHost(),
getConnection().getRemotePort()));
throw new ChatProtocolException("User name already taken: " + data.getSender());
}
//if username valid
if (!data.getSender().isBlank()) {
this.userName = data.getSender();
}
connectionRegistry.put(userName, this); connectionRegistry.put(userName, this);
sendData(USER_NONE, userName, getDataTypeConfirm(), "Registration successful for " + userName); sendData(USER_NONE, userName, DATA_TYPE_CONFIRM, "Registration successfull for " + userName);
this.state = CONNECTED; this.state = CONNECTED;
System.out.println(String.format("Connected new Client %s with IP:Port <%s:%d>", } else if (type.equals(DATA_TYPE_CONFIRM)) {
userName, System.out.println("Not expecting to receive a CONFIRM request from client");
getConnection().getRemoteHost(), } else if (type.equals(DATA_TYPE_DISCONNECT)) {
getConnection().getRemotePort()));
}
/**
* This method is called by method {@link ServerConnectionHandler#processData(Message)}
* Disconnects connection by removing connection from registry and calling method {@link ServerConnectionHandler#stopReceiving()} to terminate socket.
*
* @throws ChatProtocolException if state already DISCONNECTED.
*/
private void caseDisconnect() throws ChatProtocolException {
if (state == DISCONNECTED) if (state == DISCONNECTED)
throw new ChatProtocolException("Illegal state for disconnect request: " + state); throw new ChatProtocolException("Illegal state for disconnect request: " + state);
if (state == CONNECTED) { if (state == CONNECTED) {
connectionRegistry.remove(this.userName); connectionRegistry.remove(this.userName);
} }
sendData(USER_NONE, userName, getDataTypeConfirm(), "Confirm disconnect of " + userName); sendData(USER_NONE, userName, DATA_TYPE_CONFIRM, "Confirm disconnect of " + userName);
this.state = DISCONNECTED; this.state = DISCONNECTED;
this.stopReceiving(); 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)) {
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());
}
} }
/** public void sendData(String sender, String receiver, String type, String payload) {
* This method is called by method {@link ServerConnectionHandler#processData(Message)} if (connection.isAvailable()) {
* Checks if broadcast or unicast. Sends data accordingly new StringBuilder();
* String data = new StringBuilder()
* @param data to transmit .append(sender+"\n")
* @throws ChatProtocolException if state not equal to CONNECT .append(receiver+"\n")
*/ .append(type+"\n")
private void caseMessage(Message data) throws ChatProtocolException { .append(payload+"\n")
if (state != CONNECTED) throw new ChatProtocolException("Illegal state for message request: " + state); .toString();
if (USER_ALL.equals(data.getReceiver())) { try {
for (ServerConnectionHandler handler : connectionRegistry.values()) { connection.send(data);
handler.sendData(data.getSender(), data.getReceiver(), data.getType(), data.getText()); } catch (SocketException e) {
} System.out.println("Connection closed: " + e.getMessage());
} else { } catch (EOFException e) {
ServerConnectionHandler handler = connectionRegistry.get(data.getReceiver()); System.out.println("Connection terminated by remote");
if (handler != null) { } catch(IOException e) {
handler.sendData(data.getSender(), data.getReceiver(), data.getType(), data.getText()); System.out.println("Communication error: " + e.getMessage());
if (!data.getReceiver().equals(data.getSender())) {
sendData(data.getSender(), data.getReceiver(), data.getType(), data.getText()); //send message to sender if it's a direct message and sender is not receiver.
}
} else {
this.sendData(USER_NONE, userName, getDataTypeError(), "Unknown User: " + data.getReceiver());
} }
} }
} }