Skip to main content

TOTD #4: How to convert a Session EJB to a Web service ?

Posted by arungupta on August 23, 2007 at 6:09 AM PDT

This TOTD describes
how to convert a stateless session EJB to a Web service and uses information
from this
thread.

  1. Add @javax.jws.WebService annotation at the top of your EJB
    class. The modified code looks like:



    @javax.ejb.Stateless<br>
    	<b><font color="#FF9966">@javax.jws.WebService</font></b><br>
    	public class HelloSessionBean implements server.HelloSessionLocal {<br>
    &nbsp;&nbsp;&nbsp; public String sayHello(String name) {<br>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return &quot;Hello &quot; + name + &quot; from 
    	session bean&quot;;<br>
    &nbsp;&nbsp;&nbsp; }<br>
    	}<br>
    	<br>
    The new annotation is shown in this color.
  2. Re-build your project and redeploy it.

That's it!

There is no need to specify any additional deployment descriptor or
parameters.The WSDL exposed by the EJB Web service endpoint is available at "http://localhost:8080/HelloSessionBeanService/HelloSessionBean?wsdl".
The generated WSDL looks like:

&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>
&lt;!-- Published by JAX-WS RI at http://jax-ws.dev.java.net. RI's version is JAX-WS 
RI 2.1.2-hudson-182-RC1. --&gt;<br>
&lt;!-- Generated by JAX-WS RI at http://jax-ws.dev.java.net. RI's version is JAX-WS 
RI 2.1.2-hudson-182-RC1. --&gt;<br>
&lt;definitions<br>
&nbsp; xmlns:wsu=&quot;http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd&quot;<br>
&nbsp; xmlns:wsp=&quot;http://schemas.xmlsoap.org/ws/2004/09/policy&quot;<br>
&nbsp; xmlns:soap=&quot;http://schemas.xmlsoap.org/wsdl/soap/&quot;<br>
&nbsp; xmlns:tns=&quot;http://server/&quot;<br>
&nbsp; xmlns:xsd=&quot;http://www.w3.org/2001/XMLSchema&quot;<br>
&nbsp; xmlns=&quot;http://schemas.xmlsoap.org/wsdl/&quot;<br>
&nbsp; targetNamespace=&quot;http://server/&quot;<br>
&nbsp; name=&quot;HelloSessionBeanService&quot;&gt;<br>
&nbsp; &lt;wsp:UsingPolicy&gt;&lt;/wsp:UsingPolicy&gt;<br>
&nbsp; &lt;wsp:Policy wsu:Id=&quot;HelloSessionBeanPortBinding_sayHello_WSAT_Policy&quot;&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;wsp:ExactlyOne&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;wsp:All&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;ns1:ATAlwaysCapability 
xmlns:ns1=&quot;http://schemas.xmlsoap.org/ws/2004/10/wsat&quot; wsp:Optional=&quot;false&quot;&gt;&lt;/ns1:ATAlwaysCapability&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;ns2:ATAssertion xmlns:ns3=&quot;http://schemas.xmlsoap.org/ws/2002/12/policy&quot;
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; xmlns:ns2=&quot;http://schemas.xmlsoap.org/ws/2004/10/wsat&quot; ns3:Optional=&quot;true&quot; 
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; wsp:Optional=&quot;true&quot;&gt;&lt;/ns2:ATAssertion&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/wsp:All&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;/wsp:ExactlyOne&gt;<br>
&nbsp; &lt;/wsp:Policy&gt;<br>
&nbsp; &lt;types&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;xsd:schema&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;xsd:import namespace=&quot;http://server/&quot; 
schemaLocation=&quot;http://localhost:8080/HelloSessionBeanService/HelloSessionBean?xsd=1&quot;&gt;&lt;/xsd:import&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;/xsd:schema&gt;<br>
&nbsp; &lt;/types&gt;<br>
&nbsp; &lt;message name=&quot;sayHello&quot;&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;part name=&quot;parameters&quot; element=&quot;tns:sayHello&quot;&gt;&lt;/part&gt;<br>
&nbsp; &lt;/message&gt;<br>
&nbsp; &lt;message name=&quot;sayHelloResponse&quot;&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;part name=&quot;parameters&quot; element=&quot;tns:sayHelloResponse&quot;&gt;&lt;/part&gt;<br>
&nbsp; &lt;/message&gt;<br>
&nbsp; &lt;portType name=&quot;HelloSessionBean&quot;&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;operation name=&quot;sayHello&quot;&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;input message=&quot;tns:sayHello&quot;&gt;&lt;/input&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;output message=&quot;tns:sayHelloResponse&quot;&gt;&lt;/output&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;/operation&gt;<br>
&nbsp; &lt;/portType&gt;<br>
&nbsp; &lt;binding name=&quot;HelloSessionBeanPortBinding&quot; type=&quot;tns:HelloSessionBean&quot;&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;soap:binding transport=&quot;http://schemas.xmlsoap.org/soap/http&quot; 
style=&quot;document&quot;&gt;&lt;/soap:binding&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;operation name=&quot;sayHello&quot;&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;wsp:PolicyReference URI=&quot;#HelloSessionBeanPortBinding_sayHello_WSAT_Policy&quot;&gt;&lt;/wsp:PolicyReference&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;soap:operation soapAction=&quot;&quot;&gt;&lt;/soap:operation&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;input&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;soap:body use=&quot;literal&quot;&gt;&lt;/soap:body&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/input&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;output&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;soap:body use=&quot;literal&quot;&gt;&lt;/soap:body&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/output&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;/operation&gt;<br>
&nbsp; &lt;/binding&gt;<br>
&nbsp; &lt;service name=&quot;HelloSessionBeanService&quot;&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;port name=&quot;HelloSessionBeanPort&quot; binding=&quot;tns:HelloSessionBeanPortBinding&quot;&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;soap:address location=&quot;http://localhost:8080/HelloSessionBeanService/HelloSessionBean&quot;&gt;&lt;/soap:address&gt;<br>
&nbsp;&nbsp;&nbsp; &lt;/port&gt;<br>
&nbsp; &lt;/service&gt;<br>
&lt;/definitions&gt;

Few points to notice:

  1. A reasonable set of defaults are chosen for portType/@name,
    binding/@name, service/@name and even the soap:address/@location. Most of these values can be changed by specifying
    a different value in the @WebService annotation.

  2. Accordingly to EJB 3.0 specification, if @TransactionAttribute
    is not specified on the method then a default value of REQUIRED
    is applied. This default value is automatically converted to 

    	ATAlwaysCapability
    and ATAssertion policy assertions.

  3. Accordingly to

    Web Services for Java EE, Version 1.2    , webservices.xml is
    optional so there is no need to write any other deployment descriptor.

  4. Be careful not to deploy a WAR file with the context root
    generated (HelloSessionBeanService) for the Web service
    endpoint. The EJB Web service endpoint will be inaccessible after that.

Please leave suggestions on other TOTD that you'd like to see. A
complete archive is available
here.

Technorati:
totd
webservices
ejb
glassfish

Related Topics >>
Blog Links >>