Show Table of Contents Hide Table of Contents English 日本語 English Multi-page HTML Single-page HTML PDF ePub Administration and Configuration GuideI. Overview1. Scope of Book2. Introduction2.1. Integrated Projects2.2. Architecture2.3. Directory Structure2.4. JBoss Enterprise Application Platform Use Cases2.5. Bootstrap2.6. Hot Deployment2.6.1. Adding a Custom Deploy FolderII. JBoss Enterprise Application Platform Configuration3. Network3.1. IPv6 Support4. JBoss Web4.1. System Properties4.1.1. Modifying System Properties4.2. Configuring the JBoss Web Container4.3. The Main Config File4.4. Top-Level Elements4.4.1. Server4.4.2. Service4.5. Connector4.5.1. Executor4.6. Containers4.6.1. Engine4.6.2. Host4.6.3. Context4.7. Nested Components4.7.1. Realm4.7.2. Valve4.7.3. GlobalNamingResources5. Enterprise Applications with EJB3 Services5.1. Session Beans5.2. Entity Beans (a.k.a. Java Persistence API)5.2.1. The persistence.xml file5.2.2. Use Alternative Databases5.2.3. Default Hibernate Options5.3. Message Driven Beans5.4. Package and Deploy EJB3 Services5.4.1. Deploy the EJB3 JAR5.4.2. Deploy EAR with EJB3 JAR6. Logging6.1. Logging Defaults6.2. Component-Specific Logging6.2.1. SQL Logging with Hibernate6.2.2. Transaction Service Logging7. Deployment7.1. Deployable Application Types7.1.1. Exploded Deployment7.2. Standard Server Profiles7.2.1. Changing Profile7.2.2. Creating Your Own Profile7.3. Context Root8. Microcontainer9. The JNDI Naming Service9.1. An Overview of JNDI9.1.1. Names9.1.2. Contexts9.2. The JBoss Naming Service Architecture9.3. The Naming InitialContext Factories9.3.1. The standard naming context factory9.3.2. The org.jboss.naming.NamingContextFactory9.3.3. Naming Discovery in Clustered Environments9.3.4. The HTTP InitialContext Factory Implementation9.3.5. The Login InitialContext Factory Implementation9.3.6. The ORBInitialContextFactory9.4. JNDI over HTTP9.4.1. Accessing JNDI over HTTP9.4.2. Accessing JNDI over HTTPS9.4.3. Securing Access to JNDI over HTTP9.4.4. Securing Access to JNDI with a Read-Only Unsecured Context9.5. Additional Naming MBeans9.5.1. JNDI Binding Manager9.5.2. The org.jboss.naming.NamingAlias MBean9.5.3. org.jboss.naming.ExternalContext MBean9.5.4. The org.jboss.naming.JNDIView MBean9.6. J2EE and JNDI - The Application Component Environment9.6.1. ENC Usage Conventions10. Web Services10.1. The need for web services10.2. What web services are not10.3. Document/Literal10.4. Document/Literal (Bare)10.5. Document/Literal (Wrapped)10.6. RPC/Literal10.7. RPC/Encoded10.8. Web Service Endpoints 10.9. Plain old Java Object (POJO)10.10. The endpoint as a web application10.11. Packaging the endpoint10.12. Accessing the generated WSDL10.13. EJB3 Stateless Session Bean (SLSB)10.14. Endpoint Provider10.15. WebServiceContext10.16. Web Service Clients10.16.1. Service10.16.2. Dynamic Proxy10.16.3. WebServiceRef10.16.4. Dispatch10.16.5. Asynchronous Invocations10.16.6. Oneway Invocations10.17. Common API10.17.1. Handler Framework10.17.2. Message Context10.17.3. Fault Handling10.18. DataBinding10.18.1. Using JAXB with non annotated classes10.19. Attachments10.19.1. MTOM/XOP10.19.2. SwaRef10.20. Tools10.20.1. Bottom-Up (Using wsprovide)10.20.2. Top-Down (Using wsconsume)10.20.3. Client Side10.20.4. Command-line & Ant Task Reference10.20.5. JAX-WS binding customization10.21. Web Service Extensions10.21.1. WS-Addressing10.21.2. WS-Security10.21.3. XML Registries10.22. JBossWS Extensions10.22.1. Proprietary Annotations10.23. Web Services Appendix10.24. References11. Additional Services11.1. Exposing MBean Events via SNMP12. JBoss AOP12.1. Some key terms12.2. Creating Aspects in JBoss AOP12.3. Applying Aspects in JBoss AOP12.4. Packaging AOP Applications12.5. The JBoss AspectManager Service12.6. Loadtime transformation in the JBoss Enterprise Application Platform Using Sun JDK12.7. JRockit12.8. Improving Loadtime Performance in the JBoss Enterprise Application Platform Environment12.9. Scoping the AOP to the classloader12.9.1. Deploying as part of a scoped classloader12.9.2. Attaching to a scoped deployment13. Transaction Management13.1. Overview13.2. Configuration Essentials13.3. Transactional Resources13.4. Last Resource Commit Optimization (LRCO)13.5. Transaction Timeout Handling13.6. Recovery Configuration13.7. Transaction Service FAQ13.8. Using the JTS Module13.9. Using the XTS Module13.10. Transaction Management Console13.11. Experimental Components13.12. Source Code and Upgrading14. Remoting14.1. Background14.2. JBoss Remoting Configuration14.2.1. MBeans14.2.2. POJOs14.3. Multihomed servers14.4. Address translation14.5. Where are they now?14.6. Further information.15. Messaging15.1. Default JMS messaging providers15.2. IBM WebSphere MQ Integration15.2.1. Configuring WebSphere MQ Integration16. Using Production Databases with JBoss Enterprise Application Platform16.1. How to Use Production Databases16.2. Installing JDBC Drivers16.2.1. Special Notes on Sybase16.2.2. Configuring JDBC DataSources16.3. Switching to a Production Database16.4. Common Database-Related Tasks16.4.1. Security and Pooling16.4.2. Change Database for the JMS Services16.4.3. Support Foreign Keys in CMP Services16.4.4. Specify Database Dialect for Java Persistence API16.4.5. Change Other JBoss Enterprise Application Platform Services to use the External Database16.4.6. A Special Note About Oracle Databases17. Datasource Configuration17.1. Types of Datasources17.2. Datasource Parameters17.3. Datasource Examples17.3.1. Generic Datasource Example17.3.2. Configuring a DataSource for Remote Usage17.3.3. Configuring a Datasource to Use Login Modules18. Pooling18.1. Strategy18.2. Workaround for Oracle's JDK18.3. Pool Access18.4. Pool Filling18.5. Idle Connections18.6. Dead connections18.6.1. Valid connection checking18.6.2. Errors during SQL queries18.6.3. Changing, Closing or Flushing the pool18.6.4. Using Third Party PoolsIII. Clustering Guide19. Introduction and Quick Start19.1. Quick Start Guide19.1.1. Initial Preparation19.1.2. Launching a JBoss Enterprise Application Platform Cluster19.1.3. Web Application Clustering Quick Start19.1.4. EJB Session Bean Clustering Quick Start19.1.5. Entity Clustering Quick Start20. Clustering Concepts20.1. Cluster Definition20.2. Service Architectures20.2.1. Client-side interceptor architecture20.2.2. External Load Balancer Architecture20.3. Load Balancing Policies20.3.1. Client-side interceptor architecture20.3.2. External load balancer architecture21. Clustering Building Blocks21.1. Group Communication with JGroups21.1.1. The Channel Factory Service21.1.2. The JGroups Shared Transport21.2. Distributed Caching with JBoss Cache21.2.1. The JBoss Enterprise Application Platform CacheManager Service21.3. The HAPartition Service21.3.1. DistributedReplicantManager Service21.3.2. DistributedState Service21.3.3. Custom Use of HAPartition22. Clustered JNDI Services22.1. How it works22.2. Client configuration22.2.1. For clients running inside the Enterprise Application Platform22.2.2. For clients running outside the Enterprise Application Platform22.3. JBoss configuration22.3.1. Adding a Second HA-JNDI Service23. Clustered Session EJBs23.1. Stateless Session Bean in EJB 3.023.2. Stateful Session Beans in EJB 3.023.2.1. The EJB application configuration23.2.2. Optimize state replication23.2.3. CacheManager service configuration23.3. Stateless Session Bean in EJB 2.x23.4. Stateful Session Bean in EJB 2.x23.4.1. The EJB application configuration23.4.2. Optimize state replication23.4.3. The HASessionStateService configuration23.4.4. Handling Cluster Restart23.4.5. JNDI Lookup Process23.4.6. SingleRetryInterceptor24. Clustered Entity EJBs24.1. Entity Bean in EJB 3.024.1.1. Configure the distributed cache24.1.2. Configure the entity beans for cache24.1.3. Query result caching24.2. Entity Beans in EJB 2.x25. HTTP Services26. JBoss Messaging Clustering Notes27. Clustered Deployment Options27.1. Clustered Singleton Services27.1.1. HASingleton Deployment Options27.1.2. Determining the master node27.2. Farming Deployment28. JGroups Services28.1. Configuring a JGroups Channel's Protocol Stack28.1.1. Common Configuration Properties28.1.2. Transport Protocols28.1.3. Discovery Protocols28.1.4. Failure Detection Protocols28.1.5. Reliable Delivery Protocols28.1.6. Group Membership (GMS)28.1.7. Flow Control (FC)28.2. Fragmentation (FRAG2)28.3. State Transfer28.4. Distributed Garbage Collection (STABLE)28.5. Merging (MERGE2)28.6. Other Configuration Issues28.6.1. Binding JGroups Channels to a Particular Interface28.6.2. Isolating JGroups Channels28.6.3. JGroups Troubleshooting29. JBoss Cache Configuration and Deployment29.1. Key JBoss Cache Configuration Options29.1.1. Editing the CacheManager Configuration29.1.2. Cache Mode29.1.3. Transaction Handling29.1.4. Concurrent Access29.1.5. JGroups Integration29.1.6. Eviction29.1.7. Cache Loaders29.1.8. Buddy Replication29.2. Deploying Your Own JBoss Cache Instance29.2.1. Deployment Via the CacheManager Service29.2.2. Deployment Via a -service.xml File29.2.3. Deployment Via a -jboss-beans.xml FileIV. Legacy EJB Support30. EJBs on JBoss30.1. The EJB Client Side View30.1.1. Specifying the EJB Proxy Configuration30.2. The EJB Server Side View30.2.1. Detached Invokers - The Transport Middlemen30.2.2. The HA JRMPInvoker - Clustered RMI/JRMP Transport30.2.3. The HA HttpInvoker - Clustered RMI/HTTP Transport30.3. The EJB Container30.3.1. EJBDeployer MBean30.3.2. Container Plug-in Framework 30.4. Entity Bean Locking and Deadlock Detection30.4.1. Why JBoss Needs Locking30.4.2. Entity Bean Lifecycle30.4.3. Default Locking Behavior30.4.4. Pluggable Interceptors and Locking Policy30.4.5. Deadlock 30.4.6. Advanced Configurations and Optimizations30.4.7. Running Within a Cluster30.4.8. Troubleshooting30.5. EJB Timer Configuration31. The CMP Engine31.1. Example Code31.1.1. Enabling CMP Debug Logging31.1.2. Running the examples31.2. The jbosscmp-jdbc Structure31.3. Entity Beans31.3.1. Entity Mapping31.4. CMP Fields31.4.1. CMP Field Declaration31.4.2. CMP Field Column Mapping31.4.3. Read-only Fields31.4.4. Auditing Entity Access31.4.5. Dependent Value Classes (DVCs)31.5. Container Managed Relationships31.5.1. CMR-Field Abstract Accessors31.5.2. Relationship Declaration31.5.3. Relationship Mapping31.6. Queries31.6.1. Finder and select Declaration31.6.2. EJB-QL Declaration31.6.3. Overriding the EJB-QL to SQL Mapping31.6.4. JBossQL31.6.5. DynamicQL31.6.6. DeclaredSQL31.6.7. EJBQL 2.1 and SQL92 queries31.6.8. BMP Custom Finders31.7. Optimized Loading31.7.1. Loading Scenario31.7.2. Load Groups31.7.3. Read-ahead31.8. Loading Process31.8.1. Commit Options31.8.2. Eager-loading Process31.8.3. Lazy loading Process31.8.4. Lazy loading result sets31.9. Transactions31.10. Optimistic Locking31.11. Entity Commands and Primary Key Generation31.11.1. Existing Entity Commands31.12. Defaults31.12.1. A sample jbosscmp-jdbc.xml defaults declaration31.13. Datasource Customization31.13.1. Type Mapping31.13.2. Function Mapping31.13.3. Mapping31.13.4. User Type MappingsV. AppendicesA. Server Directory StructureA.1. Server Profile Directory StructureA.1.1. The default Server Profile File SetA.1.2. The all Server Profile File SetA.1.3. EJB3 ServicesB. Vendor-Specific Datasource DefinitionsB.1. Deployer Location and NamingB.2. DB2B.3. OracleB.3.1. Changes in Oracle 10g JDBC DriverB.3.2. Type Mapping for Oracle 10gB.3.3. Retrieving the Underlying Oracle Connection ObjectB.3.4. Limitations of Oracle 11gB.4. SybaseB.4.1. Sybase LimitationsB.5. Microsoft SQL ServerB.5.1. Microsoft JDBC DriversB.5.2. JSQL DriversB.5.3. jTDS JDBC DriverB.5.4. "Invalid object name 'JMS_SUBSCRIPTIONS' ExceptionB.6. MySQL DatasourceB.6.1. Installing the DriverB.6.2. MySQL Local-TX DatasourceB.6.3. MySQL Using a Named PipeB.7. PostgreSQLB.8. IngresC. Logging Information and RecipesC.1. Log Level DescriptionsC.2. Separate Log Files Per ApplicationC.3. Redirecting Category OutputD. Revision HistoryLegal Notice 10.20.4. Command-line & Ant Task Reference wsconsume reference page wsprovide reference page wsrunclient reference page 10.20.3. Client Side 10.20.5. JAX-WS binding customization