Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/rajdip-b/mychatserver

Last synced: about 15 hours ago
JSON representation
Host: GitHub
URL: https://github.com/rajdip-b/mychatserver
Owner: rajdip-b
Created: 2021-09-28T18:51:57.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-10-11T16:57:19.000Z (over 3 years ago)
Last Synced: 2023-03-06T12:59:18.841Z (almost 2 years ago)
Language: Java
Size: 36.1 KB
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # myChatServer 💬

> A chat server that supports my chatting app named myChat(platform independent)

sumario

A guide written and edited with great appreciation by [@rajdip-b](https://github.com/rajdip-b) and [@GustavoTxFreitas](https://github.com/GustavoTxFreitas)

📌 **Table of contents** 

1. [Environment setup](#environment-setup)

2. [Project Structure](#project-structure)

3. [Message Framework](#message-framework)

   1. [Login Request](#login-request)

   2. [Signup Request](#signup-request)

   3. [Handshake](#handshake-request)

   4. [Client List](#client-list)

   5. [Text Message](#text-message)

4. [Running the server](#running-server)

Environment setup

## Environment setup {#environment-setup}

1. Maven framework is used.

2. It is strongly recommended that you use an IDE that supports the maven framework (e.g., [Eclipse](https://www.eclipse.org/ide/), [IntelliJ](https://www.jetbrains.com/idea/), etc).

3. Once that's figured out, clone the repository into your IDE directly using the repo link.

4. From the IDE, import mysql-connectorj into the project build path and build the project.

5. That should get you set up. In case you still face some error, contact me or visit [StackOverflow](https://stackoverflow.com/)

6. Configure the .gitignore file to include all the IDE specific setting so that they don't get uploaded to the repo when you push.

7. In Main.java, change the `System.setProperty("javax.net.ssl.keyStore", "myChatKeyStore.jks")` to `System.setProperty("javax.net.ssl.keyStore", "src/main/java/myChatKeyStore.jks")` while running the project on ur IDE and revert back to normal when compiling as a jar.

8. Happy Coding! 🥳🥳🥳

Project Structure


This project is divided in two parts:

**Part 1**: handles the tasks associated with logging a user in or creating a new account (we call this the Credential part).

**Part 2**: handles all the tasks related to the main chat framework.

Message Framework


This project uses `HashMap` type of objects to communicate between the client and server or client and client. The different kinds of messages used are given below.

### Message types

(All the response messages already contain the query type from the request message in it, so I'm not rewriting them.)

 Login Request:


> This type of message is used between the client and the credential network. The purpose of this type of message is to let the server know that someone is trying to access the chat network and to log them in. 

 

This message has the following pattern: `[REQUEST -> FROM USER TO SERVER]`

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_QUERY | `QUERY_LOGIN_REQUEST` | The header that tells the server someone is trying to log in. |

| KEY_USERNAME | `USERNAME` | Holds the username of the person trying to access. |

| KEY_PASSWORD | `PASSWORD` | Holds the hashed password that is validated against the password that is stored in the database. |

This message has the following pattern: `[RESPONSE -> TO USER FROM SERVER]`

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_RESPONSE_CODE | `RESPONSE_CODE_FAILURE` or `RESPONSE_CODE_SUCCESS` | The response code tells the client whether their attempt to log in was successful or not. |

| KEY_RESPONSE_MESSAGE | `MESSAGE` | A message from the server regarding the response code in case the client wants to display it to the users. It varies for different kinds of failure. |

Once the login is successful, the user is re-directed to the chat network.

---

Signup Request:


> This type of message is used between the client and the credential network. The purpose of this type of message is to let the server know that someone is trying to register themselves into the server.

This message has the following pattern: `[REQUEST -> FROM CLIENT TO SERVER]`

   

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_QUERY | `QUERY_SIGNUP_REQUEST` | The header that tells the server someone is trying to sign up to the server. |

| KEY_USERNAME | `USERNAME` | [^1] |

| KEY_PASSWORD | `PASSWORD` | - |

| KEY_FIRST_NAME | `FIRST_NAME` | - |

| KEY_LAST_NAME | `LAST_NAME` | - |

| KEY_EMAIL | `EMAIL` | - |

[^1]: I skip the explanation of the next few lines since they are self-explanatory. If someone feels that they might want to fill it up then you are most welcome!

This message has the following pattern: `[RESPONSE -> TO CLIENT FROM SERVER]`

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_RESPONSE_CODE | `RESPONSE_CODE_FAILURE` or `RESPONSE_CODE_SUCCESS` | The response code tells the client whether their attempt to sign up was successful or not. |

| KEY_RESPONSE_MESSAGE | `MESSAGE` | A message from the server regarding the response code in case the client wants to display it to the users. It varies for different kinds of failure. |

Once the signup is successful, the user is redirected to the login screen

---

Handshake:


> This type of message is used between the client and the chat network. The purpose of this message is to let the chat server know about the whereabouts of the client. This message gets send to the chat network as the very first message. 

 

This message has the following pattern: `[REQUEST -> FROM CLIENT TO SERVER]`

   

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_QUERY | `QUERY_HANDSHAKE` | The header that tells the server that someone is trying to send their metadata to the server |

| KEY_USERNAME | `SENDER` | The person who is sending the message |

This message has the following pattern: `[RESPONSE -> TO CLIENT FROM SERVER]`

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_EXISTING_MESSAGES | A list of existing messages | A list of the previous messages is sent back to the user. |

If successful, the  client moves on to the next segment of establishing the communication.

---

 Client List Requests:


> This type of message is used between the client and the chat network. The purpose of this message is to get the list of active and inactive users from the server.

##### The client sends this message to the chat network to fetch the list.

This message has the following pattern: `[REQUEST -> FROM CLIENT TO SERVER]`

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_QUERY | `QUERY_CLIENT_LIST` | Tells the server that the client is requesting for the client list. |

| KEY_USERNAME | `USERNAME` | The client who is requesting the client list. |

This message has the following pattern: `[RESPONSE -> TO CLIENT FROM SERVER]`

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_ACTIVE_USERS_LIST | Active Users list | The server sends an arraylist of the number of clients that are currently active. |

| KEY_INACTIVE_USERS_LIST | Inactive Users list | The server sends an arraylist of the number of clients that are currently inactive. |

Once successful, the GUI in the client side is updated accordingly.

##### The chat server sends this message all active clients if any user gets connected/disconnected.

This message has the following pattern: `[RESPONSE -> TO CLIENT FROM SERVER]`

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_ACTIVE_USERS_LIST | Active Users list | The server sends an arraylist of the number of clients that are currently active. |

| KEY_INACTIVE_USERS_LIST | Inactive Users list | The server sends an arraylist of the number of clients that are currently inactive. |

Once successful, the GUI in the client side is updated accordingly.

---

 Text Message:


> This type of message is used between clients on the chat network. The purpose of this message is simply to carry the message of one user to another via the chat server. This message both generates and ends in the client side.

This message has the following pattern: `[REQUEST -> FROM CLIENT TO SERVER]`

| KEY | VALUE | DESCRIPTION |

| :--- | :--- | :--- |

| KEY_QUERY | `QUERY_SEND_MESSAGE` | Tells the server that someone wants to send a message. |

| KEY_MESSAGE | `MESSAGE` | The message that the user sends. |

This message has the following pattern: `[RESPONSE -> TO CLIENT FROM SERVER]`

(The initial message gets sent to all the active users except the one who sends it. The server doesn't reply on this kind of query)

Once successful, all the active users on the network receives the message sent.

 Running the server:


1. Create a runnable `jar`;

2. Run `java -jar jarfilename.jar`.