{"id":5045,"date":"2017-06-03T20:17:51","date_gmt":"2017-06-03T20:17:51","guid":{"rendered":"http:\/\/putridparrot.com\/blog\/?p=5045"},"modified":"2017-06-03T20:17:51","modified_gmt":"2017-06-03T20:17:51","slug":"spring-configuration-for-a-jsonxml-rest-service-in-java","status":"publish","type":"post","link":"https:\/\/putridparrot.com\/blog\/spring-configuration-for-a-jsonxml-rest-service-in-java\/","title":{"rendered":"Spring configuration for a JSON\/XML REST service in Java"},"content":{"rendered":"

In Creating a CXF service that responds with JSON or XML<\/a> and Creating a CXF client which can get JSON or XML<\/a> we created a service and a client application for interacting with REST requests using XML or JSON as the body for the messages.<\/p>\n

The Java guys love spring and beans, my code was all in Java source. So I’m going to show how to convert both the server and client into spring configurations.<\/p>\n

In your client\/server code add a resources folder to \/src\/main and within that add a new xml file, named whatever you like, mine’s spring-client.xml and spring-server.xml (for the client and server respectively).<\/p>\n

Changes to the server<\/strong><\/p>\n

Let’s concentrate on the server first – our code looked like this<\/p>\n

\r\nJAXRSServerFactoryBean factoryBean = new JAXRSServerFactoryBean();\r\nfactoryBean.setResourceClasses(SampleServiceImpl.class);\r\nfactoryBean.setResourceProvider(new SingletonResourceProvider(new SampleServiceImpl()));\r\n\r\nMap<Object, Object> extensionMappings = new HashMap<Object, Object>();\r\nextensionMappings.put("xml", MediaType.APPLICATION_XML);\r\nextensionMappings.put("json", MediaType.APPLICATION_JSON);\r\nfactoryBean.setExtensionMappings(extensionMappings);\r\n\r\nList<Object> providers = new ArrayList<Object>();\r\nproviders.add(new JAXBElementProvider());\r\nproviders.add(new JacksonJsonProvider());\r\nfactoryBean.setProviders(providers);\r\n\r\nfactoryBean.setAddress("http:\/\/localhost:9000\/");\r\nServer server = factoryBean.create();\r\n<\/pre>\n
The first thing we need to do is update our pom.xml to import spring, so add the following to the properties section<\/p>\n
\r\n<spring.version>2.5.6<\/spring.version>\r\n<\/pre>\n
and then these dependencies<\/p>\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>org.springframework<\/groupId>\r\n   <artifactId>spring-core<\/artifactId>\r\n   <version>${spring.version}<\/version>\r\n<\/dependency>\r\n<\/pre>\n
Now change the Java code in our main method, replacing all the code which is listed above, to <\/p>\n
\r\nApplicationContext context = new ClassPathXmlApplicationContext("spring-server.xml");\r\n<\/pre>\n
Now we need to add the following to our spring-server.xml file<\/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:jaxrs="http:\/\/cxf.apache.org\/jaxrs"\r\n       xsi:schemaLocation="\r\n         http:\/\/www.springframework.org\/schema\/beans http:\/\/www.springframework.org\/schema\/beans\/spring-beans-2.0.xsd\r\n         http:\/\/cxf.apache.org\/jaxrs http:\/\/cxf.apache.org\/schemas\/jaxrs.xsd">\r\n\r\n    <jaxrs:server address="http:\/\/localhost:9000">\r\n        <jaxrs:serviceBeans>\r\n            <bean class="SampleServiceImpl" \/>\r\n        <\/jaxrs:serviceBeans>\r\n        <jaxrs:extensionMappings>\r\n            <entry key="json" value="application\/json"\/>\r\n            <entry key="xml" value="application\/xml"\/>\r\n        <\/jaxrs:extensionMappings>\r\n        <jaxrs:providers>\r\n            <bean class="org.apache.cxf.jaxrs.provider.JAXBElementProvider" \/>\r\n            <bean class="org.codehaus.jackson.jaxrs.JacksonJsonProvider" \/>\r\n        <\/jaxrs:providers>\r\n    <\/jaxrs:server>\r\n<\/beans>\r\n<\/pre>\n
We’re using the jaxrs configuration to create our service beans which means the server is automatically created for us. <\/p>\n
That’s it for the server.<\/p>\n
Changes to the client<\/strong><\/p>\n
Let’s look at the existing client code<\/p>\n
\r\nList<Object> providers = new ArrayList<Object>();\r\nproviders.add(new JAXBElementProvider());\r\nproviders.add(new JacksonJsonProvider());\r\n\r\nSampleService service = JAXRSClientFactory.create(\r\n   "http:\/\/localhost:9000", SampleService.class, providers);\r\n\r\nWebClient.client(service)\r\n   .type(MediaType.APPLICATION_JSON_TYPE)\r\n   .accept(MediaType.APPLICATION_JSON_TYPE);\r\n<\/pre>\n
First off, we need to add spring to the pom.xml as we needed for the server, so duplicate the steps for updating the pom.xml as already outlined.<\/p>\n
Next we replace our client code (above) with the following<\/p>\n
\r\nApplicationContext context = new ClassPathXmlApplicationContext("spring-client.xml");\r\nSampleService service = (SampleService)context.getBean("client");\r\n<\/pre>\n
and finally put the following into the spring-client.xml file<\/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:jaxrs="http:\/\/cxf.apache.org\/jaxrs"\r\n       xsi:schemaLocation="\r\n         http:\/\/www.springframework.org\/schema\/beans http:\/\/www.springframework.org\/schema\/beans\/spring-beans-2.0.xsd\r\n         http:\/\/cxf.apache.org\/jaxrs http:\/\/cxf.apache.org\/schemas\/jaxrs.xsd">\r\n\r\n    <jaxrs:client id="client" address="http:\/\/localhost:9000" serviceClass="SampleService">\r\n        <jaxrs:providers>\r\n            <bean class="org.apache.cxf.jaxrs.provider.JAXBElementProvider" \/>\r\n            <bean class="org.codehaus.jackson.jaxrs.JacksonJsonProvider" \/>\r\n        <\/jaxrs:providers>\r\n        <jaxrs:headers>\r\n            <entry key="Accept" value="application\/json" \/>\r\n        <\/jaxrs:headers>\r\n    <\/jaxrs:client>\r\n<\/beans>\r\n<\/pre>\n
and that’s it – run the server, then run the client and all should work.<\/p>\n
Note: I’ll leave it to the reader to add the relevant import statements<\/em><\/p>\n","protected":false},"excerpt":{"rendered":"
In Creating a CXF service that responds with JSON or XML and Creating a CXF client which can get JSON or XML we created a service and a client application for interacting with REST requests using XML or JSON as the body for the messages. The Java guys love spring and beans, my code was […]<\/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":[161,164,162],"tags":[],"class_list":["post-5045","post","type-post","status-publish","format-standard","hentry","category-java","category-rest","category-spring"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/5045","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=5045"}],"version-history":[{"count":3,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/5045\/revisions"}],"predecessor-version":[{"id":5078,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/5045\/revisions\/5078"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=5045"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=5045"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=5045"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}