Page History

...

Code Block

	java
	java
borderStyle	solid
title	Calculator.java

package org.apache.geronimo.samples.jws;

import javax.jws.WebServiceWebMethod;
import javax.jws.WebParam;
import javax.jws.WebMethodWebResult;
import javax.jws.WebParam.WebService;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;

@WebService(name = "CalculatorPortType",
            targetNamespace = "http://jws.samples.geronimo.apache.org")
public interface Calculator {

    @WebMethod/**
    public int add(@WebParam(name = "value1") int value1,* @param value1
     * @param value2
     * @return returns int
     */
    @WebMethod(operationName = "add")
    @WebParam@WebResult(name = "value2return"), targetNamespace int value2);

}

The CalculatorService class implements the Web Service business logic. It implements all the methods defined in the SEI. The class does not need to implement the Calculator interface but must reference it through the @WebService.endpointInterface annotation. This class will be exposed as a Servlet through web.xml file even though it does not extend the javax.servlet.Servlet class.
The context variable marked with the @Resource annotation will be injected at runtime. The WebServiceContext can be used to obtain the message context and security information relative to the call.

Code Block
java	java
borderStyle	solid
title	CalculatorService.java
package = "http://jws.samples.geronimo.apache.org") @RequestWrapper(localName = "add", targetNamespace = "http://jws.samples.geronimo.apache.org", className = "org.apache.geronimo.samples.jws.Add") @ResponseWrapper(localName = "addResponse", targetNamespace = "http://jws.samples.geronimo.apache.org", className = "org.apache.geronimo.samples.jws; import javax.annotation.Resource; import javax.jws.WebService; import javax.xml.ws.WebServiceContext; @WebService(serviceName.AddResponse") public int add(@WebParam(name = "Calculatorvalue1", targetNamespace = "http://jws.samples.geronimo.apache.org")int value1, portName="CalculatorPort", endpointInterface@WebParam(name = "org.apache.geronimo.samples.jws.Calculator", "value2", targetNamespace = "http://jws.samples.geronimo.apache.org", wsdlLocation = "WEB-INF/wsdl/CalculatorService.wsdl") public class CalculatorService implements Calculator { @Resource private WebServiceContext context; public int add(int value1, int value2) { System.out.println("User Principal: " + context.getUserPrincipal()); return value1 + value2; } }

The web.xml descriptor is used to deploy the Web Service.

)int value2);

}

The CalculatorService class implements the Web Service business logic. It implements all the methods defined in the SEI. The class does not need to implement the Calculator interface but must reference it through the @WebService.endpointInterface annotation. This class will be exposed as a Servlet through web.xml file even though it does not extend the javax.servlet.Servlet class.
The context variable marked with the @Resource annotation will be injected at runtime. The WebServiceContext can be used to obtain the message context and security information relative to the call.

Code Block

	java
	java
borderStyle	solid
title	CalculatorService.java


package org.apache.geronimo.samples.jws;

import javax.annotation.Resource;
import javax.jws.WebService;
import javax.xml.ws.WebServiceContext;

@WebService(serviceName = "Calculator",

Code Block

xml

borderStyle

solid

title

web.xml


<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee" version="2.5">
	<servlet>
		<display-name>CalculatorService</display-name>
		<servlet-name>CalculatorService</servlet-name>
		<servlet-class>
			org.apache.geronimo.samples.jws.CalculatorService
		</servlet-class>
	</servlet>
	
	<servlet-mapping>
		<servlet-name>CalculatorService</servlet-name>
		<url-pattern>/calculator</url-pattern>
	</servlet-mapping>	

        .....
</web-app>
portName = "CalculatorPort",
        endpointInterface = "org.apache.geronimo.samples.jws.Calculator",
        targetNamespace = "http://jws.samples.geronimo.apache.org",
        wsdlLocation = "WEB-INF/wsdl/CalculatorService.wsdl")
public class CalculatorService implements Calculator {

    @Resource
    private WebServiceContext context;

    /**
     * @return returns javax.xml.ws.WebServiceContext
     */
    public WebServiceContext getContext() {
        return context;
    }

    /**
     * @param value1
     * @param value2
     * @return returns int
     */
    public int add(int value1, int value2) {
        System.out.println("User Principal: " + context.getUserPrincipal());
        System.out.println("value1: " + value1 + " value2: " + value2);
        return value1 + value2;
    }
}

The web.xml descriptor is used to deploy the Web Service.

Code Block

	xml
	xml
borderStyle	solid
title	web.xml


<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee" version="2.5">
    <servlet>
	<display-name>CalculatorService</display-name>
	<servlet-name>CalculatorService</servlet-name>
	<servlet-class>
	    org.apache.geronimo.samples.jws.CalculatorService
	</servlet-class>
    </servlet>
	
    <servlet-mapping>
	<servlet-name>CalculatorService</servlet-name>
	<url-pattern>/calculator</url-pattern>
    </servlet-mapping>	

    .....

    <service-ref>
        <service-ref-name>services/Calculator</service-ref-name>
        <service-interface>javax.xml.ws.Service</service-interface>
        <wsdl-file>WEB-INF/wsdl/CalculatorService.wsdl</wsdl-file>
    </service-ref>
</web-app>

Info

title	web.xml

The web.xml descriptor is not necessary for simple JAX-WS web service deployments. If the web.xml descriptor is not provided, it will be automatically generated during deployment. In this sample, while not required to implement the web service

Info

title	web.xml

The web.xml descriptor is not necessary for simple JAX-WS web service deployments. If the web.xml descriptor is not provided, it will be automatically generated during deployment. In this sample, while not required to implement the web service, it is required to provide the service-ref used by the jsp client.

The geronimo plan has no information for the web service but does specify more information for the service-ref for the jsp client. The . For tomcat, the plan can be located after building the project in jaxws-calculator/jaxws-calculator-tomcat/target/resources/META-INF/plan.xml. For Jetty, the plan can be located after building the project in jaxws-calculator/jaxws-calculator-jetty/target/resources/META-INF/plan.xml.

Code Block

	xml
	xml
borderStyle	solid
title	geronimo-web.xml for tomcat


<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://geronimo.apache.org/xml/ns/j2ee/web-1.1">
  <dep:environment xmlns:dep="http://geronimo.apache.org/xml/ns/deployment-1.2">
    <dep:moduleId>
      <dep:groupId>org.apache.geronimo.samples</dep:groupId>
      <dep:artifactId>jaxws-calculator-jetty<tomcat</dep:artifactId>
      <dep:version>2.1.2-SNAPSHOT</dep:version>
      <dep:type>car</dep:type>
    </dep:moduleId>
    <dep:dependencies>
      <dep:dependency>
        <dep:groupId>org.apache.geronimo.configs</dep:groupId>
        <dep:artifactId>jasper</dep:artifactId>
        <dep:version>2.1.2-SNAPSHOT</dep:version>
        <dep:type>car</dep:type>
      </dep:dependency>
      <dep:dependency>
        <dep:groupId>org.apache.geronimo.configs</dep:groupId>
        <dep:artifactId>jetty6<artifactId>tomcat6</dep:artifactId>
        <dep:version>2.1.2-SNAPSHOT</dep:version>
        <dep:type>car</dep:type>
      </dep:dependency>
      <dep:dependency>
        <dep:groupId>org.apache.geronimo.configs</dep:groupId>
        <dep:artifactId>axis2</dep:artifactId>
        <dep:version>2.1.2-SNAPSHOT</dep:version>
        <dep:groupId>org.apache.geronimo.configs<type>car</dep:groupId>type>
      </dep:dependency>
    <dep:artifactId>cxf<</dep:artifactId>dependencies>
    <dep:hidden-classes/>
    <dep:version>2.2-SNAPSHOT</dep:version>non-overridable-classes/>
  </dep:environment>
  <context-root>/jaxws-calculator</context-root>
  <service-ref>
    <service-ref-name>services/Calculator</service-ref-name>
    <dep:type>car</dep:type><port>
      </dep:dependency>
<port-name>CalculatorPort</port-name>
     </dep:dependencies> <protocol>http</protocol>
    <dep:hidden-classes/>  <host>localhost</host>
    <dep:non-overridable-classes/>
  <<port>8080</dep:environment>port>
   <context-root>   <uri>/jaxws-calculator/calculator</context-root>uri>
  <service-ref>
  </port>
  <service-ref-name>services/Calculator<</service-ref-name>
    <port>
      <port-name>CalculatorPort</port-name>
      <protocol>http</protocol>
      <host>localhost</host>
      <port>8080</port>
      <uri>/jaxws-calculator/calculator</uri>
    </port>
  </service-ref>
</web-app>
ref>
</web-app>

Info

title	Optional geronimo-web.xml

You could also deploy the jaxws-calculator-war\target\jaxws-calculator-war-version.war file without a plan,
use the steps below:

Update the "soap:address location" value in the CalculatorService.wsdl to refect the correct version
of the jaxws-calculator-war module, for example

<soap:address location="http://localhost:8080/jaxws-calculator-war-version/calculator"/>

Rebuild the sample and deploy the war.

The following WSDL file describes the Web Service:

Code Block

	xml
	xml
borderStyle	solid
title	CalculatorService.wsdl

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions name="Calculator"
    xmlns="http://schemas.xmlsoap.org/wsdl/"
    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    targetNamespace="http://jws.samples.geronimo.apache.org"
    xmlns:tns="http://jws.samples.geronimo.apache.org">

    <wsdl:types>
        <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                    xmlns="http://jws.samples.geronimo.apache.org" 
                    targetNamespace="http://jws.samples.geronimo.apache.org"
                    attributeFormDefault="unqualified" elementFormDefault="qualified">

             <xsd:element name="add">
                <xsd:complexType>
                   <xsd:sequence>
                      <xsd:element name="value1" type="xsd:int"/>
                      <xsd:element name="value2" type="xsd:int"/>
                   </xsd:sequence>
                </xsd:complexType>
             </xsd:element>

             <xsd:element name="addResponse">
                <xsd:complexType>
                   <xsd:sequence>
                      <xsd:element name="return" type="xsd:int"/>
                   </xsd:sequence>
                </xsd:complexType>
             </xsd:element>
        </xsd:schema>
    </wsdl:types>
  
    <wsdl:message name="add">
       <wsdl:part name="add" element="tns:add"/>
    </wsdl:message>

    <wsdl:message name="addResponse">
       <wsdl:part name="addResponse" element="tns:addResponse"/>
    </wsdl:message>

    <wsdl:portType name="CalculatorPortType">
       <wsdl:operation name="add">
         <wsdl:input name="add" message="tns:add"/>
         <wsdl:output name="addResponse" message="tns:addResponse"/>
       </wsdl:operation>
    </wsdl:portType>
        
    <wsdl:binding name="CalculatorSoapBinding" type="tns:CalculatorPortType">
        <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
        
        <wsdl:operation name="add">
            <soap:operation soapAction="add" style="document"/>
            <wsdl:input name="add">
                <soap:body use="literal"/>
            </wsdl:input>
            <wsdl:output name="addResponse">
                <soap:body use="literal"/>
            </wsdl:output>
        </wsdl:operation>
                
    </wsdl:binding>
  
    <wsdl:service name="Calculator">
        <wsdl:port name="CalculatorPort" binding="tns:CalculatorSoapBinding">
            <soap:address location="http://localhost:8080/jaxws-calculator-1.0/calculator"/>
        </wsdl:port>
    </wsdl:service>
      
</wsdl:definitions>

    </wsdl:service>
      
</wsdl:definitions>

Info

title	CalculatorService.wsdl

In J2EE version 1.4, wsdl file was required to describe the Web Service. In Java EE 5 wsdl file is optional. It can be generated at deployment time by the Geronimo server if CalculatorService.wsdl is not provided with the sample.

Info

title	webservices.xml

In J2EE version 1.4, the webservices.xml file was also necessary to describe the Web Service. In Java EE 5 that file is optional and is not required in this example.

...

To test this sample service use using the add.jsp (http://localhost:8080/jaxws-calculator/add.jsp) to invoke the Web Service. Once the JSP page loads type in two values to add and press the Add button. The result of the addition should show up below. For example:

Note
TODO document command Command line client CalculatorClient.java is not currently working yet.

Child pages

Versions Compared

Old Version 4

New Version Current

Key