CXF No message body writer found for class - automatically mapping non-simple resources

Question

I am using the CXF rest client which works well for simple data types  eg  Strings  ints   However  when I attempt to use custom Objects I get this   Exception in thread  main  org apache cxf interceptor Fault   No message body writer found for class   class com company datatype normal MyObject      at org apache cxf jaxrs client ClientProxyImpl BodyWriter handleMessage ClientProxyImpl java 523      at org apache cxf phase PhaseInterceptorChain doIntercept PhaseInterceptorChain java 263      at org apache cxf jaxrs client ClientProxyImpl doChainedInvocation ClientProxyImpl java 438      at org apache cxf jaxrs client ClientProxyImpl invoke ClientProxyImpl java 177      at  Proxy13 execute Unknown Source      at com company JaxTestClient main JaxTestClient java 26  Caused by  org apache cxf jaxrs client ClientWebApplicationException   No message body writer found for class   class com company datatype normal MyObject      at org apache cxf jaxrs client AbstractClient reportMessageHandlerProblem AbstractClient java 491      at org apache cxf jaxrs client AbstractClient writeBody AbstractClient java 401      at org apache cxf jaxrs client ClientProxyImpl BodyWriter handleMessage ClientProxyImpl java 515          5 more   I m calling it like this   JaxExample jaxExample   JAXRSClientFactory create   http   localhost 8111    JaxExample class    MyObject before       MyObject after   jaxExample execute  before      Here is the method in the interface    POST  Path   execute     Produces   application json    MyObject execute  MyObject myObject      The restlet library does this quite simply  by adding the XStream dependency to your path it  just works   Does CXF something similar   EDIT  1   I ve posted this as a feature improvement to the CXF issue management system here  I can only hope this will get attended to

User · Answer

When programmatically creating server  you can add message body writers for json xml by setting Providers   JAXRSServerFactoryBean bean   new JAXRSServerFactoryBean    bean setAddress  http   localhost 9000      List lt Object gt  providers   new ArrayList lt Object gt     providers add new JacksonJaxbJsonProvider     providers add new JacksonJaxbXMLProvider     bean setProviders providers    List lt Class lt     gt  gt  resourceClasses   new ArrayList lt Class lt     gt  gt     resourceClasses add YourRestServiceImpl class   bean setResourceClasses resourceClasses    bean setResourceProvider YourRestServiceImpl class  new SingletonResourceProvider new YourRestServiceImpl       BindingFactoryManager manager   bean getBus   getExtension BindingFactoryManager class   JAXRSBindingFactory restFactory   new JAXRSBindingFactory    restFactory setBus bean getBus     manager registerBindingFactory JAXRSBindingFactory JAXRS BINDING ID  restFactory    bean create

User · Answer

Step 1  Add the bean class into the dataFormat list    lt dataFormats gt       lt json id  jack  library  Jackson  prettyPrint  true            unmarshalTypeName   ur bean class path     gt    lt  dataFormats gt    Step 2  Marshal the bean prior to the client call    lt marchal id  marsh  ref  jack   gt

User · Answer

If you are using  cxf-rt-rs-client  version 3 03  or above make sure the xml name space and schemaLocation are declared as below     lt beans xmlns  http   www springframework org schema beans      xmlns xsi  http   www w3 org 2001 XMLSchema-instance       xmlns jaxrs  http   cxf apache org jaxrs       xmlns jaxrs-client  http   cxf apache org jaxrs-client      xsi schemaLocation  http   www springframework org schema beans http   www springframework org schema beans spring-beans xsd     http   cxf apache org jaxrs http   cxf apache org schemas jaxrs xsd http   cxf apache org jaxrs-client http   cxf apache org schemas jaxrs-client xsd  gt    And make sure the client have JacksonJsonProvider or your custom JsonProvider    lt jaxrs-client client id  serviceClient  address    cxf endpoint service address   serviceClass  serviceClass  gt           lt jaxrs-client headers gt               lt entry key  Accept  value  application json  gt  lt  entry gt           lt  jaxrs-client headers gt           lt jaxrs-client providers gt               lt bean class  org codehaus jackson jaxrs JacksonJsonProvider  gt               lt property name  mapper  ref  jacksonMapper    gt           lt  bean gt           lt  jaxrs-client providers gt   lt  jaxrs-client client gt

User · Answer

It isn t quite out of the box but CXF does support JSON bindings to rest services   See cxf jax-rs json docs here  You ll still need to do some minimal configuration to have the provider available and you need to be familiar with jettison if you want to have more control over how the JSON is formed   EDIT  Per comment request  here is some code   I don t have a lot of experience with this but the following code worked as an example in a quick test system     TestApi parts  GET  Path    test     Produces    application json    public Demo getDemo          Demo d   new Demo         d id   1      d name    test       return d       client config for a TestApi interface List providers   new ArrayList     JSONProvider jsonProvider   new JSONProvider     Map lt String  String gt  map   new HashMap lt String  String gt      map put    http   www myserviceapi com    myapi     jsonProvider setNamespaceMap   map    providers add   jsonProvider    TestApi proxy   JAXRSClientFactory create   url  TestApi class       providers  true     Demo d   proxy getDemo     if   d    null         System out println   d id         d name         the Demo class  XmlRootElement   name    demo   namespace    http   www myserviceapi com     XmlType   name    demo   namespace    http   www myserviceapi com        propOrder      name    id       XmlAccessorType   XmlAccessType FIELD   public class Demo        public String name      public int id      Notes    The providers list is where you code configure the JSON provider on the client   In particular  you see the namespace mapping   This needs to match what is on your server side configuration   I don t know much about Jettison options so I m not much help on manipulating all of the various knobs for controlling the marshalling process  Jettison in CXF works by marshalling XML from a JAXB provider into JSON   So you have to ensure that the payload objects are all marked up  or otherwise configured  to marshall as application xml before you can have them marshall as JSON   If you know of a way around this  other than writing your own message body writer   I d love to hear about it  I use spring on the server so my configuration there is all xml stuff   Essentially  you need to go through the same process to add the JSONProvider to the service with the same namespace configuration   Don t have code for that handy but I imagine it will mirror the client side fairly well    This is a bit dirty as an example but will hopefully get you going   Edit2  An example of a message body writer that is based on xstream to avoid jaxb    Produces    application json     Consumes    application json     Provider public class XstreamJsonProvider implements MessageBodyReader lt Object gt       MessageBodyWriter lt Object gt      Override public boolean isWriteable   Class lt   gt  type  Type genericType       Annotation   annotations  MediaType mediaType         return MediaType APPLICATION JSON TYPE equals   mediaType             amp  amp  type equals   Demo class        Override public long getSize   Object t  Class lt   gt  type  Type genericType       Annotation   annotations  MediaType mediaType            I m being lazy - should compute the actual size     return -1      Override public void writeTo   Object t  Class lt   gt  type  Type genericType       Annotation   annotations  MediaType mediaType       MultivaluedMap lt String  Object gt  httpHeaders  OutputStream entityStream        throws IOException  WebApplicationException          deal with thread safe use of xstream  etc      XStream xstream   new XStream   new JettisonMappedXmlDriver           xstream setMode   XStream NO REFERENCES           add safer encoding  error handling  etc      xstream toXML   t  entityStream        Override public boolean isReadable   Class lt   gt  type  Type genericType       Annotation   annotations  MediaType mediaType         return MediaType APPLICATION JSON TYPE equals   mediaType             amp  amp  type equals   Demo class        Override public Object readFrom   Class lt Object gt  type  Type genericType       Annotation   annotations  MediaType mediaType       MultivaluedMap lt String  String gt  httpHeaders  InputStream entityStream        throws IOException  WebApplicationException          add error handling  etc      XStream xstream   new XStream   new JettisonMappedXmlDriver           return xstream fromXML   entityStream           now your client just needs this List providers   new ArrayList     XstreamJsonProvider jsonProvider   new XstreamJsonProvider     providers add   jsonProvider    TestApi proxy   JAXRSClientFactory create   url  TestApi class       providers  true     Demo d   proxy getDemo     if   d    null         System out println   d id         d name        The sample code is missing the parts for robust media type support  error handling  thread safety  etc   But  it ought to get you around the jaxb issue with minimal code   EDIT 3 - sample server side configuration As I said before  my server side is spring configured   Here is a sample configuration that works to wire in the provider    lt  xml version  1 0  encoding  UTF-8   gt   lt beans xmlns  http   www springframework org schema beans  xmlns xsi  http   www w3 org 2001 XMLSchema-instance  xmlns jaxrs  http   cxf apache org jaxrs  xmlns cxf  http   cxf apache org core  xsi schemaLocation  http   www springframework org schema beans http   www springframework org schema beans spring-beans-3 0 xsd     http   cxf apache org jaxrs http   cxf apache org schemas jaxrs xsd     http   cxf apache org core http   cxf apache org schemas core xsd  gt    lt import resource  classpath META-INF cxf cxf xml    gt    lt jaxrs server id  TestApi  gt       lt jaxrs serviceBeans gt           lt ref bean  testApi    gt       lt  jaxrs serviceBeans gt       lt jaxrs providers gt           lt bean id  xstreamJsonProvider  class  webtests rest XstreamJsonProvider    gt       lt  jaxrs providers gt   lt  jaxrs server gt    lt bean id  testApi  class  webtests rest TestApi  gt   lt  bean gt    lt  beans gt    I have also noted that in the latest rev of cxf that I m using there is a difference in the media types  so the example above on the xstream message body reader writer needs a quick modification where isWritable isReadable change to   return MediaType APPLICATION JSON TYPE getType    equals   mediaType getType           amp  amp  MediaType APPLICATION JSON TYPE getSubtype    equals   mediaType getSubtype           amp  amp  type equals   Demo class      EDIT 4 - non-spring configuration Using your servlet container of choice  configure  org apache cxf jaxrs servlet CXFNonSpringJaxrsServlet   with at least 2 init params of   jaxrs serviceClasses jaxrs providers   where the serviceClasses is a space separated list of the service implementations you want bound  such as the TestApi mentioned above and the providers is a space separated list of message body providers  such as the XstreamJsonProvider mentioned above   In tomcat you might add the following to web xml    lt servlet gt       lt servlet-name gt cxfservlet lt  servlet-name gt       lt servlet-class gt org apache cxf jaxrs servlet CXFNonSpringJaxrsServlet lt  servlet-class gt       lt init-param gt           lt param-name gt jaxrs serviceClasses lt  param-name gt           lt param-value gt webtests rest TestApi lt  param-value gt       lt  init-param gt       lt init-param gt           lt param-name gt jaxrs providers lt  param-name gt           lt param-value gt webtests rest XstreamJsonProvider lt  param-value gt       lt  init-param gt       lt load-on-startup gt 1 lt  load-on-startup gt   lt  servlet gt    That is pretty much the quickest way to run it without spring   If you are not using a servlet container  you would need to configure the JAXRSServerFactoryBean setProviders with an instance of XstreamJsonProvider and set the service implementation via the JAXRSServerFactoryBean setResourceProvider method   Check the CXFNonSpringJaxrsServlet init method to see how they do it when setup in a servlet container   That ought to get you going no matter your scenario

User · Answer

You can also configure CXFNonSpringJAXRSServlet  assuming JSONProvider is used     lt init-param gt     lt param-name gt jaxrs providers lt  param-name gt     lt param-value gt        org apache cxf jaxrs provider JSONProvider        writeXsiType false     lt  param-value gt    lt  init-param gt

User · Answer

I encountered this problem while upgrading from CXF 2 7 0 to 3 0 2   Here is what I did to resolve it   Included the following in my pom xml       lt dependency gt           lt groupId gt org apache cxf lt  groupId gt           lt artifactId gt cxf-rt-rs-extension-providers lt  artifactId gt           lt version gt 3 0 2 lt  version gt       lt  dependency gt        lt dependency gt           lt groupId gt org codehaus jackson lt  groupId gt           lt artifactId gt jackson-jaxrs lt  artifactId gt           lt version gt 1 9 0 lt  version gt       lt  dependency gt    and added the following provider       lt jaxrs providers gt           lt bean class  org codehaus jackson jaxrs JacksonJaxbJsonProvider    gt       lt  jaxrs providers gt

User · Answer

In my scenario  i faced similar error  when the rest url without port number is not properly configured for load balancing  I verified the rest url with portnumber and this issue was not occurring  so we had to update the load balancing configuration to resolve this issue

User · Answer

You can try with mentioning   Accept  application json  in your rest client header as well  if you are expecting your object as JSON in response

User · Answer

If you are using jaxrs client route of configuring  you can choose to use the JacksonJsonProvider to provide    lt jaxrs client id  serviceId      serviceClass  classname      address    gt       lt jaxrs providers gt           lt bean class  org codehaus jackson jaxrs JacksonJsonProvider  gt               lt property name  mapper  ref  jacksonMapper    gt           lt  bean gt       lt  jaxrs providers gt   lt  jaxrs client gt    lt bean id  jacksonMapper  class  org codehaus jackson map ObjectMapper  gt   lt  bean gt    You need to include the jackson-mapper-asl and jackson-jaxr artifacts in your classpath

User · Answer

None of the above changes worked for me  Please see my worked configuration below   Dependencies                lt dependency gt                   lt groupId gt org apache cxf lt  groupId gt                   lt artifactId gt cxf-rt-frontend-jaxrs lt  artifactId gt                   lt version gt 3 3 2 lt  version gt               lt  dependency gt               lt dependency gt                   lt groupId gt org apache cxf lt  groupId gt                   lt artifactId gt cxf-rt-rs-extension-providers lt  artifactId gt                   lt version gt 3 3 2 lt  version gt               lt  dependency gt               lt dependency gt                   lt groupId gt org codehaus jackson lt  groupId gt                   lt artifactId gt jackson-jaxrs lt  artifactId gt                   lt version gt 1 9 13 lt  version gt               lt  dependency gt               lt dependency gt                   lt groupId gt org codehaus jettison lt  groupId gt                   lt artifactId gt jettison lt  artifactId gt                   lt version gt 1 4 0 lt  version gt               lt  dependency gt    web xml         lt servlet gt           lt servlet-name gt cfxServlet lt  servlet-name gt           lt servlet-class gt org apache cxf jaxrs servlet CXFNonSpringJaxrsServlet lt  servlet-class gt           lt init-param gt               lt param-name gt javax ws rs Application lt  param-name gt               lt param-value gt com MyApplication lt  param-value gt           lt  init-param gt           lt init-param gt               lt param-name gt jaxrs providers lt  param-name gt               lt param-value gt org codehaus jackson jaxrs JacksonJsonProvider lt  param-value gt           lt  init-param gt           lt init-param gt               lt param-name gt jaxrs extensions lt  param-name gt               lt param-value gt               json application json           lt  param-value gt           lt  init-param gt           lt load-on-startup gt 1 lt  load-on-startup gt       lt  servlet gt       lt servlet-mapping gt           lt servlet-name gt cfxServlet lt  servlet-name gt           lt url-pattern gt  v1   lt  url-pattern gt       lt  servlet-mapping gt    Enjoy coding

[java] CXF: No message body writer found for class - automatically mapping non-simple resources

Examples related to java

Examples related to web-services

Examples related to cxf