From 042f9503f1ad77d6de5e24daf0e6dcc3ea9185c5 Mon Sep 17 00:00:00 2001
From: mokeddes <youva.mokeddes@gmail.com>
Date: Sun, 7 Mar 2021 23:28:28 +0100
Subject: [PATCH] doc

---
 .../org.eclipse.core.resources.prefs          |  1 -
 serveurFTP/src/main/java/sr/projet2/Main.java |  5 ++
 .../java/sr/projet2/Request/AUTH_SSL.java     |  8 ++-
 .../java/sr/projet2/Request/AUTH_TLS.java     |  3 +
 .../main/java/sr/projet2/Request/CDUP.java    |  5 ++
 .../src/main/java/sr/projet2/Request/CWD.java |  6 ++
 .../main/java/sr/projet2/Request/FEAT.java    |  1 +
 .../main/java/sr/projet2/Request/LIST.java    |  6 ++
 .../src/main/java/sr/projet2/Request/MKD.java |  5 ++
 .../main/java/sr/projet2/Request/PASS.java    |  4 ++
 .../main/java/sr/projet2/Request/PASV.java    |  4 ++
 .../src/main/java/sr/projet2/Request/PWD.java |  4 ++
 .../main/java/sr/projet2/Request/QUIT.java    |  4 ++
 .../main/java/sr/projet2/Request/RNFR.java    |  4 ++
 .../main/java/sr/projet2/Request/RNTO.java    |  5 ++
 .../main/java/sr/projet2/Request/SYST.java    |  4 ++
 .../main/java/sr/projet2/Request/TYPE.java    |  4 ++
 .../main/java/sr/projet2/Request/USER.java    |  4 ++
 .../sr/projet2/Server/ConnectionServer.java   | 21 +++++-
 .../java/sr/projet2/Server/FtpConnexion.java  | 65 +++++++++++++++++--
 20 files changed, 156 insertions(+), 7 deletions(-)

diff --git a/serveurFTP/.settings/org.eclipse.core.resources.prefs b/serveurFTP/.settings/org.eclipse.core.resources.prefs
index f9fe345..e9441bb 100644
--- a/serveurFTP/.settings/org.eclipse.core.resources.prefs
+++ b/serveurFTP/.settings/org.eclipse.core.resources.prefs
@@ -1,4 +1,3 @@
 eclipse.preferences.version=1
 encoding//src/main/java=UTF-8
-encoding//src/test/java=UTF-8
 encoding/<project>=UTF-8
diff --git a/serveurFTP/src/main/java/sr/projet2/Main.java b/serveurFTP/src/main/java/sr/projet2/Main.java
index 2a8b88b..d492c35 100644
--- a/serveurFTP/src/main/java/sr/projet2/Main.java
+++ b/serveurFTP/src/main/java/sr/projet2/Main.java
@@ -5,6 +5,11 @@ import java.io.IOException;
 import sr.projet2.Server.ConnectionServer;
 
 public class Main {
+	/**
+	 * la classe qui nous permet de lancer notre application
+	 * @param args
+	 * @throws IOException
+	 */
 	public static void main(String[] args) throws IOException{
 		ConnectionServer server=new ConnectionServer(2020);
 		server.serverConnect();
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/AUTH_SSL.java b/serveurFTP/src/main/java/sr/projet2/Request/AUTH_SSL.java
index c361788..5752f74 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/AUTH_SSL.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/AUTH_SSL.java
@@ -5,12 +5,18 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class AUTH_SSL implements request {
+	/**
+	 * authentification de notre application
+	 */
 	private FtpConnexion ftp;
 	public AUTH_SSL(FtpConnexion ftp) {
 		this.ftp =ftp;
 	}
 
-	@Override
+	
+	/*
+	 * 
+	 */
 	public void send() throws IOException{
 		if (this.ftp.getSocket() == null ) {
 			throw new IOException("Ftp server error");
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/AUTH_TLS.java b/serveurFTP/src/main/java/sr/projet2/Request/AUTH_TLS.java
index fca7013..0ce77e6 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/AUTH_TLS.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/AUTH_TLS.java
@@ -5,6 +5,9 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class AUTH_TLS implements request {
+	/**
+	 * authentification de notre application
+	 */
 	private FtpConnexion ftp;
 	public AUTH_TLS(FtpConnexion ftp) {
 		this.ftp =ftp;
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/CDUP.java b/serveurFTP/src/main/java/sr/projet2/Request/CDUP.java
index 3950375..00d58f7 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/CDUP.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/CDUP.java
@@ -6,6 +6,11 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class CDUP implements request {
+	/**
+	 * retour au dossier parent
+     * Process pour retourner au dossier parent
+     * [CDUP]
+	 */
 	private FtpConnexion ftp;
 	public CDUP(FtpConnexion ftp) {
 		this.ftp =ftp;
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/CWD.java b/serveurFTP/src/main/java/sr/projet2/Request/CWD.java
index 0f13d03..7cb017c 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/CWD.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/CWD.java
@@ -6,6 +6,12 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class CWD implements request {
+	/**
+	 * 
+     * Process pour ouvrir un dossier
+     * [CWD]
+     */
+	 
 	private FtpConnexion ftp;
 	private String directory;
 	public CWD(FtpConnexion ftp,String directory) {
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/FEAT.java b/serveurFTP/src/main/java/sr/projet2/Request/FEAT.java
index 035ed15..d3ef454 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/FEAT.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/FEAT.java
@@ -5,6 +5,7 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class FEAT implements request {
+
 	private FtpConnexion ftp;
 	public FEAT(FtpConnexion ftp) {
 		this.ftp =ftp;
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/LIST.java b/serveurFTP/src/main/java/sr/projet2/Request/LIST.java
index 84decec..64f7e03 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/LIST.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/LIST.java
@@ -14,6 +14,12 @@ import java.text.SimpleDateFormat;
 import sr.projet2.Server.FtpConnexion;
 
 public class LIST implements request {
+	/**
+	 *     
+     * Process  qui permet de lister un repertoir
+     * [LIST]
+     */
+	 
 	private FtpConnexion ftp;
 	public LIST(FtpConnexion ftp) {
 		this.ftp =ftp;
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/MKD.java b/serveurFTP/src/main/java/sr/projet2/Request/MKD.java
index de116f5..aee25d7 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/MKD.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/MKD.java
@@ -6,6 +6,11 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class MKD implements request {
+	/**  
+     * Process pour creer un dossier
+     * [MKD]
+     */
+	
 	private FtpConnexion ftp;
 	private String DIR;
 	public MKD(FtpConnexion ftp, String DIR) {
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/PASS.java b/serveurFTP/src/main/java/sr/projet2/Request/PASS.java
index 90e22a9..be4a2ee 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/PASS.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/PASS.java
@@ -5,6 +5,10 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class PASS implements request {
+	/**
+	 * procces pour l'authentification -> mot de passe
+	 * [PASS]
+	 */
 	private FtpConnexion ftp;
 	private String pass;
 	public PASS(FtpConnexion ftp, String pass) {
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/PASV.java b/serveurFTP/src/main/java/sr/projet2/Request/PASV.java
index bbad071..637a777 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/PASV.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/PASV.java
@@ -7,6 +7,10 @@ import java.net.Socket;
 import sr.projet2.Server.FtpConnexion;
 
 public class PASV implements request {
+    /**
+     * Process pour passer en mode passif
+     * [PASV]
+     */
 	private FtpConnexion ftp;
 	public PASV(FtpConnexion ftp) {
 		this.ftp =ftp;
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/PWD.java b/serveurFTP/src/main/java/sr/projet2/Request/PWD.java
index f3c1263..0957364 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/PWD.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/PWD.java
@@ -5,6 +5,10 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class PWD implements request {
+    /**
+     * Process pour renvoyer l'enplacement courant (le chemin)
+     * [PWD]
+     */
 	private FtpConnexion ftp;
 	public PWD(FtpConnexion ftp) {
 		this.ftp =ftp;
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/QUIT.java b/serveurFTP/src/main/java/sr/projet2/Request/QUIT.java
index 3b92195..1daaa52 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/QUIT.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/QUIT.java
@@ -5,6 +5,10 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class QUIT implements request {
+	/**
+	 * process pour fermer un socket
+	 * [QUIT]
+	 */
 	private FtpConnexion ftp;
 	public QUIT(FtpConnexion ftp) {
 		this.ftp =ftp;
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/RNFR.java b/serveurFTP/src/main/java/sr/projet2/Request/RNFR.java
index 5e06d7f..8f1ccdd 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/RNFR.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/RNFR.java
@@ -6,6 +6,10 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class RNFR implements request {
+    /**
+     * Process rename from pour sauvgarder le nom du dossier a renomer
+     * [RNFR]
+     */
 	private FtpConnexion ftp;
 	private String name;
 	public RNFR(FtpConnexion ftp, String name) {
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/RNTO.java b/serveurFTP/src/main/java/sr/projet2/Request/RNTO.java
index d2e5a78..0976f6c 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/RNTO.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/RNTO.java
@@ -6,6 +6,11 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class RNTO implements request {
+	
+    /**
+     * Process rename to ( renomer le dossier sauvgardé avec rnfr )
+     * [RNTO]
+     */
 	private FtpConnexion ftp;
 	private String name;
 	public RNTO(FtpConnexion ftp, String name) {
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/SYST.java b/serveurFTP/src/main/java/sr/projet2/Request/SYST.java
index f5d3d80..09ea94d 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/SYST.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/SYST.java
@@ -5,6 +5,10 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class SYST implements request {
+    /**
+     * Process rename to ( renomer le dossier sauvgardé avec rnfr )
+     * [SYST]
+     */
 	private FtpConnexion ftp;
 	public SYST(FtpConnexion ftp) {
 		this.ftp =ftp;
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/TYPE.java b/serveurFTP/src/main/java/sr/projet2/Request/TYPE.java
index 35190e9..0eaf726 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/TYPE.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/TYPE.java
@@ -5,6 +5,10 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class TYPE implements request {
+	/**
+	 * return mode type
+	 * [TYPE]
+	 */
 	private FtpConnexion ftp;
 	private String type;
 	public TYPE(FtpConnexion ftp,String type) {
diff --git a/serveurFTP/src/main/java/sr/projet2/Request/USER.java b/serveurFTP/src/main/java/sr/projet2/Request/USER.java
index a522291..e04c059 100644
--- a/serveurFTP/src/main/java/sr/projet2/Request/USER.java
+++ b/serveurFTP/src/main/java/sr/projet2/Request/USER.java
@@ -5,6 +5,10 @@ import java.io.IOException;
 import sr.projet2.Server.FtpConnexion;
 
 public class USER implements request {
+	/**
+	 * process pour l'authentification -> utilisateur
+	 * [USER]
+	 */
 	private FtpConnexion ftp;
 	private String user;
 	public USER(FtpConnexion ftp,String user) {
diff --git a/serveurFTP/src/main/java/sr/projet2/Server/ConnectionServer.java b/serveurFTP/src/main/java/sr/projet2/Server/ConnectionServer.java
index 5827d07..5b4c6cb 100644
--- a/serveurFTP/src/main/java/sr/projet2/Server/ConnectionServer.java
+++ b/serveurFTP/src/main/java/sr/projet2/Server/ConnectionServer.java
@@ -10,9 +10,17 @@ import java.net.Socket;
 import java.util.Random;
 
 public class ConnectionServer {
+	/**
+	 * connexion au serveur
+	 */
 	private int PORT;
 	private ServerSocket srvSckt;
 	
+	/**
+	 * verifie si le port est bon , sinon on va generer un autre aléatoirment 
+	 * @param PORT
+	 * @throws IOException
+	 */
 	public ConnectionServer (int PORT) throws IOException {
 		if(PORT>1024 && PORT<8080){
 		this.PORT=PORT;
@@ -26,7 +34,10 @@ public class ConnectionServer {
 		
 	}
 	
-	
+	/**
+	 * 
+	 * @throws IOException
+	 */
 	public void server() throws IOException {
 		try {
 		this.srvSckt=new ServerSocket(this.PORT);
@@ -37,9 +48,17 @@ public class ConnectionServer {
 		}
 		
 	}
+	/**
+	 * 
+	 * @return serveSocket
+	 */
 	public ServerSocket getServ() {
 		return this.srvSckt;
 	}
+	/**
+	 * 
+	 * @throws IOException
+	 */
 	public void serverConnect() throws IOException {
 		try {
 		Socket socket=this.srvSckt.accept();
diff --git a/serveurFTP/src/main/java/sr/projet2/Server/FtpConnexion.java b/serveurFTP/src/main/java/sr/projet2/Server/FtpConnexion.java
index 5dfc3df..bfa417b 100644
--- a/serveurFTP/src/main/java/sr/projet2/Server/FtpConnexion.java
+++ b/serveurFTP/src/main/java/sr/projet2/Server/FtpConnexion.java
@@ -26,6 +26,9 @@ import sr.projet2.Request.TYPE;
 import sr.projet2.Request.USER;
 
 public class FtpConnexion extends Thread {
+	/**
+	 * établir une connexion ftp 
+	 */
 	private Socket socket;
 	private BufferedReader bfR;
 	private BufferedWriter bfW;
@@ -40,7 +43,10 @@ public class FtpConnexion extends Thread {
 		this.Connected=false;
 		this.directory="/";
 	}
-	
+	/**
+	 * 
+	 * @throws IOException
+	 */
 	public void auth() throws  IOException{
 		try {
 			this.bfW.write("220 FTP SERVER\r\n");
@@ -49,7 +55,9 @@ public class FtpConnexion extends Thread {
 			throw new IOException("FTP Connexion failed");
 		}
 	}
-	
+	/**
+	 * 
+	 */
 	public void run() {
 		try {
 			this.auth();
@@ -66,7 +74,11 @@ public class FtpConnexion extends Thread {
 		}
 	}
 	
-	
+	/**
+	 * appliquer la méthode send d'une commande selon son type
+	 * @param readLine
+	 * @throws IOException
+	 */
 	public void read(String readLine) throws IOException {
 		if(readLine.startsWith("AUTH TLS")) {
 			AUTH_TLS request= new AUTH_TLS(this);
@@ -149,40 +161,85 @@ public class FtpConnexion extends Thread {
 		}
 
 	}
-	
+	/**
+	 * 
+	 * @return socket
+	 */
 	public Socket getSocket() {
 		return this.socket;
 	}
+	/**
+	 * 
+	 * @return bufferwriter
+	 */
 	public BufferedWriter getBufferedWriter() {
 		return this.bfW;
 	}
+	/**
+	 * 
+	 * @return bufferReader
+	 */
 	public BufferedReader getBufferedReader() {
 		return this.bfR;
 	}
+	/**
+	 * 
+	 * @return connexionstate
+	 */
 	public boolean getConnectedState(){
 		return this.Connected;
 	}
+	/**
+	 *  connexion 
+	 */
 	public void connect() {
 		this.Connected=true;
 	}
+	/**
+	 * deconnexion
+	 */
 	public void disconnect(){
 		this.Connected=false;
 	}
+	/**
+	 * 
+	 * @return rep
+	 */
 	public String getDirectory(){
 		return this.directory;
 	}
+	/**
+	 * modifier le repertoir ou l'initialiser
+	 * @param Directory
+	 */
 	public void SetDirectory(String Directory){
 		this.directory=Directory;
 	}
+	/**
+	 * 
+	 * @return socketserver
+	 */
 	public ServerSocket getServerSocket(){
 		return this.socketServer;
 	}
+	/**
+	 * 
+	 * @param s
+	 */
 	public void SetServerSocket(ServerSocket s){
 		this.socketServer=s;
 	}
+	/**
+	 * 
+	 * @return rename
+	 */
 	public String getRename(){
 		return this.rename;
 	}
+	/**
+	 * rename
+	 * @param s
+	 */
 	public void SetRename(String s){
 		this.rename=s;
 	}
-- 
GitLab