Stand-alone app for save-and-restore search results #3279
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * Copyright (C) 2024 European Spallation Source ERIC. | ||
| */ | ||
|
|
||
| package org.phoebus.applications.saveandrestore; | ||
|
|
||
| import org.phoebus.framework.spi.AppInstance; | ||
| import org.phoebus.framework.spi.AppResourceDescriptor; | ||
|
|
||
| import java.net.URI; | ||
|
|
||
| /** | ||
| * Application showing list of save-and-restore nodes matching a particular filter. Its UI is a subset of the | ||
| * search and filter view of the {@link SaveAndRestoreApplication} UI. | ||
| */ | ||
| public class FilterViewApplication implements AppResourceDescriptor { | ||
|
|
||
| public static final String NAME = "saveandrestorefilterview"; | ||
| public static final String DISPLAY_NAME = "SAR Filter"; | ||
|
|
||
| @Override | ||
| public String getDisplayName() { | ||
| return DISPLAY_NAME; | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return NAME; | ||
| } | ||
|
|
||
| @Override | ||
| public AppInstance create() { | ||
| return create(null); | ||
| } | ||
|
|
||
| @Override | ||
| public AppInstance create(URI uri) { | ||
| if(FilterViewInstance.INSTANCE == null){ | ||
| FilterViewInstance.INSTANCE = new FilterViewInstance(this); | ||
| } | ||
| else{ | ||
| FilterViewInstance.INSTANCE.raise(); | ||
| } | ||
|
|
||
| if(uri != null){ | ||
| FilterViewInstance.INSTANCE.openResource(uri); | ||
| } | ||
|
|
||
| return FilterViewInstance.INSTANCE; | ||
| } | ||
|
|
||
| public AppInstance getInstance(){ | ||
| return FilterViewInstance.INSTANCE; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * Copyright (C) 2024 European Spallation Source ERIC. | ||
| */ | ||
|
|
||
| package org.phoebus.applications.saveandrestore; | ||
|
|
||
| import javafx.fxml.FXMLLoader; | ||
| import org.phoebus.applications.saveandrestore.ui.search.SearchResultTableViewController; | ||
| import org.phoebus.framework.nls.NLS; | ||
| import org.phoebus.framework.spi.AppDescriptor; | ||
| import org.phoebus.framework.spi.AppInstance; | ||
| import org.phoebus.security.tokens.ScopedAuthenticationToken; | ||
| import org.phoebus.ui.docking.DockItem; | ||
| import org.phoebus.ui.docking.DockPane; | ||
|
|
||
| import java.net.URI; | ||
| import java.net.URLDecoder; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.List; | ||
| import java.util.ResourceBundle; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** | ||
| * Instance maintaining a list of save-and-restore nodes matching a particular filter. Its UI is a subset of the | ||
| * search and filter view of the {@link SaveAndRestoreApplication} UI. | ||
| */ | ||
| public class FilterViewInstance implements AppInstance { | ||
|
|
||
| private final AppDescriptor appDescriptor; | ||
| public static FilterViewInstance INSTANCE; | ||
| private DockItem dockItem; | ||
| private final SearchResultTableViewController searchResultTableViewController; | ||
|
|
||
| public FilterViewInstance(AppDescriptor appDescriptor) { | ||
| this.appDescriptor = appDescriptor; | ||
|
|
||
| dockItem = null; | ||
|
|
||
| FXMLLoader loader = new FXMLLoader(); | ||
| try { | ||
| ResourceBundle resourceBundle = NLS.getMessages(Messages.class); | ||
| loader.setResources(resourceBundle); | ||
| loader.setLocation(FilterViewApplication.class.getResource("/org/phoebus/applications/saveandrestore/ui/search/SearchResultTableView.fxml")); | ||
| dockItem = new DockItem(this, loader.load()); | ||
| } catch (Exception e) { | ||
| Logger.getLogger(SaveAndRestoreApplication.class.getName()).log(Level.SEVERE, "Failed loading fxml", e); | ||
| } | ||
|
|
||
| searchResultTableViewController = loader.getController(); | ||
| dockItem.addCloseCheck(() -> { | ||
| INSTANCE = null; | ||
| return CompletableFuture.completedFuture(true); | ||
| }); | ||
|
|
||
| DockPane.getActiveDockPane().addTab(dockItem); | ||
| } | ||
|
|
||
| @Override | ||
| public AppDescriptor getAppDescriptor() { | ||
| return appDescriptor; | ||
| } | ||
|
|
||
| public void openResource(URI uri) { | ||
| searchResultTableViewController.loadFilter(URLDecoder.decode(uri.getPath().substring(1), StandardCharsets.UTF_8)); | ||
| } | ||
|
|
||
| public void raise() { | ||
| dockItem.select(); | ||
| } | ||
|
|
||
| public void secureStoreChanged(List<ScopedAuthenticationToken> validTokens) { | ||
| searchResultTableViewController.secureStoreChanged(validTokens); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,6 +19,8 @@ | |
|
|
||
| package org.phoebus.applications.saveandrestore.authentication; | ||
|
|
||
| import org.phoebus.applications.saveandrestore.FilterViewApplication; | ||
| import org.phoebus.applications.saveandrestore.FilterViewInstance; | ||
| import org.phoebus.applications.saveandrestore.SaveAndRestoreApplication; | ||
| import org.phoebus.applications.saveandrestore.SaveAndRestoreInstance; | ||
| import org.phoebus.framework.spi.AppDescriptor; | ||
|
|
@@ -38,15 +40,26 @@ public class SecureStoreChangeHandlerImpl implements SecureStoreChangeHandler { | |
| */ | ||
| @Override | ||
| public void secureStoreChanged(List<ScopedAuthenticationToken> validTokens) { | ||
| AppDescriptor saveAndRestoreAppDescriptor = ApplicationService.findApplication(SaveAndRestoreApplication.NAME); | ||
| if (saveAndRestoreAppDescriptor != null && saveAndRestoreAppDescriptor instanceof SaveAndRestoreApplication) { | ||
| SaveAndRestoreApplication saveAndRestoreApplication = (SaveAndRestoreApplication) saveAndRestoreAppDescriptor; | ||
|
Collaborator
There was a problem hiding this comment. The cast can be made type-safe by changing the the
Collaborator
Author
There was a problem hiding this comment. How is it not type-safe the way it stands?
Collaborator
There was a problem hiding this comment. is type-safe. In the newfangled syntax, the type is only written once
Collaborator
There was a problem hiding this comment. As a downside, the new syntax is ugly.
Collaborator
There was a problem hiding this comment. @georgweiss: You are right that casting (in Java) is type-safe. However, a runtime-exception will be thrown if the cast doesn't succeed, and the compiler doesn't check that the runtime exception is caught. With the pattern matching construct the compiler can give better guarantees: in the body of the In simple cases such as this, the main advantage is to guard against typos as @kasemir pointed out. In more complicated cases it can help the programmer to know that all cases that can arise have been covered in the code. |
||
| SaveAndRestoreInstance saveAndRestoreInstance = (SaveAndRestoreInstance) saveAndRestoreApplication.getInstance(); | ||
|
Collaborator
There was a problem hiding this comment. This cast can be made type-safe by changing the return type of |
||
| // Save&restore app may not be launched (yet) | ||
| if(saveAndRestoreInstance == null){ | ||
| return; | ||
| } | ||
| saveAndRestoreInstance.secureStoreChanged(validTokens); | ||
| } | ||
|
|
||
| AppDescriptor filterViewAppDescriptor = ApplicationService.findApplication(FilterViewApplication.NAME); | ||
| if (filterViewAppDescriptor != null && filterViewAppDescriptor instanceof FilterViewApplication) { | ||
| FilterViewApplication filterViewApplication = (FilterViewApplication) filterViewAppDescriptor; | ||
|
Collaborator
There was a problem hiding this comment. As above, this cast can be made type-safe by changing the |
||
| FilterViewInstance filterViewInstance = (FilterViewInstance) filterViewApplication.getInstance(); | ||
|
Collaborator
There was a problem hiding this comment. As above, this can be made type-safe by changing the return type of |
||
| // Save&restore filter view app may not be launched (yet) | ||
| if(filterViewInstance == null){ | ||
| return; | ||
| } | ||
| filterViewInstance.secureStoreChanged(validTokens); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.