Jump To Close Expand all Collapse all Table of contents Development Guide 1. Get Started Developing Applications Expand section "1. Get Started Developing Applications" Collapse section "1. Get Started Developing Applications" 1.1. Introduction Expand section "1.1. Introduction" Collapse section "1.1. Introduction" 1.1.1. About Red Hat JBoss Enterprise Application Platform 6 1.2. Prerequisites Expand section "1.2. Prerequisites" Collapse section "1.2. Prerequisites" 1.2.1. Become Familiar with Java Enterprise Edition 6 Expand section "1.2.1. Become Familiar with Java Enterprise Edition 6" Collapse section "1.2.1. Become Familiar with Java Enterprise Edition 6" 1.2.1.1. Overview of EE 6 Profiles 1.2.1.2. Java Enterprise Edition 6 Web Profile 1.2.1.3. Java Enterprise Edition 6 Full Profile 1.2.2. About Modules and the New Modular Class Loading System used in JBoss EAP 6 Expand section "1.2.2. About Modules and the New Modular Class Loading System used in JBoss EAP 6" Collapse section "1.2.2. About Modules and the New Modular Class Loading System used in JBoss EAP 6" 1.2.2.1. Modules 1.3. Set Up the Development Environment Expand section "1.3. Set Up the Development Environment" Collapse section "1.3. Set Up the Development Environment" 1.3.1. Download and Install Red Hat JBoss Developer Studio Expand section "1.3.1. Download and Install Red Hat JBoss Developer Studio" Collapse section "1.3.1. Download and Install Red Hat JBoss Developer Studio" 1.3.1.1. Setup Red Hat JBoss Developer Studio 1.3.1.2. Download Red Hat JBoss Developer Studio 1.3.1.3. Install Red Hat JBoss Developer Studio 1.3.1.4. Start Red Hat JBoss Developer Studio 1.3.1.5. Add the JBoss EAP Server Using Define New Server 1.4. Run Your First Application Expand section "1.4. Run Your First Application" Collapse section "1.4. Run Your First Application" 1.4.1. Download the Quickstart Code Examples Expand section "1.4.1. Download the Quickstart Code Examples" Collapse section "1.4.1. Download the Quickstart Code Examples" 1.4.1.1. Access the Quickstarts 1.4.2. Run the Quickstarts Expand section "1.4.2. Run the Quickstarts" Collapse section "1.4.2. Run the Quickstarts" 1.4.2.1. Run the Quickstarts in Red Hat JBoss Developer Studio 1.4.2.2. Run the Quickstarts Using a Command Line 1.4.3. Review the Quickstart Tutorials Expand section "1.4.3. Review the Quickstart Tutorials" Collapse section "1.4.3. Review the Quickstart Tutorials" 1.4.3.1. Explore the helloworld Quickstart 1.4.3.2. Explore the numberguess Quickstart 1.4.4. Replace the Default Welcome Web Application 1.4.5. Using WS-AtomicTransaction 2. Maven Guide Expand section "2. Maven Guide" Collapse section "2. Maven Guide" 2.1. Learn about Maven Expand section "2.1. Learn about Maven" Collapse section "2.1. Learn about Maven" 2.1.1. About the Maven Repository 2.1.2. About the Maven POM File 2.1.3. Minimum Requirements of a Maven POM File 2.1.4. About the Maven Settings File 2.2. Install Maven and the JBoss Maven Repository Expand section "2.2. Install Maven and the JBoss Maven Repository" Collapse section "2.2. Install Maven and the JBoss Maven Repository" 2.2.1. Download and Install Maven 2.2.2. Install the JBoss EAP 6 Maven Repository 2.2.3. Install the JBoss EAP 6 Maven Repository Locally 2.2.4. Install the JBoss EAP 6 Maven Repository for Use with Apache httpd 2.2.5. Install the JBoss EAP 6 Maven Repository Using Nexus Maven Repository Manager 2.2.6. About Maven Repository Managers 2.3. Use the Maven Repository Expand section "2.3. Use the Maven Repository" Collapse section "2.3. Use the Maven Repository" 2.3.1. Configure the JBoss EAP Maven 6 Repository 2.3.2. Configure the JBoss EAP 6 Maven Repository Using the Maven Settings 2.3.3. Configure Maven for Use with Red Hat JBoss Developer Studio 2.3.4. Configure the JBoss EAP 6 Maven Repository Using the Project POM 2.3.5. Manage Project Dependencies 2.4. Upgrade the Maven Repository Expand section "2.4. Upgrade the Maven Repository" Collapse section "2.4. Upgrade the Maven Repository" 2.4.1. Apply a Patch to the Local Maven Repository 3. Class Loading and Modules Expand section "3. Class Loading and Modules" Collapse section "3. Class Loading and Modules" 3.1. Introduction Expand section "3.1. Introduction" Collapse section "3.1. Introduction" 3.1.1. Overview of Class Loading and Modules 3.1.2. Class Loading 3.1.3. Modules 3.1.4. Module Dependencies 3.1.5. Class Loading in Deployments 3.1.6. Class Loading Precedence 3.1.7. Dynamic Module Naming 3.1.8. jboss-deployment-structure.xml 3.2. Add an Explicit Module Dependency to a Deployment 3.3. Generate MANIFEST.MF entries using Maven 3.4. Prevent a Module Being Implicitly Loaded 3.5. Exclude a Subsystem from a Deployment 3.6. Use the Class Loader Programmatically in a Deployment Expand section "3.6. Use the Class Loader Programmatically in a Deployment" Collapse section "3.6. Use the Class Loader Programmatically in a Deployment" 3.6.1. Programmatically Load Classes and Resources in a Deployment 3.6.2. Programmatically Iterate Resources in a Deployment 3.7. Class Loading and Subdeployments Expand section "3.7. Class Loading and Subdeployments" Collapse section "3.7. Class Loading and Subdeployments" 3.7.1. Modules and Class Loading in Enterprise Archives 3.7.2. Subdeployment Class Loader Isolation 3.7.3. Enable Subdeployment Class Loader Isolation Within a EAR 3.8. Deploy Tag Library Descriptors (TLDs) in a Custom Module 3.9. Reference Expand section "3.9. Reference" Collapse section "3.9. Reference" 3.9.1. Implicit Module Dependencies 3.9.2. Included Modules 3.9.3. JBoss Deployment Structure Deployment Descriptor Reference 4. Valves Expand section "4. Valves" Collapse section "4. Valves" 4.1. About Valves 4.2. About Global Valves 4.3. About Authenticator Valves 4.4. Configure a Web Application to use a Valve 4.5. Configure a Web Application to use an Authenticator Valve 4.6. Create a Custom Valve 5. Logging for Developers Expand section "5. Logging for Developers" Collapse section "5. Logging for Developers" 5.1. Introduction Expand section "5.1. Introduction" Collapse section "5.1. Introduction" 5.1.1. About Logging 5.1.2. Application Logging Frameworks Supported By JBoss LogManager 5.1.3. About Log Levels 5.1.4. Supported Log Levels 5.1.5. Default Log File Locations 5.2. Logging with the JBoss Logging Framework Expand section "5.2. Logging with the JBoss Logging Framework" Collapse section "5.2. Logging with the JBoss Logging Framework" 5.2.1. About JBoss Logging 5.2.2. Features of JBoss Logging 5.2.3. Add Logging to an Application with JBoss Logging 5.3. Per-deployment Logging Expand section "5.3. Per-deployment Logging" Collapse section "5.3. Per-deployment Logging" 5.3.1. About Per-deployment Logging 5.3.2. Add Per-deployment Logging to an Application 5.3.3. Example logging.properties File 5.4. Logging Profiles Expand section "5.4. Logging Profiles" Collapse section "5.4. Logging Profiles" 5.4.1. About Logging Profiles 5.4.2. Specify a Logging Profile in an Application 6. Internationalization and Localization Expand section "6. Internationalization and Localization" Collapse section "6. Internationalization and Localization" 6.1. Introduction Expand section "6.1. Introduction" Collapse section "6.1. Introduction" 6.1.1. About Internationalization 6.1.2. About Localization 6.2. JBoss Logging Tools Expand section "6.2. JBoss Logging Tools" Collapse section "6.2. JBoss Logging Tools" 6.2.1. Overview Expand section "6.2.1. Overview" Collapse section "6.2.1. Overview" 6.2.1.1. JBoss Logging Tools Internationalization and Localization 6.2.1.2. JBoss Logging Tools Quickstart 6.2.1.3. Message Logger 6.2.1.4. Message Bundle 6.2.1.5. Internationalized Log Messages 6.2.1.6. Internationalized Exceptions 6.2.1.7. Internationalized Messages 6.2.1.8. Translation Properties Files 6.2.1.9. JBoss Logging Tools Project Codes 6.2.1.10. JBoss Logging Tools Message IDs 6.2.2. Creating Internationalized Loggers, Messages and Exceptions Expand section "6.2.2. Creating Internationalized Loggers, Messages and Exceptions" Collapse section "6.2.2. Creating Internationalized Loggers, Messages and Exceptions" 6.2.2.1. Create Internationalized Log Messages 6.2.2.2. Create and Use Internationalized Messages 6.2.2.3. Create Internationalized Exceptions 6.2.3. Localizing Internationalized Loggers, Messages and Exceptions Expand section "6.2.3. Localizing Internationalized Loggers, Messages and Exceptions" Collapse section "6.2.3. Localizing Internationalized Loggers, Messages and Exceptions" 6.2.3.1. Generate New Translation Properties Files with Maven 6.2.3.2. Translate an Internationalized Logger, Exception or Message 6.2.4. Customizing Internationalized Log Messages Expand section "6.2.4. Customizing Internationalized Log Messages" Collapse section "6.2.4. Customizing Internationalized Log Messages" 6.2.4.1. Add Message IDs and Project Codes to Log Messages 6.2.4.2. Specify the Log Level for a Message 6.2.4.3. Customize Log Messages with Parameters 6.2.4.4. Specify an Exception as the Cause of a Log Message 6.2.5. Customizing Internationalized Exceptions Expand section "6.2.5. Customizing Internationalized Exceptions" Collapse section "6.2.5. Customizing Internationalized Exceptions" 6.2.5.1. Add Message IDs and Project Codes to Exception Messages 6.2.5.2. Customize Exception Messages with Parameters 6.2.5.3. Specify One Exception as the Cause of Another Exception 6.2.6. Reference Expand section "6.2.6. Reference" Collapse section "6.2.6. Reference" 6.2.6.1. JBoss Logging Tools Maven Configuration 6.2.6.2. Translation Property File Format 6.2.6.3. JBoss Logging Tools Annotations Reference 7. Remote JNDI Lookup Expand section "7. Remote JNDI Lookup" Collapse section "7. Remote JNDI Lookup" 7.1. Registering Objects to JNDI 7.2. Configuring a Remote JNDI Client 8. Enterprise JavaBeans Expand section "8. Enterprise JavaBeans" Collapse section "8. Enterprise JavaBeans" 8.1. Introduction Expand section "8.1. Introduction" Collapse section "8.1. Introduction" 8.1.1. Overview of Enterprise JavaBeans 8.1.2. EJB 3.1 Feature Set 8.1.3. EJB 3.1 Lite 8.1.4. EJB 3.1 Lite Features 8.1.5. Enterprise Beans 8.1.6. Overview of Writing Enterprise Beans 8.1.7. Session Bean Business Interfaces Expand section "8.1.7. Session Bean Business Interfaces" Collapse section "8.1.7. Session Bean Business Interfaces" 8.1.7.1. Enterprise Bean Business Interfaces 8.1.7.2. EJB Local Business Interfaces 8.1.7.3. EJB Remote Business Interfaces 8.1.7.4. EJB No-interface Beans 8.2. Creating Enterprise Bean Projects Expand section "8.2. Creating Enterprise Bean Projects" Collapse section "8.2. Creating Enterprise Bean Projects" 8.2.1. Create an EJB Archive Project Using Red Hat JBoss Developer Studio 8.2.2. Create an EJB Archive Project in Maven 8.2.3. Create an EAR Project containing an EJB Project 8.2.4. Add a Deployment Descriptor to an EJB Project 8.3. Session Beans Expand section "8.3. Session Beans" Collapse section "8.3. Session Beans" 8.3.1. Session Beans 8.3.2. Stateless Session Beans 8.3.3. Stateful Session Beans 8.3.4. Singleton Session Beans 8.3.5. Add Session Beans to a Project in Red Hat JBoss Developer Studio 8.4. Message-Driven Beans Expand section "8.4. Message-Driven Beans" Collapse section "8.4. Message-Driven Beans" 8.4.1. Message-Driven Beans 8.4.2. Resource Adapters 8.4.3. Create a JMS-based Message-Driven Bean in Red Hat JBoss Developer Studio 8.4.4. Specifying a Resource Adapter in jboss-ejb3.xml for an MDB 8.4.5. Enable EJB and MDB Property Substitution in an Application 8.5. Invoking Session Beans Expand section "8.5. Invoking Session Beans" Collapse section "8.5. Invoking Session Beans" 8.5.1. Invoke a Session Bean Remotely using JNDI 8.5.2. About EJB Client Contexts 8.5.3. Considerations When Using a Single EJB Context 8.5.4. Using Scoped EJB Client Contexts 8.5.5. Configure EJBs Using a Scoped EJB Client Context 8.5.6. EJB Client Properties 8.5.7. Remote EJB Data Compression 8.6. Container Interceptors Expand section "8.6. Container Interceptors" Collapse section "8.6. Container Interceptors" 8.6.1. About Container Interceptors 8.6.2. Create a Container Interceptor Class 8.6.3. Configure a Container Interceptor 8.6.4. Change the Security Context Identity 8.6.5. Use a Client Side Interceptor in an Application 8.7. Clustered Enterprise JavaBeans Expand section "8.7. Clustered Enterprise JavaBeans" Collapse section "8.7. Clustered Enterprise JavaBeans" 8.7.1. About Clustered Enterprise JavaBeans (EJBs) 8.7.2. Standalone and In-server Client Configuration 8.7.3. Implementing a Custom Load Balancing Policy for EJB Calls 8.7.4. Transaction Behavior of EJB Invocations 8.8. Reference Expand section "8.8. Reference" Collapse section "8.8. Reference" 8.8.1. EJB JNDI Naming Reference 8.8.2. EJB Reference Resolution 8.8.3. Project dependencies for Remote EJB Clients 8.8.4. jboss-ejb3.xml Deployment Descriptor Reference 9. JBoss MBean Services Expand section "9. JBoss MBean Services" Collapse section "9. JBoss MBean Services" 9.1. Writing JBoss MBean Services 9.2. A Standard MBean Example 9.3. Deploying JBoss MBean Services 10. Clustering in Web Applications Expand section "10. Clustering in Web Applications" Collapse section "10. Clustering in Web Applications" 10.1. Session Replication Expand section "10.1. Session Replication" Collapse section "10.1. Session Replication" 10.1.1. About HTTP Session Replication 10.1.2. About the Web Session Cache 10.1.3. Configure the Web Session Cache 10.1.4. Enable Session Replication in Your Application 10.2. HttpSession Passivation and Activation Expand section "10.2. HttpSession Passivation and Activation" Collapse section "10.2. HttpSession Passivation and Activation" 10.2.1. About HTTP Session Passivation and Activation 10.2.2. Configure HttpSession Passivation in Your Application 10.3. Implement an HA Singleton 10.4. Apache mod_cluster-manager Application Expand section "10.4. Apache mod_cluster-manager Application" Collapse section "10.4. Apache mod_cluster-manager Application" 10.4.1. About mod_cluster-manager Application 10.4.2. Exploring mod_cluster-manager Application 11. CDI Expand section "11. CDI" Collapse section "11. CDI" 11.1. Overview of CDI Expand section "11.1. Overview of CDI" Collapse section "11.1. Overview of CDI" 11.1.1. Overview of CDI 11.1.2. About Contexts and Dependency Injection (CDI) 11.1.3. Benefits of CDI 11.1.4. About Type-safe Dependency Injection 11.1.5. Relationship Between Weld, Seam 2, and JavaServer Faces 11.2. Use CDI Expand section "11.2. Use CDI" Collapse section "11.2. Use CDI" 11.2.1. First Steps Expand section "11.2.1. First Steps" Collapse section "11.2.1. First Steps" 11.2.1.1. Enable CDI 11.2.2. Use CDI to Develop an Application Expand section "11.2.2. Use CDI to Develop an Application" Collapse section "11.2.2. Use CDI to Develop an Application" 11.2.2.1. Use CDI to Develop an Application 11.2.2.2. Use CDI with Existing Code 11.2.2.3. Exclude Beans From the Scanning Process 11.2.2.4. Use an Injection to Extend an Implementation 11.2.3. Ambiguous or Unsatisfied Dependencies Expand section "11.2.3. Ambiguous or Unsatisfied Dependencies" Collapse section "11.2.3. Ambiguous or Unsatisfied Dependencies" 11.2.3.1. About Ambiguous or Unsatisfied Dependencies 11.2.3.2. About Qualifiers 11.2.3.3. Use a Qualifier to Resolve an Ambiguous Injection 11.2.4. Managed Beans Expand section "11.2.4. Managed Beans" Collapse section "11.2.4. Managed Beans" 11.2.4.1. About Managed Beans 11.2.4.2. Types of Classes That are Beans 11.2.4.3. Use CDI to Inject an Object Into a Bean 11.2.5. Contexts, Scopes, and Dependencies Expand section "11.2.5. Contexts, Scopes, and Dependencies" Collapse section "11.2.5. Contexts, Scopes, and Dependencies" 11.2.5.1. Contexts and Scopes 11.2.5.2. Available Contexts 11.2.6. Bean Lifecycle Expand section "11.2.6. Bean Lifecycle" Collapse section "11.2.6. Bean Lifecycle" 11.2.6.1. Manage the Lifecycle of a Bean 11.2.6.2. Use a Producer Method 11.2.7. Named Beans and Alternative Beans Expand section "11.2.7. Named Beans and Alternative Beans" Collapse section "11.2.7. Named Beans and Alternative Beans" 11.2.7.1. About Named Beans 11.2.7.2. Use Named Beans 11.2.7.3. About Alternative Beans 11.2.7.4. Override an Injection with an Alternative 11.2.8. Stereotypes Expand section "11.2.8. Stereotypes" Collapse section "11.2.8. Stereotypes" 11.2.8.1. About Stereotypes 11.2.8.2. Use Stereotypes 11.2.9. Observer Methods Expand section "11.2.9. Observer Methods" Collapse section "11.2.9. Observer Methods" 11.2.9.1. About Observer Methods 11.2.9.2. Transactional Observers 11.2.9.3. Fire and Observe Events 11.2.10. Interceptors Expand section "11.2.10. Interceptors" Collapse section "11.2.10. Interceptors" 11.2.10.1. About Interceptors 11.2.10.2. Use Interceptors with CDI 11.2.11. About Decorators 11.2.12. About Portable Extensions 11.2.13. Bean Proxies Expand section "11.2.13. Bean Proxies" Collapse section "11.2.13. Bean Proxies" 11.2.13.1. About Bean Proxies 11.2.13.2. Use a Proxy in an Injection 12. Java Transaction API (JTA) Expand section "12. Java Transaction API (JTA)" Collapse section "12. Java Transaction API (JTA)" 12.1. Overview Expand section "12.1. Overview" Collapse section "12.1. Overview" 12.1.1. Overview of Java Transactions API (JTA) 12.2. Transaction Concepts Expand section "12.2. Transaction Concepts" Collapse section "12.2. Transaction Concepts" 12.2.1. About Transactions 12.2.2. About ACID Properties for Transactions 12.2.3. About the Transaction Coordinator or Transaction Manager 12.2.4. About Transaction Participants 12.2.5. About Java Transactions API (JTA) 12.2.6. About Java Transaction Service (JTS) 12.2.7. About XA Datasources and XA Transactions 12.2.8. About XA Recovery 12.2.9. About the 2-Phase Commit Protocol 12.2.10. About Transaction Timeouts 12.2.11. About Distributed Transactions 12.2.12. About the ORB Portability API 12.2.13. About Nested Transactions 12.2.14. About XML Transaction Service Expand section "12.2.14. About XML Transaction Service" Collapse section "12.2.14. About XML Transaction Service" 12.2.14.1. Overview of Protocols Used by XTS 12.2.14.2. Web Services-Atomic Transaction Process 12.2.14.3. Web Services-Business Activity Process 12.2.14.4. Transaction Bridging Overview 12.3. Transaction Optimizations Expand section "12.3. Transaction Optimizations" Collapse section "12.3. Transaction Optimizations" 12.3.1. Overview of Transaction Optimizations 12.3.2. About the LRCO Optimization for Single-phase Commit (1PC) Expand section "12.3.2. About the LRCO Optimization for Single-phase Commit (1PC)" Collapse section "12.3.2. About the LRCO Optimization for Single-phase Commit (1PC)" 12.3.2.1. Commit Markable Resource 12.3.3. About the Presumed-Abort Optimization 12.3.4. About the Read-Only Optimization 12.4. Transaction Outcomes Expand section "12.4. Transaction Outcomes" Collapse section "12.4. Transaction Outcomes" 12.4.1. About Transaction Outcomes 12.4.2. About Transaction Commit 12.4.3. About Transaction Roll-Back 12.4.4. About Heuristic Outcomes 12.4.5. JBoss Transactions Errors and Exceptions 12.5. Overview of JTA Transactions Expand section "12.5. Overview of JTA Transactions" Collapse section "12.5. Overview of JTA Transactions" 12.5.1. About Java Transactions API (JTA) 12.5.2. Lifecycle of a JTA Transaction 12.6. Transaction Subsystem Configuration Expand section "12.6. Transaction Subsystem Configuration" Collapse section "12.6. Transaction Subsystem Configuration" 12.6.1. Transactions Configuration Overview 12.6.2. Transactional Datasource Configuration Expand section "12.6.2. Transactional Datasource Configuration" Collapse section "12.6.2. Transactional Datasource Configuration" 12.6.2.1. Configure an XA Datasource 12.6.2.2. Create a Non-XA Datasource with the Management Interfaces 12.6.2.3. Configure Your Datasource to Use JTA Transaction API 12.6.2.4. Configure Database Connection Validation Settings 12.6.2.5. Datasource Parameters 12.6.3. Transaction Logging Expand section "12.6.3. Transaction Logging" Collapse section "12.6.3. Transaction Logging" 12.6.3.1. About Transaction Log Messages 12.6.3.2. Configure Logging for the Transaction Subsystem 12.6.3.3. Browse and Manage Transactions 12.7. Use JTA Transactions Expand section "12.7. Use JTA Transactions" Collapse section "12.7. Use JTA Transactions" 12.7.1. Transactions JTA Task Overview 12.7.2. Control Transactions 12.7.3. Begin a Transaction 12.7.4. Nested Transactions 12.7.5. Commit a Transaction 12.7.6. Roll Back a Transaction 12.7.7. Handle a Heuristic Outcome in a Transaction 12.7.8. Transaction Timeouts Expand section "12.7.8. Transaction Timeouts" Collapse section "12.7.8. Transaction Timeouts" 12.7.8.1. About Transaction Timeouts 12.7.8.2. Configure the Transaction Manager 12.7.9. JTA Transaction Error Handling Expand section "12.7.9. JTA Transaction Error Handling" Collapse section "12.7.9. JTA Transaction Error Handling" 12.7.9.1. Handle Transaction Errors 12.8. ORB Configuration Expand section "12.8. ORB Configuration" Collapse section "12.8. ORB Configuration" 12.8.1. About Common Object Request Broker Architecture (CORBA) 12.8.2. Configure the ORB for JTS Transactions 12.9. Transaction References Expand section "12.9. Transaction References" Collapse section "12.9. Transaction References" 12.9.1. JBoss Transactions Errors and Exceptions 12.9.2. JTA Transaction Example 12.9.3. API Documentation for JBoss Transactions JTA 12.9.4. Limitations of the XA Recovery Process 13. Hibernate Expand section "13. Hibernate" Collapse section "13. Hibernate" 13.1. About Hibernate Core 13.2. Java Persistence API (JPA) Expand section "13.2. Java Persistence API (JPA)" Collapse section "13.2. Java Persistence API (JPA)" 13.2.1. About JPA 13.2.2. Hibernate EntityManager 13.2.3. Getting Started Expand section "13.2.3. Getting Started" Collapse section "13.2.3. Getting Started" 13.2.3.1. Create a JPA project in Red Hat JBoss Developer Studio 13.2.3.2. Create the Persistence Settings File in Red Hat JBoss Developer Studio 13.2.3.3. Example Persistence Settings File 13.2.3.4. Create the Hibernate Configuration File in Red Hat JBoss Developer Studio 13.2.3.5. Example Hibernate Configuration File 13.2.4. Configuration Expand section "13.2.4. Configuration" Collapse section "13.2.4. Configuration" 13.2.4.1. Hibernate Configuration Properties 13.2.4.2. Hibernate JDBC and Connection Properties 13.2.4.3. Hibernate Cache Properties 13.2.4.4. Hibernate Transaction Properties 13.2.4.5. Miscellaneous Hibernate Properties 13.2.4.6. Hibernate SQL Dialects 13.2.5. Second-Level Caches Expand section "13.2.5. Second-Level Caches" Collapse section "13.2.5. Second-Level Caches" 13.2.5.1. About Second-Level Caches 13.2.5.2. Configure a Second Level Cache for Hibernate 13.3. Hibernate Annotations Expand section "13.3. Hibernate Annotations" Collapse section "13.3. Hibernate Annotations" 13.3.1. Hibernate Annotations 13.4. Hibernate Query Language Expand section "13.4. Hibernate Query Language" Collapse section "13.4. Hibernate Query Language" 13.4.1. About Hibernate Query Language 13.4.2. HQL Statements 13.4.3. About the INSERT Statement 13.4.4. About the FROM Clause 13.4.5. About the WITH Clause 13.4.6. About Bulk Update, Insert and Delete 13.4.7. About Collection Member References 13.4.8. About Qualified Path Expressions 13.4.9. About Scalar Functions 13.4.10. HQL Standardized Functions 13.4.11. About the Concatenation Operation 13.4.12. About Dynamic Instantiation 13.4.13. About HQL Predicates 13.4.14. About Relational Comparisons 13.4.15. About the IN Predicate 13.4.16. About HQL Ordering 13.5. Hibernate Services Expand section "13.5. Hibernate Services" Collapse section "13.5. Hibernate Services" 13.5.1. About Hibernate Services 13.5.2. About Service Contracts 13.5.3. Types of Service Dependencies 13.5.4. The ServiceRegistry Expand section "13.5.4. The ServiceRegistry" Collapse section "13.5.4. The ServiceRegistry" 13.5.4.1. About the ServiceRegistry 13.5.5. Custom Services Expand section "13.5.5. Custom Services" Collapse section "13.5.5. Custom Services" 13.5.5.1. About Custom Services 13.5.6. The Bootstrap Registry Expand section "13.5.6. The Bootstrap Registry" Collapse section "13.5.6. The Bootstrap Registry" 13.5.6.1. About the Boot-strap Registry 13.5.6.2. Using BootstrapServiceRegistryBuilder 13.5.6.3. BootstrapRegistry Services 13.5.7. The SessionFactory Registry Expand section "13.5.7. The SessionFactory Registry" Collapse section "13.5.7. The SessionFactory Registry" 13.5.7.1. SessionFactory Registry 13.5.7.2. SessionFactory Services 13.5.8. Integrators Expand section "13.5.8. Integrators" Collapse section "13.5.8. Integrators" 13.5.8.1. Integrators 13.5.8.2. Integrator use-cases 13.6. Bean Validation Expand section "13.6. Bean Validation" Collapse section "13.6. Bean Validation" 13.6.1. About Bean Validation 13.6.2. Hibernate Validator 13.6.3. Validation Constraints Expand section "13.6.3. Validation Constraints" Collapse section "13.6.3. Validation Constraints" 13.6.3.1. About Validation Constraints 13.6.3.2. Create a Constraint Annotation in Red Hat JBoss Developer Studio 13.6.3.3. Hibernate Validator Constraints 13.6.4. Configuration Expand section "13.6.4. Configuration" Collapse section "13.6.4. Configuration" 13.6.4.1. Example Validation Configuration File 13.7. Envers Expand section "13.7. Envers" Collapse section "13.7. Envers" 13.7.1. About Hibernate Envers 13.7.2. About Auditing Persistent Classes 13.7.3. Auditing Strategies Expand section "13.7.3. Auditing Strategies" Collapse section "13.7.3. Auditing Strategies" 13.7.3.1. About Auditing Strategies 13.7.3.2. Set the Auditing Strategy 13.7.4. Getting Started with Entity Auditing Expand section "13.7.4. Getting Started with Entity Auditing" Collapse section "13.7.4. Getting Started with Entity Auditing" 13.7.4.1. Add Auditing Support to a JPA Entity 13.7.5. Configuration Expand section "13.7.5. Configuration" Collapse section "13.7.5. Configuration" 13.7.5.1. Configure Envers Parameters 13.7.5.2. Enable or Disable Auditing at Runtime 13.7.5.3. Configure Conditional Auditing 13.7.5.4. Envers Configuration Properties 13.7.6. Queries Expand section "13.7.6. Queries" Collapse section "13.7.6. Queries" 13.7.6.1. Retrieve Auditing Information 13.8. Performance Tuning Expand section "13.8. Performance Tuning" Collapse section "13.8. Performance Tuning" 13.8.1. Alternative Batch Loading Algorithms 13.8.2. Second Level Caching of Object References for Non-mutable Data 14. Hibernate Search Expand section "14. Hibernate Search" Collapse section "14. Hibernate Search" 14.1. Getting Started with Hibernate Search Expand section "14.1. Getting Started with Hibernate Search" Collapse section "14.1. Getting Started with Hibernate Search" 14.1.1. About Hibernate Search 14.1.2. First Steps with Hibernate Search 14.1.3. Enable Hibernate Search using Maven 14.1.4. Add Annotations 14.1.5. Indexing 14.1.6. Searching 14.1.7. Analyzer 14.2. Mapping Entities to the Index Structure Expand section "14.2. Mapping Entities to the Index Structure" Collapse section "14.2. Mapping Entities to the Index Structure" 14.2.1. Mapping an Entity Expand section "14.2.1. Mapping an Entity" Collapse section "14.2.1. Mapping an Entity" 14.2.1.1. Basic Mapping Expand section "14.2.1.1. Basic Mapping" Collapse section "14.2.1.1. Basic Mapping" 14.2.1.1.1. @Indexed 14.2.1.1.2. @Field 14.2.1.1.3. @NumericField 14.2.1.1.4. @Id 14.2.1.2. Mapping Properties Multiple Times 14.2.1.3. Embedded and Associated Objects 14.2.1.4. Limiting Object Embedding to Specific Paths 14.2.2. Boosting Expand section "14.2.2. Boosting" Collapse section "14.2.2. Boosting" 14.2.2.1. Static Index Time Boosting 14.2.2.2. Dynamic Index Time Boosting 14.2.3. Analysis Expand section "14.2.3. Analysis" Collapse section "14.2.3. Analysis" 14.2.3.1. Default Analyzer and Analyzer by Class 14.2.3.2. Named Analyzers 14.2.3.3. Available Analyzers 14.2.3.4. Dynamic Analyzer Selection 14.2.3.5. Retrieving an Analyzer 14.2.4. Bridges Expand section "14.2.4. Bridges" Collapse section "14.2.4. Bridges" 14.2.4.1. Built-in Bridges 14.2.4.2. Custom Bridges Expand section "14.2.4.2. Custom Bridges" Collapse section "14.2.4.2. Custom Bridges" 14.2.4.2.1. StringBridge 14.2.4.2.2. Parameterized Bridge 14.2.4.2.3. Type Aware Bridge 14.2.4.2.4. Two-Way Bridge 14.2.4.2.5. FieldBridge 14.2.4.2.6. ClassBridge 14.3. Querying Expand section "14.3. Querying" Collapse section "14.3. Querying" 14.3.1. Building Queries Expand section "14.3.1. Building Queries" Collapse section "14.3.1. Building Queries" 14.3.1.1. Building a Lucene Query Using the Lucene API 14.3.1.2. Building a Lucene Query 14.3.1.3. Keyword Queries 14.3.1.4. Fuzzy Queries 14.3.1.5. Wildcard Queries 14.3.1.6. Phrase Queries 14.3.1.7. Range Queries 14.3.1.8. Combining Queries 14.3.1.9. Query Options 14.3.1.10. Build a Hibernate Search Query Expand section "14.3.1.10. Build a Hibernate Search Query" Collapse section "14.3.1.10. Build a Hibernate Search Query" 14.3.1.10.1. Generality 14.3.1.10.2. Pagination 14.3.1.10.3. Sorting 14.3.1.10.4. Fetching Strategy 14.3.1.10.5. Projection 14.3.1.10.6. Customizing Object Initialization Strategies 14.3.1.10.7. Limiting the Time of a Query 14.3.1.10.8. Raise an Exception on Time Limit 14.3.2. Retrieving the Results Expand section "14.3.2. Retrieving the Results" Collapse section "14.3.2. Retrieving the Results" 14.3.2.1. Performance Considerations 14.3.2.2. Result Size 14.3.2.3. ResultTransformer 14.3.2.4. Understanding Results 14.3.3. Filters Expand section "14.3.3. Filters" Collapse section "14.3.3. Filters" 14.3.3.1. Using Filters in a Sharded Environment 14.3.4. Faceting Expand section "14.3.4. Faceting" Collapse section "14.3.4. Faceting" 14.3.4.1. Creating a Faceting Request 14.3.4.2. Applying a Faceting Request 14.3.4.3. Restricting Query Results 14.3.5. Optimizing the Query Process Expand section "14.3.5. Optimizing the Query Process" Collapse section "14.3.5. Optimizing the Query Process" 14.3.5.1. Caching Index Values: FieldCache 14.4. Manual Index Changes Expand section "14.4. Manual Index Changes" Collapse section "14.4. Manual Index Changes" 14.4.1. Adding Instances to the Index 14.4.2. Deleting Instances from the Index 14.4.3. Rebuilding the Index Expand section "14.4.3. Rebuilding the Index" Collapse section "14.4.3. Rebuilding the Index" 14.4.3.1. Using flushToIndexes() 14.4.3.2. Using a MassIndexer 14.5. Index Optimization Expand section "14.5. Index Optimization" Collapse section "14.5. Index Optimization" 14.5.1. Automatic Optimization 14.5.2. Manual Optimization 14.5.3. Adjusting Optimization 14.6. Advanced Features Expand section "14.6. Advanced Features" Collapse section "14.6. Advanced Features" 14.6.1. Accessing the SearchFactory 14.6.2. Using an IndexReader 14.6.3. Accessing a Lucene Directory 14.6.4. Sharding Indexes 14.6.5. Customizing Lucene's Scoring Formula 14.6.6. Exception Handling Configuration 14.6.7. Disable Hibernate Search 15. JAX-RS Web Services Expand section "15. JAX-RS Web Services" Collapse section "15. JAX-RS Web Services" 15.1. About JAX-RS 15.2. About RESTEasy 15.3. About RESTful Web Services 15.4. RESTEasy Defined Annotations 15.5. RESTEasy Configuration Expand section "15.5. RESTEasy Configuration" Collapse section "15.5. RESTEasy Configuration" 15.5.1. RESTEasy Configuration Parameters 15.6. JAX-RS Web Service Security Expand section "15.6. JAX-RS Web Service Security" Collapse section "15.6. JAX-RS Web Service Security" 15.6.1. Enable Role-Based Security for a RESTEasy JAX-RS Web Service 15.6.2. Secure a JAX-RS Web Service using Annotations 15.7. Exception Handling Expand section "15.7. Exception Handling" Collapse section "15.7. Exception Handling" 15.7.1. Create an Exception Mapper 15.7.2. RESTEasy Internally Thrown Exceptions 15.8. RESTEasy Interceptors Expand section "15.8. RESTEasy Interceptors" Collapse section "15.8. RESTEasy Interceptors" 15.8.1. Intercept JAX-RS Invocations 15.8.2. Bind an Interceptor to a JAX-RS Method 15.8.3. Register an Interceptor 15.8.4. Interceptor Precedence Families Expand section "15.8.4. Interceptor Precedence Families" Collapse section "15.8.4. Interceptor Precedence Families" 15.8.4.1. About Interceptor Precedence Families 15.8.4.2. Define a Custom Interceptor Precedence Family 15.9. String Based Annotations Expand section "15.9. String Based Annotations" Collapse section "15.9. String Based Annotations" 15.9.1. Convert String Based @*Param Annotations to Objects 15.10. Configure File Extensions Expand section "15.10. Configure File Extensions" Collapse section "15.10. Configure File Extensions" 15.10.1. Map File Extensions to Media Types in the web.xml File 15.10.2. Map File Extensions to Languages in the web.xml File 15.10.3. RESTEasy Supported Media Types 15.11. RESTEasy JavaScript API Expand section "15.11. RESTEasy JavaScript API" Collapse section "15.11. RESTEasy JavaScript API" 15.11.1. About the RESTEasy JavaScript API 15.11.2. Enable the RESTEasy JavaScript API Servlet 15.11.3. RESTEasy Javascript API Parameters 15.11.4. Build AJAX Queries with the JavaScript API 15.11.5. REST.Request Class Members 15.12. RESTEasy Asynchronous Job Service Expand section "15.12. RESTEasy Asynchronous Job Service" Collapse section "15.12. RESTEasy Asynchronous Job Service" 15.12.1. About the RESTEasy Asynchronous Job Service 15.12.2. Enable the Asynchronous Job Service 15.12.3. Configure Asynchronous Jobs for RESTEasy 15.12.4. Asynchronous Job Service Configuration Parameters 15.13. RESTEasy JAXB Expand section "15.13. RESTEasy JAXB" Collapse section "15.13. RESTEasy JAXB" 15.13.1. Create a JAXB Decorator 15.13.2. JAXB and XML Provider 15.13.3. JAXB and JSON Provider 15.14. RESTEasy Atom Support Expand section "15.14. RESTEasy Atom Support" Collapse section "15.14. RESTEasy Atom Support" 15.14.1. About the Atom API and Provider 15.14.2. Using JAXB with Atom Provider 15.15. YAML Provider 15.16. EJB Integration 15.17. JSON Support via Jackson 15.18. RESTEasy/Spring Integration Expand section "15.18. RESTEasy/Spring Integration" Collapse section "15.18. RESTEasy/Spring Integration" 15.18.1. RESTEasy/Spring integration 16. JAX-WS Web Services Expand section "16. JAX-WS Web Services" Collapse section "16. JAX-WS Web Services" 16.1. About JAX-WS Web Services 16.2. Configure the webservices Subsystem 16.3. Configure the HTTP Timeout per Application 16.4. JAX-WS Web Service Endpoints Expand section "16.4. JAX-WS Web Service Endpoints" Collapse section "16.4. JAX-WS Web Service Endpoints" 16.4.1. About JAX-WS Web Service Endpoints 16.4.2. Write and Deploy a JAX-WS Web Service Endpoint 16.5. JAX-WS Web Service Clients Expand section "16.5. JAX-WS Web Service Clients" Collapse section "16.5. JAX-WS Web Service Clients" 16.5.1. Consume and Access a JAX-WS Web Service 16.5.2. Develop a JAX-WS Client Application 16.6. JAX-WS Development Reference Expand section "16.6. JAX-WS Development Reference" Collapse section "16.6. JAX-WS Development Reference" 16.6.1. Enable Web Services Addressing (WS-Addressing) 16.6.2. JAX-WS Common API Reference 17. WebSockets Expand section "17. WebSockets" Collapse section "17. WebSockets" 17.1. About WebSockets 17.2. Create a WebSocket Application 18. Application Security Expand section "18. Application Security" Collapse section "18. Application Security" 18.1. Foundational Concepts Expand section "18.1. Foundational Concepts" Collapse section "18.1. Foundational Concepts" 18.1.1. About Encryption 18.1.2. About Security Domains 18.1.3. About SSL Encryption 18.1.4. About Declarative Security 18.2. Role-Based Security in Applications Expand section "18.2. Role-Based Security in Applications" Collapse section "18.2. Role-Based Security in Applications" 18.2.1. About Application Security 18.2.2. About Authentication 18.2.3. About Authorization 18.2.4. About Security Auditing 18.2.5. About Security Mapping 18.2.6. Java Authentication and Authorization Service (JAAS) 18.2.7. About Java Authentication and Authorization Service (JAAS) 18.2.8. Use a Security Domain in Your Application 18.2.9. Use Role-Based Security In Servlets 18.2.10. Use A Third-Party Authentication System In Your Application 18.3. Login Modules Expand section "18.3. Login Modules" Collapse section "18.3. Login Modules" 18.3.1. Using Modules Expand section "18.3.1. Using Modules" Collapse section "18.3.1. Using Modules" 18.3.1.1. Password Stacking 18.3.1.2. Password Hashing 18.3.1.3. Unauthenticated Identity 18.3.1.4. Ldap Login Module 18.3.1.5. LdapExtended Login Module 18.3.1.6. UsersRoles Login Module 18.3.1.7. Database Login Module 18.3.1.8. Certificate Login Module 18.3.1.9. Identity Login Module 18.3.1.10. RunAs Login Module Expand section "18.3.1.10. RunAs Login Module" Collapse section "18.3.1.10. RunAs Login Module" 18.3.1.10.1. RunAsIdentity Creation 18.3.1.11. Client Login Module 18.3.1.12. SPNEGO Login Module 18.3.1.13. RoleMapping Login Module 18.3.1.14. bindCredential Module Option 18.3.2. Custom Modules Expand section "18.3.2. Custom Modules" Collapse section "18.3.2. Custom Modules" 18.3.2.1. Subject Usage Pattern Support 18.3.2.2. Custom LoginModule Example 18.4. EJB Application Security Expand section "18.4. EJB Application Security" Collapse section "18.4. EJB Application Security" 18.4.1. Security Identity Expand section "18.4.1. Security Identity" Collapse section "18.4.1. Security Identity" 18.4.1.1. About EJB Security Identity 18.4.1.2. Set the Security Identity of an EJB 18.4.2. EJB Method Permissions Expand section "18.4.2. EJB Method Permissions" Collapse section "18.4.2. EJB Method Permissions" 18.4.2.1. About EJB Method Permissions 18.4.2.2. Use EJB Method Permissions 18.4.3. EJB Security Annotations Expand section "18.4.3. EJB Security Annotations" Collapse section "18.4.3. EJB Security Annotations" 18.4.3.1. About EJB Security Annotations 18.4.3.2. Use EJB Security Annotations 18.4.4. Remote Access to EJBs Expand section "18.4.4. Remote Access to EJBs" Collapse section "18.4.4. Remote Access to EJBs" 18.4.4.1. About Remote Method Access 18.4.4.2. About Remoting Callbacks 18.4.4.3. About Remoting Server Detection 18.4.4.4. Configure the Remoting Subsystem 18.4.4.5. Use Security Realms with Remote EJB Clients 18.4.4.6. Add a New Security Realm 18.4.4.7. Add a User to a Security Realm 18.4.4.8. About Remote EJB Access Using SSL Encryption 18.5. JAX-RS Application Security Expand section "18.5. JAX-RS Application Security" Collapse section "18.5. JAX-RS Application Security" 18.5.1. Enable Role-Based Security for a RESTEasy JAX-RS Web Service 18.5.2. Secure a JAX-RS Web Service using Annotations 18.6. Password Vaults for Sensitive Strings Expand section "18.6. Password Vaults for Sensitive Strings" Collapse section "18.6. Password Vaults for Sensitive Strings" 18.6.1. Password Vault System 18.6.2. Configure and Use Password Vault 18.6.3. Obtain Keystore Password From External Source 18.6.4. Create a Java Keystore to Store Sensitive Strings 18.6.5. Initialize the Password Vault 18.6.6. Configure JBoss EAP 6 to Use the Password Vault 18.6.7. Configure JBoss EAP 6 to Use a Custom Implementation of the Password Vault 18.6.8. Store a Sensitive String in the Password Vault 18.6.9. Use an Encrypted Sensitive String in Configuration 18.6.10. Use an Encrypted Sensitive String in an Application 18.6.11. Check if a Sensitive String is in the Password Vault 18.6.12. Remove a Sensitive String from the Password Vault 18.7. Java Authorization Contract for Containers (JACC) Expand section "18.7. Java Authorization Contract for Containers (JACC)" Collapse section "18.7. Java Authorization Contract for Containers (JACC)" 18.7.1. About Java Authorization Contract for Containers (JACC) 18.7.2. Configure Java Authorization Contract for Containers (JACC) Security 18.8. Java Authentication SPI for Containers (JASPI) Expand section "18.8. Java Authentication SPI for Containers (JASPI)" Collapse section "18.8. Java Authentication SPI for Containers (JASPI)" 18.8.1. About Java Authentication SPI for Containers (JASPI) Security 18.8.2. Configure Java Authentication SPI for Containers (JASPI) Security 19. Single Sign On (SSO) Expand section "19. Single Sign On (SSO)" Collapse section "19. Single Sign On (SSO)" 19.1. About Single Sign On (SSO) for Web Applications 19.2. About Clustered Single Sign On (SSO) for Web Applications 19.3. Choose the Right SSO Implementation 19.4. Use Single Sign On (SSO) In A Web Application 19.5. About Kerberos 19.6. About SPNEGO 19.7. About Microsoft Active Directory 19.8. Configure Kerberos or Microsoft Active Directory Desktop SSO for Web Applications 19.9. Configure SPNEGO Fall Back to Form Authentication 19.10. About SAML Web Browser Based SSO 19.11. Cookie Domain Expand section "19.11. Cookie Domain" Collapse section "19.11. Cookie Domain" 19.11.1. About the Cookie Domain 19.11.2. Configure the Cookie Domain for Single Sign On 20. Development Security References Expand section "20. Development Security References" Collapse section "20. Development Security References" 20.1. EJB Security Parameter Reference 21. Configuration References Expand section "21. Configuration References" Collapse section "21. Configuration References" 21.1. jboss-web.xml Configuration Reference 22. Supplemental References Expand section "22. Supplemental References" Collapse section "22. Supplemental References" 22.1. Types of Java Archives A. Revision History Legal Notice Settings Close Language: 日本語 English Français Language: 日本語 English Français Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 日本語 English Français Language: 日本語 English Français Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Red Hat Training A Red Hat training course is available for Red Hat JBoss Enterprise Application Platform Appendix A. Revision History Revision HistoryRevision 6.4.0-48Thursday November 16 2017Red Hat Customer Content Services Red Hat JBoss Enterprise Application Platform 6.4.0.GA Continuous Release Previous Next