| Re: [ice-dev] Enabling ConnectCoreAction |
|
Hi Ram,
On 11/28/2016 2:55 PM, Ramachandran K. Narayanan wrote:
Yeah...I didn't include all the changes to all classes because I thought that you might want a patch, or a pull request, or something more complete than an email with attachments. But in any case, all Client.getDefault() does is return the singleton instance set upon start...see attached. I think the only thing I changed in Client was the addition of static getDefault() and getContext() along with the setting of the instance and context member variables. I'm not sure if you want to keep Client as it is though, as it serves as the proxy for the Jersey remote service. With Remote Services the proxy is created for you upon import. In any event, I'll leave that up to you.
For testing, I added a simple command handler and attached it as a viewbar button so that I could invoke it and make sure the code in CoreConnectAction.run() was working properly. This was just for testing...I've been assuming that you would want to put the connect action elsewhere in the user interface, but I didn't know where you would want it to be. I didn't want everyone to be distracted by the resulting 'franken ui', so I just left it out.
I would rather not include in the patch the UI that I cobbled together to test.
Yeah you can do that...or if you prefer you can take out the annotations and use/edit the xml directly. I just have gotten used to the using the annotations for DS. Actually the RSCore class (the whole thing) is just intended as an example...i.e. you can get a hold of ICore proxy instances (created and registered by ECF) in other ways. I just think that using DS for the dynamics (the remote service should generally be dynamic, since it happens at runtime) that DS makes it easy, and I saw that you are already using DS in other parts of ICE.
Actually, once it's enabled all you should need to do is make a trivial change to the java code (e.g. insert a space) and then save it, and the OSGI-INF xml file should be created.
Yes, I believe so. The RSCore component does two things: 1) It has a reference to the org.osgi.service.remoteserviceadmin.RemoteServiceAdmin service. This is the OSGi RSA standard service instance (implemented via ECF). The RSA service is used when run() is invoked to import the ICore remote service (RSCoreConnectAction line 117) . By 'import' I mean to connect to remote host, get information about ICore service, and to create a client-side proxy to the ICore service. 2) To bind the ICore remote service to something once imported via RSA. You may wish to restructure this so that these two functions are done in separate parts of the code rather than in a single class. For example, you might want the ICore proxy instance injected into some other class/component (2). I just put them together in RSCore in order to test it quickly. Also, I don't really know the ICE code well enough to know where/how you wish to use the ICore proxy.
No, either are fine and for this use case will behave the same. Other providers require other/additional bundles to be added in both the Core server and ICE client so given that you already had the ECF generic provider exporting the ICore service remotely, I just left it that way.
If you would rather have a patch...or I've left something else out...please let me know. Thanks, Scott |
/******************************************************************************* * Copyright (c) 2012, 2014 UT-Battelle, LLC. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Initial API and implementation and/or initial documentation - Jay Jay Billings, * Jordan H. Deyton, Dasha Gorin, Alexander J. McCaskey, Taylor Patterson, * Claire Saunders, Matthew Wang, Anna Wojtowicz *******************************************************************************/ package org.eclipse.ice.client.internal; import java.net.URI; import java.net.URL; import java.util.ArrayList; import java.util.HashMap; import java.util.Hashtable; import java.util.concurrent.atomic.AtomicBoolean; import org.eclipse.core.resources.IFile; import org.eclipse.core.resources.IProject; import org.eclipse.ecf.osgi.services.remoteserviceadmin.EndpointDescriptionReader; import org.eclipse.ice.client.common.internal.ClientHolder; import org.eclipse.ice.core.iCore.ICore; import org.eclipse.ice.datastructures.ICEObject.Identifiable; import org.eclipse.ice.datastructures.form.Form; import org.eclipse.ice.datastructures.form.FormStatus; import org.eclipse.ice.datastructures.resource.ICEResource; import org.eclipse.ice.iclient.IClient; import org.eclipse.ice.iclient.IItemProcessor; import org.eclipse.ice.iclient.uiwidgets.IErrorBox; import org.eclipse.ice.iclient.uiwidgets.IExtraInfoWidget; import org.eclipse.ice.iclient.uiwidgets.IFormWidget; import org.eclipse.ice.iclient.uiwidgets.IProcessEventListener; import org.eclipse.ice.iclient.uiwidgets.ISimpleResourceProvider; import org.eclipse.ice.iclient.uiwidgets.IStreamingTextWidget; import org.eclipse.ice.iclient.uiwidgets.ITextEditor; import org.eclipse.ice.iclient.uiwidgets.IUpdateEventListener; import org.eclipse.ice.iclient.uiwidgets.IWidgetClosedListener; import org.eclipse.ice.iclient.uiwidgets.IWidgetFactory; import org.osgi.framework.BundleActivator; import org.osgi.framework.BundleContext; import org.osgi.framework.ServiceReference; import org.osgi.framework.ServiceRegistration; import org.osgi.service.remoteserviceadmin.EndpointDescription; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * The Client class is a base class for clients of the Core. It's primary * function is to manage calls to and from the Core to and from whatever user * interface is provided by IWidgetFactory. * <p> * The Client realizes the IClient interface and is registered as an OSGi * service. It requires an implementation of the IWidgetFactory so that it can * present data from ICE to users. It also implements IUpdateEvenListener, * IProcessEventListener, ISimpleResourceProvider and IWidgetClosedLIstener so * that it can handle notifications and requests from the widgets and data * structures. * </p> * * @author Jay Jay Billings */ public class Client implements IUpdateEventListener, IProcessEventListener, ISimpleResourceProvider, IWidgetClosedListener, IClient, BundleActivator { /** * Logger for handling event messages and other information. */ private static final Logger logger = LoggerFactory.getLogger(Client.class); /** * The running ICE core that provides all of the required services to the * client. */ private ICore iCore; /** * The widget factory used to create widgets. */ private IWidgetFactory iWidgetFactory; /** * <p> * The set of IFormWidgets used by the Client. This set is stored in a * HashTable with Forms as keys and IFormWidgets as the values. * </p> */ private Hashtable<Integer, IFormWidget> formWidgetTable; /** * <p> * This AtomicBoolean is true if the IExtraInfoWidget used by the Client was * closed OK and is false otherwise. * </p> * */ private AtomicBoolean widgetClosedOK; /** * <p> * This AtomicBoolean is true if the IExtraInfoWidget used by the Client was * cancelled and is false otherwise. * </p> * */ private AtomicBoolean widgetCancelled; /** * A set of status messages used by the core to describe the different * states of Items. */ HashMap<FormStatus, String> statusMessageMap = new HashMap<FormStatus, String>(); /** * A service reference for retrieving the core. */ private ServiceReference<ICore> iCoreServiceRef; /** * This is the service registration used to register the Client as a service * of the OSGi framework. */ private ServiceRegistration<IClient> registration; /** * The processor that handles all Item processing for the Client. */ private IItemProcessor processor; /** * The Constructor */ public Client() { processor = new ItemProcessor(); initialize(); } /** * The test constructor for injecting the IItemProcessor used to process * Forms. * * @param processor * the Item Processor that should be used for testing. */ public Client(IItemProcessor processor) { this.processor = processor; initialize(); } /** * This operation initializes all of the class variables for the * constructors. */ private void initialize() { // Create the lists of widgets formWidgetTable = new Hashtable<Integer, IFormWidget>(); // Setup the Atomics for the extra info widget widgetClosedOK = new AtomicBoolean(); widgetClosedOK.set(false); widgetCancelled = new AtomicBoolean(); widgetCancelled.set(false); // Setup the message map. This map contains the messages that will be // posted to the IFormWidget based on the status of the process. statusMessageMap.put(FormStatus.Processed, "Done!"); statusMessageMap.put(FormStatus.Processing, "Processing Form..."); statusMessageMap.put(FormStatus.InfoError, "The Form contains an error" + " and cannot be processed."); statusMessageMap.put(FormStatus.ReadyToProcess, "Ready to process."); statusMessageMap.put(FormStatus.NeedsInfo, "The Form requires additional information before " + "it can be processed."); statusMessageMap.put(FormStatus.InReview, "In review..."); statusMessageMap.put(FormStatus.Unacceptable, "This Form will not be " + "processed or updated. It should be considered read-only."); // Set the reference to this in the Singleton for the widget classes to // retrieve as needed. ClientHolder.setClient(this); } private static Client instance; private BundleContext context; public static Client getDefault() { return instance; } public BundleContext getContext() { return context; } /** * This operation starts the client and stores the bundle context * * @param context * the bundle's context from the OSGi */ @Override public void start(BundleContext context) throws Exception { instance = this; this.context = context; // Acquire the Core service if it is available iCoreServiceRef = context.getServiceReference(ICore.class); if (iCoreServiceRef != null) { logger.info("Retrieving ICore for the client."); iCore = context.getService(iCoreServiceRef); logger.info("Core service set."); } else { // Failure to get the core is a catastrophic error. logger.error("Unable to access core!."); } // Get the widgets factory service by using the static inferace method // and directly registering it. At the moment we have only a single // factory, so we will grab the 0-th entry. setUIWidgetFactory(IWidgetFactory.getIWidgetFactories()[0]); // I realize how hilarious it is to use two different mechanisms for // acquiring services here. FIXME! This is just testing for now. // Register this class as a service with the framework. registration = context.registerService(IClient.class, this, null); return; } /** * This operation releases the ICore service references and stops the Client * service. * * @param context * the bundle's context from the OSGi */ @Override public void stop(BundleContext context) throws Exception { // Release the service reference if (iCoreServiceRef != null) { context.ungetService(iCoreServiceRef); } // Unregister this service from the framework registration.unregister(); return; } /** * This operation grabs and sets the iCore if it is not already available. */ public ICore getCore() { return iCore; } /** * This private operation is called by the implementations of * IClient.processItem() and IProcessEventListener.processSelected(). It * calls the ICore and directs it to process an Item. This operation * launches a FormProcessor to handle polling and update the IFormWidget for * the Item as it is processed by the Core. * * @param formWidget * <p> * The Form that represents the Item that will be processed. * </p> * @param actionName * <p> * The name of the action which should be performed when the Item * is processed. * </p> */ private void processItem(IFormWidget formWidget, String actionName) { // TODO Auto-generated method stub // Local Declarations IExtraInfoWidget infoWidget = null; IStreamingTextWidget textWidget = null; // Check the Item Id and forward the request if it is valid if (formWidget != null) { // Load up the processor processor.setActionName(actionName); processor.setCore(getCore()); infoWidget = iWidgetFactory.getExtraInfoWidget(); infoWidget.setForm(formWidget.getForm()); textWidget = iWidgetFactory.getStreamingTextWidget(); processor.setInfoWidget(infoWidget); processor.setFormWidget(formWidget); processor.setStreamingTextWidget(textWidget); processor.setItemId(formWidget.getForm().getItemID()); // Launch the processor on another thread processor.launch(); } else { // Otherwise notify the use that the Item is invalid throwSimpleError("IClient Message: " + "Item has no parent widget in this client."); } } /* * (non-Javadoc) * * @see IClient#setCoreService(ICore core) */ @Override public void setCoreService(ICore core) { logger.info("IClient Message: Core service set."); iCore = core; } /* * (non-Javadoc) * * @see IClient#createItem(String itemType) */ @Override public int createItem(String itemType) { // Local Declarations int itemId = -1; // Create the Item itemId = Integer.valueOf(getCore().createItem(itemType)); // Load the Item into the editor loadAfterCreate(itemId, itemType); return itemId; } /* * (non-Javadoc) * * @see org.eclipse.ice.iclient.IClient#createItem(java.lang.String, * org.eclipse.core.resources.IProject) */ @Override public int createItem(String itemType, IProject project) { // Local Declarations int itemId = -1; // Create the Item itemId = Integer.valueOf(getCore().createItem(itemType, project)); // Load the Item into the editor loadAfterCreate(itemId, itemType); return itemId; } /** * This operation attempts to load a recently created Item into the UI an * throws an error message if it cannot. * * @param itemId * The id of the Item to load. * @param itemType * The type of the Item that was created. */ private void loadAfterCreate(int itemId, String itemType) { // FIXME - Get the status! Need ItemStatus type or something // Either load the Item or throw an error if (itemId > 0) {// FIXME Status check! loadItem(itemId); } else if (itemId <= 0) { throwSimpleError( "Unable to load Item " + itemType + " after creating it."); } } /* * (non-Javadoc) * * @see IClient#setUIWidgetFactory(IWidgetFactory widgetFactory) */ @Override public void setUIWidgetFactory(IWidgetFactory widgetFactory) { iWidgetFactory = widgetFactory; if (iWidgetFactory != null) { logger.info("IClient Message: Widget Factory set!"); } else { logger.info( "IClient Message: " + "Widget Factory set, but is null."); } return; } /* * (non-Javadoc) * * @see IClient#loadItem(int itemId) */ @Override public void loadItem(int itemId) { // Local Declarations IFormWidget formWidget = null; Form form = null; FormStatus formStatus = FormStatus.ReadyToProcess; // If the Item exists if (itemId > 0) { // Get the Form form = getCore().getItem(itemId); // Load the editor formWidget = iWidgetFactory.getFormWidget(form.getName()); formWidget.setForm(form); // Display the editor formWidget.display(); // Set the initial status of the Form formStatus = getCore().getItemStatus(itemId); formWidget.updateStatus( statusMessageMap.get(iCore.getItemStatus(itemId))); // If the FormStatus signifies that the Form is absolutely // unacceptable, then the user should be warned. if (formStatus.equals(FormStatus.Unacceptable)) { formWidget.disable(true); throwSimpleError( "This Form has been set to a read-only mode by " + "ICE. Please be advised that it can not be upated" + " or processed."); } // Register for updates formWidget.registerUpdateListener(this); formWidget.registerProcessListener(this); formWidget.registerResourceProvider(this); logger.info("IClient Message: Loaded Item " + itemId + ", " + form.getName()); // Store the widget in the table of FormWidgets formWidgetTable.put(itemId, formWidget); } else { // Complain otherwise throwSimpleError("Unable to load Item " + itemId + "."); } return; } /* * (non-Javadoc) * * @see org.eclipse.ice.iclient.IClient#loadItem(org.eclipse.core.resources. * IFile) */ @Override public Form loadItem(IFile itemFile) { // Just delegate this return getCore().loadItem(itemFile); } /* * (non-Javadoc) * * @see IClient#throwSimpleError(String error) */ @Override public void throwSimpleError(String error) { // Local Declarations IErrorBox errorBox = null; // Make sure the error isn't null and post it if (error != null) { errorBox = iWidgetFactory.getErrorBox(); errorBox.setErrorString(error); errorBox.display(); } return; } /** * (non-Javadoc) * * @see IClient#getAvailableItemTypes() */ @Override public ArrayList<String> getAvailableItemTypes() { // Local Declarations ArrayList<String> types = null; // Get the types types = this.getCore().getAvailableItemTypes().getList(); return types; } /** * (non-Javadoc) * * @see IClient#processItem(int itemId, String actionName) */ @Override public void processItem(int itemId, String actionName) { // Local Declarations Form itemForm = null; // Check the Item Id and forward the request if it is valid if (itemId > 0) { // Find the Form widget in the table. Linear search for now since // the list should be small. for (Integer i : formWidgetTable.keySet()) { if (i == itemId) { itemForm = formWidgetTable.get(i).getForm(); break; } } // Process the item if (itemForm != null) { logger.info("IClient Message: Processing Item " + itemId + ", " + itemForm.getName()); processItem(formWidgetTable.get(itemId), actionName); } } else if (itemId < 0 || itemForm == null) { // Otherwise notify the use that the Item is invalid throwSimpleError("The Item id is invalid. " + "Please double check it and try again " + "or notify your systems administrator."); } return; } /* * (non-Javadoc) * * @see IClient#connectToCore(String hostname, int port) */ @Override public boolean connectToCore(String hostname, int port) { // Local Declarations boolean status = false; int realPort = (port <= 0) ? 80 : port, newClientId = -1; RemoteCoreProxy proxyCore = null; // Connect the RemoteClientProxy if the hostname is not null if (hostname != null) { proxyCore = new RemoteCoreProxy(); proxyCore.setHost(hostname); proxyCore.setPort(realPort); // Connect and parse the response as an integer. It should be // greater than 0. newClientId = Integer.parseInt(proxyCore.connect("ice", "veryice")); // If the id is acceptable, set the status and core reference. if (newClientId > 0) { status = true; iCore = proxyCore; } } logger.info("IClient Message: Connected to core... " + status); return status; } /* * (non-Javadoc) * * @see IClient#getItems() */ @Override public ArrayList<Identifiable> getItems() { return getCore().getItemList(); } /* * (non-Javadoc) * * @see IClient#deleteItem(int id) */ @Override public void deleteItem(int id) { // Forward the call getCore().deleteItem(String.valueOf(id)); } /* * (non-Javadoc) * * @see IUpdateEventListener#formUpdated(Form form) */ @Override public void formUpdated(Form form) { // Local Declarations int formId = -1; FormStatus status = FormStatus.InfoError; // Process the Form if it is not null if (form != null) { formId = form.getId(); // Post the update //FIXME! Client ID! status = this.getCore().updateItem(form, 1); // Update the Form if needed, skip FormStatus.InReview for now. // FIXME! - need FormStatus.InReview if (!status.equals(FormStatus.InfoError) && !status.equals(FormStatus.Unacceptable)) { form = getCore().getItem(formId); // Update the status of the Item update if (formWidgetTable.containsKey(form.getItemID())) { String statusMessage = statusMessageMap.get(status); formWidgetTable.get(form.getItemID()) .updateStatus(statusMessage); } } else { // Notify the user that there is some invalid information in the // Form throwSimpleError("Form contains invalid information. " + "Please review it for completeness and " + "accuracy and resubmit."); } } else { // Otherwise let the user know throwSimpleError("Fatal Error: " + "Form returned to Client can not be null!"); } return; } /* * (non-Javadoc) * * @see IProcessEventListener#processSelected(Form form, String process) */ @Override public void processSelected(Form form, String process) { // Forward the request to process the form on to the Core. The // actual processing is done by the Item that is represented by the // Form, so send the ItemID along. processItem(form.getItemID(), process); return; } /* * (non-Javadoc) * * @see IProcessEventListener#cancelRequested(Form form, String process) */ @Override public void cancelRequested(Form form, String process) { // Forward the request to the core so that it can try to shut the // process down. getCore().cancelItemProcess(form.getId(), process); return; } /* * (non-Javadoc) * * @see ISimpleResourceProvider#loadResource(ICEResource resource) */ @Override public void loadResource(ICEResource resource) { // Make sure the ICEResource is not null if (resource != null) { // Get an ITextEditor from the WidgetFactory ITextEditor textEditor = iWidgetFactory.getTextEditor(); // Set the Resource textEditor.setResource(resource); // Display the widget textEditor.display(); } else { throwSimpleError("The resource that you asked to load does not " + "exist or is erroneously linked."); } } /* * (non-Javadoc) * * @see IWidgetClosedListener#closedOK() */ @Override public void closedOK() { widgetClosedOK.set(true); } /* * (non-Javadoc) * * @see IWidgetClosedListener#cancelled() */ @Override public void cancelled() { widgetCancelled.set(true); } /* * (non-Javadoc) * * @see IClient#importFile(URI file) */ @Override public void importFile(URI file) { // Just forward the call getCore().importFile(file); return; } /* * (non-Javadoc) * * @see org.eclipse.ice.iclient.IClient#importFile(java.net.URI, * org.eclipse.core.resources.IProject) */ @Override public void importFile(URI file, IProject project) { // Just forward the call getCore().importFile(file, project); } /* * (non-Javadoc) * * @see org.eclipse.ice.iclient.IClient#importFile(java.net.URI, * java.lang.String) */ @Override public void importFile(URI file, String projectName) { // Just forward the call getCore().importFile(file, projectName); } /* * (non-Javadoc) * * @see org.eclipse.ice.iclient.IClient#importFileAsItem(java.net.URI, * java.lang.String) */ @Override public int importFileAsItem(URI file, String itemType) { // Pass the call on to the core return Integer.valueOf(getCore().importFileAsItem(file, itemType)); } /* * (non-Javadoc) * * @see org.eclipse.ice.iclient.IClient#importFileAsItem(java.net.URI, * java.lang.String, org.eclipse.core.resources.IProject) */ @Override public int importFileAsItem(URI file, String itemType, IProject project) { // Pass the call on to the core return Integer .valueOf(getCore().importFileAsItem(file, itemType, project)); } /* * (non-Javadoc) * * @see org.eclipse.ice.iclient.IClient#importFileAsItem(org.eclipse.core. * resources.IFile, java.lang.String) */ @Override public int importFileAsItem(IFile file, String itemType) { // Pass the call on to the core return Integer.valueOf(getCore().importFileAsItem(file, itemType)); } /* * (non-Javadoc) * * @see org.eclipse.ice.iclient.IClient#importFileAsItem(java.net.URI, * java.lang.String, java.lang.String) */ @Override public int importFileAsItem(URI file, String itemType, String projectName) { // Pass the call on to the core return Integer.valueOf( getCore().importFileAsItem(file, itemType, projectName)); } /* * (non-Javadoc) * * @see org.eclipse.ice.iclient.IClient#renameItem(int, java.lang.String) */ @Override public void renameItem(int itemID, String name) { getCore().renameItem(itemID, name); } /* * (non-Javadoc) * * @see * org.eclipse.ice.iclient.IClient#setFormWidget(org.eclipse.ice.iclient. * uiwidgets.IFormWidget) */ @Override public void addFormWidget(IFormWidget widget) { // Add this Form Widget to the formWidgetTable // so it can be used in Item processing. formWidgetTable.put(widget.getForm().getItemID(), widget); } /** * This operation returns the IFormWidget corresponding to the given Item * Id. * * @param itemId * The id of the Item whose IFormWidget has been requested * @return formWidget */ public IFormWidget getFormWidget(int itemId) { return formWidgetTable.get(itemId); } }