{"id":54738,"date":"2018-01-29T15:00:30","date_gmt":"2018-01-29T13:00:30","guid":{"rendered":"http:\/\/examples.javacodegeeks.com\/?p=54738"},"modified":"2018-01-26T17:47:32","modified_gmt":"2018-01-26T15:47:32","slug":"jax-ws-jaxb-example","status":"publish","type":"post","link":"https:\/\/examples.javacodegeeks.com\/java-development\/enterprise-java\/jws\/jax-ws-jaxb-example\/","title":{"rendered":"JAX-WS JAXB Example"},"content":{"rendered":"

1. Introduction<\/h2>\n

Java Architecture for XML Web Services<\/a> (JAX-WS) is a Java programming language for creating web services, particularly SOAP services.<\/p>\n

Java Architecture for XML Binding<\/a> (JAXB) is a Java-XML binding technology that simplifies the development of web services by enabling transformations between a schema and Java objects, and also between XML instance documents and Java object instances.<\/p>\n

Both JAX-WS and JAXB have been a part of JDK since version 6. JAX-WS uses JAXB internally\u00a0as the binding layer to convert Java objects to and from XML.<\/p>\n

In this example, I will build a JAX-WS service with three steps:<\/p>\n

    \n
  1. Generate Java stubs from the WSDL file<\/li>\n
  2. Create an implementation class for the generated interface and annotate it with @WebService(endpointInterface=\"\")<\/code><\/li>\n
  3. Create an Endpoint<\/code> to publish the service<\/li>\n<\/ol>\n

    2. Business Use Case<\/h2>\n

    BestPay<\/code> is a fictional company which provides employee paycheck services. BestPay<\/code>\u00a0defines\u00a0WSDL.\u00a0BestPay<\/code>‘s customer implements the service.\u00a0BestPay<\/code>\u00a0reads the client’s employee records via the service.<\/p>\n

    BestPay<\/code>\u00a0WSDL which defines the employeeLookupService<\/code> and employee detail from employee.xsd<\/code>.<\/p>\n

    employeeService.wsdl<\/em><\/span><\/p>\n

    <?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<wsdl:definitions name=\"Employee\"\r\n\ttargetNamespace=\"http:\/\/bestpay.payroll\/employee\" xmlns:soap=\"http:\/\/schemas.xmlsoap.org\/wsdl\/soap\/\"\r\n\txmlns:tns=\"http:\/\/bestpay.payroll\/employee\" xmlns:wsdl=\"http:\/\/schemas.xmlsoap.org\/wsdl\/\"\r\n\txmlns:xsd=\"http:\/\/www.w3.org\/2001\/XMLSchema\">\r\n\r\n\t<wsdl:types>\r\n\t\t<xsd:schema>\r\n\t\t\t<xsd:import namespace=\"http:\/\/bestpay.payroll\/employee\"\r\n\t\t\t\tschemaLocation=\"..\/xsd\/employee.xsd\" \/>\r\n\t\t<\/xsd:schema>\r\n\t<\/wsdl:types>\r\n\r\n\t<wsdl:message name=\"employeeLookupRequest\">\r\n\t\t<wsdl:part element=\"tns:EmployeeIdList\" name=\"employeeIdList\" \/>\r\n\t<\/wsdl:message>\r\n\r\n\t<wsdl:message name=\"employeeLookupResponse\">\r\n\t\t<wsdl:part element=\"tns:EmployeeInfoList\" name=\"employeeInfoList\" \/>\r\n\t<\/wsdl:message>\r\n\r\n\t<wsdl:portType name=\"employeeLookupService\">\r\n\t\t<wsdl:operation name=\"employeeLookup\">\r\n\t\t\t<wsdl:input message=\"tns:employeeLookupRequest\" \/>\r\n\t\t\t<wsdl:output message=\"tns:employeeLookupResponse\" \/>\r\n\t\t<\/wsdl:operation>\r\n\t<\/wsdl:portType>\r\n\r\n\t<wsdl:binding name=\"employeeLookupBinding\" type=\"tns:employeeLookupService\">\r\n\t\t<soap:binding style=\"document\"\r\n\t\t\ttransport=\"http:\/\/schemas.xmlsoap.org\/soap\/http\" \/>\r\n\t\t<wsdl:operation name=\"employeeLookup\">\r\n\t\t\t<soap:operation soapAction=\"http:\/\/bestpay.payroll\/employee\/employeeLookup\" \/>\r\n\t\t\t<wsdl:input>\r\n\t\t\t\t<soap:body use=\"literal\" \/>\r\n\t\t\t<\/wsdl:input>\r\n\t\t\t<wsdl:output>\r\n\t\t\t\t<soap:body use=\"literal\" \/>\r\n\t\t\t<\/wsdl:output>\r\n\t\t<\/wsdl:operation>\r\n\t<\/wsdl:binding>\r\n\r\n\t<wsdl:service name=\"employeeLookupService\">\r\n\t\t<wsdl:port binding=\"tns:employeeLookupBinding\" name=\"employeeLookupPort\">\r\n\t\t\t<soap:address location=\"http:\/\/localhost\" \/>\r\n\t\t<\/wsdl:port>\r\n\t<\/wsdl:service>\r\n\r\n<\/wsdl:definitions><\/pre>\n
    Employee schema file which defines\u00a0EmployeeInfo<\/code> data structure.<\/p>\n
    employee.xsd<\/em><\/span><\/p>\n
    <?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<xs:schema xmlns:xs=\"http:\/\/www.w3.org\/2001\/XMLSchema\"\r\n\ttargetNamespace=\"http:\/\/bestpay.payroll\/employee\" xmlns:tns=\"http:\/\/bestpay.payroll\/employee\"\r\n\telementFormDefault=\"qualified\">\r\n\r\n\t<xs:simpleType name=\"EmployeeId\">\r\n\t\t<xs:restriction base=\"xs:string\">\r\n\t\t\t<xs:length value=\"7\" \/>\r\n\t\t\t<xs:pattern value=\"E[0-9]{7}\" \/>\r\n\t\t<\/xs:restriction>\r\n\t<\/xs:simpleType>\r\n\r\n\t<xs:simpleType name=\"EmployeeType\">\r\n\t\t<xs:restriction base=\"xs:string\">\r\n\t\t\t<xs:enumeration value=\"Hourly\" \/>\r\n\t\t\t<xs:enumeration value=\"Salary\" \/>\r\n\t\t<\/xs:restriction>\r\n\t<\/xs:simpleType>\r\n\r\n\t<xs:complexType name=\"EmployeeInfo\">\r\n\t\t<xs:sequence>\r\n\t\t\t<xs:element name=\"eid\" type=\"tns:EmployeeId\" minOccurs=\"0\"\r\n\t\t\t\tnillable=\"false\" \/>\r\n\t\t\t<xs:element name=\"firstName\" type=\"xs:string\" minOccurs=\"0\"\r\n\t\t\t\tnillable=\"false\" \/>\r\n\t\t\t<xs:element name=\"lastName\" type=\"xs:string\" minOccurs=\"0\"\r\n\t\t\t\tnillable=\"false\" \/>\r\n\t\t\t<xs:element name=\"hourlyRate\" type=\"xs:decimal\" minOccurs=\"0\"\r\n\t\t\t\tnillable=\"false\" \/>\r\n\t\t\t<xs:element name=\"type\" type=\"tns:EmployeeType\"\r\n\t\t\t\tminOccurs=\"0\" nillable=\"false\" \/>\r\n\t\t<\/xs:sequence>\r\n\t<\/xs:complexType>\r\n\r\n\t<xs:complexType name=\"EmployeeInfoWrapper\">\r\n\t\t<xs:sequence>\r\n\t\t\t<xs:element name=\"employeeInfo\" type=\"tns:EmployeeInfo\"\r\n\t\t\t\tminOccurs=\"0\" maxOccurs=\"unbounded\" nillable=\"false\" \/>\r\n\t\t<\/xs:sequence>\r\n\t<\/xs:complexType>\r\n\r\n\t<xs:complexType name=\"EmployeeIdWrapper\">\r\n\t\t<xs:sequence>\r\n\t\t\t<xs:element name=\"eid\" type=\"tns:EmployeeId\" minOccurs=\"0\"\r\n\t\t\t\tmaxOccurs=\"unbounded\" nillable=\"false\" \/>\r\n\t\t<\/xs:sequence>\r\n\t<\/xs:complexType>\r\n\r\n\t<xs:element name=\"EmployeeIdList\" type=\"tns:EmployeeIdWrapper\" \/>\r\n\t<xs:element name=\"EmployeeInfoList\" type=\"tns:EmployeeInfoWrapper\" \/>\r\n\r\n<\/xs:schema><\/pre>\n
    Each customer of BestPay<\/code>\u00a0implements the employeeLookupService<\/code>\u00a0as defined in the WSDL. There is no additional development work at BestPay<\/code> except configuring the customer’s service endpoint.<\/p>\n
    3. Technologies used<\/h2>\n
    The example code in this article was built and run using:
     
    <\/div> <\/div><\/p>\n