| Table of Contents |
|---|
| Child pages (Children Display) |
|---|
...
- Install Eclipse
- Install Google Web Toolkit, Google App Engine SDK, and Google plug-in for Eclipse using Eclipse new software from Google's update site - http://dl.google.com/eclipse/plugin/4.2. Note: if you were using an older version of this plugin you will need to uninstall it and then re-install it to ensure it has GWT 2.4.0 support. Another note: Installing the Google App Engine Maven Integration software made Eclipse error when building the SynapseWebClient. It would not work until I uninstalled it.
- Install the Maven2Eclipse plugin: http://download.eclipse.org/technology/m2e/releases
- (Optional) Install the EGit eclipse plugin: http://www.eclipse.org/egit/download/
- Create a GitHub user account
- Internal Sage developers will be added as a developer on the project and will be able to push directly
- External contributors should fork the repository and submit GitHub Pull Requests for code inclusion
Set up Git: https://help.github.com/articles/set-up-git
- Import the project as a maven project
- File -> Import -> Maven -> Existing Maven Projects
- Next, in Root Directory enter the local path to your repository clone
- Next, Finish
- (Optional) Enable Git Team tracking
- Now right click on portal (project name) -> Team -> Share Project
- Next, Select repository type Git
- Next, Check the box "Use or create repository in parent folder of project
- Next, Finish
- You need to make sure the GWT xml files are on the classpath. All of these resources can be found in src/main/resources and src/test/resources directories.
- Right-click on portal (project name) ->Build Path>Configure Build Path...
- Remove the "Exclude" filter from the source tab on the src/main/resources and src/test/resources directories.
- We need to tell the GWT Eclipse-plugin that this is a GWT project. Do this by Right-Clicking on the project in the package explorer and select: Google->Web Toolkit Settings...
- From the resulting dialog make sure the "Use Google Web Tookit" check box is selected.
- Also make sure you are using GWT 2.4.0 (or 2.5.1).
- We need to tell the Google plugin where our web app directory can be found. Right-click on the project in the package explorer and select Properties.
- From the tree on the left of the dialog navigate to Google->Web Application
- Check the the check box: "This project has a WAR directory"
- With the "Browse" button, select "src/main/webapp"
- UN-CHECK the "Launch and deploy from this directory" This is very important, if you keep this checked then Maven will not be able to generate a clean WAR file. If you see "GWT needs to recompile" when you deploy your WAR then you probably have this box checked.
- Now that the Portal.gwt.xml file is on the classpath, make sure GWT knows it is the entry point.
- Right-Click on the project from the package explorer.
- Select Google->Web Toolkit Settings...
- Under the "entry point modules" you should see "Portal - org.sagebionetworks.web", if not, then add it with the add button.
- Now make sure GWT can compile your code
- Right-Click on the project in the package explorer
- Google->GWT Compile
- The first time you run this you will be asked to select the output directory where GWT will compile the code. You want this to match the Maven WAR output directory, so use "target/portal-<VERSION>-SNAPSHOT"
- If you get compilation errors from the JavaScript validator (i.e. NullPointerException), navigate to the project's properties -> JavaScript -> Include Path -> Source, and exclude all files from the source. If an OutOfMemoryError was thrown while compiling, you can click the "Advanced" tab towards the bottom of the Google->GWT Compile window and add "-Xms512M -Xmx1524M" to the VM arguments to increase heap space.
- The next step creates a Run Configuration. You should modify this configuration to avoid a PermGen OutOfMemoryError
(the error is likely due to the gwt development environment, where gwt does not properly gc the classes loaded in the permanent generation area of the heap (that were loaded in a previous run)):- Right-Click on the project in the package explorer.
- Select: Run As->Run Configurations...
- Select the GWT Web Application run configuration named Portal.html.
- If the run configuration is not present, perform step 18. When the OutOfMemoryError occurs, restart Eclipse.
- Click on the Arguments tab.
- In the VM arguments, add "-XX:MaxPermSize=512m"
- Right-Click on the project in the package explorer
- Select: Run As->Web Application
- Double-click on the link provided in the Development Mode window to view the portal in your browser. If you get asked what page to start on choose Portal.html
- If you get a 404 error, you may need to navigate to the project root directory and "mvn clean install".
...
As of Chrome version 39, the old GWT Development Mode is no longer available.
Using Super Dev Mode (SDM) means running two servers, one for the web application and one for the Code Server that compiles classes for SDM when the compile button is pushed on the web page or in the bookmark.
...
First thing to do is to make sure that your Google Plugin for Eclipse is up to date (version >= 3.8.0.v201410302155-rel-r42).
The Google plugin wraps the two servers into NOTE: After we update to GWT v2.6 or greater, this section needs to be rewritten (can be a single launch configuration . So let's create the launch configuration!
...
if using GWT 2.6).
- In your existing web application Portal launch configuration (created in the previous section above), add the following to the VM Arguments: "-Xmx512m -XX:MaxPermSize=512m -Dgwt.codeserver.port=9876"
Now it's time to create a new Run Configuration for the Code Server:
- From the Run Configurations window, add a new Java Application, named "Portal GWT Super Dev Mode Code Server" (for example).
- Set the Project to the Portal project.
- Set the Main Class to com.google.gwt.dev.codeserver.CodeServer
- Set the Program Arguments to "-src <SynapseWebClient_root_directory>/src/main/java -port 9876 org.sagebionetworks.web.Portal"
You should now be ready to launch the Code Server. Here are a couple of common problems...
- Missing jars in your WEB-INF/lib directory (the maven dependencies)? Go to the command line and run: "mvn eclipse:eclipse -Dwtpversion=2.0" to automatically add these libraries to the Deployment Assembly.
- Failure to serialize objects when using SDM? Known issue
Looks like the adopted fix was checked in on 4/2/2013. Serialization problems? Due to this known issue that applies to GWT v2.5.1 was released in 3/2013, so it does not contain the fix, but 2.6.0 should. I (Jay) am investigating a work around. One way is to copy gwt.rpc files after startup, which I have now verified fixed the problem (by copying all gwt.rpc files into the target/portal-DEVELOP-SNAPSHOT/Portal directory), you should always run the Code Server first, then start the Portal web application once the code server is available. We now copy over gwt.rpc files on servlet init as a workaround until we upgrade to GWT v2.6.
Eclipse Workspace Settings
...
- For dependency injection (IoC) we are using a combination of GIN and Guice.
- Guice - is the base IoC technology but it is only fully functional in Server-side. http://code.google.com/docreader/#p=google-guice&s=google-guice&t=Motivation
- Gin - provides basic IoC for GWT client-side code. http://code.google.com/p/google-gin/wiki/GinTutorial
- Guice Servlet - This is a sub-project of Guice that allows dependency inject into Servelets. http://code.google.com/p/google-guice/wiki/ServletModule
- Http REST calls are currently made using Spring's RestTemplate. http://blog.springsource.com/2009/03/27/rest-in-spring-3-resttemplate/
- To create API REST stub-services we are using a combination of two technologies:
- Jersey - provides a quick and easy method for transforming simple POJO's into RESTful web services using annotations. http://jersey.java.net/nonav/documentation/latest/user-guide.html
- Grizzly - The GrizzlyWebContainerFactory makes it simple to start a local web container. http://blog.msbbc.co.uk/2008/11/java-using-jersey-and-grizzly-to-create.html
How to override configuration (obsolete, needs updating)
If you want to point it to a locally running instance of the repository service:
...