Moved web socket client related code out of SaveAndRestoreService

Author: georgweiss

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/ui/DataChangeListener.java

@@ -20,6 +20,7 @@
 package org.phoebus.applications.saveandrestore.ui;
 
 import javafx.beans.property.SimpleStringProperty;
+import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
 import org.phoebus.security.store.SecureStore;
 import org.phoebus.security.tokens.AuthenticationScope;
 import org.phoebus.security.tokens.ScopedAuthenticationToken;
@@ -63,4 +64,11 @@ public void secureStoreChanged(List<ScopedAuthenticationToken> validTokens) {
     public SimpleStringProperty getUserIdentity() {
         return userIdentity;
     }
+
+    /**
+     * Default no-op implementation of a handler for {@link SaveAndRestoreWebSocketMessage}s.
+     * @param webSocketMessage See {@link SaveAndRestoreWebSocketMessage}
+     */
+    public void handleWebSocketMessage(SaveAndRestoreWebSocketMessage<?> webSocketMessage){
+    }
 }

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/ui/SaveAndRestoreBaseController.java

@@ -168,24 +168,17 @@ public class SaveAndRestoreController extends SaveAndRestoreBaseController
     @FXML
     private VBox treeViewPane;
 
-    protected SaveAndRestoreService saveAndRestoreService;
+    private SaveAndRestoreService saveAndRestoreService;
+    private WebSocketClientService webSocketClientService;
 
     private final ObjectMapper objectMapper = new ObjectMapper();
-
     protected MultipleSelectionModel<TreeItem<Node>> browserSelectionModel;
-
     private static final String TREE_STATE = "tree_state";
-
     private static final String FILTER_NAME = "filter_name";
-
     protected static final Logger LOG = Logger.getLogger(SaveAndRestoreController.class.getName());
-
     protected Comparator<TreeItem<Node>> treeNodeComparator;
-
     protected SimpleBooleanProperty disabledUi = new SimpleBooleanProperty(false);
-
     private final SimpleBooleanProperty filterEnabledProperty = new SimpleBooleanProperty(false);
-
     private static final Logger logger = Logger.getLogger(SaveAndRestoreController.class.getName());
 
     @SuppressWarnings("unused")
@@ -263,7 +256,6 @@ public void initialize(URL url, ResourceBundle resourceBundle) {
         treeNodeComparator = Comparator.comparing(TreeItem::getValue);
 
         saveAndRestoreService = SaveAndRestoreService.getInstance();
-        saveAndRestoreService.openWebSocket();
         treeView.getSelectionModel().setSelectionMode(SelectionMode.MULTIPLE);
         treeView.getStylesheets().add(getClass().getResource("/save-and-restore-style.css").toExternalForm());
 
@@ -291,9 +283,6 @@ public void initialize(URL url, ResourceBundle resourceBundle) {
         });
 
         treeView.setShowRoot(true);
-
-        saveAndRestoreService.addWebSocketMessageHandler(this);
-
         treeView.setCellFactory(p -> new BrowserTreeCell(this));
         treeViewPane.disableProperty().bind(disabledUi);
         progressIndicator.visibleProperty().bind(disabledUi);
@@ -369,6 +358,12 @@ public Filter fromString(String s) {
         loadTreeData();
 
         webSocketTrackerLabel.textProperty().bind(webSocketTrackerText);
+
+        webSocketClientService = WebSocketClientService.getInstance();
+        webSocketClientService.addWebSocketMessageHandler(this);
+        webSocketClientService.setConnectCallback(() -> Platform.runLater(() -> webSocketTrackerText.setValue("Web Socket Connected")));
+        webSocketClientService.setDisconnectCallback(() -> Platform.runLater(() -> webSocketTrackerText.setValue("Web Socket Disconnected")));
+        webSocketClientService.connect();
     }
 
     /**
@@ -540,6 +535,7 @@ public SearchAndFilterTab openSearchWindow() {
             return searchAndFilterTab;
         }
     }
+
     /**
      * Creates a new folder {@link Node}.
      */
@@ -791,7 +787,7 @@ private void nodeChanged(Node node) {
         nodeSubjectToUpdate.setValue(node);
         // For updated and expanded folder nodes, refresh with respect to child nodes as
         // a move/copy operation may add/remove nodes.
-        if(nodeSubjectToUpdate.getValue().getNodeType().equals(NodeType.FOLDER) && nodeSubjectToUpdate.isExpanded()){
+        if (nodeSubjectToUpdate.getValue().getNodeType().equals(NodeType.FOLDER) && nodeSubjectToUpdate.isExpanded()) {
             expandTreeNode(nodeSubjectToUpdate);
         }
     }
@@ -802,7 +798,7 @@ private void nodeChanged(Node node) {
      *
      * @param nodeId Unique id of the added {@link Node}
      */
-    private void nodeAdded(String nodeId){
+    private void nodeAdded(String nodeId) {
         Node newNode = saveAndRestoreService.getNode(nodeId);
         try {
             Node parentNode = saveAndRestoreService.getParentNode(nodeId);
@@ -819,11 +815,12 @@ private void nodeAdded(String nodeId){
     /**
      * Handles callback in order to update the tree view when a {@link Node} has been deleted.
      * The purpose is to update the {@link TreeView} accordingly to reflect the change.
+     *
      * @param nodeId Unique id of the deleted {@link Node}
      */
-    private void nodeRemoved(String nodeId){
+    private void nodeRemoved(String nodeId) {
         TreeItem<Node> treeItemToRemove = recursiveSearch(nodeId, treeView.getRoot());
-        if(treeItemToRemove != null){
+        if (treeItemToRemove != null) {
             treeItemToRemove.getParent().getChildren().remove(treeItemToRemove);
         }
     }
@@ -932,8 +929,9 @@ public void saveLocalState() {
 
     public void handleTabClosed() {
         saveLocalState();
-        saveAndRestoreService.closeWebSocket();
-        saveAndRestoreService.removeWebSocketMessageHandler(this);
+        webSocketClientService.closeWebSocket();
+        webSocketClientService.removeWebSocketMessageHandler(this);
+        webSocketClientService.close();
     }
 
     /**
@@ -1298,10 +1296,10 @@ public boolean mayPaste() {
         if (clipBoardContent == null || browserSelectionModel.getSelectedItems().size() != 1) {
             return false;
         }
-        if(selectedItemsProperty.size() != 1 ||
-           selectedItemsProperty.get(0).getUniqueId().equals(Node.ROOT_FOLDER_UNIQUE_ID) ||
-           (!selectedItemsProperty.get(0).getNodeType().equals(NodeType.FOLDER) && !selectedItemsProperty.get(0).getNodeType().equals(NodeType.CONFIGURATION))){
-           return false;
+        if (selectedItemsProperty.size() != 1 ||
+                selectedItemsProperty.get(0).getUniqueId().equals(Node.ROOT_FOLDER_UNIQUE_ID) ||
+                (!selectedItemsProperty.get(0).getNodeType().equals(NodeType.FOLDER) && !selectedItemsProperty.get(0).getNodeType().equals(NodeType.CONFIGURATION))) {
+            return false;
         }
         // Check is made if target node is of supported type for the clipboard content.
         List<Node> selectedNodes = (List<Node>) clipBoardContent;
@@ -1491,14 +1489,13 @@ private void addOptionalLoggingMenuItem() {
     }
 
     @Override
-    public void handleWebSocketMessage(SaveAndRestoreWebSocketMessage<?> saveAndRestoreWebSocketMessage){
-        switch (saveAndRestoreWebSocketMessage.messageType()){
-            case NODE_ADDED -> nodeAdded((String)saveAndRestoreWebSocketMessage.payload());
-            case NODE_REMOVED -> nodeRemoved((String)saveAndRestoreWebSocketMessage.payload());
-            case NODE_UPDATED -> nodeChanged((Node)saveAndRestoreWebSocketMessage.payload());
-            case FILTER_ADDED_OR_UPDATED -> filterAddedOrUpdated((Filter)saveAndRestoreWebSocketMessage.payload());
-            case FILTER_REMOVED -> filterRemoved((String)saveAndRestoreWebSocketMessage.payload());
+    public void handleWebSocketMessage(SaveAndRestoreWebSocketMessage saveAndRestoreWebSocketMessage) {
+        switch (saveAndRestoreWebSocketMessage.messageType()) {
+            case NODE_ADDED -> nodeAdded((String) saveAndRestoreWebSocketMessage.payload());
+            case NODE_REMOVED -> nodeRemoved((String) saveAndRestoreWebSocketMessage.payload());
+            case NODE_UPDATED -> nodeChanged((Node) saveAndRestoreWebSocketMessage.payload());
+            case FILTER_ADDED_OR_UPDATED -> filterAddedOrUpdated((Filter) saveAndRestoreWebSocketMessage.payload());
+            case FILTER_REMOVED -> filterRemoved((String) saveAndRestoreWebSocketMessage.payload());
         }
     }
-
 }

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/ui/SaveAndRestoreController.java

@@ -19,13 +19,10 @@
 package org.phoebus.applications.saveandrestore.ui;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import org.epics.vtype.VType;
-import org.phoebus.applications.saveandrestore.client.Preferences;
 import org.phoebus.applications.saveandrestore.client.SaveAndRestoreClient;
 import org.phoebus.applications.saveandrestore.client.SaveAndRestoreClientImpl;
 import org.phoebus.applications.saveandrestore.model.CompositeSnapshot;
@@ -43,20 +40,15 @@
 import org.phoebus.applications.saveandrestore.model.UserData;
 import org.phoebus.applications.saveandrestore.model.search.Filter;
 import org.phoebus.applications.saveandrestore.model.search.SearchResult;
-import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
-import org.phoebus.applications.saveandrestore.model.websocket.WebMessageDeserializer;
 import org.phoebus.core.vtypes.VDisconnectedData;
-import org.phoebus.core.websocket.WebSocketClient;
 import org.phoebus.pv.PV;
 import org.phoebus.pv.PVPool;
 import org.phoebus.saveandrestore.util.VNoData;
 import org.phoebus.util.time.TimestampFormats;
 
 import javax.ws.rs.core.MultivaluedMap;
-import java.net.URI;
 import java.time.Instant;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Future;
@@ -71,33 +63,20 @@ public class SaveAndRestoreService {
 
     private final ExecutorService executor;
 
-    private final List<WebSocketMessageHandler> webSocketMessageHandlers = Collections.synchronizedList(new ArrayList<>());
     private static final Logger LOG = Logger.getLogger(SaveAndRestoreService.class.getName());
 
     private static SaveAndRestoreService instance;
 
     private final SaveAndRestoreClient saveAndRestoreClient;
     private final ObjectMapper objectMapper;
 
-    private final WebSocketClient webSocketClient;
-
     private SaveAndRestoreService() {
         saveAndRestoreClient = new SaveAndRestoreClientImpl();
-        String baseUrl = Preferences.jmasarServiceUrl;
-        String schema = baseUrl.startsWith("https") ? "wss" : "ws";
-        String webSocketUrl = schema + baseUrl.substring(baseUrl.indexOf("://")) + "/web-socket";
-        URI webSocketUri = URI.create(webSocketUrl);
-        webSocketClient  = new WebSocketClient(webSocketUri, this::handleWebSocketConnect, this::handleWebSocketDisconnect, this::handleWebSocketMessage);
         executor = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.SECONDS, new LinkedBlockingQueue<>());
         objectMapper = new ObjectMapper();
         objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
         objectMapper.registerModule(new JavaTimeModule());
         objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
-        SimpleModule module = new SimpleModule();
-        module.addDeserializer(SaveAndRestoreWebSocketMessage.class,
-                new WebMessageDeserializer(SaveAndRestoreWebSocketMessage.class));
-        objectMapper.registerModule(module);
-
     }
 
     public static SaveAndRestoreService getInstance() {
@@ -173,6 +152,7 @@ public List<Tag> getAllTags() throws Exception {
         Future<List<Tag>> future = executor.submit(saveAndRestoreClient::getAllTags);
         return future.get();
     }
+
     /**
      * Moves the <code>sourceNode</code> to the <code>targetNode</code>. The target {@link Node} may not contain
      * any {@link Node} of same name and type as the source {@link Node}.
@@ -447,39 +427,4 @@ private VType readFromArchiver(String pvName, Instant time) {
             return VDisconnectedData.INSTANCE;
         }
     }
-
-    private void handleWebSocketDisconnect(){
-        LOG.log(Level.INFO, "Web socket disonnected");
-    }
-
-    private void handleWebSocketConnect(){
-        LOG.log(Level.INFO, "Web socket connected");
-    }
-
-    private void handleWebSocketMessage(CharSequence charSequence){
-        try {
-            SaveAndRestoreWebSocketMessage saveAndRestoreWebSocketMessage =
-                    objectMapper.readValue(charSequence.toString(), SaveAndRestoreWebSocketMessage.class);
-            webSocketMessageHandlers.forEach(w -> w.handleWebSocketMessage(saveAndRestoreWebSocketMessage));
-
-        } catch (JsonProcessingException e) {
-            throw new RuntimeException(e);
-        }
-    }
-
-    public void closeWebSocket(){
-        webSocketClient.close("Application shutdown");
-    }
-
-    public void openWebSocket(){
-        webSocketClient.connect();
-    }
-
-    public void addWebSocketMessageHandler(WebSocketMessageHandler webSocketMessageHandler){
-        webSocketMessageHandlers.add(webSocketMessageHandler);
-    }
-
-    public void removeWebSocketMessageHandler(WebSocketMessageHandler webSocketMessageHandler){
-        webSocketMessageHandlers.remove(webSocketMessageHandler);
-    }
 }