{"id":4507,"date":"2020-08-21T15:07:04","date_gmt":"2020-08-21T09:37:04","guid":{"rendered":"https:\/\/www.h2kinfosys.com\/blog\/?p=4507"},"modified":"2020-08-22T18:02:16","modified_gmt":"2020-08-22T12:32:16","slug":"web-service-example","status":"publish","type":"post","link":"https:\/\/www.h2kinfosys.com\/blog\/web-service-example\/","title":{"rendered":"Web Service Example"},"content":{"rendered":"\n

In this article, we will see the configuration of a simple web service Example.<\/p>\n\n\n\n

For this, we annotate a class with @WebService <\/a>and @Stateless.<\/p>\n\n\n\n

Step 1: <\/strong>No external xml files are needed. The below class will be placed in a jar or war and deployed into a compliant Java EE<\/a> server like TomEE.<\/p>\n\n\n\n

import javax.ejb.Stateless;\nimport javax.jws.WebService;\n@Stateless\n@WebService(\n        portName = \"CalculatorPort\",\n        serviceName = \"CalculatorService\",\n        targetNamespace = \"https:\/\/superbiz.org\/wsdl\",\n        endpointInterface = \"org.superbiz.calculator.ws.CalculatorWs\")\npublic class Calculator implements CalculatorWs {\n    public int sum(int add1, int add2) {\n        return add1 + add2;\n    }\n    public int multiply(int mul1, int mul2) {\n        return mul1 * mul2;\n    }\n}<\/pre>\n\n\n\n
Step 2: @WebService Endpoint Interface<\/strong><\/p>\n\n\n\n
import javax.jws.WebService;\n@WebService(targetNamespace = \"https:\/\/superbiz.org\/wsdl\")\npublic interface CalculatorWs {\n    public int sum(int add1, int add2);\n    public int multiply(int mul1, int mul2);\n}<\/pre>\n\n\n\n
Step 3: <\/strong>Calculator WSDL<\/p>\n\n\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<wsdl:definitions xmlns:wsdl=\"https:\/\/schemas.xmlsoap.org\/wsdl\/\" name=\"CalculatorService\"\n                  targetNamespace=\"https:\/\/superbiz.org\/wsdl\"\n                  xmlns:soap=\"https:\/\/schemas.xmlsoap.org\/wsdl\/soap\/\"\n                  xmlns:tns=\"https:\/\/superbiz.org\/wsdl\" xmlns:xsd=\"https:\/\/www.w3.org\/2001\/XMLSchema\">\n  <wsdl:types>\n    <xsd:schema attributeFormDefault=\"unqualified\" elementFormDefault=\"unqualified\"\n                targetNamespace=\"https:\/\/superbiz.org\/wsdl\" xmlns:tns=\"https:\/\/superbiz.org\/wsdl\"\n                xmlns:xsd=\"https:\/\/www.w3.org\/2001\/XMLSchema\">\n      <xsd:element name=\"multiply\" type=\"tns:multiply\"\/>\n      <xsd:complexType name=\"multiply\">\n        <xsd:sequence>\n          <xsd:element name=\"arg0\" type=\"xsd:int\"\/>\n          <xsd:element name=\"arg1\" type=\"xsd:int\"\/>\n        <\/xsd:sequence>\n      <\/xsd:complexType>\n      <xsd:element name=\"multiplyResponse\" type=\"tns:multiplyResponse\"\/>\n      <xsd:complexType name=\"multiplyResponse\">\n        <xsd:sequence>\n          <xsd:element name=\"return\" type=\"xsd:int\"\/>\n        <\/xsd:sequence>\n      <\/xsd:complexType>\n      <xsd:element name=\"sum\" type=\"tns:sum\"\/>\n      <xsd:complexType name=\"sum\">\n        <xsd:sequence>\n          <xsd:element name=\"arg0\" type=\"xsd:int\"\/>\n          <xsd:element name=\"arg1\" type=\"xsd:int\"\/>\n        <\/xsd:sequence>\n      <\/xsd:complexType>\n      <xsd:element name=\"sumResponse\" type=\"tns:sumResponse\"\/>\n      <xsd:complexType name=\"sumResponse\">\n        <xsd:sequence>\n          <xsd:element name=\"return\" type=\"xsd:int\"\/>\n        <\/xsd:sequence>\n      <\/xsd:complexType>\n    <\/xsd:schema>\n  <\/wsdl:types>\n  <wsdl:message name=\"multiplyResponse\">\n    <wsdl:part element=\"tns:multiplyResponse\" name=\"parameters\"\/>\n  <\/wsdl:message>\n  <wsdl:message name=\"sumResponse\">\n    <wsdl:part element=\"tns:sumResponse\" name=\"parameters\"\/>\n  <\/wsdl:message>\n  <wsdl:message name=\"sum\">\n    <wsdl:part element=\"tns:sum\" name=\"parameters\"\/>\n  <\/wsdl:message>\n  <wsdl:message name=\"multiply\">\n    <wsdl:part element=\"tns:multiply\" name=\"parameters\"\/>\n  <\/wsdl:message>\n  <wsdl:portType name=\"CalculatorWs\">\n    <wsdl:operation name=\"multiply\">\n      <wsdl:input message=\"tns:multiply\" name=\"multiply\"\/>\n      <wsdl:output message=\"tns:multiplyResponse\" name=\"multiplyResponse\"\/>\n    <\/wsdl:operation>\n    <wsdl:operation name=\"sum\">\n      <wsdl:input message=\"tns:sum\" name=\"sum\"\/>\n      <wsdl:output message=\"tns:sumResponse\" name=\"sumResponse\"\/>\n    <\/wsdl:operation>\n  <\/wsdl:portType>\n  <wsdl:binding name=\"CalculatorServiceSoapBinding\" type=\"tns:CalculatorWs\">\n    <soap:binding style=\"document\" transport=\"https:\/\/schemas.xmlsoap.org\/soap\/http\"\/>\n    <wsdl:operation name=\"multiply\">\n      <soap:operation soapAction=\"\" style=\"document\"\/>\n      <wsdl:input name=\"multiply\">\n        <soap:body use=\"literal\"\/>\n      <\/wsdl:input>\n      <wsdl:output name=\"multiplyResponse\">\n        <soap:body use=\"literal\"\/>\n      <\/wsdl:output>\n    <\/wsdl:operation>\n    <wsdl:operation name=\"sum\">\n      <soap:operation soapAction=\"\" style=\"document\"\/>\n      <wsdl:input name=\"sum\">\n        <soap:body use=\"literal\"\/>\n      <\/wsdl:input>\n      <wsdl:output name=\"sumResponse\">\n        <soap:body use=\"literal\"\/>\n      <\/wsdl:output>\n    <\/wsdl:operation>\n  <\/wsdl:binding>\n  <wsdl:service name=\"CalculatorService\">\n    <wsdl:port binding=\"tns:CalculatorServiceSoapBinding\" name=\"CalculatorPort\">\n      <soap:address location=\"https:\/\/127.0.0.1:4204\/Calculator?wsdl\"\/>\n    <\/wsdl:port>\n  <\/wsdl:service>\n<\/wsdl:definitions><\/pre>\n\n\n\n
Step 4: <\/strong>Accessing the @WebService with javax.xml.ws.Service<\/p>\n\n\n\n
import org.junit.BeforeClass;\nimport org.junit.Test;\nimport javax.ejb.embeddable.EJBContainer;\nimport javax.xml.namespace.QName;\nimport javax.xml.ws.Service;\nimport java.net.URL;\nimport java.util.Properties;\nimport static org.junit.Assert.assertEquals;\nimport static org.junit.Assert.assertNotNull;\npublic class CalculatorTest {\n    @BeforeClass\n    public static void setUp() throws Exception {\n        Properties properties = new Properties();\n        properties.setProperty(\"openejb.embedded.remotable\", \"true\");\n        \/\/properties.setProperty(\"httpejbd.print\", \"true\");\n        \/\/properties.setProperty(\"httpejbd.indent.xml\", \"true\");\n        EJBContainer.createEJBContainer(properties);\n    }\n    @Test\n    public void test() throws Exception {\n        Service calculatorService = Service.create(\n                new URL(\"https:\/\/127.0.0.1:4204\/Calculator?wsdl\"),\n                new QName(\"https:\/\/superbiz.org\/wsdl\", \"CalculatorService\"));\n        assertNotNull(calculatorService);\n        CalculatorWs calculator = calculatorService.getPort(CalculatorWs.class);\n        assertEquals(10, calculator.sum(4, 6));\n        assertEquals(12, calculator.multiply(3, 4));\n    }\n}<\/pre>\n\n\n\n
Inspecting the messages<\/strong> in Web Service Example<\/h2>\n\n\n\n
sum(int, int)<\/strong><\/p>\n\n\n\n
Request SOAP message:<\/em><\/strong><\/p>\n\n\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soap:Envelope xmlns:soap=\"https:\/\/schemas.xmlsoap.org\/soap\/envelope\/\">\n  <soap:Body>\n    <ns1:sum xmlns:ns1=\"https:\/\/superbiz.org\/wsdl\">\n      <arg0>4<\/arg0>\n      <arg1>6<\/arg1>\n    <\/ns1:sum>\n  <\/soap:Body>\n<\/soap:Envelope><\/pre>\n\n\n\n
Response SOAP message:<\/em><\/strong><\/p>\n\n\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soap:Envelope xmlns:soap=\"https:\/\/schemas.xmlsoap.org\/soap\/envelope\/\">\n  <soap:Body>\n    <ns1:sumResponse xmlns:ns1=\"https:\/\/superbiz.org\/wsdl\">\n      <return>10<\/return>\n    <\/ns1:sumResponse>\n  <\/soap:Body>\n<\/soap:Envelope><\/pre>\n\n\n\n
multiply(int, int)<\/strong><\/p>\n\n\n\n
Request SOAP message:<\/em><\/strong><\/p>\n\n\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soap:Envelope xmlns:soap=\"https:\/\/schemas.xmlsoap.org\/soap\/envelope\/\">\n  <soap:Body>\n    <ns1:multiply xmlns:ns1=\"https:\/\/superbiz.org\/wsdl\">\n      <arg0>3<\/arg0>\n      <arg1>4<\/arg1>\n    <\/ns1:multiply>\n  <\/soap:Body>\n<\/soap:Envelope><\/pre>\n\n\n\n
Response SOAP message:<\/em><\/strong><\/p>\n\n\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soap:Envelope xmlns:soap=\"https:\/\/schemas.xmlsoap.org\/soap\/envelope\/\">\n  <soap:Body>\n    <ns1:multiplyResponse xmlns:ns1=\"https:\/\/superbiz.org\/wsdl\">\n      <return>12<\/return>\n    <\/ns1:multiplyResponse>\n  <\/soap:Body>\n<\/soap:Envelope><\/pre>\n","protected":false},"excerpt":{"rendered":"
In this article, we will see the configuration of a simple web service Example. For this, we annotate a class with @WebService and @Stateless. Step 1: No external xml files are needed. The below class will be placed in a jar or war and deployed into a compliant Java EE server like TomEE. import javax.ejb.Stateless; […]<\/p>\n","protected":false},"author":1,"featured_media":4524,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[42],"tags":[1274,1275,1273],"class_list":["post-4507","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-java-tutorials","tag-endpoint-interface","tag-inspecting-the-messages","tag-web-service-example"],"_links":{"self":[{"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/posts\/4507","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/comments?post=4507"}],"version-history":[{"count":0,"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/posts\/4507\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/media\/4524"}],"wp:attachment":[{"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/media?parent=4507"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/categories?post=4507"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.h2kinfosys.com\/blog\/wp-json\/wp\/v2\/tags?post=4507"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}