Jersey RESTful web service - How to post XML file using jersey framework

[Rudra Narayan Garnaik]

Hi All,

I am writing a RESTful web service which will take a XML file as input and process the same, and save it into database. I am new to RESTful web services(jersey), can anybody please help me how to achieve the things using jersey.

1- Please give any link if you have?
2- Sample code which will help me to undersatnd how I ll post xml to jersey.
3- May be any API where I can learn and do.
4- If we cant not achieve that or not good to do that way please suggest what is the best way to send XML file to my app using webservice.
5- Keep in mind I need a secure web service, I may send user credential with the xml file as a header/element.

Waiting for quick response as it is little urgent for me.


Many thanks in advance for your help.

[William Brogden]

If I understand you correctly, your problem is to create a client program to send a document to a RESTful service as a POST request, right?

You can use the standard library HttpURLConnection to do that - the fact that the document is formatted as XML makes no difference. This has come up before in this forum so do some searching. Doesn't the Jersey download include some client examples?

Bill

[Rudra Narayan Garnaik]

Thanks for your quick response, exactly I want to know how my jersey client lwill post a XML file. Can you please give here some sample code or link for quick reference? I will try my best to search but i am completely new to webservices as well as jersey.

[William Brogden]

A major point about using RESTful style is that the methods used are exactly HTTP methods as used all over in the web clients and servers. So all you really need to learn is the way a HTTP POST works.

See this wikipedia discussion for background.

Here is a bare-bones example in which the body of the request was available as a String.

void sendRequest()throws Exception {
    System.out.println("Start sending " + action + " request");
    URL url = new URL( serviceURL );
    HttpURLConnection rc = (HttpURLConnection)url.openConnection();
    //System.out.println("Connection opened " + rc );
    rc.setRequestMethod("POST");
    rc.setDoOutput( true );
    rc.setDoInput( true ); 
    rc.setRequestProperty( "Content-Type", "text/xml; charset=utf-8" );
    String reqStr = reqT.getRequest();  // the entire payload in a single String
    int len = reqStr.length();
    rc.setRequestProperty( "Content-Length", Integer.toString( len ) );
    rc.connect();    
    OutputStreamWriter out = new OutputStreamWriter( rc.getOutputStream() ); 
    out.write( reqStr, 0, len );
    out.flush();
    System.out.println("Request sent, reading response ");
    InputStreamReader read = new InputStreamReader( rc.getInputStream() );
    StringBuilder sb = new StringBuilder();   
    int ch = read.read();
    while( ch != -1 ){
      sb.append((char)ch);
      ch = read.read();
    }
    response = sb.toString(); // entire response ends up in String
    read.close();
    rc.disconnect();
  }

[Rudra Narayan Garnaik]

Thanks a lot William.

Nice link and code, I have saved huge time due to your help.

[Rudra Narayan Garnaik]

Anybody Interested- Please refere:

http://download.oracle.com/javaee/6/tutorial/doc/gkoib.html


Sample Code:
======================
Server code:

import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

/**
 * This resource represents the WebServices "test"
 * 
 * @author rudraGar
 */

@Path("/test")
@Component
// tell Spring it's a component, so Spring will parse it at the start of the
// application
// (see the <context:component-scan base-package="com.codeartex.jersey.web" />
// declaration in the applicationcontext.xml)
@Scope("singleton")
// tell Spring it's a singleton, so instanciate it only one time
public class WSTest {

    @GET
    // the path to cal this webservice:
    // http://xx.xx.xx.xx:8080/test/showDate/2010-08-27
    @Path("showDate/{dateMaj}")
    @Produces("text/plain")
    public String getUpdatedMagasins(@PathParam("dateMaj") String dateMaj) {
        return dateMaj;
    }

    @GET
    @Path("hello/{name}")
    @Produces("text/plain")
    public String getMagasinById(@PathParam("name") String name) {

        StringBuffer buffer = new StringBuffer();
        buffer.append("Hello ").append(name);

        return buffer.toString();
    }

    @GET
    @Path("disp/{val}")
    @Produces("text/plain")
    public String getParameterToAdd(@PathParam("val") String name) {

        StringBuffer buffer = new StringBuffer();
        buffer.append("Didplay Message : ").append(name);

        return buffer.toString();
    }

    @POST
    @Path("xmltest")
    @Consumes("application/xml")
    @Produces("text/plain")
    public String postOnlyXML(String incomingXML) {
        System.out.println("incomingXML :" + incomingXML);
       // here is the XML file....enjoy.
        return "Return your string mesage";
    }

}

URL for this in local machine :

http://localhost:8080/RESTful/test/xmltest/


Client Program :

import java.io.File;
import java.net.URI;

import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.UriBuilder;

import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.api.client.config.ClientConfig;
import com.sun.jersey.api.client.config.DefaultClientConfig;

public class WSTestClient {
    public static void main(String[] args) {

        ClientConfig config = new DefaultClientConfig();
        Client client = Client.create(config);
        WebResource service = client.resource(getBaseURI());
        String s = service.path("test").path("disp/garnaik222 ddd").accept(MediaType.TEXT_PLAIN).get(String.class);

       // System.out.println(" Test Simple Text : " + s);

        //System.out.println("============================= ");
        String xml = "<a>hello xml file</a>";

        //String s1 = service.path("test").path("xmltest").post(xml);

        String response = service.path("test").path("xmltest").type(MediaType.APPLICATION_XML).accept(MediaType.TEXT_PLAIN).entity(
                new File("D:/logs/xml/emp.xml")).post(String.class);
           //  System.out.println("XML File : "+response); uncomment to see the response

    }

    private static URI getBaseURI() {
        return UriBuilder.fromUri("http://localhost:8080/RESTful/").build();
    }

}

Happy Jersey coding.

[R Patel]

Thanks for this post and code snippets ,,, it really helped me a lot,,, and m sure will show the way to many others.....

Thanks
Ronak.

[Michael Munsey]

Bumping an old thread...

There is a good example of how to do this at http://www.mkyong.com/webservices/jax-rs/restful-java-client-with-jersey-client/

String input = "{\"singer\":\"Metallica\",\"title\":\"Fade To Black\"}";
ClientResponse response = webResource.type("application/json").post(ClientResponse.class, input);