Skip to content

Commit

Permalink
eclipse-glsp#132 Further clean up server API (eclipse-glsp#89)
Browse files Browse the repository at this point in the history
- Move  classes from root package into a matching subpackage
- Create "org.eclipse.glsp.server.features.core.model" package that contains all actions and related classes that are needed for model loading
- Create a dedicated feature subpackage for undo/redo

Resolves eclipse-glsp/glsp/issues/132
  • Loading branch information
tortmayr authored Nov 19, 2020
1 parent e565e25 commit 3ce80ce
Show file tree
Hide file tree
Showing 49 changed files with 85 additions and 68 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,21 @@
import org.eclipse.glsp.example.workflow.taskedit.TaskEditContextActionProvider;
import org.eclipse.glsp.example.workflow.taskedit.TaskEditValidator;
import org.eclipse.glsp.graph.GraphExtension;
import org.eclipse.glsp.server.DefaultGLSPModule;
import org.eclipse.glsp.server.actions.ActionHandler;
import org.eclipse.glsp.server.di.DefaultGLSPModule;
import org.eclipse.glsp.server.diagram.DiagramConfiguration;
import org.eclipse.glsp.server.factory.ModelFactory;
import org.eclipse.glsp.server.factory.PopupModelFactory;
import org.eclipse.glsp.server.features.commandpalette.CommandPaletteActionProvider;
import org.eclipse.glsp.server.features.contextactions.ContextActionsProvider;
import org.eclipse.glsp.server.features.contextactions.RequestContextActionsHandler;
import org.eclipse.glsp.server.features.contextmenu.ContextMenuItemProvider;
import org.eclipse.glsp.server.features.core.model.ModelFactory;
import org.eclipse.glsp.server.features.directediting.ContextEditValidator;
import org.eclipse.glsp.server.features.directediting.LabelEditValidator;
import org.eclipse.glsp.server.features.modelsourcewatcher.FileWatcher;
import org.eclipse.glsp.server.features.modelsourcewatcher.ModelSourceWatcher;
import org.eclipse.glsp.server.features.navigation.NavigationTargetProvider;
import org.eclipse.glsp.server.features.navigation.NavigationTargetResolver;
import org.eclipse.glsp.server.features.popup.PopupModelFactory;
import org.eclipse.glsp.server.features.validation.ModelValidator;
import org.eclipse.glsp.server.layout.ILayoutEngine;
import org.eclipse.glsp.server.layout.ServerLayoutConfiguration;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import org.eclipse.glsp.graph.GModelElement;
import org.eclipse.glsp.graph.GPreRenderedElement;
import org.eclipse.glsp.graph.GraphFactory;
import org.eclipse.glsp.server.factory.PopupModelFactory;
import org.eclipse.glsp.server.features.popup.PopupModelFactory;
import org.eclipse.glsp.server.features.popup.RequestPopupModelAction;
import org.eclipse.glsp.server.model.GModelState;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@

import org.eclipse.glsp.graph.GModelRoot;
import org.eclipse.glsp.server.actions.ActionDispatcher;
import org.eclipse.glsp.server.actions.RequestModelAction;
import org.eclipse.glsp.server.factory.JsonFileModelFactory;
import org.eclipse.glsp.server.features.core.model.JsonFileModelFactory;
import org.eclipse.glsp.server.features.core.model.RequestModelAction;
import org.eclipse.glsp.server.model.GModelState;
import org.eclipse.glsp.server.utils.ServerMessageUtil;
import org.eclipse.glsp.server.utils.ServerStatusUtil;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import javax.websocket.server.ServerEndpointConfig;

import org.apache.log4j.Logger;
import org.eclipse.glsp.server.GLSPModule;
import org.eclipse.glsp.server.di.GLSPModule;
import org.eclipse.glsp.server.launch.GLSPServerLauncher;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.servlet.ServletContextHandler;
Expand Down
8 changes: 5 additions & 3 deletions plugins/org.eclipse.glsp.server/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,21 @@ Require-Bundle: org.apache.commons.io;bundle-version="2.2.0",
javax.websocket;bundle-version="1.0.0";visibility:=reexport,
org.eclipse.glsp.graph;bundle-version="[0.8.0,1.0.0)";visibility:=reexport
Import-Package: com.google.inject.multibindings;version="1.3.0"
Export-Package: org.eclipse.glsp.server,
org.eclipse.glsp.server.actions,
Export-Package: org.eclipse.glsp.server.actions,
org.eclipse.glsp.server.di,
org.eclipse.glsp.server.diagram,
org.eclipse.glsp.server.factory,
org.eclipse.glsp.server.disposable,
org.eclipse.glsp.server.features.clipboard,
org.eclipse.glsp.server.features.commandpalette,
org.eclipse.glsp.server.features.contextactions,
org.eclipse.glsp.server.features.contextmenu,
org.eclipse.glsp.server.features.core.model,
org.eclipse.glsp.server.features.directediting,
org.eclipse.glsp.server.features.modelsourcewatcher,
org.eclipse.glsp.server.features.navigation,
org.eclipse.glsp.server.features.popup,
org.eclipse.glsp.server.features.toolpalette,
org.eclipse.glsp.server.features.undoredo,
org.eclipse.glsp.server.features.validation,
org.eclipse.glsp.server.internal.action;x-internal:=true,
org.eclipse.glsp.server.internal.di;x-internal:=true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
import java.util.List;
import java.util.Optional;

import org.eclipse.glsp.server.Handler;
import org.eclipse.glsp.server.model.GModelState;
import org.eclipse.glsp.server.utils.Handler;

public interface ActionHandler extends Handler<Action> {
List<Class<? extends Action>> getHandledActionTypes();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

import java.util.List;

import org.eclipse.glsp.server.MultiRegistry;
import org.eclipse.glsp.server.utils.MultiRegistry;

public interface ActionHandlerRegistry extends MultiRegistry<Class<? extends Action>, ActionHandler> {
default List<ActionHandler> get(final Action action) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@
********************************************************************************/
package org.eclipse.glsp.server.actions;

import org.eclipse.glsp.server.Registry;
import org.eclipse.glsp.server.utils.Registry;

public interface ActionRegistry extends Registry<String, Action> {}
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@

import org.apache.log4j.Logger;
import org.eclipse.glsp.graph.GGraph;
import org.eclipse.glsp.server.factory.GraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.features.modelsourcewatcher.ModelSourceWatcher;
import org.eclipse.glsp.server.jsonrpc.GraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.model.GModelState;
import org.eclipse.glsp.server.utils.ClientOptions;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
package org.eclipse.glsp.server;
package org.eclipse.glsp.server.di;

import static org.eclipse.glsp.server.actions.ClientActionHandler.CLIENT_ACTIONS;

Expand All @@ -27,7 +27,6 @@
import org.eclipse.glsp.server.actions.ClientActionHandler;
import org.eclipse.glsp.server.diagram.DiagramConfiguration;
import org.eclipse.glsp.server.diagram.DiagramConfigurationRegistry;
import org.eclipse.glsp.server.factory.GraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.features.contextactions.ContextActionsProvider;
import org.eclipse.glsp.server.features.contextactions.ContextActionsProviderRegistry;
import org.eclipse.glsp.server.features.directediting.ContextEditValidator;
Expand All @@ -48,6 +47,7 @@
import org.eclipse.glsp.server.internal.json.DefaultGraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.jsonrpc.DefaultClientSessionManager;
import org.eclipse.glsp.server.jsonrpc.DefaultGLSPServer;
import org.eclipse.glsp.server.jsonrpc.GraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.model.DefaultModelStateProvider;
import org.eclipse.glsp.server.model.ModelStateProvider;
import org.eclipse.glsp.server.operations.OperationHandler;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
******************************************************************************/
package org.eclipse.glsp.server;
package org.eclipse.glsp.server.di;

import java.util.Optional;

Expand All @@ -22,19 +22,19 @@
import org.eclipse.glsp.server.actions.ActionHandlerRegistry;
import org.eclipse.glsp.server.actions.ActionRegistry;
import org.eclipse.glsp.server.diagram.DiagramConfigurationRegistry;
import org.eclipse.glsp.server.factory.GraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.factory.ModelFactory;
import org.eclipse.glsp.server.factory.PopupModelFactory;
import org.eclipse.glsp.server.features.commandpalette.CommandPaletteActionProvider;
import org.eclipse.glsp.server.features.contextactions.ContextActionsProviderRegistry;
import org.eclipse.glsp.server.features.contextmenu.ContextMenuItemProvider;
import org.eclipse.glsp.server.features.core.model.ModelFactory;
import org.eclipse.glsp.server.features.directediting.ContextEditValidatorRegistry;
import org.eclipse.glsp.server.features.directediting.LabelEditValidator;
import org.eclipse.glsp.server.features.modelsourcewatcher.ModelSourceWatcher;
import org.eclipse.glsp.server.features.navigation.NavigationTargetProviderRegistry;
import org.eclipse.glsp.server.features.navigation.NavigationTargetResolver;
import org.eclipse.glsp.server.features.popup.PopupModelFactory;
import org.eclipse.glsp.server.features.toolpalette.ToolPaletteItemProvider;
import org.eclipse.glsp.server.features.validation.ModelValidator;
import org.eclipse.glsp.server.jsonrpc.GraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.layout.ILayoutEngine;
import org.eclipse.glsp.server.layout.ServerLayoutConfiguration;
import org.eclipse.glsp.server.model.ModelStateProvider;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import java.util.Map;

import org.eclipse.emf.ecore.EClass;
import org.eclipse.glsp.server.Registry;
import org.eclipse.glsp.server.utils.Registry;

public interface DiagramConfigurationRegistry extends Registry<String, DiagramConfiguration> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import org.eclipse.glsp.graph.GModelIndex;
import org.eclipse.glsp.server.actions.Action;
import org.eclipse.glsp.server.actions.BasicActionHandler;
import org.eclipse.glsp.server.factory.GraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.jsonrpc.GraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.model.GModelState;

import com.google.gson.Gson;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@
********************************************************************************/
package org.eclipse.glsp.server.features.contextactions;

import org.eclipse.glsp.server.Registry;
import org.eclipse.glsp.server.utils.Registry;

public interface ContextActionsProviderRegistry extends Registry<String, ContextActionsProvider> {}
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
package org.eclipse.glsp.server.actions;
package org.eclipse.glsp.server.features.core.model;

import java.util.List;

import org.eclipse.glsp.server.actions.Action;
import org.eclipse.glsp.server.types.ElementAndAlignment;
import org.eclipse.glsp.server.types.ElementAndBounds;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
package org.eclipse.glsp.server.actions;
package org.eclipse.glsp.server.features.core.model;

import java.util.List;

import org.eclipse.glsp.graph.GModelRoot;
import org.eclipse.glsp.server.actions.Action;
import org.eclipse.glsp.server.actions.BasicActionHandler;
import org.eclipse.glsp.server.model.GModelState;
import org.eclipse.glsp.server.utils.LayoutUtil;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
package org.eclipse.glsp.server.factory;
package org.eclipse.glsp.server.features.core.model;

import java.io.File;
import java.io.FileInputStream;
Expand All @@ -25,7 +25,7 @@

import org.eclipse.glsp.graph.GGraph;
import org.eclipse.glsp.graph.GModelRoot;
import org.eclipse.glsp.server.actions.RequestModelAction;
import org.eclipse.glsp.server.jsonrpc.GraphGsonConfiguratorFactory;
import org.eclipse.glsp.server.model.GModelState;
import org.eclipse.glsp.server.protocol.GLSPServerException;
import org.eclipse.glsp.server.utils.ClientOptions;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
******************************************************************************/
package org.eclipse.glsp.server.factory;
package org.eclipse.glsp.server.features.core.model;

import org.eclipse.glsp.graph.GModelRoot;
import org.eclipse.glsp.server.actions.RequestModelAction;
import org.eclipse.glsp.server.model.GModelState;

public interface ModelFactory {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,14 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
package org.eclipse.glsp.server.actions;
package org.eclipse.glsp.server.features.core.model;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.eclipse.glsp.graph.GModelRoot;
import org.eclipse.glsp.server.actions.Action;
import org.eclipse.glsp.server.layout.ILayoutEngine;
import org.eclipse.glsp.server.layout.ServerLayoutConfiguration;
import org.eclipse.glsp.server.layout.ServerLayoutKind;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
******************************************************************************/
package org.eclipse.glsp.server.actions;
package org.eclipse.glsp.server.features.core.model;

import org.eclipse.glsp.graph.GModelRoot;
import org.eclipse.glsp.server.actions.Action;

public class RequestBoundsAction extends Action {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
******************************************************************************/
package org.eclipse.glsp.server.actions;
package org.eclipse.glsp.server.features.core.model;

import java.util.Map;

import org.eclipse.glsp.server.actions.Action;

public class RequestModelAction extends Action {

public static final String ID = "requestModel";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
package org.eclipse.glsp.server.actions;
package org.eclipse.glsp.server.features.core.model;

import java.util.List;

import org.eclipse.glsp.graph.GModelRoot;
import org.eclipse.glsp.server.factory.ModelFactory;
import org.eclipse.glsp.server.actions.Action;
import org.eclipse.glsp.server.actions.BasicActionHandler;
import org.eclipse.glsp.server.features.modelsourcewatcher.ModelSourceWatcher;
import org.eclipse.glsp.server.model.GModelState;
import org.eclipse.glsp.server.utils.ClientOptions;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
******************************************************************************/
package org.eclipse.glsp.server.actions;
package org.eclipse.glsp.server.features.core.model;

import java.util.List;

import org.eclipse.glsp.server.actions.Action;
import org.eclipse.glsp.server.types.ElementAndBounds;

public class SetBoundsAction extends Action {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
******************************************************************************/
package org.eclipse.glsp.server.actions;
package org.eclipse.glsp.server.features.core.model;

import org.eclipse.glsp.graph.GModelRoot;
import org.eclipse.glsp.server.actions.Action;

public class SetModelAction extends Action {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
******************************************************************************/
package org.eclipse.glsp.server.actions;
package org.eclipse.glsp.server.features.core.model;

import org.eclipse.glsp.graph.GModelRoot;
import org.eclipse.glsp.server.actions.Action;

public class UpdateModelAction extends Action {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@
********************************************************************************/
package org.eclipse.glsp.server.features.directediting;

import org.eclipse.glsp.server.Registry;
import org.eclipse.glsp.server.utils.Registry;

public interface ContextEditValidatorRegistry extends Registry<String, ContextEditValidator> {}
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@
********************************************************************************/
package org.eclipse.glsp.server.features.navigation;

import org.eclipse.glsp.server.Registry;
import org.eclipse.glsp.server.utils.Registry;

public interface NavigationTargetProviderRegistry extends Registry<String, NavigationTargetProvider> {}
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
******************************************************************************/
package org.eclipse.glsp.server.factory;
package org.eclipse.glsp.server.features.popup;

import java.util.Optional;

import org.eclipse.glsp.graph.GHtmlRoot;
import org.eclipse.glsp.graph.GModelElement;
import org.eclipse.glsp.server.features.popup.RequestPopupModelAction;
import org.eclipse.glsp.server.model.GModelState;

public interface PopupModelFactory {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import org.eclipse.glsp.graph.GModelElement;
import org.eclipse.glsp.server.actions.Action;
import org.eclipse.glsp.server.actions.BasicActionHandler;
import org.eclipse.glsp.server.factory.PopupModelFactory;
import org.eclipse.glsp.server.model.GModelState;

import com.google.inject.Inject;
Expand Down
Loading

0 comments on commit 3ce80ce

Please sign in to comment.