Merge pull request #3 from eluchsinger/client-renaming

Client renaming

Author: eluchsinger

Client/src/main/java/controllers/networking/streaming/music/MusicStreamingService.java

@@ -3,6 +3,7 @@
 import controllers.io.cache.file.FileCacheService;
 import controllers.networking.streaming.music.callback.OnMusicStreamingStatusChanged;
 import controllers.networking.streaming.music.callback.OnPlay;
+import controllers.networking.streaming.music.callback.OnRename;
 import controllers.networking.streaming.music.callback.OnStop;
 import models.clients.Server;
 
@@ -12,9 +13,20 @@
  */
 public interface MusicStreamingService {
 
+    /**
+     * Starts the streaming service.
+     */
     void start();
+
+    /**
+     * Stops the streaming service.
+     */
     void stop();
 
+    /**
+     * Sets the current server.
+     * @param server The new server object.
+     */
     void setServer(Server server);
 
     void addServiceStatusChangedListener(OnMusicStreamingStatusChanged listener);
@@ -26,9 +38,14 @@ public interface MusicStreamingService {
     void addOnStopListener(OnStop listener);
     void removeOnStopListener(OnStop listener);
 
+    void addOnRenameListener(OnRename listener);
+    void removeOnRenameListener(OnRename listener);
+
     /**
      * Returns the cache (FileCache) of the MusicStreamingService.
      * @return FileCacheService.
      */
     FileCacheService getCache();
+
+    void sendName(String name);
 }

Client/src/main/java/controllers/networking/streaming/music/callback/OnRename.java

@@ -0,0 +1,14 @@
+package controllers.networking.streaming.music.callback;
+
+/**
+ * Created by Esteban on 01.04.2016.
+ *
+ */
+@FunctionalInterface
+public interface OnRename {
+    /**
+     * Renames the client.
+     * @param name The new name of the client.
+     */
+    void rename(String name);
+}

Client/src/main/java/controllers/networking/streaming/music/tcp/TCPMusicStreamingController.java

@@ -6,9 +6,11 @@
 import controllers.networking.streaming.music.ServiceStatus;
 import controllers.networking.streaming.music.callback.OnMusicStreamingStatusChanged;
 import controllers.networking.streaming.music.callback.OnPlay;
+import controllers.networking.streaming.music.callback.OnRename;
 import controllers.networking.streaming.music.callback.OnStop;
 import models.clients.Server;
 import models.networking.dtos.PlayCommand;
+import models.networking.dtos.RenameCommand;
 import models.networking.dtos.StopCommand;
 
 import java.io.IOException;
@@ -56,6 +58,8 @@ public class TCPMusicStreamingController implements MusicStreamingService {
 
     //endregion
 
+    private final Logger logger;
+
     /**
      * Current status of the service.
      */
@@ -92,33 +96,36 @@ public class TCPMusicStreamingController implements MusicStreamingService {
     /**
      * List of listeners listening for currentServiceStatus changes.
      */
-    private List<OnMusicStreamingStatusChanged> statusChangedListeners;
+    private final List<OnMusicStreamingStatusChanged> statusChangedListeners;
 
     /**
      * List of listeners listening for playCommands received.
      */
-    private List<OnPlay> playCommandListeners;
+    private final List<OnPlay> playCommandListeners;
 
     /**
      * List of listeners listening for stopCommands received.
      */
-    private List<OnStop> stopCommandListeners;
+    private final List<OnStop> stopCommandListeners;
+
+    private final ArrayList<OnRename> renameCommandListeners;
 
     //endregion listeners
 
     /**
      * Default constructor
      */
     public TCPMusicStreamingController() throws IOException {
-        this.initializeListeners();
-        this.cache = new StaticFileCacheService();
-        this.setCurrentServiceStatus(ServiceStatus.STOPPED);
-    }
+        this.logger = Logger.getLogger(this.getClass().getName());
 
-    private void initializeListeners() {
+        // Initialize Listeners
         this.statusChangedListeners = new ArrayList<>();
         this.playCommandListeners = new ArrayList<>();
         this.stopCommandListeners = new ArrayList<>();
+        this.renameCommandListeners = new ArrayList<>();
+
+        this.cache = new StaticFileCacheService();
+        this.setCurrentServiceStatus(ServiceStatus.STOPPED);
     }
 
     /**
@@ -134,8 +141,8 @@ public void start() {
             this.setCurrentServiceStatus(ServiceStatus.WAITING);
         } catch (IOException exception) {
             this.isRunning = false;
-            Logger.getLogger(this.getClass().getName())
-                    .log(Level.SEVERE, "Failed starting Music Streaming Service.", exception);
+            this.logger.log(Level.SEVERE, "Failed starting Music Streaming Service.", exception);
+
         }
     }
 
@@ -151,7 +158,7 @@ public void stop() {
             if (this.listeningThread != null && !this.listeningThread.isAlive())
                 this.listeningThread.join(SOCKET_TIMEOUT + 1000);
         } catch (InterruptedException e) {
-            Logger.getLogger(this.getClass().getName()).log(Level.SEVERE,
+            this.logger.log(Level.SEVERE,
                     "Error joining TCP Listening Thread", e);
         } finally {
             if (this.listeningThread == null || !this.listeningThread.isAlive())
@@ -163,8 +170,7 @@ public void stop() {
                     if(!this.getSocket().isClosed())
                         this.getSocket().close();
                 } catch (IOException e) {
-                    Logger.getLogger(this.getClass().getName())
-                            .log(Level.SEVERE,
+                    this.logger.log(Level.SEVERE,
                                     "Error closing the open socket", e);
                 }
             }
@@ -185,16 +191,22 @@ private void listen() {
 
                 // If it's a play command.
                 if(receivedObject instanceof PlayCommand) {
-                    System.out.println("Received PlayCommand");
+                    this.logger.log(Level.INFO, "Received PlayCommand");
                     PlayCommand command = (PlayCommand) receivedObject;
                     this.cache.writeData(command.data);
                     this.setCurrentServiceStatus(ServiceStatus.READY);
                     this.onPlayCommandReceived(command.songTitle, command.artist);
                 }
                 else if(receivedObject instanceof StopCommand) {
-                    System.out.println("Received StopCommand");
+                    this.logger.log(Level.INFO, "Received StopCommand");
                     this.onStopCommandReceived();
                 }
+                else if(receivedObject instanceof RenameCommand) {
+                    this.logger.log(Level.INFO, "Received RenameCommand");
+
+                    RenameCommand command = (RenameCommand) receivedObject;
+                    this.onRenameCommandReceived(command.getName());
+                }
 
             } catch (SocketTimeoutException ignore) {
             } catch(SocketException socketException) {
@@ -207,17 +219,16 @@ else if(receivedObject instanceof StopCommand) {
                     }
                 }
                 catch(Exception e) {
-                    Logger.getLogger(this.getClass().getName())
-                            .log(Level.SEVERE, "Error in the TCPStreaming listener!", e);
+                    this.logger.log(Level.SEVERE, "Error in the TCPStreaming listener!", e);
                 }
             }
             catch (IOException | ClassNotFoundException e) {
-                Logger.getLogger(this.getClass().getName())
-                        .log(Level.SEVERE, "Error in the TCPStreaming listener!", e);
+                this.logger.log(Level.SEVERE, "Error in the TCPStreaming listener!", e);
             }
         }
     }
 
+
     @Override
     public void setServer(Server server) {
         if (this.currentServer != server) {
@@ -335,34 +346,28 @@ private synchronized void setCurrentServiceStatus(ServiceStatus currentServiceSt
     }
 
     @Override
-    public void addServiceStatusChangedListener(OnMusicStreamingStatusChanged listener) {
-        this.statusChangedListeners.add(listener);
-    }
+    public void addServiceStatusChangedListener(OnMusicStreamingStatusChanged listener) { this.statusChangedListeners.add(listener); }
 
     @Override
-    public void removeServiceStatusChangedListener(OnMusicStreamingStatusChanged listener) {
-        this.statusChangedListeners.remove(listener);
-    }
+    public void removeServiceStatusChangedListener(OnMusicStreamingStatusChanged listener) { this.statusChangedListeners.remove(listener); }
 
     @Override
-    public void addOnPlayListener(OnPlay listener) {
-        this.playCommandListeners.add(listener);
-    }
+    public void addOnPlayListener(OnPlay listener) { this.playCommandListeners.add(listener); }
 
     @Override
-    public void removeOnPlayListener(OnPlay listener) {
-        this.playCommandListeners.remove(listener);
-    }
+    public void removeOnPlayListener(OnPlay listener) { this.playCommandListeners.remove(listener); }
 
     @Override
-    public void addOnStopListener(OnStop listener) {
-        this.stopCommandListeners.add(listener);
-    }
+    public void addOnStopListener(OnStop listener) { this.stopCommandListeners.add(listener); }
 
     @Override
-    public void removeOnStopListener(OnStop listener) {
-        this.stopCommandListeners.remove(listener);
-    }
+    public void removeOnStopListener(OnStop listener) { this.stopCommandListeners.remove(listener); }
+
+    @Override
+    public void addOnRenameListener(OnRename listener) { this.renameCommandListeners.add(listener);}
+
+    @Override
+    public void removeOnRenameListener(OnRename listener) { this.renameCommandListeners.remove(listener); }
 
     /**
      * Returns the cache (FileCache) of the MusicStreamingService.
@@ -374,6 +379,18 @@ public FileCacheService getCache() {
         return this.cache;
     }
 
+    /**
+     * Tells the server the name of this client.
+     * @param name
+     */
+    public void sendName(String name) {
+        try {
+            this.objectOutputStream.writeObject(new RenameCommand(name));
+        } catch(IOException ioException) {
+            this.logger.log(Level.WARNING, "Failed sending the current name to the server", ioException);
+        }
+    }
+
     //region Event Launchers
 
     /**
@@ -389,8 +406,8 @@ private void onServiceStatusChanged() {
     /**
      *
      * Fires the corresponding event to all the listeners.
-     * @param songTitle
-     * @param artist
+     * @param songTitle The title of the received song. (May be null)
+     * @param artist The artist of the received song. (May be null)
      */
     private void onPlayCommandReceived(String songTitle, String artist) {
         this.playCommandListeners.forEach(onPlay -> onPlay.play(songTitle, artist));
@@ -404,5 +421,10 @@ private void onStopCommandReceived() {
         this.stopCommandListeners.forEach(OnStop::stop);
     }
 
+    /**
+     * Fires the corresponding event to all the listeners.
+     */
+    private void onRenameCommandReceived(String name) { this.renameCommandListeners.forEach(l -> l.rename(name));}
+
     //endregion Event Launchers
 }