#103 added some comments

fabioformosa · Dec 11, 2022 · 527ee12 · 527ee12
1 parent 7fd174b
commit 527ee12
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/...er-api/src/main/java/it/fabioformosa/quartzmanager/api/configuration/WebsocketConfig.java b/...er-api/src/main/java/it/fabioformosa/quartzmanager/api/configuration/WebsocketConfig.java
@@ -1,5 +1,6 @@
 package it.fabioformosa.quartzmanager.api.configuration;
 
+import it.fabioformosa.quartzmanager.api.common.config.QuartzManagerPaths;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.messaging.simp.config.MessageBrokerRegistry;
@@ -14,14 +15,16 @@ public class WebsocketConfig extends AbstractWebSocketMessageBrokerConfigurer {
 
   @Override
   public void configureMessageBroker(MessageBrokerRegistry config) {
-    config.enableSimpleBroker("/topic");
-    config.setApplicationDestinationPrefixes("/job");
+    config.enableSimpleBroker("/topic"); //enable a simple memory-based message broker
+                                                        // on destinations prefixed with /topic
+    config.setApplicationDestinationPrefixes("/job"); // it designates the prefix for messages
+                                                      // that are bound for methods annotated with @MessageMapping
   }
 
   @Override
   public void registerStompEndpoints(StompEndpointRegistry registry) {
-    registry.addEndpoint("/quartz-manager/logs").setAllowedOrigins("/**").withSockJS();
-    registry.addEndpoint("/quartz-manager/progress").setAllowedOrigins("/**").withSockJS();
+    registry.addEndpoint(QuartzManagerPaths.QUARTZ_MANAGER_BASE_CONTEXT_PATH + "/logs").setAllowedOrigins("/**").withSockJS();
+    registry.addEndpoint(QuartzManagerPaths.QUARTZ_MANAGER_BASE_CONTEXT_PATH + "/progress").setAllowedOrigins("/**").withSockJS();
   }
 
 }
diff --git a/...-api/src/main/java/it/fabioformosa/quartzmanager/api/controllers/WebsocketController.java b/...-api/src/main/java/it/fabioformosa/quartzmanager/api/controllers/WebsocketController.java
@@ -8,7 +8,10 @@
 @Controller
 public class WebsocketController {
 
-    @MessageMapping({ QuartzManagerPaths.QUARTZ_MANAGER_BASE_CONTEXT_PATH + "/logs", QuartzManagerPaths.QUARTZ_MANAGER_BASE_CONTEXT_PATH + "/progress" })
+    @MessageMapping({
+      QuartzManagerPaths.QUARTZ_MANAGER_BASE_CONTEXT_PATH + "/logs",
+      QuartzManagerPaths.QUARTZ_MANAGER_BASE_CONTEXT_PATH + "/progress"
+    })
     @SendTo("/topic/logs")
     public String subscribe() {
         return "subscribed";

diff --git a/...api/src/main/java/it/fabioformosa/quartzmanager/api/websockets/WebSocketLogsNotifier.java b/...api/src/main/java/it/fabioformosa/quartzmanager/api/websockets/WebSocketLogsNotifier.java
@@ -14,7 +14,7 @@ public class WebSocketLogsNotifier implements WebhookSender<LogRecord> {
   private SimpMessageSendingOperations messagingTemplate;
 
   @Override
-  public void send(LogRecord logRecord)  {
+  public void send(LogRecord logRecord) {
     messagingTemplate.convertAndSend(TOPIC_LOGS, logRecord);
   }
 }