JBoss.orgCommunity Documentation

Errai

Errai Reference Guide

Legal Notice

Abstract

This is the Errai Reference Guide.

Preface
1. Document Conventions
2. Feedback
1. Introduction
1.1. What is it?
1.2. Required software
2. Messaging
2.1. Messaging Overview
2.2. Messaging API Basics
2.2.1. Sending Messages with the Client Bus
2.2.2. Recieving Messages on the Server Bus / Server Services
2.2.3. Sending Messages with the Server Bus
2.2.4. Receiving Messages on the Client Bus/ Client Services
2.3. Conversations
2.4. Handling Errors
2.5. Single-Response Conversations & Psuedo-Synchronous Messaging
2.6. Broadcasting
2.7. Client-to-Client Communication
2.7.1. Relay Services
2.8. Asynchronous Message Tasks
2.9. Repeating Tasks
2.10. Sender Inferred Subjects
2.11. Message Routing Information
2.12. Queue Sessions
2.12.1. Lifecycle
2.12.2. Scopes
2.13. Client Logging and Error Handling
2.14. Wire Protocol (J.REP)
2.14.1. Payload Structure
2.14.2. Message Routing
2.14.3. Bus Management and Handshaking Protocols
3. Dependency Injection
3.1. Container Wiring
3.2. Wiring server side components
3.3. Scopes
3.3.1. Dependent Scope
3.4. Built-in Extensions
3.4.1. Bus Services
3.4.2. Client Components
3.4.3. Lifecycle Tools
3.5. Client-Side Bean Manager
3.5.1. Looking up beans
3.5.2. Availability of beans
3.6. Alternatives and Mocks
3.6.1. Alternatives
3.6.2. Test Mocks
3.7. Bean Lifecycle
3.7.1. Destruction of Beans
4. Marshalling
4.1. Mapping Your Domain
4.1.1. @Portable
4.1.2. Manual Class Mapping
4.1.3. Custom Marshallers
5. Remote Procedure Calls (RPC)
5.1. Making calls
5.1.1. Proxy Injection
5.2. Handling exceptions
5.3. Session and request objects in RPC endpoints
6. Errai CDI
6.1. Features and Limitations
6.1.1. Other features
6.2. Events
6.2.1. Conversational events
6.2.2. Client-Server Event Example
6.3. Producers
6.4. Deploying Errai CDI
6.4.1. Deployment in Development Mode
6.4.2. Deployment to a Servlet Engine
6.4.3. Deployment to an Application Server
6.4.4. Configuration Options
7. Errai JAX-RS
7.1. Creating Requests
7.1.1. Proxy Injection
7.2. Handling Responses
7.3. Wire Format
7.4. Errai JAX-RS Configuration
8. Configuration
8.1. Appserver Configuration
8.2. Client Configuration
8.3. ErraiApp.properties
8.4. ErraiService.properties
8.4.1. errai.dispatcher.implementation
8.4.2. errai.async_thread_pool_size
8.4.3. errai.async.worker_timeout
8.4.4. errai.authentication_adapter
8.4.5. errai.require_authentication_for_all
8.4.6. errai.auto_discover_services
8.4.7. errai.auto_load_extensions
8.5. Dispatcher Implementations
8.5.1. SimpleDispatcher
8.5.2. AsyncDispatcher
8.6. Servlet Implementations
8.6.1. DefaultBlockingServlet
8.6.2. JBossCometServlet
8.6.3. JettyContinuationsServlet
8.6.4. StandardAsyncServlet
9. Debugging Errai Applications
10. Upgrade Guide
10.1. Upgrading from 1.x to 2.0
10.2. Upgrading from 2.0.Beta to 2.0.CR1 (or Final)
11. Downloads
12. Sources
13. Reporting problems
14. Errai License
A. Revision History