CXF Session Management

By admin | September 08, 2012 | Updated : March 26, 2016 cxf, rest, soap, webservice, 2 Comments

CXF session Management explains about Enabling Session Handling In Apache CXF

I am showing here, How to do session management in CXF framework, this is applicable for both SOAP & RESTFul services

Message message = PhaseInterceptorChain.getCurrentMessage();
HttpServletRequest request = (HttpServletRequest)message.get(AbstractHTTPDestination.HTTP_REQUEST);
HttpSession  session = request.getSession(true);

On this code, we are getting HttpServletRequest and from that we are getting HttpSession Using CXF

You can see the below CXF Session example, on which we are storing a value to session and retrieving the same, using CXF Framework

Note

This tutorial is also applicable for JAX-WS Web services because PhaseInterceptorChain.getCurrentMessage() applicable for both JAX-WS and JAX-RS based services

You can change CXF Web Service Tutorial according to the below tutorial, if you are using JAX-WS based service

Session Management Using CXF

I am going to re-use CXF Restful Tutorial

We are making changes ChangeStudentDetailsImpl class, just adding

PhaseInterceptorChain.getCurrentMessage() and getting HttpServletRequest, so that we can access HttpSession object in CXF Framework

package com.student;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;

import org.apache.cxf.message.Message;
import org.apache.cxf.phase.PhaseInterceptorChain;
import org.apache.cxf.transport.http.AbstractHTTPDestination;

@Consumes("application/json")
@Produces("application/json")
public class ChangeStudentDetailsImpl implements ChangeStudentDetails {

@POST
@Path("/changeName")
public Student changeName(Student student) {
    // Here We are getting session from Message
    Message message = PhaseInterceptorChain.getCurrentMessage();
    HttpServletRequest request = (HttpServletRequest)message.get(AbstractHTTPDestination.HTTP_REQUEST);
    HttpSession session = request.getSession(true);
    session.setAttribute("name","HELLO "+student.getName());
    student.setName(session.getAttribute("name").toString());
    return student;
}

@GET
@Path("/getName")
public Student getName() {
    Student student = new Student();
    student.setName("Rockey");
    return student;
}
}

Run Client

package com.client;

import java.io.IOException;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Scanner;

// Session Handling Using CXF

public class PostStudentClient {

public static void main(String[] args) {
    try {
      URL url = new URL("http://localhost:8080/CXFRestfulTutorial/rest/changeName");
      HttpURLConnection conn = (HttpURLConnection) url.openConnection();
      conn.setDoOutput(true);
      conn.setRequestMethod("POST");
      conn.setRequestProperty("Content-Type", "application/json");

      String input = "{\"Student\":{\"name\":\"Tom\"}}";

      OutputStream os = conn.getOutputStream();
      os.write(input.getBytes());
      os.flush();

      Scanner scanner;
      String response;
      if (conn.getResponseCode() != 200) {
        scanner = new Scanner(conn.getErrorStream());
        response = "Error From Server \n\n";
      } else {
        scanner = new Scanner(conn.getInputStream());
        response = "Response From Server \n\n";
      }
      scanner.useDelimiter("\\Z");
      System.out.println(response + scanner.next());
      scanner.close();
      conn.disconnect();
    } catch (MalformedURLException e) {
      e.printStackTrace();
    } catch (IOException e) {
      e.printStackTrace();
    }
}
}

Output

Response From Server 

{"Student":{"name":"HELLO Tom"}}

You might also like following tutorials :

2 Responses to "CXF Session Management"

sort 2012-09-10 10:05:01.0

Can you tell me how to share session between web service calls?

admin 2012-09-11 10:05:01.0

@sort,

If you are using CXF rest/jax-rs you can use org.apache.cxf.message.Message.MAINTAIN_SESSION property to be true

WebClient.getConfig(proxy).getRequestContext().put(org.apache.cxf.message.Message.MAINTAIN_SESSION, Boolean.TRUE);

Session Management Using CXF

Run Client

Output

Related Posts