{"id":13000,"date":"2016-08-16T18:44:00","date_gmt":"2016-08-16T16:44:00","guid":{"rendered":"https:\/\/touk.pl\/blog\/?guid=839edd0238f706b0dfc0e7e6e8f505ae"},"modified":"2023-04-27T11:30:18","modified_gmt":"2023-04-27T09:30:18","slug":"deploy-wsdl-file-as-osgi-bundle-in-apache-karaf","status":"publish","type":"post","link":"https:\/\/touk.pl\/blog\/2016\/08\/16\/deploy-wsdl-file-as-osgi-bundle-in-apache-karaf\/","title":{"rendered":"Deploy WSDL file as OSGI Bundle in Apache Karaf"},"content":{"rendered":"

Introduction<\/h2>\n

WSDL file describes webservices. Java classes are often generated from WSDL. For this purpose, we could use command line tools (e. g. wsdl2Java<\/a> or wsimport<\/a>) or using maven plugin<\/a>.<\/p>\n

From the other side, we have Apache Karaf<\/a> which is OSGI container. Karaf has installed by default many deployers for creating OSGi bundles from files, e. g. Blueprint deployer<\/a>, Spring deployer<\/a> or War deployer<\/a>.<\/p>\n

It is easy to generate java classes from WSDL file and also to create custom deployer for Karaf, so why do not join these two features?<\/p>\n

Installation of WSDL deployer<\/h2>\n

Source code of my WSDL deployer is provided here<\/a>. You can download and build it:<\/p>\n

mvn clean install\r\n<\/pre>\n
We also need Karaf. I will use the newest version 4.0.5. It could be download from Karaf website<\/a>. When you download and unpack it, you can run it:<\/p>\n
$ cd PUT_PATH_TO_KARAF_DIR_HERE\r\n$ .\/bin\/karaf\r\n    __ __                  ____      \r\n   \/ \/\/_\/____ __________ _\/ __\/      \r\n  \/ ,<  \/ __ \/ ___\/ __ <\/code>\/ \/_        \r\n \/ \/| |\/ \/_\/ \/ \/  \/ \/_\/ \/ __\/        \r\n\/_\/ |_|\\__,_\/_\/   \\__,_\/_\/         \r\n\r\nApache Karaf (4.0.5)\r\n\r\nHit '<tab>' for a list of available commands\r\nand '[cmd] --help' for help on a specific command.\r\nHit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown Karaf.\r\n\r\nkaraf@root()>\r\n<\/pre>\n
and install commons-io and wsdl-delpoyer bundles:<\/p>\n
karaf@root()> install -s mvn:org.apache.servicemix.bundles\/org.apache.servicemix.bundles.commons-io\/1.4_3\r\nBundle ID: 52\r\nkaraf@root()> install -s mvn:com.github.alien11689.karaf\/wsdl-deployer\/1.0.0-SNAPSHOT\r\nBundle ID: 53\r\n<\/pre>\n
Install WSDL from Karaf shell<\/h2>\n
I will test deployer using WSDL file named exampleService-2.0.0.wsdl<\/code> (provided WSDL is similar to this<\/a>, but has another namespace in types schama for testing purpose):<\/p>\n
<?xml version=\"1.0\"?>\r\n<wsdl:definitions\r\n    xmlns:soap=\"http:\/\/schemas.xmlsoap.org\/wsdl\/soap\/\"\r\n    xmlns:wsu=\"http:\/\/docs.oasis-open.org\/wss\/2004\/01\/oasis-200401-wss-wssecurity-utility-1.0.xsd\"\r\n    xmlns:soapenc=\"http:\/\/schemas.xmlsoap.org\/soap\/encoding\/\"\r\n    xmlns:tns=\"http:\/\/Example.org\"\r\n    xmlns:sns=\"http:\/\/Example.org\/schema\"\r\n    xmlns:wsa=\"http:\/\/schemas.xmlsoap.org\/ws\/2004\/08\/addressing\"\r\n    xmlns:wsp=\"http:\/\/schemas.xmlsoap.org\/ws\/2004\/09\/policy\"\r\n    xmlns:wsap=\"http:\/\/schemas.xmlsoap.org\/ws\/2004\/08\/addressing\/policy\"\r\n    xmlns:xsd=\"http:\/\/www.w3.org\/2001\/XMLSchema\"\r\n    xmlns:msc=\"http:\/\/schemas.microsoft.com\/ws\/2005\/12\/wsdl\/contract\"\r\n    xmlns:wsaw=\"http:\/\/www.w3.org\/2006\/05\/addressing\/wsdl\"\r\n    xmlns:soap12=\"http:\/\/schemas.xmlsoap.org\/wsdl\/soap12\/\"\r\n    xmlns:wsa10=\"http:\/\/www.w3.org\/2005\/08\/addressing\"\r\n    xmlns:wsx=\"http:\/\/schemas.xmlsoap.org\/ws\/2004\/09\/mex\"\r\n  targetNamespace=\"http:\/\/Example.org\"\r\n    xmlns:wsdl=\"http:\/\/schemas.xmlsoap.org\/wsdl\/\">\r\n    <wsdl:types>\r\n        <xsd:schema targetNamespace=\"http:\/\/Example.org\/schema\" elementFormDefault=\"qualified\" >\r\n            <xsd:element name=\"Add\">\r\n                <xsd:complexType>\r\n                    <xsd:sequence>\r\n                        <xsd:element minOccurs=\"0\" name=\"a\" type=\"xsd:int\" \/>\r\n                        <xsd:element minOccurs=\"0\" name=\"b\" type=\"xsd:int\" \/>\r\n                    <\/xsd:sequence>\r\n                <\/xsd:complexType>\r\n            <\/xsd:element>\r\n            <xsd:element name=\"AddResponse\">\r\n                <xsd:complexType>\r\n                    <xsd:sequence>\r\n                        <xsd:element minOccurs=\"0\" name=\"result\" type=\"xsd:int\" \/>\r\n                    <\/xsd:sequence>\r\n                <\/xsd:complexType>\r\n            <\/xsd:element>\r\n            <xsd:element name=\"Subtract\">\r\n                <xsd:complexType>\r\n                    <xsd:sequence>\r\n                        <xsd:element minOccurs=\"0\" name=\"a\" type=\"xsd:int\" \/>\r\n                        <xsd:element minOccurs=\"0\" name=\"b\" type=\"xsd:int\" \/>\r\n                    <\/xsd:sequence>\r\n                <\/xsd:complexType>\r\n            <\/xsd:element>\r\n            <xsd:element name=\"SubtractResponse\">\r\n                <xsd:complexType>\r\n                    <xsd:sequence>\r\n                        <xsd:element minOccurs=\"0\" name=\"result\" type=\"xsd:int\" \/>\r\n                    <\/xsd:sequence>\r\n                <\/xsd:complexType>\r\n            <\/xsd:element>\r\n        <\/xsd:schema>\r\n    <\/wsdl:types>\r\n    <wsdl:message name=\"ICalculator_Add_InputMessage\">\r\n        <wsdl:part name=\"parameters\" element=\"sns:Add\" \/>\r\n    <\/wsdl:message>\r\n    <wsdl:message name=\"ICalculator_Add_OutputMessage\">\r\n        <wsdl:part name=\"parameters\" element=\"sns:AddResponse\" \/>\r\n    <\/wsdl:message>\r\n    <wsdl:message name=\"ICalculator_Subtract_InputMessage\">\r\n        <wsdl:part name=\"parameters\" element=\"sns:Subtract\" \/>\r\n    <\/wsdl:message>\r\n    <wsdl:message name=\"ICalculator_Subtract_OutputMessage\">\r\n        <wsdl:part name=\"parameters\" element=\"sns:SubtractResponse\" \/>\r\n    <\/wsdl:message>\r\n    <wsdl:portType name=\"ICalculator\">\r\n        <wsdl:operation name=\"Add\">\r\n            <wsdl:input wsaw:Action=\"http:\/\/Example.org\/ICalculator\/Add\" message=\"tns:ICalculator_Add_InputMessage\" \/>\r\n            <wsdl:output wsaw:Action=\"http:\/\/Example.org\/ICalculator\/AddResponse\" message=\"tns:ICalculator_Add_OutputMessage\" \/>\r\n        <\/wsdl:operation>\r\n        <wsdl:operation name=\"Subtract\">\r\n            <wsdl:input wsaw:Action=\"http:\/\/Example.org\/ICalculator\/Subtract\" message=\"tns:ICalculator_Subtract_InputMessage\" \/>\r\n            <wsdl:output wsaw:Action=\"http:\/\/Example.org\/ICalculator\/SubtractResponse\" message=\"tns:ICalculator_Subtract_OutputMessage\" \/>\r\n        <\/wsdl:operation>\r\n    <\/wsdl:portType>\r\n    <wsdl:binding name=\"DefaultBinding_ICalculator\" type=\"tns:ICalculator\">\r\n        <soap:binding transport=\"http:\/\/schemas.xmlsoap.org\/soap\/http\" \/>\r\n        <wsdl:operation name=\"Add\">\r\n            <soap:operation soapAction=\"http:\/\/Example.org\/ICalculator\/Add\" style=\"document\" \/>\r\n            <wsdl:input>\r\n                <soap:body use=\"literal\" \/>\r\n            <\/wsdl:input>\r\n            <wsdl:output>\r\n                <soap:body use=\"literal\" \/>\r\n            <\/wsdl:output>\r\n        <\/wsdl:operation>\r\n        <wsdl:operation name=\"Subtract\">\r\n            <soap:operation soapAction=\"http:\/\/Example.org\/ICalculator\/Subtract\" style=\"document\" \/>\r\n            <wsdl:input>\r\n                <soap:body use=\"literal\" \/>\r\n            <\/wsdl:input>\r\n            <wsdl:output>\r\n                <soap:body use=\"literal\" \/>\r\n            <\/wsdl:output>\r\n        <\/wsdl:operation>\r\n    <\/wsdl:binding>\r\n    <wsdl:service name=\"CalculatorService\">\r\n        <wsdl:port name=\"ICalculator\" binding=\"tns:DefaultBinding_ICalculator\">\r\n            <soap:address location=\"http:\/\/localhost\/ICalculator\" \/>\r\n        <\/wsdl:port>\r\n    <\/wsdl:service>\r\n<\/wsdl:definitions>\r\n<\/pre>\n
We could install it via command:<\/p>\n
karaf@root()> install -s wsdl:file:PUT_PATH_TO_WSDL_HERE\/exampleService-2.0.0.wsdl\\$package=org.github.alien11689.example&s1=http:\/\/Example.org\/schema&t1=org.github.alien11689.example.schema\r\nBundle ID: 54\r\n<\/pre>\n
File must have format ${bundleSymbolicName}-${version}.wsdl<\/code>.<\/p>\n
Provided options are:<\/p>\n