Skip to content

Latest commit

 

History

History
149 lines (83 loc) · 8.03 KB

README.md

File metadata and controls

149 lines (83 loc) · 8.03 KB

contacts-mobile-proxy: Contacts CRUD Mobile Proxied Web Application

Author: Daniel Bevenius
Level: Beginner
Technologies: REST
Summary: The contacts-mobile-proxy quickstart is basic example of CRUD operations that are proxied to a backend system.
Target Product: JBoss Unified Push
Versions: 1.0
Source: https://github.com/jboss-developer/jboss-mobile-quickstarts/

What is it?

The contacts-mobile-proxy quickstart is a deployable Maven 3 project to help you get started in developing proxied web applications with Java EE 6 on JBoss EAP.

So what is a proxied web application?
The need of a proxied web application arises when you have a backend system that is not allowed to be exposed to direct traffic from the internet, but there is a service in this backend system that needs to be exposed, without jeopardizing the whole backend system (backend systems would most often be protected by a firewall).

A proxied web application would be deployed on a server on the other side of that firewall (on a server that is safe to expose to direct traffic from the internet), and would proxy its request to the exposed service in this backend system.

How do I use it?

0. System Requirements

  • Java 6
  • Maven 3.0 or later
  • Red Hat JBoss Enterprise Application Platform (EAP) 6.3.0.GA

1. Prepare Maven Libraries

This quickstart is designed to be built with Maven. It requires the JBoss Unified Push and JBoss EAP 6.3.0 Maven repositories.

You must have the JBoss Unified Push Maven repository available and Maven configured to use it. For more information, see the Configure Maven or the README distributed with the JBoss Unified Push Maven repository.

2. Start the JBoss EAP Server

This quickstart requires three instances of JBoss EAP running with the following quickstart deployed: push-contacts-mobile-picketlink-secured, contacts-mobile-webapp, and contacts-mobile-proxy

If you have previously deployed the above quickstart then please undeploy them so we start from a clean state. Then follow the instructions below to startup the server with the correct ports and also to deploy the quickstart to the correct servers.

  1. Open a command line and navigate to the root of the JBoss EAP directory.

  2. Start the server instance that will host the push-contacts-mobile-picketlink-secured quickstart

     For Linux:   EAP_HOME/bin/standalone.sh
 For Windows: EAP_HOME\bin\standalone.bat

  3. Start the server instance that will host the contacts-mobile-webapp quickstart

     For Linux:   EAP_HOME/bin/standalone.sh -Djboss.socket.binding.port-offset=100
 For Windows: EAP_HOME\bin\standalone.bat -Djboss.socket.binding.port-offset=100

  4. Start the server instance that will host the contacts-mobile-proxy quickstart quickstart

     For Linux:   EAP_HOME/bin/standalone.sh -Djboss.socket.binding.port-offset=200
 For Windows: EAP_HOME\bin\standalone.bat -Djboss.socket.binding.port-offset=200

Note: Adding "-b 0.0.0.0" to the above commands will allow external clients (phones, tablets, desktops, etc...) to connect through your local network.

For example

    For Linux:   EAP_HOME/bin/standalone.sh -b 0.0.0.0
    For Windows: EAP_HOME\bin\standalone.bat -b 0.0.0.0

3. Configure contacts-mobile-webapp

By default the contacts-mobile-webapp is set up to work directly against push-contacts-mobile-picketlink-secured as its backend. For this quickstart we will instead have contacts-mobile_webapp work against contacts-mobile-proxy. This requires a change to contacts-mobile-webapp/src/main/webapp/js/app.js.

Please open for edit contacts-mobile-webapp/src/main/webapp/js/app.js and update the CONTACTS.app.serverURL variable to:

    CONTACTS.app.serverUrl = "http://localhost:8280/jboss-contacts-mobile-proxy";

4. Build and Deploy the Quickstart

  1. Make sure you have started the JBoss EAP servers as described above.

  2. Open a command line and navigate to the root directory of this quickstart.

  3. From the push-contacts-mobile-picketlink-secured directory run the following command to deploy the quickstart:

     mvn clean package jboss-as:deploy

  4. From the contacts-mobile-webapp directory run the following command to deploy the quickstart:

     mvn clean package jboss-as:deploy -Djboss-as.port=10099

  5. From the contacts-mobile-proxy directory run the following command to deploy the quickstart:

     mvn clean package jboss-as:deploy -Djboss-as.port=10199

The reason why we need the servers to be started before deploying is that since all server are using the same configuration file, standalone.xml, all deployments are persisted to this file. This means that if you restart the server all three quickstart will be deployed which is not desirable. You can either undeploy each quickstart or edit standalone/configuration/standalone.xml and remove the deployments element.

5. Test the Application

Access the running client application in a browser at the following URL: http://localhost:8180/jboss-contacts-mobile-webapp/#signin-page.
Please refer to the documentation for contacts-mobile-webapp for details about testing these quickstarts.

6. Undeploy the Quickstart

  1. Make sure you have started the JBoss EAP server as described above.

  2. Open a command line and navigate to the root directory of this quickstart

  3. From the contacts-mobile-webapp directory run the following command to undeploy the quickstart:

     mvn jboss-as:undeploy -Djboss-as.port=10099

  4. From the contacts-mobile-proxy directory run the following command to undeploy the quickstart:

     mvn jboss-as:undeploy -Djboss-as.port=10199

  5. From the push-contacts-mobile-picketlink-secured directory run the following command to undeploy the quickstart:

     mvn jboss-as:undeploy

FAQ

How do I configure the proxy application?

By default there is nothing to configure in this quickstart. But you might be interested in how the proxy is configured. The rules for the proxy can be found in proxy-gateway-config.json.

This JSON file defines the mapping of URLs that the proxy can handle. You can define as many rules are you like; the basic single rule looks like this:

    { "rule": "/rest/contacts", "to": "http://localhost:8080/jboss-push-contacts-mobile-picketlink-secured/rest/contacts"}

The above can be read as: any request with a request URI of /rest/contacts should be sent to the URI of to.
You can also have path parameters in your rules. For example, we have the following rule in addition to the one above exists in this quickstart:

    { "rule": "/rest/contacts/{id}", "to": "http://localhost:8080/jboss-push-contacts-mobile-picketlink-secured/rest/contacts{id}"}

With this rule, any request URI in the format /rest/contacts/10001 will be proxied to the URI of to.

Use the Project with an IDE

You can import this project into an IDE (JBoss Developer Studio, NetBeans or IntelliJ IDEA). If you are using JBoss Developer Studio you must import the project as a Maven project. If you are using NetBeans 6.8 or IntelliJ IDEA 9, then you can open the project as an existing project as both of these IDEs recognize Maven projects natively.

You can also start the server and deploy the quickstarts from JBoss Developer Studio. For more information , see the Get Started with JBoss Developer Studio.

If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.

mvn dependency:sources