Migrating from Atmosphere 2.x to 4.0

Overview of Changes

Package Changes

// 2.x
import javax.inject.Inject;
import javax.servlet.http.HttpServletRequest;
// 4.0
import jakarta.inject.Inject;
import jakarta.servlet.http.HttpServletRequest;

@ManagedService (Unchanged)

// Same in both 2.x and 4.0
@ManagedService(path = "/chat")
public class Chat {
 @Ready
 public void onReady() { }
 @Disconnect
 public void onDisconnect() { }
 @Message(encoders = {JacksonEncoder.class}, decoders = {JacksonDecoder.class})
 public Message onMessage(Message message) { return message; }
}

Removed Features

New Features in 4.0

Client Migration

2.x (jQuery-based)

var socket = $.atmosphere;
var request = {
 url: '/chat',
 transport: 'websocket',
 fallbackTransport: 'long-polling'
};
request.onMessage = function(response) {
 var message = response.responseBody;
};
var subSocket = socket.subscribe(request);
subSocket.push(JSON.stringify(data));

4.0 (TypeScript, no jQuery)

import { Atmosphere } from 'atmosphere.js';
const atm = new Atmosphere();
const sub = await atm.subscribe(
 {
 url: '/chat',
 transport: 'websocket',
 fallbackTransport: 'long-polling',
 },
 {
 message: (response) => {
 const data = JSON.parse(response.responseBody);
 },
 }
);
sub.push(JSON.stringify(data));

const sub = await atmosphere.atmosphere.subscribe(request, handlers);

Step-by-Step Migration

web.xml Changes

<!-- 2.x -->
<web-app xmlns="http://java.sun.com/xml/ns/javaee" version="3.0">
<!-- 4.0 -->
<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee" version="6.0">