Flexible Communication

AJAX Mode

The simplest and most efficient mode for typical web applications.

• User triggers event (click, form submit, etc.)
• Request sent to server via AJAX
• Server processes event and returns UI updates
• Browser applies updates to the DOM

Best for: Forms, CRUD operations, content pages, admin panels

AJAX + SSE Mode

Combines AJAX requests with Server-Sent Events for server push.

• AJAX for client-to-server communication
• Persistent SSE connection for server push
• Server can update UI at any time
• Automatic reconnection if connection drops

Best for: Dashboards, notifications, live feeds, monitoring

WebSocket Mode

Full bidirectional communication over a persistent connection.

• Single persistent connection
• Instant bidirectional messaging
• Lowest latency possible
• Efficient for high-frequency updates

Best for: Chat apps, collaborative editing, gaming, trading platforms

@WebListener
public class MyApplication extends Application
{
    @Override
    public void contextInitialized(ServletContextEvent sce)
    {
        super.contextInitialized(sce);

        // Change the default mode to AJAX only (no SSE connection)
        setCommunicationMode(CommunicationMode.AJAX_ONLY);

        // Or use WebSocket as the default
        setCommunicationMode(CommunicationMode.WEBSOCKET);
    }
}

// Simple form page - use AJAX only (no SSE overhead)
@Page("/contact")
public class ContactPage extends HtmlPage
{
    public ContactPage()
    {
        setCommunicationMode(CommunicationMode.AJAX_ONLY);
    }
}

// Dashboard with live updates - use AJAX + SSE for server push
@Page("/dashboard")
public class DashboardPage extends HtmlPage
{
    public DashboardPage()
    {
        setCommunicationMode(CommunicationMode.AJAX_WITH_SSE);
    }

    // Server can push updates anytime
    public void updateMetrics(Metrics metrics)
    {
        metricsPanel.update(metrics);
        sendUpdate(); // Push changes to browser
    }
}

// Chat application - use WebSocket for real-time messaging
@Page("/chat")
public class ChatPage extends HtmlPage
{
    public ChatPage()
    {
        setCommunicationMode(CommunicationMode.WEBSOCKET);
    }

    // Instant bidirectional messaging
    public void onMessageReceived(ChatMessage message)
    {
        chatArea.addMessage(message);
        sendUpdate(); // Instant delivery
    }
}