# HG changeset patch # User Ingo Weinzierl # Date 1297160989 0 # Node ID 4e8be5e7855f336e4ee3fa23b6997a103c9c9e31 Start of a GWT based client for FLYS-3.0 flys-client/trunk@1305 c6561f87-3c4e-4783-a992-168aeb5c3f6f diff -r 000000000000 -r 4e8be5e7855f flys-client/.classpath --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/.classpath Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,11 @@ + + + + + + + + + + + diff -r 000000000000 -r 4e8be5e7855f flys-client/.project --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/.project Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,15 @@ + + + FLYS + FLYS project + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.jdt.core.javanature + + diff -r 000000000000 -r 4e8be5e7855f flys-client/FLYS.launch --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/FLYS.launch Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff -r 000000000000 -r 4e8be5e7855f flys-client/FLYSTest-dev.launch --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/FLYSTest-dev.launch Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff -r 000000000000 -r 4e8be5e7855f flys-client/FLYSTest-prod.launch --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/FLYSTest-prod.launch Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff -r 000000000000 -r 4e8be5e7855f flys-client/README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/README.txt Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,84 @@ +--- Generated by GWT WebAppCreator --- + +Congratulations, you've successfully generated a starter project! What next? + +-- Option A: Import your project into Eclipse (recommended) -- + +If you use Eclipse, you can simply import the generated project into Eclipse. +We've tested against Eclipse 3.4 and 3.5. Later versions will likely also +work, earlier versions may not. + +If the directory containing this file does not have a .classpath or .project +file, generate them by running 'ant eclipse.generate' + +In Eclipse, go to the File menu and choose: + + File -> Import... -> Existing Projects into Workspace + + Browse to the directory containing this file, + select "FLYS". + + Be sure to uncheck "Copy projects into workspace" if it is checked. + + Click Finish. + +You can now browse the project in Eclipse. + +To launch your web app in GWT development mode, go to the Run menu and choose: + + Run -> Open Debug Dialog... + + Under Java Application, you should find a launch configuration + named "FLYS". Select and click "Debug". + + You can now use the built-in debugger to debug your web app in development mode. + +If you supplied the junit path when invoking webAppCreator, you should see +launch configurations for running your tests in development and production +mode. + +-- Option B: Build from the command line with Ant -- + +If you prefer to work from the command line, you can use Ant to build your +project. (http://ant.apache.org/) Ant uses the generated 'build.xml' file +which describes exactly how to build your project. This file has been tested +to work against Ant 1.7.1. The following assumes 'ant' is on your command +line path. + +To run development mode, just type 'ant devmode'. + +To compile your project for deployment, just type 'ant'. + +To compile and also bundle into a .war file, type 'ant war'. + +If you supplied the junit path when invoking webAppCreator, you can type 'ant +test' to run tests in development and production mode. + +For a full listing of other targets, type 'ant -p'. + +-- Option C: Using another IDE -- + +GWT projects can be run in other IDEs as well, but will require some manual +setup. If you go this route, be sure to: + +* Have your IDE build .class files into 'war/WEB-INF/classes'. +* Add gwt-user.jar and gwt-dev.jar to your project build path. +* When creating a launch configuration, add a classpath entry for your 'src' + folder (this is somewhat unusual but GWT needs access to your source files). + +If you get stuck, try to mimic what the Ant 'build.xml' would do. + +-- Option D: Using Maven -- + +If you have generated your project with the option '-maven', you have a 'pom.xml' +file ready to use. Assuming you have 'maven2' installed in your system, 'mvn' is +in your path, and you have access to maven repositories, you should be able to run: + +mvn clean # delete temporary stuff +mvn test # run all the tests (gwt and junit) +mvn gwt:run # run development mode +mvn gwt:compile # compile to javascript +mvn package # generate a .war package ready to deploy + +For more information about other available goals, read maven and gwt-maven-plugin +documentation (http://maven.apache.org, http://mojo.codehaus.org/gwt-maven-plugin) diff -r 000000000000 -r 4e8be5e7855f flys-client/pom.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/pom.xml Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,139 @@ + + + + + 4.0.0 + de.intevation.flys.client + FLYS + war + 1.0-SNAPSHOT + de.intevation.flys.client.FLYS + + + + 2.1.1 + + 1.5 + 1.5 + + + + + com.google.gwt + gwt-servlet + ${gwtVersion} + runtime + + + com.google.gwt + gwt-user + ${gwtVersion} + provided + + + com.google.gwt + gwt-dev + ${gwtVersion} + test + + + junit + junit + 4.4 + test + + + + + + target/www/WEB-INF/classes + + + + + + org.codehaus.mojo + gwt-maven-plugin + + + + prepare-package + + compile + + + + + + + FLYS.html + + target/www + + true + + + + + + maven-surefire-plugin + + + ${project.build.sourceDirectory} + ${project.build.testSourceDirectory} + + false + always + + + + + gwt.args + -out target/www + + + + + + + + maven-resources-plugin + + + compile + + copy-resources + + + target/www + + + src/main/webapp + + + + + + + + + + maven-clean-plugin + + + src/main/webapp/flys + src/main/webapp/WEB-INF/classes + tomcat + www-test + .gwt-tmp + + + + + + + + + diff -r 000000000000 -r 4e8be5e7855f flys-client/src/main/java/de/intevation/flys/client/FLYS.gwt.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/java/de/intevation/flys/client/FLYS.gwt.xml Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + diff -r 000000000000 -r 4e8be5e7855f flys-client/src/main/java/de/intevation/flys/client/client/FLYS.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/java/de/intevation/flys/client/client/FLYS.java Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,147 @@ +package de.intevation.flys.client.client; + +import de.intevation.flys.client.shared.FieldVerifier; +import com.google.gwt.core.client.EntryPoint; +import com.google.gwt.core.client.GWT; +import com.google.gwt.event.dom.client.ClickEvent; +import com.google.gwt.event.dom.client.ClickHandler; +import com.google.gwt.event.dom.client.KeyCodes; +import com.google.gwt.event.dom.client.KeyUpEvent; +import com.google.gwt.event.dom.client.KeyUpHandler; +import com.google.gwt.user.client.rpc.AsyncCallback; +import com.google.gwt.user.client.ui.Button; +import com.google.gwt.user.client.ui.DialogBox; +import com.google.gwt.user.client.ui.HTML; +import com.google.gwt.user.client.ui.Label; +import com.google.gwt.user.client.ui.RootPanel; +import com.google.gwt.user.client.ui.TextBox; +import com.google.gwt.user.client.ui.VerticalPanel; + +/** + * Entry point classes define onModuleLoad(). + */ +public class FLYS implements EntryPoint { + /** + * The message displayed to the user when the server cannot be reached or + * returns an error. + */ + private static final String SERVER_ERROR = "An error occurred while " + + "attempting to contact the server. Please check your network " + + "connection and try again."; + + /** + * Create a remote service proxy to talk to the server-side Greeting service. + */ + private final GreetingServiceAsync greetingService = GWT.create(GreetingService.class); + + /** + * This is the entry point method. + */ + public void onModuleLoad() { + final Button sendButton = new Button("Send"); + final TextBox nameField = new TextBox(); + nameField.setText("GWT User"); + final Label errorLabel = new Label(); + + // We can add style names to widgets + sendButton.addStyleName("sendButton"); + + // Add the nameField and sendButton to the RootPanel + // Use RootPanel.get() to get the entire body element + RootPanel.get("nameFieldContainer").add(nameField); + RootPanel.get("sendButtonContainer").add(sendButton); + RootPanel.get("errorLabelContainer").add(errorLabel); + + // Focus the cursor on the name field when the app loads + nameField.setFocus(true); + nameField.selectAll(); + + // Create the popup dialog box + final DialogBox dialogBox = new DialogBox(); + dialogBox.setText("Remote Procedure Call"); + dialogBox.setAnimationEnabled(true); + final Button closeButton = new Button("Close"); + // We can set the id of a widget by accessing its Element + closeButton.getElement().setId("closeButton"); + final Label textToServerLabel = new Label(); + final HTML serverResponseLabel = new HTML(); + VerticalPanel dialogVPanel = new VerticalPanel(); + dialogVPanel.addStyleName("dialogVPanel"); + dialogVPanel.add(new HTML("Sending name to the server:")); + dialogVPanel.add(textToServerLabel); + dialogVPanel.add(new HTML("
Server replies:")); + dialogVPanel.add(serverResponseLabel); + dialogVPanel.setHorizontalAlignment(VerticalPanel.ALIGN_RIGHT); + dialogVPanel.add(closeButton); + dialogBox.setWidget(dialogVPanel); + + // Add a handler to close the DialogBox + closeButton.addClickHandler(new ClickHandler() { + public void onClick(ClickEvent event) { + dialogBox.hide(); + sendButton.setEnabled(true); + sendButton.setFocus(true); + } + }); + + // Create a handler for the sendButton and nameField + class MyHandler implements ClickHandler, KeyUpHandler { + /** + * Fired when the user clicks on the sendButton. + */ + public void onClick(ClickEvent event) { + sendNameToServer(); + } + + /** + * Fired when the user types in the nameField. + */ + public void onKeyUp(KeyUpEvent event) { + if (event.getNativeKeyCode() == KeyCodes.KEY_ENTER) { + sendNameToServer(); + } + } + + /** + * Send the name from the nameField to the server and wait for a response. + */ + private void sendNameToServer() { + // First, we validate the input. + errorLabel.setText(""); + String textToServer = nameField.getText(); + if (!FieldVerifier.isValidName(textToServer)) { + errorLabel.setText("Please enter at least four characters"); + return; + } + + // Then, we send the input to the server. + sendButton.setEnabled(false); + textToServerLabel.setText(textToServer); + serverResponseLabel.setText(""); + greetingService.greetServer(textToServer, new AsyncCallback() { + public void onFailure(Throwable caught) { + // Show the RPC error message to the user + dialogBox.setText("Remote Procedure Call - Failure"); + serverResponseLabel.addStyleName("serverResponseLabelError"); + serverResponseLabel.setHTML(SERVER_ERROR); + dialogBox.center(); + closeButton.setFocus(true); + } + + public void onSuccess(String result) { + dialogBox.setText("Remote Procedure Call"); + serverResponseLabel.removeStyleName("serverResponseLabelError"); + serverResponseLabel.setHTML(result); + dialogBox.center(); + closeButton.setFocus(true); + } + }); + } + } + + // Add a handler to send the name to the server + MyHandler handler = new MyHandler(); + sendButton.addClickHandler(handler); + nameField.addKeyUpHandler(handler); + } +} diff -r 000000000000 -r 4e8be5e7855f flys-client/src/main/java/de/intevation/flys/client/client/GreetingService.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/java/de/intevation/flys/client/client/GreetingService.java Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,12 @@ +package de.intevation.flys.client.client; + +import com.google.gwt.user.client.rpc.RemoteService; +import com.google.gwt.user.client.rpc.RemoteServiceRelativePath; + +/** + * The client side stub for the RPC service. + */ +@RemoteServiceRelativePath("greet") +public interface GreetingService extends RemoteService { + String greetServer(String name) throws IllegalArgumentException; +} diff -r 000000000000 -r 4e8be5e7855f flys-client/src/main/java/de/intevation/flys/client/client/GreetingServiceAsync.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/java/de/intevation/flys/client/client/GreetingServiceAsync.java Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,11 @@ +package de.intevation.flys.client.client; + +import com.google.gwt.user.client.rpc.AsyncCallback; + +/** + * The async counterpart of GreetingService. + */ +public interface GreetingServiceAsync { + void greetServer(String input, AsyncCallback callback) + throws IllegalArgumentException; +} diff -r 000000000000 -r 4e8be5e7855f flys-client/src/main/java/de/intevation/flys/client/server/GreetingServiceImpl.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/java/de/intevation/flys/client/server/GreetingServiceImpl.java Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,48 @@ +package de.intevation.flys.client.server; + +import de.intevation.flys.client.client.GreetingService; +import de.intevation.flys.client.shared.FieldVerifier; +import com.google.gwt.user.server.rpc.RemoteServiceServlet; + +/** + * The server side implementation of the RPC service. + */ +@SuppressWarnings("serial") +public class GreetingServiceImpl extends RemoteServiceServlet implements + GreetingService { + + public String greetServer(String input) throws IllegalArgumentException { + // Verify that the input is valid. + if (!FieldVerifier.isValidName(input)) { + // If the input is not valid, throw an IllegalArgumentException back to + // the client. + throw new IllegalArgumentException( + "Name must be at least 4 characters long"); + } + + String serverInfo = getServletContext().getServerInfo(); + String userAgent = getThreadLocalRequest().getHeader("User-Agent"); + + // Escape data from the client to avoid cross-site script vulnerabilities. + input = escapeHtml(input); + userAgent = escapeHtml(userAgent); + + return "Hello, " + input + "!

I am running " + serverInfo + + ".

It looks like you are using:
" + userAgent; + } + + /** + * Escape an html string. Escaping data received from the client helps to + * prevent cross-site script vulnerabilities. + * + * @param html the html string to escape + * @return the escaped string + */ + private String escapeHtml(String html) { + if (html == null) { + return null; + } + return html.replaceAll("&", "&").replaceAll("<", "<").replaceAll( + ">", ">"); + } +} diff -r 000000000000 -r 4e8be5e7855f flys-client/src/main/java/de/intevation/flys/client/shared/FieldVerifier.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/java/de/intevation/flys/client/shared/FieldVerifier.java Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,42 @@ +package de.intevation.flys.client.shared; + +/** + *

+ * FieldVerifier validates that the name the user enters is valid. + *

+ *

+ * This class is in the shared package because we use it in both + * the client code and on the server. On the client, we verify that the name is + * valid before sending an RPC request so the user doesn't have to wait for a + * network round trip to get feedback. On the server, we verify that the name is + * correct to ensure that the input is correct regardless of where the RPC + * originates. + *

+ *

+ * When creating a class that is used on both the client and the server, be sure + * that all code is translatable and does not use native JavaScript. Code that + * is note translatable (such as code that interacts with a database or the file + * system) cannot be compiled into client side JavaScript. Code that uses native + * JavaScript (such as Widgets) cannot be run on the server. + *

+ */ +public class FieldVerifier { + + /** + * Verifies that the specified name is valid for our service. + * + * In this example, we only require that the name is at least four + * characters. In your application, you can use more complex checks to ensure + * that usernames, passwords, email addresses, URLs, and other fields have the + * proper syntax. + * + * @param name the name to validate + * @return true if valid, false if invalid + */ + public static boolean isValidName(String name) { + if (name == null) { + return false; + } + return name.length() > 3; + } +} diff -r 000000000000 -r 4e8be5e7855f flys-client/src/main/webapp/FLYS.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/webapp/FLYS.css Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,34 @@ +/** Add css rules here for your application. */ + + +/** Example rules used by the template application (remove for your app) */ +h1 { + font-size: 2em; + font-weight: bold; + color: #777777; + margin: 40px 0px 70px; + text-align: center; +} + +.sendButton { + display: block; + font-size: 16pt; +} + +/** Most GWT widgets already have a style name defined */ +.gwt-DialogBox { + width: 400px; +} + +.dialogVPanel { + margin: 5px; +} + +.serverResponseLabelError { + color: red; +} + +/** Set ids using widget.getElement().setId("idOfElement") */ +#closeButton { + margin: 15px 6px 6px; +} diff -r 000000000000 -r 4e8be5e7855f flys-client/src/main/webapp/FLYS.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/webapp/FLYS.html Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + Web Application Starter Project + + + + + + + + + + + + + + + + + + + + +

+ Your web browser must have JavaScript enabled + in order for this application to display correctly. +

+ +

Web Application Starter Project

+ + + + + + + + + + + + +

Please enter your name:

+ + diff -r 000000000000 -r 4e8be5e7855f flys-client/src/main/webapp/WEB-INF/web.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/main/webapp/WEB-INF/web.xml Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,24 @@ + + + + + + + + greetServlet + de.intevation.flys.client.server.GreetingServiceImpl + + + + greetServlet + /flys/greet + + + + + FLYS.html + + + diff -r 000000000000 -r 4e8be5e7855f flys-client/src/test/java/de/intevation/flys/client/FLYSJUnit.gwt.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/test/java/de/intevation/flys/client/FLYSJUnit.gwt.xml Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,9 @@ + + + + + + + + + diff -r 000000000000 -r 4e8be5e7855f flys-client/src/test/java/de/intevation/flys/client/client/FLYSTest.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-client/src/test/java/de/intevation/flys/client/client/FLYSTest.java Tue Feb 08 10:29:49 2011 +0000 @@ -0,0 +1,68 @@ +package de.intevation.flys.client.client; + +import de.intevation.flys.client.shared.FieldVerifier; +import com.google.gwt.core.client.GWT; +import com.google.gwt.junit.client.GWTTestCase; +import com.google.gwt.user.client.rpc.AsyncCallback; +import com.google.gwt.user.client.rpc.ServiceDefTarget; + +/** + * GWT JUnit tests must extend GWTTestCase. + */ +public class FLYSTest extends GWTTestCase { + + /** + * Must refer to a valid module that sources this class. + */ + public String getModuleName() { + return "de.intevation.flys.client.FLYSJUnit"; + } + + /** + * Tests the FieldVerifier. + */ + public void testFieldVerifier() { + assertFalse(FieldVerifier.isValidName(null)); + assertFalse(FieldVerifier.isValidName("")); + assertFalse(FieldVerifier.isValidName("a")); + assertFalse(FieldVerifier.isValidName("ab")); + assertFalse(FieldVerifier.isValidName("abc")); + assertTrue(FieldVerifier.isValidName("abcd")); + } + + /** + * This test will send a request to the server using the greetServer method in + * GreetingService and verify the response. + */ + public void testGreetingService() { + // Create the service that we will test. + GreetingServiceAsync greetingService = GWT.create(GreetingService.class); + ServiceDefTarget target = (ServiceDefTarget) greetingService; + target.setServiceEntryPoint(GWT.getModuleBaseURL() + "flys/greet"); + + // Since RPC calls are asynchronous, we will need to wait for a response + // after this test method returns. This line tells the test runner to wait + // up to 10 seconds before timing out. + delayTestFinish(10000); + + // Send a request to the server. + greetingService.greetServer("GWT User", new AsyncCallback() { + public void onFailure(Throwable caught) { + // The request resulted in an unexpected error. + fail("Request failure: " + caught.getMessage()); + } + + public void onSuccess(String result) { + // Verify that the response is correct. + assertTrue(result.startsWith("Hello, GWT User!")); + + // Now that we have received a response, we need to tell the test runner + // that the test is complete. You must call finishTest() after an + // asynchronous test finishes successfully, or the test will time out. + finishTest(); + } + }); + } + + +}