Skip to content

Latest commit

 

History

History
147 lines (84 loc) · 6.64 KB

README.md

File metadata and controls

147 lines (84 loc) · 6.64 KB
Raw

helloworld-rs: Helloworld Using JAX-RS (Java API for RESTful Web Services)

Authors: Gustavo A. Brey, Gaston Coco and others

What is it?

This example demonstrates the use of CDI 1.0 and JAX-RS in JBoss AS 7 or JBoss Enterprise Application Platform 6.

System requirements

All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.

The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.

Configure Maven

If you have not yet done so, you must Configure Maven before testing the quickstarts.

Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile

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

  2. The following shows the command line to start the server with the web profile:

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

Build and Deploy the Quickstart

NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Build and Deploy the Quickstarts for complete instructions and additional options.

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

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

  3. Type this command to build and deploy the archive:

     mvn clean package jboss-as:deploy

  4. This will deploy target/jboss-as-helloworld-rs.war to the running instance of the server.

Access the application

The application is deployed to http://localhost:8080/jboss-as-helloworld-rs.

The XML content can be viewed by accessing the following URL: http://localhost:8080/jboss-as-helloworld-rs/rest/xml

The JSON content can be viewed by accessing this URL: http://localhost:8080/jboss-as-helloworld-rs/rest/json

Undeploy the Archive

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

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

  3. When you are finished testing, type this command to undeploy the archive:

     mvn jboss-as:undeploy

Run the Quickstart in JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts

Debug the Application

If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.

    mvn dependency:sources
    mvn dependency:resolve -Dclassifier=javadoc

Build and Deploy the Quickstart - to OpenShift

NOTE: At the time of this writing, JBoss Enterprise Application Platform 6 is not yet available on OpenShift, so only the JBoss AS 7 version of this quickstart can be deployed to OpenShift.

Create an OpenShift Express Account and Domain

If you do not yet have an OpenShift account and domain, Sign in to OpenShift to create the account and domain. Get Started with OpenShift will show you how to install the OpenShift Express command line interface.

Create the OpenShift Application

Open a shell command prompt and change to a directory of your choice. Enter the following command:

    rhc app create -a helloworldrs -t jbossas-7

NOTE: The domain name for this application will be helloworldrs-YOUR_DOMAIN_NAME.rhcloud.com. Here we use the quickstart domain. You will need to replace it with your own OpenShift domain name.

This command creates an OpenShift application called helloworldrs and will run the application inside a jbossas-7 container. You should see some output similar to the following:

Creating application: helloworldrs
Now your new domain name is being propagated worldwide (this might take a minute)...
Warning: Permanently added 'helloworldrs-quickstart.rhcloud.com,107.22.36.32' (RSA) to the list of known hosts.
Confirming application 'helloworldrs' is available:  Success!

helloworldrs published:  http://helloworldrs-quickstart.rhcloud.com/
git url:  ssh://b92047bdc05e46c980cc3501c3577c1e@helloworldrs-quickstart.rhcloud.com/~/git/helloworldrs.git/
Successfully created application: helloworldrs

The create command creates a git repository in the current directory with the same name as the application. Notice that the output also reports the URL at which the application can be accessed. Make sure it is available by typing the published url http://helloworldrs-quickstart.rhcloud.com/ into a browser or use command line tools such as curl or wget.

Migrate the Quickstart Source

Now that you have confirmed it is working you can now migrate the quickstart source. You no longer need the default application so change directory into the new git repository and tell git to remove the source files and pom:

    cd helloworldrs
    git rm -r src pom.xml

Copy the source for the helloworld-rs quickstart into this new git repository:

    cp -r <quickstarts>/helloworld-rs/src .
    cp <quickstarts>/helloworld-rs/pom.xml .

You can now deploy the changes to your OpenShift application using git as follows:

    git add src pom.xml
    git commit -m "helloworld-rs quickstart on OpenShift"
    git push

The final push command triggers the OpenShift infrastructure to build and deploy the changes.

Note that the openshift profile in pom.xml is activated by OpenShift, and causes the war build by openshift to be copied to the deployments directory, and deployed without a context path.

When the push command returns you can retest the application by getting the following URLs either via a browser or using tools such as curl or wget:

You can use the OpenShift command line tools or the OpenShift web console to discover and control the application.

Destroy the OpenShift Application

When you are finished with the application you can destroy it as follows:

    rhc app destroy -a helloworldrs