Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
Axis2
Axis2

Axis2 1.3 has/had a bug with the issue related to HTTP Content-Type header. This bug was fixed in Axis2 1.4 yet Geronimo 2.1.1 uses Axis2 1.3

Setting Up an Eclipse

...

project

  1. Create a Dynamic Web Project
    • Select File->New->Project (or Ctrl+N)





    • In the popup window, Select select Web->Dynamic Web Project category (or type dynamic in Wizards' input field so it's left alone) and click Next





    • Type jaxws-rest-converter as the Project Name and click Next two times twice.





    • Modify the Group Id to org.apache.geronimo.samples.jaxws.rest and the artifact id Artifact Id to jaxws-rest-converter.





    • Click Finish

This completes the configuration of Eclipse for application developmentThe project is now ready for further RESTful Web Services developments.

Creating the Web Services Implementation code

  1. Right click on JavaResources:src and select New->Package (or Ctrl+N, start typing package and select Package)





  2. Name the package to org.apache.geronimo.samples.jaxws.rest and click Finish





  3. Right click on the new package and select New->Class (or Ctrl+N, start typing class and select Class)





  4. Name the interface class as ConverterService and click Finish





  5. Add the following code to the ConverterService class
    Code Block
    titleConverterService.java
    borderStylesolid
    
    package org.apache.geronimo.samples.jaxws.rest;
    
    import java.io.ByteArrayInputStream;
    import java.math.BigDecimal;
    
    import javax.annotation.Resource;
    import javax.servlet.ServletRequest;
    import javax.xml.parsers.DocumentBuilder;
    import javax.xml.parsers.DocumentBuilderFactory;
    import javax.xml.transform.Source;
    import javax.xml.transform.dom.DOMSource;
    import javax.xml.transform.stream.StreamSource;
    import javax.xml.ws.BindingType;
    import javax.xml.ws.Provider;
    import javax.xml.ws.WebServiceContext;
    import javax.xml.ws.WebServiceProvider;
    import javax.xml.ws.handler.MessageContext;
    import javax.xml.ws.http.HTTPBinding;
    import javax.xml.ws.http.HTTPException;
    
    import org.w3c.dom.Node;
    import org.w3c.dom.NodeList;
    import org.xml.sax.InputSource;
    
    @WebServiceProvider
    @BindingType(value = HTTPBinding.HTTP_BINDING)
    public class ConverterService implements Provider<Source> {
    
        @Resource
        protected WebServiceContext wsContext;
    
        
    	private BigDecimal rupeeRate = new BigDecimal("40.58");
    	
        private BigDecimal euroRate = new BigDecimal("0.018368");
    
        public Source invoke(Source source) {
            try {
                	String amount = null;
    
                if (source == null) {
                    System.out.println("Getting input from query string");
                    MessageContext mc = wsContext.getMessageContext();
                    String query = (String) mc.get(MessageContext.QUERY_STRING);
                    System.out.println("Query String = " + query);
                    ServletRequest req = (ServletRequest) mc.get(MessageContext.SERVLET_REQUEST);
                    amount = req.getParameter("amount");
                } else {
                    System.out.println("Getting input from input message");
                    Node n = null;
                    if (source instanceof DOMSource) {
                        n = ((DOMSource) source).getNode();
                    } else if (source instanceof StreamSource) {
                        StreamSource streamSource = (StreamSource) source;
                        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
                        DocumentBuilder db = dbf.newDocumentBuilder();
                        InputSource inputSource = null;
                        if (streamSource.getInputStream() != null) {
                            inputSource = new InputSource(streamSource.getInputStream());
                        } else if (streamSource.getReader() != null) {
                            inputSource = new InputSource(streamSource.getReader());
                        }
                        n = db.parse(inputSource);
                    } else {
                        throw new RuntimeException("Unsupported source: " + source);
                    }
                    NodeList children = n.getChildNodes();
                    for (int i = 0; i < children.getLength(); i++) {
                        Node child = children.item(i);
                        if (child.getNodeName().equals("add")) {
                            amount = child.getAttributes().getNamedItem("amount").getNodeValue();
                            break;
                        }
                    }
                }
                BigDecimal dollars = new BigDecimal(amount);
                BigDecimal rupees = dollarToRupees(dollars);
                BigDecimal euros = rupeesToEuro(rupees);
                return createResultSource(rupees, euros);
            } catch (Exception e) {
                e.printStackTrace();
                throw new HTTPException(500);
            }
        }
    
        
    	public BigDecimal dollarToRupees(BigDecimal dollars) {
    		        BigDecimal result = dollars.multiply(rupeeRate);
    		        return result.setScale(2, BigDecimal.ROUND_UP);
    	    }
    
    	    public BigDecimal rupeesToEuro(BigDecimal rupees) {
    		 {
            BigDecimal result = rupees.multiply(euroRate);
    		        return result.setScale(2, BigDecimal.ROUND_UP);
    	}
        }
    
        private Source createResultSource(BigDecimal rupees, BigDecimal euros) {
        	String body =
        String body  = 	"<ns:return xmlns:ns=\"http://rest.jaxws.samples.geronimo.apache.org\">"
                    + "<ns:dollarToRupeesResponse>"
     +  rupees     	+rupees
            	+"</ns:dollarToRupeesResponse><ns:rupeesToEurosResponse>"
      +
            	euros
          + euros 	+ "</ns:rupeesToEurosResponse></ns:return>" ;
            Source source = new StreamSource(new ByteArrayInputStream(body.getBytes()));
            return source;
        }
    }
    
    

...

Setting Up the Deployment Descriptor and Deployment Plan

There isnt isn't much to do in this part for deploying RESTful Web Services except that we need to expose our ConverterService as servlet and CXF automatically generates the required files.

  • Expand WEB-INF directory and add the following code to the deployment descriptor (web.xml)
    Code Block
    titleweb.xml
    borderStylesolid
    
    <?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    	  xmlns="http://java.sun.com/xml/ns/javaee"
    	  xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" 
    	  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    	  id="WebApp_ID" version="2.5">
    	  <display-name>jaxws-rest-converter</display-name>
    	  <servlet>
    		    <servlet-name>ConverterService</servlet-name>
    		    <servlet-class>
    			 org.apache.geronimo.samples.jaxws.rest.ConverterService
    		 </servlet-class>
    		    <load-on-startup>0</load-on-startup>
    	  </servlet>
    	  <servlet-mapping>
    		    <servlet-name>ConverterService</servlet-name>
    		    <url-pattern>/converter</url-pattern>
    	  </servlet-mapping>
    </web-app>
    
    

...

  • Right click on the Apache Geronimo Server Runtime present available in the servers Servers view and select Add or Remove Projects





  • In the popup dialog, select the jaxws-rest-converter project and click Add





  • Make sure that jaxws-rest-converter is in the configured Configured projects list panel and then click Finish





  • Wait for some time a little bit till the server status is changed to synchronized (start Geronimo if it has not been started before).

Test

  • You should see CXF reporting that it's created Service from our Service implementation.





  • Finally we can also test the GET method of accessing our REST Service.

This is just a tip of iceberg in RESTful Web Services. There's still a lot to explore in RESTful services.