Clear code + ajout commentaire

Notmoo-PC\Notmoo
1 parent 1e8c5c71
Showing 21 changed files with 180 additions and 60 deletions Show diff stats
src/main/java/core/ServerApp.java
src/main/java/core/dao/DebianDao.java
src/main/java/core/dao/HibernateDao.java
src/main/java/core/repository/AccessPoint.java
src/main/java/core/repository/IJavaBean.java
src/main/java/core/repository/Location.java
src/main/java/core/repository/Map.java
src/main/java/core/repository/RssiRecord.java
src/main/java/core/repository/TempRssi.java
src/main/java/core/service/CalibrationService.java
src/main/java/core/service/MapService.java
src/main/java/core/service/MeasurementService.java
src/main/java/core/service/PositioningService.java
src/main/java/core/utils/HibernateUtil.java
src/main/java/servlet/APCalibrationServlet.java
src/main/java/servlet/APMeasurementServlet.java
src/main/java/servlet/CalibrationServlet.java
src/main/java/servlet/MapByteServlet.java
src/main/java/servlet/MapScaleServlet.java
src/main/java/servlet/PositioningServlet.java
-import core.dao.HibernateDao;
-import core.repository.AccessPoint;
-import core.repository.Map;
-
-/**
- * Created by Guillaume on 09/05/2017.
- */
-public class ServerApp {
-    public static void main(String args[]){
-        HibernateDao dao = new HibernateDao();
-        AccessPoint ap = new AccessPoint();
-        ap.setMac_addr("aa:aa:aa:aa:aa:aa:aa:aa");
-        dao.saveAccessPoint(ap);
-        
-        Map map = new Map();
-        dao.saveMap(map);/**/
-    }
-}
-package core.dao;
-
-/**
- * Created by Guillaume on 09/05/2017.
- */
-public class DebianDao {
-    
-    public String getMacAddr(String ipAddr){
-        //TODO
-        return null;
-    }
-}
@@ -12,13 +12,24 @@ import java.util.List;
 /**
+ * Dao class handling access to database's data using Hibernate
+ *
  * Created by Guillaume on 09/05/2017.
  */
 public class HibernateDao {
     public HibernateDao () {
     }
-    
+
+    /**
+     * Execute a ITransactionProcess containing an Hibernate transaction,
+     * and return a callback object containing a list of results filled by
+     * the transactioin process and a boolean status.
+     *
+     * Handle properly Hibernate session's opening and closing, and handle exceptions that can occur.
+     * @param itp transaction process to run
+     * @return {@link TransactionCallBack}
+     */
     private TransactionCallBack execTransactionProcess(ITransactionProcess itp) {
         Session session = HibernateUtil.getSessionFactory().openSession();
         TransactionCallBack reply = new TransactionCallBack();
@@ -48,9 +59,18 @@ public class HibernateDao {
         }
         return reply;
     }
-    private <T> List<T> internal_getData(Class<T> clazz){
+
+    /**
+     * Generic method that return a list of objects that
+     * are contained in the database handled by Hibernate.
+     *
+     * @param clazz class of elements requests
+     *
+     * @return a list of objects of class {@code clazz}
+     */
+    private <T extends IJavaBean> List<T> internal_getData(Class<T> clazz){
         TransactionCallBack callBack = execTransactionProcess((session)->{
-            TransactionCallBack reply = new TransactionCallBack<T>();
+            TransactionCallBack reply = new TransactionCallBack<IJavaBean>();
             Query query = session.createQuery("from "+clazz.getSimpleName());
             List<Object> results = query.list();
             for(Object result : results){
@@ -61,6 +81,12 @@ public class HibernateDao {
         });
         return callBack.getResults();
     }
+
+    /**
+     * Generic method that push javabeans to the database using Hibernate.
+     * @param objs
+     * @return status, true if the transaction is successful, false otherwise
+     */
     private boolean internal_saveData(Object... objs){
         TransactionCallBack callBack = execTransactionProcess((session)->{
             TransactionCallBack reply = new TransactionCallBack();
@@ -72,10 +98,21 @@ public class HibernateDao {
         return callBack!=null && callBack.isStatus();
     }
-    
+
+    /**
+     *
+     * @param trs
+     * @return
+     */
     public boolean saveTempRssi(TempRssi... trs){
         return internal_saveData(trs);
     }
+
+    /**
+     *
+     * @param macAddr
+     * @return
+     */
     public List<TempRssi> getTempRssi(String macAddr){
         if(macAddr == null)
             return new ArrayList<>();
@@ -93,13 +130,28 @@ public class HibernateDao {
         });
         return callBack.getResults();
     }
-    
+
+    /**
+     *
+     * @param rssis
+     * @return
+     */
     public boolean saveRssiRecord(RssiRecord... rssis){
         return internal_saveData(rssis);
     }
+    /**
+     *
+     * @return
+     */
     public List<RssiRecord> getRssiRecord(){
         return internal_getData(RssiRecord.class);
     }
+
+    /**
+     *
+     * @param locationID
+     * @return
+     */
     public List<RssiRecord> getRssiRecord(Integer locationID){
         if(locationID == null)
             return getRssiRecord();
@@ -117,19 +169,44 @@ public class HibernateDao {
         });
         return callBack.getResults();
     }
-    
+
+    /**
+     *
+     * @return
+     */
     public List<Location> getLocations(){
         return internal_getData(Location.class);
     }
-    
+
+    /**
+     *
+     * @param aps
+     * @return
+     */
     public boolean saveAccessPoint (final AccessPoint... aps) {
         return internal_saveData(aps);
     }
+
+    /**
+     *
+     * @return
+     */
     public List<AccessPoint> getAccessPoint () {
        return internal_getData(AccessPoint.class);
     }
-    
+
+    /**
+     *
+     * @param map
+     * @return
+     */
     public boolean saveMap(final Map map){return internal_saveData(map);}
+
+    /**
+     *
+     * @param mapId
+     * @return
+     */
     public Map getMap(int mapId){
         TransactionCallBack callBack = execTransactionProcess((session)->{
             TransactionCallBack reply = new TransactionCallBack<Map>();
@@ -145,6 +222,11 @@ public class HibernateDao {
         return (callBack.getResults().isEmpty()?null:(Map)callBack.getResults().get(0));
     }
+    /**
+     *
+     * @param apMacAddress
+     * @return
+     */
     public List<AccessPoint> getAccessPoints(String apMacAddress) {
         TransactionCallBack callBack = execTransactionProcess((session)->{
             TransactionCallBack reply = new TransactionCallBack<AccessPoint>();
@@ -163,7 +245,11 @@ public class HibernateDao {
         return reply;
     }
-
+    /**
+     *
+     * @param location
+     * @return
+     */
     public int saveLocation(Location location) {
         TransactionCallBack callBack = execTransactionProcess((session)->{
             TransactionCallBack<Integer> reply = new TransactionCallBack<Integer>();
@@ -177,6 +263,12 @@ public class HibernateDao {
             return (Integer)callBack.results.get(0);
         return -1;
     }
+
+    /**
+     *
+     * @param Location
+     * @return
+     */
     public Location getLocation(int Location) {
         TransactionCallBack callBack = execTransactionProcess((session)->{
             TransactionCallBack reply = new TransactionCallBack<Location>();
@@ -192,11 +284,19 @@ public class HibernateDao {
         return (callBack.getResults().isEmpty()?null:(Location)callBack.getResults().get(0));
     }
-
+    /**
+     * This functional interface's purpose is to define a common
+     * type to give process to internal methods.
+     */
     private interface ITransactionProcess{
         TransactionCallBack exec(Session tr);
     }
-    
+
+    /**
+     *  Class designed to contains results from transaction process.
+     *
+     * @param <T>
+     */
     private class TransactionCallBack<T>{
         private boolean status;
         private List<T> results;
@@ -8,7 +8,7 @@ import javax.persistence.*;
  */
 @Entity
 @Table(name ="ACCESS_POINT")
-public class AccessPoint implements Serializable{
+public class AccessPoint implements IJavaBean{
     @Id @GeneratedValue
     private int id;
+package core.repository;
+
+import java.io.Serializable;
+
+/**
+ * Common type shared by all javabeans created for this positioning server
+ *
+ * Created by Notmoo on 17/06/2017.
+ */
+public interface IJavaBean extends Serializable{
+}
@@ -8,7 +8,7 @@ import java.io.Serializable;
  */
 @Entity
 @Table(name = "LOCATION")
-public class Location implements Serializable {
+public class Location implements IJavaBean {
     @Id @GeneratedValue
     private int id;
     private Double x, y;
@@ -8,7 +8,7 @@ import java.io.Serializable;
  */
 @Entity
 @Table(name = "MAP")
-public class Map implements Serializable{
+public class Map implements IJavaBean{
     @Id @GeneratedValue
     private int id;
     private Double x_topLeft, y_topLeft;
@@ -8,7 +8,7 @@ import java.io.Serializable;
  */
 @Entity
 @Table (name = "RSSI_RECORD")
-public class RssiRecord implements Serializable {
+public class RssiRecord implements IJavaBean {
     @Id @GeneratedValue
     private int id;
@@ -7,7 +7,7 @@ import javax.persistence.*;
  */
 @Entity
 @Table (name = "TEMP_RSSI")
-public class TempRssi {
+public class TempRssi implements IJavaBean{
     @Id @GeneratedValue
     private int id;
@@ -8,6 +8,9 @@ import core.repository.RssiRecord;
 import java.util.List;
 /**
+ * CalibrationService is a service class providing a way to register new calibration datas and new locations,
+ * that can be used afterwards to compute locations.
+ *
  * Created by Guillaume on 09/05/2017.
  */
 public class CalibrationService {
@@ -4,6 +4,9 @@ import core.dao.HibernateDao;
 import core.repository.Map;
 /**
+ * MapService is a service class providing methods to access map data
+ * stored in the database according to a map id.
+ *
  * Created by Guillaume on 29/05/2017.
  */
 public class MapService {
@@ -7,6 +7,10 @@ import core.repository.TempRssi;
 import java.util.List;
 /**
+ * MesaurementService is a service class providing methods to register positioning data.
+ * One shouldn't use this service to registrer calibration data, as a dedicated service class
+ * has been made to handle this kind of registrations.
+ *
  * Created by Guillaume on 29/05/2017.
  */
 public class MeasurementService {
@@ -16,7 +20,13 @@ public class MeasurementService {
     public MeasurementService(){
         dao = new HibernateDao();
     }
-    
+
+    /**
+     * Register into the database a measured positioning data.
+     * @param apMacAddr mac address of access point that measured the data
+     * @param clientMacAddr mac address of client that has been use as base for measurement
+     * @param val value measured
+     */
     public void registerMeasurement(String apMacAddr, String clientMacAddr, double val){
         List<AccessPoint> aps = dao.getAccessPoints(apMacAddr);
 package core.service;
-import core.dao.DebianDao;
 import core.dao.HibernateDao;
 import core.repository.Location;
 import core.repository.RssiRecord;
@@ -10,24 +9,23 @@ import java.util.ArrayList;
 import java.util.List;
 /**
+ * PositioningService is a service class designed to provide methods to compute one's location using measured data.
+ *
+ * To register measured data, please use {@link MeasurementService}. To register calibration data, please use {@link CalibrationService}
  * Created by Guillaume on 09/05/2017.
  */
 public class PositioningService {
-    private static final double DEFAULT_POSITIONING_PRECISION = 7.5;
-    
     private HibernateDao hibDao;
-    private DebianDao debDao;
     public PositioningService () {
-        this.debDao = new DebianDao();
         this.hibDao = new HibernateDao();
     }
-    public Location getLocation (String ipAddr) {
+    public Location getLocation (String macAddr) {
         //Liste des RSSISample associé à un ap, mesuré pour un client
-        List<TempRssi> clientRssi = hibDao.getTempRssi(debDao.getMacAddr(ipAddr));
+        List<TempRssi> clientRssi = hibDao.getTempRssi(macAddr);
         if(clientRssi.size()>=3) {
@@ -3,6 +3,9 @@ package core.utils;
 import org.hibernate.SessionFactory;
 import org.hibernate.cfg.AnnotationConfiguration;
+/**
+ * Singleton class granting access to Hibernate's session, built from annotations and hibernate config file
+ */
 public class HibernateUtil {
     private static final SessionFactory sessionFactory = buildSessionFactory();
@@ -10,6 +10,8 @@ import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
 /**
+ * Servlet designed to receive registration requests about calibration data.
+ *
  * Created by Guillaume on 07/06/2017.
  */
 public class APCalibrationServlet extends HttpServlet {
@@ -9,6 +9,8 @@ import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
 /**
+ * Servlet designed to receive registration requests about positioning data.
+ *
  * Created by Guillaume on 29/05/2017.
  */
 public class APMeasurementServlet extends HttpServlet {
@@ -14,6 +14,8 @@ import java.net.InetAddress;
 import java.util.Random;
 /**
+ * Servlet handling calibration request coming from clients.
+ *
  * Created by Guillaume on 15/05/2017.
  */
 public class CalibrationServlet extends HttpServlet{
@@ -60,10 +62,15 @@ public class CalibrationServlet extends HttpServlet{
         execute(servletRequest, servletResponse);
     }
+    /**
+     * Method broadcasting UPD request to AP, request asking fo calibration data.
+     * @param clientMacAddress mac address of client on which ap's measurement will be based
+     * @param locationId id of corresponding location in database
+     */
     private void multicastCalibrationRequest(String clientMacAddress, int locationId){
         try (DatagramSocket socket = new DatagramSocket(4445)){
-            byte[] buf = new byte[256];
+            byte[] buf;
             String dString = "{\"CALIB\": \"" + clientMacAddress + "\", \"SERV\": \"" + Inet4Address.getLocalHost().getHostAddress()+"\", \"LOC_ID\": \""+locationId+"\"}";
             buf = dString.getBytes();
@@ -10,6 +10,8 @@ import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
 /**
+ * Servlet designed to access to map image bytes. This kind of request is usually sent by clients.
+ *
  * Created by Guillaume on 29/05/2017.
  */
 public class MapByteServlet extends HttpServlet {
@@ -10,6 +10,8 @@ import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
 /**
+ * Servlet designed to access to map scale, which can be use to convert real-life coordinates to on-screen coordinates. This kind of request is usually sent by clients.
+ *
  * Created by Guillaume on 29/05/2017.
  */
 public class MapScaleServlet extends HttpServlet {
@@ -16,6 +16,8 @@ import java.net.InetAddress;
 import static java.lang.Thread.sleep;
 /**
+ * Servlet handling positioning request coming from clients.
+ *
  * Created by Guillaume on 15/05/2017.
  */
 public class PositioningServlet extends HttpServlet{
@@ -30,10 +32,10 @@ public class PositioningServlet extends HttpServlet{
         multicastPositioningRequest(clientMacAddr);
-        Location loc = null;
+        Location loc;
         do{
             try{
-                sleep(500l);
+                sleep(500L);
             } catch (InterruptedException e) {
                e.printStackTrace();
             }
@@ -56,11 +58,16 @@ public class PositioningServlet extends HttpServlet{
             throws ServletException, IOException {
         service(servletRequest, servletResponse);
     }
-    
+
+    /**
+     * Method broadcasting UPD request to AP, request asking for positioning data.
+     *
+     * @param clientMacAddress mac address of client on which ap's measurement will be based
+     */
     private void multicastPositioningRequest(String clientMacAddress){
         try (DatagramSocket socket = new DatagramSocket(4445)){
-            byte[] buf = new byte[256];
+            byte[] buf;
             String dString = "{\"LOCATE\": \"" + clientMacAddress + "\", \"SERV\": \"" + Inet4Address.getLocalHost().getHostAddress()+"\"}";
             buf = dString.getBytes();
@@ -10,7 +10,7 @@
         <property name="connection.username">lo53_user</property>
         <property name="connection.password">lo53</property>
         <property name="connection.pool_size">1</property>
-        <property name="hibernate.hbm2ddl.auto">create</property>
+        <property name="hibernate.hbm2ddl.auto">update</property>
         <mapping class="core.repository.AccessPoint"/>
         <mapping class="core.repository.Location"/>