Before I get into this post, I’m well aware that SOAP hasn’t been the cool kid on the block in terms of web service messaging for a while, but I’m looking at updating an old application’s webservice from a framework which is no longer supported on an older version of Java to a supported framework. So we need to keep everything working using SOAP.<\/p>\n
Following these steps, we can get a service up and running in next to no time (ofcourse it took me far longer than “no time” to find out how to do this :)).<\/p>\n
\r\n<project xmlns="http:\/\/maven.apache.org\/POM\/4.0.0" xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance"\r\n xsi:schemaLocation="http:\/\/maven.apache.org\/POM\/4.0.0 http:\/\/maven.apache.org\/maven-v4_0_0.xsd">\r\n <modelVersion>4.0.0<\/modelVersion>\r\n <groupId>com.putridparrot.core<\/groupId>\r\n <artifactId>cxftest<\/artifactId>\r\n <packaging>jar<\/packaging>\r\n <version>1.0-SNAPSHOT<\/version>\r\n <name>cxftest<\/name>\r\n <url>http:\/\/maven.apache.org<\/url>\r\n\r\n <properties>\r\n <cxf.version>2.2.3<\/cxf.version>\r\n <\/properties>\r\n\r\n <dependencies>\r\n\r\n <dependency>\r\n <groupId>org.apache.cxf<\/groupId>\r\n <artifactId>cxf-rt-frontend-jaxws<\/artifactId>\r\n <version>${cxf.version}<\/version>\r\n <\/dependency>\r\n\r\n <dependency>\r\n <groupId>org.apache.cxf<\/groupId>\r\n <artifactId>cxf-rt-transports-http<\/artifactId>\r\n <version>${cxf.version}<\/version>\r\n <\/dependency>\r\n\r\n <dependency>\r\n <groupId>junit<\/groupId>\r\n <artifactId>junit<\/artifactId>\r\n <version>3.8.1<\/version>\r\n <scope>test<\/scope>\r\n <\/dependency>\r\n <\/dependencies>\r\n<\/project>\r\n<\/pre>\n<\/li>\n\r\npackage com.putridparrot.core;\r\n\r\nimport javax.jws.WebParam;\r\nimport javax.jws.WebService;\r\n\r\n@WebService\r\npublic interface HelloWorld {\r\n String reply(@WebParam(name="text") String text);\r\n}\r\n<\/pre>\n<\/li>\n\r\npackage com.putridparrot.core;\r\n\r\nimport javax.jws.WebParam;\r\nimport javax.jws.WebService;\r\n\r\n@WebService(endpointInterface = "com.putridparrot.core.HelloWorld", serviceName="HelloWorld")\r\npublic class HelloWorldImpl implements HelloWorld {\r\n public String reply(@WebParam(name = "text") String text) {\r\n return "Hello " + text;\r\n }\r\n}\r\n<\/pre>\n<\/li>\n\r\npackage com.putridparrot.core;\r\n\r\nimport javax.xml.ws.Endpoint;\r\nimport java.io.IOException;\r\n\r\npublic class App {\r\n public static void main( String[] args ) \r\n throws IOException, InterruptedException {\r\n\r\n HelloWorldImpl impl = new HelloWorldImpl();\r\n String address = "http:\/\/localhost:9000\/HelloWorld";\r\n Endpoint.publish(address, impl);\r\n\r\n \/\/ hold the service open\r\n System.in.read();\r\n\r\n System.exit(0);\r\n}\r\n<\/pre>\n<\/li>\n<\/ul>\nAs you’ve probably noticed, we’re not using Spring to create our webservice (the HelloWorldImpl) and thus there’s no spring configuration or the likes. This really is a bare bones implementation to get us started.<\/p>\n
Now if you run this you should be able to use the URL http:\/\/localhost:9000\/HelloWorld?wsdl to grab the definition meta data. Hence from a C# client you can use wsdl.exe or using Visual Studio’s Add Service reference to generate C# classes to use this service.<\/p>\n
Alternate code to start the server<\/strong><\/p>\nIn the above we used Endpoint to create the server, the alternative is to use the JaxWsServerFactoryBean, here’s the code<\/p>\n
\r\nJaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();\r\nfactory.setServiceClass(HelloWorld.class);\r\nfactory.setAddress("http:\/\/localhost:9000\/HelloWorld");\r\nfactory.create();\r\n<\/pre>\nBeanify it<\/strong><\/p>\nOkay, so we’ve proved the service works at this point, but we really don’t want to hardcode the service like this, so it’s type to turn it into a Spring bean.<\/p>\n
First off let’s add to our pom.xml file, you’ll need the following added to the properties element<\/p>\n
\r\n<spring.version>3.0.5.RELEASE<\/spring.version>\r\n<\/pre>\nand then the following dependencies need to be added<\/p>\n
\r\n <dependency>\r\n <groupId>org.springframework.boot<\/groupId>\r\n <artifactId>spring-boot<\/artifactId>\r\n <version>1.5.2.RELEASE<\/version>\r\n <\/dependency>\r\n\r\n <dependency>\r\n <groupId>org.springframework.boot<\/groupId>\r\n <artifactId>spring-boot-autoconfigure<\/artifactId>\r\n <version>1.5.2.RELEASE<\/version>\r\n <\/dependency>\r\n\r\n <dependency>\r\n <groupId>org.springframework<\/groupId>\r\n <artifactId>spring-core<\/artifactId>\r\n <version>${spring.version}<\/version>\r\n <\/dependency>\r\n\r\n <dependency>\r\n <groupId>org.springframework<\/groupId>\r\n <artifactId>spring-context<\/artifactId>\r\n <version>${spring.version}<\/version>\r\n <\/dependency>\r\n\r\n <dependency>\r\n <groupId>cglib<\/groupId>\r\n <artifactId>cglib<\/artifactId>\r\n <version>2.2.2<\/version>\r\n <\/dependency>\r\n<\/pre>\nand we’re going to use Jetty as the HTTP server, so also add the following dependency<\/p>\n
\r\n<dependency>\r\n <groupId>org.apache.cxf<\/groupId>\r\n <artifactId>cxf-rt-transports-http-jetty<\/artifactId>\r\n <version>${cxf.version}<\/version>\r\n<\/dependency>\r\n<\/pre>\nObviously you’ll need to run mvn install<\/em> to get the dependencies updated.<\/p>\nNext we need to create our beans file, within this we’ll actually create a server\/endpoint which will be executed. So create a resources folder off of src\/main in your project’s folder and add an XML file, mine’s named cxf.xml – within this file we can use one of either of these configurations<\/p>\n
\r\n<beans xmlns="http:\/\/www.springframework.org\/schema\/beans"\r\n xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance"\r\n xmlns:jaxws="http:\/\/cxf.apache.org\/jaxws"\r\n xsi:schemaLocation=" http:\/\/www.springframework.org\/schema\/beans http:\/\/www.springframework.org\/schema\/beans\/spring-beans.xsd http:\/\/cxf.apache.org\/jaxws http:\/\/cxf.apache.org\/schemas\/jaxws.xsd">\r\n <import resource="classpath:META-INF\/cxf\/cxf.xml"\/>\r\n <import resource="classpath:META-INF\/cxf\/cxf-extension-http.xml" \/>\r\n <import resource="classpath:META-INF\/cxf\/cxf-extension-soap.xml" \/>\r\n <import resource="classpath:META-INF\/cxf\/cxf-extension-http-jetty.xml" \/>\r\n\r\n <jaxws:server id="helloWorld" serviceClass="com.putridparrot.core.HelloWorld" address="http:\/\/localhost:9000\/HelloWorld">\r\n <jaxws:serviceBean>\r\n <bean class="com.putridparrot.core.HelloWorldImpl"\/>\r\n <\/jaxws:serviceBean>\r\n <\/jaxws:server>\r\n<\/beans>\r\n<\/pre>\nor using an Endpoint we can use the following<\/p>\n
\r\n<beans xmlns="http:\/\/www.springframework.org\/schema\/beans"\r\n xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance"\r\n xmlns:jaxws="http:\/\/cxf.apache.org\/jaxws"\r\n xsi:schemaLocation=" http:\/\/www.springframework.org\/schema\/beans http:\/\/www.springframework.org\/schema\/beans\/spring-beans.xsd http:\/\/cxf.apache.org\/jaxws http:\/\/cxf.apache.org\/schemas\/jaxws.xsd">\r\n <import resource="classpath:META-INF\/cxf\/cxf.xml"\/>\r\n <import resource="classpath:META-INF\/cxf\/cxf-extension-http.xml" \/>\r\n <import resource="classpath:META-INF\/cxf\/cxf-extension-soap.xml" \/>\r\n <import resource="classpath:META-INF\/cxf\/cxf-extension-http-jetty.xml" \/>\r\n\r\n <jaxws:endpoint id="helloWorld" implementor="com.putridparrot.core.HelloWorldImpl"\r\n address="http:\/\/localhost:9000\/HelloWorld">\r\n <jaxws:features>\r\n <bean class="org.apache.cxf.feature.LoggingFeature"\/>\r\n <\/jaxws:features>\r\n <\/jaxws:endpoint>\r\n<\/beans>\r\n<\/pre>\nYou can change the address to address=”\/HelloWorld”<\/em> if you are using the default port etc. Otherwise to remove this will require looking into overriding Jetty’s port etc. (which is outside the scope of this post).<\/p>\nFinally we need to have the main<\/em> method wire everything up, so within main we should have the following<\/p>\n\r\nnew ClassPathXmlApplicationContext("cxf.xml");\r\n\r\n\/\/ stop the server shutting down\r\nSystem.in.read();\r\nSystem.exit(0);\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"Before I get into this post, I’m well aware that SOAP hasn’t been the cool kid on the block in terms of web service messaging for a while, but I’m looking at updating an old application’s webservice from a framework which is no longer supported on an older version of Java to a supported framework. […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[163,161,77],"tags":[],"class_list":["post-4707","post","type-post","status-publish","format-standard","hentry","category-cxf","category-java","category-soap"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/4707","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=4707"}],"version-history":[{"count":9,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/4707\/revisions"}],"predecessor-version":[{"id":4724,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/4707\/revisions\/4724"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=4707"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=4707"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=4707"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}