The CometD Reference Book – 3.1.1



Table of Contents

• Preface
• 1. CometD Commercial Support Services
• 2. Contributing to CometD
  • 2.1. Contributing via Mailing Lists
  • 2.2. Contributing by Reporting Issues
  • 2.3. Contributing Code Fixes, Enhancements and Documentation
• 3. Installation
  • 3.1. Requirements and Dependencies
  • 3.2. Downloading and Installing
  • 3.3. Running the Demos
    • 3.3.1. Running the Demos with Maven
  • 3.4. Deploying your CometD Application
    • 3.4.1. Deploying your CometD Application in Standalone Jetty
    • 3.4.2. Deploying your CometD Application using Embedded Jetty
    • 3.4.3. Running the Demos with Another Servlet Container
• 4. Troubleshooting
  • 4.1. Logging
    • 4.1.1. Enabling Debug Logging in the JavaScript Library
    • 4.1.2. Enabling Debug Logging in the Java Server Library
• 5. Primer
  • 5.1. Preparing
  • 5.2. Setting Up the Project
    • 5.2.1. The Maven Way
    • 5.2.2. The Non-Maven Way
    • 5.2.3. Setup Details
• 6. Concepts and Architecture
  • 6.1. Definitions
    • 6.1.1. Channel Definitions
  • 6.2. The High Level View
  • 6.3. The Lower Level View
    • 6.3.1. Sessions
    • 6.3.2. The Server
    • 6.3.3. Listeners
    • 6.3.4. Message Processing
    • 6.3.5. Threading
    • 6.3.6. Application Interaction
    • 6.3.7. Bayeux Protocol
    • 6.3.8. Binary Data
• 7. Security
  • 7.1. Security of the session id
  • 7.2. Security against man-in-the-middle attacks
  • 7.3. Security against cross-site scripting (XSS) attacks
  • 7.4. Security against cross site request forgery (CSRF) attacks
• 8. JavaScript Library
  • 8.1. Configuring and Initializing
    • 8.1.1. Configuring and Initializing Multiple Objects
    • 8.1.2. Configuring Extensions in Multiple Objects
  • 8.2. Handshaking
  • 8.3. Subscribing and Unsubscribing
    • 8.3.1. Meta Channels
    • 8.3.2. Service Channels
    • 8.3.3. Broadcast Channels
    • 8.3.4. Subscribers versus Listeners
    • 8.3.5. Dynamic Resubscription
    • 8.3.6. Listeners and Subscribers Exception Handling
    • 8.3.7. Wildcard Subscriptions
    • 8.3.8. Meta Channel List
  • 8.4. Sending Messages
    • 8.4.1. Publishing
    • 8.4.2. Publishing Binary Data
    • 8.4.3. Remote Calls
    • 8.4.4. Remote Calls with Binary Data
  • 8.5. Disconnecting
    • 8.5.1. Short Network Failures
    • 8.5.2. Long Network Failures or Server Failures
  • 8.6. Message Batching
  • 8.7. JavaScript Transports
    • 8.7.1. The long-polling Transport
    • 8.7.2. The callback-polling Transport
    • 8.7.3. The websocket Transport
    • 8.7.4. Unregistering Transports
    • 8.7.5. The cross-origin Mode
• 9. Java Libraries
  • 9.1. CometD Java Libraries and Servlet 3.0
  • 9.2. Client Library
    • 9.2.1. Handshaking
    • 9.2.2. Subscribing and Unsubscribing
    • 9.2.3. Sending Messages
    • 9.2.4. Disconnecting
    • 9.2.5. Client Transports
  • 9.3. Server Library
    • 9.3.1. Configuring the Java Server
    • 9.3.2. Configuring BayeuxServer
    • 9.3.3. Using Services
    • 9.3.4. Authorization
    • 9.3.5. Authentication
    • 9.3.6. Server Channel Authorizers
    • 9.3.7. Server Transports
    • 9.3.8. Contextual Information
    • 9.3.9. Lazy Channels and Messages
    • 9.3.10. Multiple Sessions
    • 9.3.11. Multiple Sessions with HTTP/1.1
    • 9.3.12. Multiple Sessions with HTTP/2
    • 9.3.13. JMX Integration
  • 9.4. JSON Libraries
    • 9.4.1. JSONContext API
    • 9.4.2. Portability Considerations
    • 9.4.3. Customizing Deserialization of JSON objects
  • 9.5. Scalability Clustering with Oort
    • 9.5.1. Typical Infrastructure
    • 9.5.2. Terminology
    • 9.5.3. Oort Cluster
    • 9.5.4. Common Configuration
    • 9.5.5. Automatic Discovery Configuration
    • 9.5.6. Static Discovery Configuration
    • 9.5.7. Membership Organization
    • 9.5.8. Authentication
    • 9.5.9. Broadcast Messages Forwarding
  • 9.6. Seti
    • 9.6.1. Configuring Seti
    • 9.6.2. Associating and Disassociating Users
    • 9.6.3. Listening for Presence Messages
    • 9.6.4. Sending Messages
  • 9.7. Distributed Objects and Services
    • 9.7.1. OortObject
    • 9.7.2. OortService
    • 9.7.3. OortObject and OortService TradeOffs
• 10. Extensions
  • 10.1. Writing the Extension
  • 10.2. Registering the Extension
  • 10.3. Extension Exception Handling
  • 10.4. Activity Extension
    • 10.4.1. Enabling the Extension
    • 10.4.2. Enabling the Extension Only for a Specific ServerSession
  • 10.5. Message Acknowledgment Extension
    • 10.5.1. Enabling the Server-side Message Acknowledgment Extension
    • 10.5.2. Enabling the Client-side Message Acknowledgment Extension
    • 10.5.3. Acknowledge Extension Details
    • 10.5.4. Message Ordering
    • 10.5.5. Demo
  • 10.6. Binary Extension
    • 10.6.1. Enabling the Server-side Extension
    • 10.6.2. Enabling the Client-side Extension
  • 10.7. Reload Extension
    • 10.7.1. Enabling the Client-side Extension
    • 10.7.2. Configuring the Reload Extension
    • 10.7.3. Understanding Reload Extension Details
  • 10.8. Timestamp Extension
    • 10.8.1. Enabling the Server-side Extension
    • 10.8.2. Enabling the Client-side Extension
  • 10.9. Timesync Extension
    • 10.9.1. Enabling the Server-side Extension
    • 10.9.2. Enabling the Client-side Extension
    • 10.9.3. Understanding Timesync Extension Details
• 11. Benchmarking CometD
  • 11.1. Benchmark Setup
  • 11.2. Running the Benchmark
    • 11.2.1. Running the Server
    • 11.2.2. Running the Client
    • 11.2.3. Running Multiple Clients
• Appendix A: Building
  • Requirements
  • Obtaining the source code
  • Performing the Build
  • Trying out your Build
• Appendix B: Migration Guides
  • Migrating from CometD 2
    • Required JDK Version Changes
    • Servlet Specification Changes
    • Class Names Changes
    • Maven Artifacts Changes
    • web.xml Changes
    • CometD Servlet Parameters Changes
    • Method Signature Changes
    • Inherited Services Service Method Signature Changes
  • Migrating from CometD 3.0 to CometD 3.1
    • API Behavior Changes
    • Binary Data
    • Message Processing Order Changes
    • HTTP/2 Support
    • CometD Servlet Parameters Changes
    • CometD APIs Additions
  • JavaScript Implementation Changes
    • Jetty WebSocket Server Transport Requirements
• Appendix C: The Bayeux Protocol Specification 1.0
  • Status of this Document
  • Abstract
  • Introduction
    • Purpose
    • Requirements
    • Terminology
  • Overall Operation
    • HTTP Transport
    • Non HTTP Transports
    • JavaScript
    • Client to Server event delivery
    • Server to Client event delivery
    • Polling transports
    • Streaming transports
    • Two connection operation
    • Connection Negotiation
    • Unconnected operation
    • Client State Table
  • Protocol Elements
    • Common Elements
    • Channels
    • Meta Channels
    • Service Channels
    • Version
    • Client ID
    • Messages
  • Common Message Field Definitions
    • channel
    • version
    • minimumVersion
    • supportedConnectionTypes
    • clientId
    • advice
    • connectionType
    • id
    • timestamp
    • data
    • successful
    • subscription
    • error
    • ext
    • connectionId
    • json-comment-filtered
  • Meta Message Field Definitions
    • Handshake
    • Connect
    • Disconnect
    • Subscribe
    • Unsubscribe
  • Event Message Field Definitions
    • Publish
    • Delivery
  • Transports
    • The long-polling Transport
    • The callback-polling Transport
  • Security
    • Authentication
    • AJAX Hijacking
  • Multiple clients operation
    • Server-side Multiple clients detection
    • Client-side Multiple clients handling
  • Request / Response operation with service channels
• Appendix D: Committer Release Instructions
  • Creating the Release
  • Managing the Repository
  • Upload the Archetype Catalog
  • Close the GitHub Issues Milestone