3.2. Changes Dependent on Your Application Architecture and Components

Procedure 3.14. Configure the Application

1. Copy the required Hibernate 3 JARs to your application library.
   You may be able to resolve the issue by copying the specific Hibernate 3 JARs that contain the missing classes into the application's lib/ directory or by adding them to the classpath using some other method. In some cases this may result in ClassCastExceptions or other class loading issues due to the mixed use of the Hibernate versions. If that happens, you need to use the next approach.
2. Instruct the server to use only the Hibernate 3 libraries.
   JBoss EAP 6 allows you to package Hibernate 3.5 (or greater) persistence provider jars with the application. To direct the server to use only the Hibernate 3 libraries and to exclude the Hibernate 4 libraries, you need to set the jboss.as.jpa.providerModule to hibernate3-bundled in the persistence.xml as follows:

   <?xml version="1.0" encoding="UTF-8"?>
   <persistence xmlns="http://java.sun.com/xml/ns/persistence" version="1.0">
       <persistence-unit name="plannerdatasource_pu">
           <description>Hibernate 3 Persistence Unit.</description>
           <jta-data-source>java:jboss/datasources/PlannerDS</jta-data-source>
           <properties>
               <property name="hibernate.show_sql" value="false" />
               <property name="jboss.as.jpa.providerModule" value="hibernate3-bundled" />
           </properties>
       </persistence-unit>
   </persistence>
   

   The Java Persistence API (JPA) deployer will detect the presence of a persistence provider in the application and use the Hibernate 3 libraries. For more information on the JPA persistence properties, refer Section 3.2.2.3, “Persistence Unit Properties”.
3. Disable Hibernate second-level cache.
   Second-level cache for Hibernate 3 does not exhibit the same behavior with JBoss EAP 6 as it did in previous releases. If you are using Hibernate second-level cache with your application, you must disable it until you upgrade to Hibernate 4. To disable second-level cache, set the <hibernate.cache.use_second_level_cache> to false in the persistence.xml file.
4. Replace references to org.jboss.ejb3.entity.ExtendedEntityManager.
   In JBoss EAP 5, the org.jboss.ejb3.entity.ExtendedEntityManager class extended javax.persistence.EntityManager for extended persistence context management. In JBoss EAP 6, this class was replaced with the org.jboss.as.jpa.container.ExtendedEntityManager class. However, it is recommended that you update the code to use the standard Java EE 6 JPA API javax.persistence.EntityManager class instead of the proprietary class.

Procedure 3.15. Update the application to use Hibernate 4

1. The default behavior of autoincrement sequence generator has changed in JBoss EAP 6. For more information, refer Section 3.2.2.5, “Preserve the Existing Behavior of the Hibernate Identity Auto Generated Value”.
2. Determine the version of Hibernate currently used by the application and choose the correct update procedure below.
   • Section 3.2.2.6, “Migrate Your Hibernate 3.3.x Application to Hibernate 4.x”
   • Section 3.2.2.7, “Migrate Your Hibernate 3.5.x Application to Hibernate 4.x”
3. Refer Section 3.2.2.8, “Modify Persistence Properties for Migrated Seam and Hibernate Applications that Run in a Clustered Environment” if you plan to run your application in a clustered environment.

1. Hibernate text types are now mapped to JDBC LONGVARCHAR
   In versions of Hibernate prior to 3.5, text type was mapped to JDBC CLOB. A new Hibernate type, materialized_clob, was added in Hibernate 4 to map Java String properties to JDBC CLOB. If your application has properties configured as type="text" that are intended to be mapped to JDBC CLOB, you must do one of the following:
   1. If your application uses hbm mapping files, change the property to type="materialized_clob".
   2. If your application uses annotations, you should replace @Type(type = "text") with @Lob.
2. Review code to find changes in returned value types
   Numeric aggregate criteria projections now return the same value type as their HQL counterparts. As a result, the return types from the following projections in org.hibernate.criterion have changed.
   1. Due to changes in CountProjection, Projections.rowCount(), Projections.count(propertyName), and Projections.countDistinct(propertyName), the count and count distinct projections now return a Long value.
   2. Due to changes in Projections.sum(propertyName), the sum projections now return a value type that depends on the property type.

      Note

      Failure to modify your application code could result in a java.lang.ClassCastException.
      1. For properties mapped as Long, Short, Integer, or primitive integer types, a Long value is returned;
      2. For properties mapped as Float, Double, or primitive floating point types, a Double value is returned.
3. Update the UserType signatures for the nullSafeGet() and nullSafeSet() methods.
   The signatures for the nullSafeGet() and nullSafeSet() methods in the UserType class changed in Hibernate 4. Any application code that uses these methods must be updated to use the new signatures.
   The following is an example of the method signatures in Hibernate 3.x.

   public Object nullSafeGet(ResultSet rs, String[] names, Object owner) 
       throws HibernateException, SQLException;
   
   public void nullSafeSet(PreparedStatement st, Object value, int index) 
       throws HibernateException, SQLException;

   The following is an example of the new method signatures in Hibernate 4.

   public Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) 
       throws HibernateException, SQLException;
   
   public void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) 
       throws HibernateException, SQLException;

1. AnnotationConfiguration was merged into Configuration
   Although AnnotationConfiguration is now deprecated, it should not affect your migration.
   1. If you are still using an hbm.xml file, you should be aware that JBoss EAP 6 now uses the org.hibernate.cfg.EJB3NamingStrategy in AnnotationConfiguration instead of the org.hibernate.cfg.DefaultNamingStrategy that was used in previous releases. This can result in naming mismatches.
   2. If you rely on the naming strategy to default the name of an association (many-to-many and collections of elements) table, you may see this issue. To resolve it, you can tell Hibernate to use the legacy org.hibernate.cfg.DefaultNamingStrategy by calling Configuration#setNamingStrategy and passing it org.hibernate.cfg.DefaultNamingStrategy#INSTANCE.
2. Modify the namespaces to conform to the new Hibernate DTD file names as noted in the following table.

   Table 3.5. DTD Namespace Mapping Table

   Previous DTD Namespace	New DTD Namespace
   http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd	http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd
   http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd	http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd

3. Modify environment variables.
   1. If you are using Oracle and using the materialized_clob or materialized_blob properties, the global environment variable hibernate.jdbc.use_streams_for_binary must be set to true.
   2. If you are using PostgreSQL and using the CLOB or BLOB properties, the global environment variable hibernate.jdbc.use_streams_for_binary must be set to false.
4. Update the UserType signatures for the nullSafeGet() and nullSafeSet() methods.
   The signatures for the nullSafeGet() and nullSafeSet() methods in the UserType class changed in Hibernate 4. Any application code that uses these methods must be updated to use the new signatures. See Section 3.2.2.6, “Migrate Your Hibernate 3.3.x Application to Hibernate 4.x” for details.

Procedure 3.16. Set persistence properties to run in a clustered environment

1. Set the hibernate.session_factory_name value to a unique name. This name must be unique across all application deployments on the JBoss EAP 6 instance. For example:

   <property name="hibernate.session_factory_name" value="jboss-seam-booking.ear_session_factory"/>
   

2. Set the hibernate.ejb.entitymanager_factory_name value to a unique name. This name must be unique across all application deployments on the JBoss EAP 6 instance. For example:

   <property name="hibernate.ejb.entitymanager_factory_name" value="seam-booking.ear_PersistenceUnitName"/>
   

Procedure 3.17. Modify the persistence.xml file to use Infinispan

1. Configure Infinispan for a JPA application in JBoss EAP 6
   This is an example of how properties to achieve the same configuration for a JPA application using Infinispan in JBoss EAP 6 can be specified:

   <property name="hibernate.cache.use_second_level_cache" value="true"/>
   

   In addition, you need to specify a shared-cache-mode with a value of ENABLE_SELECTIVE or ALL as follows:
   • ENABLE_SELECTIVE is the default and recommended value. It means entities are not cached unless you explicitly mark them as cacheable.

     <shared-cache-mode>ENABLE_SELECTIVE</shared-cache-mode>
     

   • ALL means entities are always cached even if you mark them as not cacheable.

     <shared-cache-mode>ALL</shared-cache-mode>
     

2. Configure Infinispan for a native Hibernate application in JBoss EAP 6
   This is an example of how the same configuration for a native Hibernate application using Infinispan with JBoss EAP 6 can be specified:

   <property name="hibernate.cache.region.factory_class"
        value="org.jboss.as.jpa.hibernate4.infinispan.InfinispanRegionFactory"/>
   <property name="hibernate.cache.infinispan.cachemanager"
        value="java:jboss/infinispan/container/hibernate"/>     
   <property name="hibernate.transaction.jta.platform"
        value="org.hibernate.service.jta.platform.internal.JBossAppServerJtaPlatform"/>
   <property name="hibernate.cache.use_second_level_cache" value="true"/>
   
   

   You must also add the following dependencies to the MANIFEST.MF file:

   Manifest-Version: 1.0
   Dependencies: org.infinispan, org.hibernate
   

Procedure 3.18. You may need to perform one or more of the following tasks

1. Access the default ValidatorFactory
   JBoss EAP 6 binds a default ValidatorFactory to the JNDI context under the name java:comp/ValidatorFactory.
2. Understand life cycle triggered validation
   When used in combination with Hibernate Core 4, life-cycle based validation is automatically enabled by Hibernate Core.
   1. Validation occurs on entity INSERT, UPDATE, and DELETE operations.
   2. You can configure the groups to be validated by event type using the following properties:

      • javax.persistence.validation.group.pre-persist,
      • javax.persistence.validation.group.pre-update, and
      • javax.persistence.validation.group.pre-remove.

      The values of these properties are the comma-separated, fully qualified class names of the groups to validate.
      Validation groups are a new feature of the Bean Validation specification. If you do not want to take advantage of this new feature, no changes are required when you migrate to Hibernate Validator 4.
   3. You can disable life-cycle based validation by setting the javax.persistence.validation.mode property to none. Other valid values for this property are auto (the default), callback and ddl.
3. Configure your application to use manual validation
   1. To manually control validation, you can create a Validator in either of the following ways:

      • Create a Validator instance from the ValidatorFactory using the getValidator() method.
      • Inject Validator instances in your EJB, CDI bean or any other Java EE injectable resource.
   2. You can use the ValidatorContext returned by the ValidatorFactory.usingContext() to customize your Validator instance. Using this API you can configure a custom MessageInterpolator, TraverableResolver and ConstraintValidatorFactory. These interfaces are specified in the Bean Validation specification and are new to Hibernate Validator 4.
4. Modify code to use the new Bean Validation constraints
   The new Bean level validation constraints require code changes when you migrate to Hibernate Validator 4.
   1. To upgrade to Hibernate Validator 4, you must use the constraints in the following packages:

      • javax.validation.constraints
      • org.hibernate.validator.constraints
   2. All constraints that existed in Hibernate Validator 3 are still available in Hibernate Validator 4. To use them, you need to import the specified class, and in some cases, change the name or type of the constraint parameter.
5. Use custom constraints
   In Hibernate Validator 3, a custom constraint needed to implement the org.hibernate.validator.Validator interface. In Hibernate Validator 4, you need to implement the javax.validation.ConstraintValidator interface. This interface contains the same initialize() and isValid() methods as the previous interface, however, the method signature has changed. In addition, DDL alteration is no longer supported in Hibernate Validator 4.
6. The following Hibernate 3.x Validator classes are obsolete.
   1. Replace org.hibernate.validator.NotNull with javax.validation.constraints.NotNull.
   2. Replace org.hibernate.validator.ClassValidator with javax.validation.Validator..
   3. Replace org.hibernate.validator.InvalidValue with javax.validation.Validator..
   For more information, see the Hibernate Valitator Reference Guide.
7. The jboss-ejb3-ext-api-VERSION.jar file removed many of the annotation extension APIs because they are no longer needed in JBoss EAP 6. For example, the org.jboss.ejb3.annotation.IgnoreDependency class is no longer available or needed because JBoss EAP 6 handles the interdependencies automatically.

Procedure 3.19. Configure JBoss EAP to Use Axis

1. You must first disable the web services implementation that ships with JBoss EAP 6. For detailed instructions, see Section 3.2.6.3, “Disable JBossWS in JBoss EAP 6”.
2. Rebuild and deploy the application. The Axis WS API implementation should now access the Java EE 6 API classes correctly.

Procedure 3.20. Disable JBossWS for a Single Deployment

1. Create a jboss-deployment-structure.xml file for your application.
   • If your application is packaged and deployed as a WAR, create the jboss-deployment-structure.xml file in either the META-INF/ or the WEB-INF/ directory of the WAR with the following contents.

     <jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
       <deployment>
         <!-- Exclude webservices subsystem so the implicit dependencies will not be added -->
          <exclude-subsystems>
             <subsystem name="webservices"/>
         </exclude-subsystems>
       </deployment>
     </jboss-deployment-structure>

   • If your application is packaged and deployed in an EAR, create the jboss-deployment-structure.xml file in the META-INF/ directory of the EAR with contents similar to the following example.

     <jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
       ...
       <sub-deployment name="example.war">
         <!-- Exclude webservices subsystem so the implicit dependencies will not be added -->
          <exclude-subsystems>
             <subsystem name="webservices"/>
         </exclude-subsystems>
         <dependencies>
            ...
         </dependencies>
       </sub-deployment>
     </jboss-deployment-structure>
     

2. Deploy the application in the usual manner. JBossWS is now disabled for the application.

Procedure 3.21. Disable JBossWS for All Deployments to the Server

1. Stop the JBoss EAP server.
2. Open the server configuration file for editing. For a standalone server, this is the EAP_HOME/standalone/configuration/standalone.xml file. For a managed domain, this is the EAP_HOME/domain/configuration/domain.xml file.
3. Find the org.jboss.as.webservices extension and either comment it out or remove it.
4. Find the webservices subsystem profile and either comment it out or remove it.
5. The following is an example of the changes maded to a standalone.xml file.

   <?xml version='1.0' encoding='UTF-8'?>
   <server xmlns="urn:jboss:domain:1.7">
     <extensions>
          ...
       <!-- <extension module="org.jboss.as.webservices"/> -->
          ...
     </extensions>
     ...
     <profile>
       <!--
       <subsystem xmlns="urn:jboss:domain:webservices:1.2">
         <modify-wsdl-address>true</modify-wsdl-address>
         <wsdl-host>${jboss.bind.address:127.0.0.1}</wsdl-host>
         <endpoint-config name="Standard-Endpoint-Config"/>
         <endpoint-config name="Recording-Endpoint-Config">
           <pre-handler-chain name="recording-handlers" protocol-bindings="##SOAP11_HTTP ##SOAP11_HTTP_MTOM ##SOAP12_HTTP ##SOAP12_HTTP_MTOM">
   	       <handler name="RecordingHandler" class="org.jboss.ws.common.invocation.RecordingServerHandler"/>
           </pre-handler-chain>
         </endpoint-config>
       	<client-config name="Standard-Client-Config"/>
     	</subsystem>
       -->
     ...
     </profile>
     ...
   </server>

Procedure 3.22. Create a JMS Bridge

1. Configure the Bridge on the Source JBoss EAP 5.x Server
   To avoid conflicts in classes between releases, you must follow these steps to configure the JMS bridge on JBoss EAP 5.x. The names of the SAR directory and bridge are arbitrary and can be changed if you prefer.
   1. Create a subdirectory in the JBoss EAP 5 deployment directory to contain the SAR, for example: EAP5_HOME/server/PROFILE_NAME/deploy/myBridge.sar/.
   2. Create a subdirectory named META-INF in EAP5_HOME/server/PROFILE_NAME/deploy/myBridge.sar/.
   3. Create a jboss-service.xml file in the EAP5_HOME/server/PROFILE_NAME/deploy/myBridge.sar/META-INF/ directory. It should contain information similar to the following example.

      <server>
         <loader-repository>
            com.example:archive=unique-archive-name
            <loader-repository-config>java2ParentDelegation=false</loader-repository-config>
         </loader-repository> 
      
         <!-- JBoss EAP 6 JMS Provider --> 
         <mbean code="org.jboss.jms.jndi.JMSProviderLoader" name="jboss.messaging:service=JMSProviderLoader,name=EnterpriseApplicationPlatform6JMSProvider">
            <attribute name="ProviderName">EnterpriseApplicationPlatform6JMSProvider</attribute>
            <attribute name="ProviderAdapterClass">org.jboss.jms.jndi.JNDIProviderAdapter</attribute>
            <attribute name="FactoryRef">jms/RemoteConnectionFactory</attribute> 
            <attribute name="QueueFactoryRef">jms/RemoteConnectionFactory</attribute>  
            <attribute name="TopicFactoryRef">jms/RemoteConnectionFactory</attribute>      
            <attribute name="Properties">
               java.naming.factory.initial=org.jboss.naming.remote.client.InitialContextFactory
               java.naming.provider.url=remote://EnterpriseApplicationPlatform6host:4447
               java.naming.security.principal=jbossuser
               java.naming.security.credentials=jbosspass
            </attribute>
         </mbean> 
      
         <mbean code="org.jboss.jms.server.bridge.BridgeService" name="jboss.jms:service=Bridge,name=MyBridgeName" xmbean-dd="xmdesc/Bridge-xmbean.xml">      
            <depends optional-attribute-name="SourceProviderLoader">jboss.messaging:service=JMSProviderLoader,name=JMSProvider</depends>          
            <depends optional-attribute-name="TargetProviderLoader">jboss.messaging:service=JMSProviderLoader,name=EnterpriseApplicationPlatform6JMSProvider</depends>          
            <attribute name="SourceDestinationLookup">/queue/A</attribute>      
            <attribute name="TargetDestinationLookup">jms/queue/test</attribute>       
            <attribute name="QualityOfServiceMode">1</attribute>           
            <attribute name="MaxBatchSize">1</attribute>      
            <attribute name="MaxBatchTime">-1</attribute>           
            <attribute name="FailureRetryInterval">60000</attribute>      
            <attribute name="MaxRetries">-1</attribute>      
            <attribute name="AddMessageIDInHeader">false</attribute>
            <attribute name="TargetUsername">jbossuser</attribute>
            <attribute name="TargetPassword">jbosspass</attribute>
         </mbean>
      </server>
      
      

      Note

      The load-repository element is present to ensure the SAR has an isolated class loader. Also note both the JNDI look-up and the bridge "target" include security credentials for user "jbossuser" with password "jbosspass". This is because JBoss EAP 6 is secured by default. The user named "jbossuser" with password "jbosspass" was created in the ApplicationRealm with the guest role using the EAP_HOME/bin/add_user.sh script.
   4. Copy the following JARs from the EAP_HOME/modules/system/layers/base/ directory into the EAP5_HOME/server/PROFILE_NAME/deploy/myBridge.sar/ directory. Replace each VERSION_NUMBER with the actual version number in your JBoss EAP 6 distribution.

      • org/hornetq/main/hornetq-core-VERSION_NUMBER.jar
      • org/hornetq/main/hornetq-jms-VERSION_NUMBER.jar
      • org/jboss/ejb-client/main/jboss-ejb-client-VERSION_NUMBER.jar
      • org/jboss/logging/main/jboss-logging-VERSION_NUMBER.jar
      • org/jboss/logmanager/main/jboss-logmanager-VERSION_NUMBER.jar
      • org/jboss/marshalling/main/jboss-marshalling-VERSION_NUMBER.jar
      • org/jboss/marshalling/river/main/jboss-marshalling-river-VERSION_NUMBER.jar
      • org/jboss/remote-naming/main/jboss-remote-naming-VERSION_NUMBER.jar
      • org/jboss/remoting3/main/jboss-remoting-VERSION_NUMBER.jar
      • org/jboss/sasl/main/jboss-sasl-VERSION_NUMBER.jar
      • org/jboss/netty/main/netty-VERSION_NUMBER.jar
      • org/jboss/remoting3/remote-jmx/main/remoting-jmx-VERSION_NUMBER.jar
      • org/jboss/xnio/main/xnio-api-VERSION_NUMBER.jar
      • org/jboss/xnio/nio/main.xnio-nio-VERSION_NUMBER.jar

      Note

      Do not simply copy the EAP_HOME/bin/client/jboss-client.jar because the javax API classes will conflict with those in JBoss EAP 5.x.
2. Configure the Bridge on the Destination JBoss EAP 6 Server
   In JBoss EAP 6.1 and later, the JMS bridge can be used to bridge messages from any JMS 1.1 compliant server. Because the source and target JMS resources are looked up using JNDI, the JNDI lookup classes of the source messaging provider, or message broker, must be bundled in a JBoss Module. The following steps use the fictitious 'MyCustomMQ' message broker as an example.
   1. Create the JBoss module for the messaging provider.
      1. Create a directory structure under EAP_HOME/modules/system/layers/base/ for the new module. The main/ subdirectory will contain the client JARs and module.xml file. The following is an example of the directory structure created for the MyCustomMQ messaging provider: EAP_HOME/modules/system/layers/base/org/mycustommq/main/
      2. In the main/ subdirectory, create a module.xml file containing the module definition for the messaging provider. The following is an example of the module.xml created for the MyCustomMQ messaging provider.

         <?xml version="1.0" encoding="UTF-8"?>
         <module xmlns="urn:jboss:module:1.1" name="org.mycustommq">
             <properties>
                 <property name="jboss.api" value="private"/>
             </properties> 
         
             <resources>
                 <!-- Insert resources required to connect to the source or target   -->
                 <resource-root path="mycustommq-1.2.3.jar" />
                 <resource-root path="mylogapi-0.0.1.jar" />
             </resources> 
         
             <dependencies>
                <!-- Add the dependencies required by JMS Bridge code                 -->
                <module name="javax.api" />
                <module name="javax.jms.api" />
                <module name="javax.transaction.api"/>
                <!-- Add a dependency on the org.hornetq module since we send         -->
                <!-- messages tothe HornetQ server embedded in the local EAP instance -->
                <module name="org.hornetq" />
             </dependencies>
         </module>
         

      3. Copy the messaging provider JARs required for the JNDI lookup of the source resources to the module's main/ subdirectory. The directory structure for the MyCustomMQ module should now look like the following.

         modules/
         `-- system
             `-- layers
                 `-- base
                     `-- org
                           `-- mycustommq
                               `-- main
                                   |-- mycustommq-1.2.3.jar
                                   |-- mylogapi-0.0.1.jar
                                   |-- module.xml
         

   2. Configure the JMS bridge in the messaging subsystem of the JBoss EAP 6 server.
      1. Before you begin, stop the server and back up the current server configuration files. If you are running a standalone server, this is the EAP_HOME/standalone/configuration/standalone-full-ha.xml file. If you are running a managed domain, back up both the EAP_HOME/domain/configuration/domain.xml and the EAP_HOME/domain/configuration/host.xml files.
      2. Add the jms-bridge element to the messaging subsystem in the server configuration file. The source and target elements provide the names of the JMS resources used for JNDI lookups. If user and password credentials are specified, they are passed as arguments when JMS connection is created.
         The following is an example of the jms-bridge element configured for the MyCustomMQ messaging provider:

         <subsystem xmlns="urn:jboss:domain:messaging:1.3">
            ...
            <jms-bridge name="myBridge" module="org.mycustommq">
               <source>
                  <connection-factory name="ConnectionFactory"/>
                  <destination name="sourceQ"/>
                  <user>user1</user>
                  <password>pwd1</password>
                  <context>
                     <property key="java.naming.factory.initial" value="org.mycustommq.jndi.MyCustomMQInitialContextFactory"/>
                     <property key="java.naming.provider.url"    value="tcp://127.0.0.1:9292"/>
                  </context>
               </source>
               <target>
                  <connection-factory name="java:/ConnectionFactory"/>
                  <destination name="/jms/targetQ"/>
               </target>
               <quality-of-service>DUPLICATES_OK</quality-of-service>
               <failure-retry-interval>500</failure-retry-interval>
               <max-retries>1</max-retries>
               <max-batch-size>500</max-batch-size>
               <max-batch-time>500</max-batch-time>
               <add-messageID-in-header>true</add-messageID-in-header>
            </jms-bridge>
         </subsystem>
         

         In the above example, the JNDI properties are defined in the context element for the source. If the context element is omitted, as in the target example above, the JMS resources are looked up in the local instance.

Procedure 3.23. Change Your Provider to HornetQ

1. Transfer configurations.
   Transfer the existing JBoss Messaging configurations to the JBoss EAP 6 configuration. The following configurations can be found in deployment descriptors located on the JBoss Messaging server:
   • Connection Factories Service Configuration
     This configuration describes the JMS connection factories deployed with the JBoss Messaging server. JBoss Messaging configures connection factories in a file named connection-factories-service.xml which is located in the deployment directory of the application server.
   • Destination Configuration
     This configuration describes JMS queues and topics deployed with JBoss Messaging server. By default, JBoss Messaging configures destinations in a file named destinations-service.xml which is located in the deployment directory of the application server.
   • Message Bridge Service Configuration
     This configuration includes bridge services deployed with JBoss Messaging server. No bridges are deployed by default so the name of the deployment file varies depending on your JBoss Messaging installation.
2. Modify your application code.
   If the application code uses standard JMS, no code changes are required. However, you must modify the application to use the new standardized JNDI namespaces as described in the section Section 3.1.8.2, “Portable EJB JNDI Names”. If the application uses features specific to JBoss Messaging, you must modify the code to use the equivalent features available in HornetQ.
   The following is an example of a JMS client that creates the InitialContext and looks up a queue in JBoss EAP 6.

   Hashtable<String, String> env = new Hashtable<String, String>();
   String providerUrl = "remote:" + host + ":" + port;
   env.put(Context.URL_PKG_PREFIXES, "org.jboss.ejb.client.naming");
   env.put("java.naming.factory.initial", "org.jboss.naming.remote.client.InitialContextFactory");
   env.put("java.naming.provider.url", providerUrl);
   env.put(Context.SECURITY_PRINCIPAL, user);
   env.put(Context.SECURITY_CREDENTIALS, pass);
   InitialContext context = new InitialContext(env);
   Queue myTestQueue = (Queue) context.lookup("jms/queue/myTestQueue");
   

   If the application will be connecting to a cluster, you must carefully review the HornetQ documentation on clustering semantics. Clustering is outside the scope of the JMS specification and HornetQ and JBoss Messaging have taken substantially different approaches in their respective implementations of clustering functionality.
   For more information on how to configure messaging with HornetQ, see: Section 3.2.9.5, “Configure Messaging with HornetQ”
3. Migrate existing messages.
   Move any messages in the JBoss Messaging database to the HornetQ journal using a JMS bridge. Instructions for configuring the JMS bridge can be found here: Section 3.2.9.2, “Configure a JMS Bridge to Migrate Existing JMS Messages to JBoss EAP 6”.

1. Start JBoss EAP 6 with clustering enabled

   To enable clustering in JBoss EAP 5.x, you needed to start your server instances using the all profile or some derivation of it, like this:

   $ EAP5_HOME/bin/run.sh -c all

   In JBoss EAP 6, the method for enabling clustering depends on whether the servers are standalone or running in a managed domain.

   1. Enable clustering for servers running in a managed domain

      To enable clustering for servers started using the domain controller, update your domain.xml and designate a server group to use the ha profile and ha-sockets socket binding group. For example:

      <server-groups>
        <server-group name="main-server-group" profile="ha">
          <jvm name="default">
            <heap size="64m" max-size="512m"/>
          </jvm>
          <socket-binding-group ref="ha-sockets"/>
        </server-group>
      </server-group>

   2. Enable clustering for standalone servers

      To enable clustering for standalone servers, start the server using the appropriate configuration file as follows:

      $ EAP_HOME/bin/standalone.sh --server-config=standalone-ha.xml -Djboss.node.name=UNIQUE_NODE_NAME

2. Specify the bind address

   In JBoss EAP 5.x, you would typically indicate the bind address used for clustering using the -b command line argument like this:

   $ EAP5_HOME/bin/run.sh -c all -b 192.168.0.2

   JBoss EAP 6 binds sockets to the IP addresses and interfaces contained in the <interfaces> elements in standalone.xml, domain.xml and host.xml files. The standard configurations that ship with JBoss EAP include two interface configurations:

   <interfaces>
       <interface name="management">
           <inet-address value="${jboss.bind.address.management:127.0.0.1}"/>
       </interface>
       <interface name="public">
          <inet-address value="${jboss.bind.address:127.0.0.1}"/>
       </interface>
   </interfaces>

   These interface configurations use the values of the system properties jboss.bind.address.management and jboss.bind.address. If these system properties are not set, the default 127.0.0.1 is used for each value.
   You can also specify the bind address as a command line argument when you start the server or you can explicitly define it within the JBoss EAP 6 server configuration file.
   • Specify the bind argument on the command line when you start the JBoss EAP standalone server.
     The following is an example of how to specify the bind address on the command line for a standalone server:

     EAP_HOME/bin/standalone.sh -Djboss.bind.address=127.0.0.1

     Note

     You can also use the -b argument, which is a shortcut for -Djboss.bind.address=127.0.0.1:

     EAP_HOME/bin/standalone.sh -b=127.0.0.1

     The JBoss EAP 5 syntax format is also still supported:

     EAP_HOME/bin/standalone.sh -b 127.0.0.1

     Note that the -b argument only changes the public interface. It does not affect the management interface.
   • Specify the bind address in the server configuration file.
     For servers running in a managed domain, specify the bind addresses in the domain/configuration/host.xml file. For standalone servers, specify the bind addresses in the standalone-ha.xml file.
     In the following example, the public interface is specified as the default interface for all sockets within the ha-sockets socket binding group.

     <interfaces>
       <interface name="management">
         <inet-address value="192.168.0.2"/>
       </interface>
       <interface name="public">
         <inet-address value="192.168.0.2"/>
       </interface>
     </interfaces>

     <socket-binding-groups>
       <socket-binding-group name="ha-sockets" default-interface="public">
         <!-- ... -->
       </socket-binding-group>
     </socket-binding-groups>

     Note

     If you specify the bind address as a hard-coded value rather than a system property in the configuration file, you can not override it with a command line argument.

3. Configure jvmRoute to support mod_jk and mod_proxy

   In JBoss EAP 5, the web server jvmRoute was configured using a property in the server.xml file. In JBoss EAP 6, the jvmRoute attribute is configured in the web subsystem of the server configuration file using the instance-id attribute as follows:

   <subsystem xmlns="urn:jboss:domain:web:1.1" default-virtual-server="default-host" native="false" instance-id="{JVM_ROUTE_SERVER}">
   

   The {JVM_ROUTE_SERVER} above should be replaced by the jvmRoute server ID.
   The instance-id can also be set using the Management Console.

4. Specify the multicast address and port

   In JBoss EAP 5.x, you could specify the multicast address and port used for intra-cluster communication using the command line arguments -u and -m, respectively, like this:

   $ EAP5_HOME/bin/run.sh -c all -u 228.11.11.11 -m 45688

   In JBoss EAP 6, the multicast address and port used for intra-cluster communication are defined by the socket-binding referenced by the relevant JGroups protocol stack as follows:

   <subsystem xmlns="urn:jboss:domain:jgroups:1.0" default-stack="udp">
       <stack name="udp">
           <transport type="UDP" socket-binding="jgroups-udp"/>
           <!-- ... -->
       </stack>
   </subsystem>

   <socket-binding-groups>
       <socket-binding-group name="ha-sockets" default-interface="public">
           <!-- ... -->
           <socket-binding name="jgroups-udp" port="55200" multicast-address="228.11.11.11" multicast-port="45688"/>
           <!-- ... -->
       </socket-binding-group>
   </socket-binding-groups>
   

   If you prefer to specify the multicast address and port in the command line, you can define the multicast address and ports as system properties and then use those properties on the command line when you start the server. In the following example, jboss.mcast.addr is the variable name for the multicast address and jboss.mcast.port is the variable name for the port.

   <socket-binding name="jgroups-udp" port="55200"
    multicast-address="${jboss.mcast.addr:230.0.0.4}" multicast-port="${jboss.mcast.port:45688}"/>
   

   You can then start your server using the following command line arguments:

   $ EAP_HOME/bin/domain.sh -Djboss.mcast.addr=228.11.11.11 -Djboss.mcast.port=45688

5. Use an alternate protocol stack

   In JBoss EAP 5.x, you could manipulate the default protocol stack used for all clustering services using the jboss.default.jgroups.stack system property.

   $ EAP5_HOME/bin/run.sh -c all -Djboss.default.jgroups.stack=tcp

   In JBoss EAP 6, the default protocol stack is defined by the JGroups subsystem within domain.xml or standalone-ha.xml:

   <subsystem xmlns="urn:jboss:domain:jgroups:1.0" default-stack="udp">
       <stack name="udp">
           <!-- ... -->
       </stack>
   </subsystem>

6. Replace Buddy Replication

   JBoss EAP 5.x used JBoss Cache Buddy Replication to suppress replication of data to all instances in a cluster.
   In JBoss EAP 6, Buddy Replication has been replaced by Infinispan's distributed cache, also known as DIST mode. Distribution is a powerful clustering mode which allows Infinispan to scale linearly as more servers are added to the cluster. The following is an example of how to configure the server to use the DIST caching mode.
   1. Open a command line and start the server with either the HA or Full Profile, for example:

      EAP_HOME/bin/standalone.sh -c standalone-ha.xml

   2. Open another command line and connect to the Management CLI.
      • For Linux, enter the following at the command line:

        $ EAP_HOME/bin/jboss-cli.sh --connect
        

      • For Windows, enter the following at a command line:

        C:\>EAP_HOME\bin\jboss-cli.bat --connect
        

      You should see the following response:

      Connected to standalone controller at localhost:9999

   3. Issue the following commands to configure the cache tell the server to reload the new configuration:

      /subsystem=infinispan/cache-container=web/:write-attribute(name=default-cache,value=dist)
      /subsystem=infinispan/cache-container=web/distributed-cache=dist/:write-attribute(name=owners,value=3)
      reload
      

      You should see the following response after each command:

      "outcome" => "success"
      

      These commands modify the dist <distributed-cache> element in the web <cache-container> configuration in the infinispan subsystem of the standalone-ha.xml file as follows:

      <cache-container name="web" aliases="standard-session-cache" default-cache="dist" module="org.jboss.as.clustering.web.infinispan">
          <transport lock-timeout="60000"/>
          <replicated-cache name="repl" mode="ASYNC" batching="true">
              <file-store/>
          </replicated-cache>
          <replicated-cache name="sso" mode="SYNC" batching="true"/>
          <distributed-cache name="dist" owners="3" l1-lifespan="0" mode="ASYNC" batching="true">
              <file-store/>
          </distributed-cache>
      </cache-container>
      

      For more information, see the chapter entitled Clustering in Web Applications in the Development Guide for JBoss EAP 6 located on the Customer Portal at https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/?version=6.4.

Procedure 3.24. Implement an HA Singleton Service

1. Write the HA singleton service application.
   The following is a simple example of a Service that is wrapped with the SingletonService decorator to be deployed as a singleton service. A complete example can be found in the cluster-ha-singleton quickstart that ships with Red Hat JBoss Enterprise Application Platform 6. This quickstart contains all the instructions to build and deploy the application.
   1. Create a service.
      The following listing is an example of a service:

      package org.jboss.as.quickstarts.cluster.hasingleton.service.ejb;
      
      import java.util.Date;
      import java.util.concurrent.atomic.AtomicBoolean;
      
      import javax.naming.InitialContext;
      import javax.naming.NamingException;
      
      import org.jboss.logging.Logger;
      import org.jboss.msc.service.Service;
      import org.jboss.msc.service.ServiceName;
      import org.jboss.msc.service.StartContext;
      import org.jboss.msc.service.StartException;
      import org.jboss.msc.service.StopContext;
      
      
      /**
       * @author <a href="mailto:wfink@redhat.com">Wolf-Dieter Fink</a>
       */
      public class HATimerService implements Service<String> {
          private static final Logger LOGGER = Logger.getLogger(HATimerService.class);
          public static final ServiceName SINGLETON_SERVICE_NAME = ServiceName.JBOSS.append("quickstart", "ha", "singleton", "timer");
      
          /**
           * A flag whether the service is started.
           */
          private final AtomicBoolean started = new AtomicBoolean(false);
      
          /**
           * @return the name of the server node
           */
          public String getValue() throws IllegalStateException, IllegalArgumentException {
              LOGGER.infof("%s is %s at %s", HATimerService.class.getSimpleName(), (started.get() ? "started" : "not started"), System.getProperty("jboss.node.name"));
              return "";
          }
      
          public void start(StartContext arg0) throws StartException {
              if (!started.compareAndSet(false, true)) {
                  throw new StartException("The service is still started!");
              }
              LOGGER.info("Start HASingleton timer service '" + this.getClass().getName() + "'");
      
              final String node = System.getProperty("jboss.node.name");
              try {
                  InitialContext ic = new InitialContext();
                  ((Scheduler) ic.lookup("global/jboss-cluster-ha-singleton-service/SchedulerBean!org.jboss.as.quickstarts.cluster.hasingleton.service.ejb.Scheduler")).initialize("HASingleton timer @" + node + " " + new Date());
              } catch (NamingException e) {
                  throw new StartException("Could not initialize timer", e);
              }
          }
      
          public void stop(StopContext arg0) {
              if (!started.compareAndSet(true, false)) {
                  LOGGER.warn("The service '" + this.getClass().getName() + "' is not active!");
              } else {
                  LOGGER.info("Stop HASingleton timer service '" + this.getClass().getName() + "'");
                  try {
                      InitialContext ic = new InitialContext();
                      ((Scheduler) ic.lookup("global/jboss-cluster-ha-singleton-service/SchedulerBean!org.jboss.as.quickstarts.cluster.hasingleton.service.ejb.Scheduler")).stop();
                  } catch (NamingException e) {
                      LOGGER.error("Could not stop timer", e);
                  }
              }
          }
      }
      

   2. Create an activator that installs the Service as a clustered singleton.
      The following listing is an example of a Service activator that installs the HATimerService as a clustered singleton service:

      package org.jboss.as.quickstarts.cluster.hasingleton.service.ejb;
      
      import org.jboss.as.clustering.singleton.SingletonService;
      import org.jboss.logging.Logger;
      import org.jboss.msc.service.DelegatingServiceContainer;
      import org.jboss.msc.service.ServiceActivator;
      import org.jboss.msc.service.ServiceActivatorContext;
      import org.jboss.msc.service.ServiceController;
      
      
      /**
       * Service activator that installs the HATimerService as a clustered singleton service
       * during deployment.
       *
       * @author Paul Ferraro
       */
      public class HATimerServiceActivator implements ServiceActivator {
          private final Logger log = Logger.getLogger(this.getClass());
      
          @Override
          public void activate(ServiceActivatorContext context) {
              log.info("HATimerService will be installed!");
      
              HATimerService service = new HATimerService();
              SingletonService<String> singleton = new SingletonService<String>(service, HATimerService.SINGLETON_SERVICE_NAME);
              /*
               * To pass a chain of election policies to the singleton, for example, 
               * to tell JGroups to prefer running the singleton on a node with a
               * particular name, uncomment the following line:
               */
              // singleton.setElectionPolicy(new PreferredSingletonElectionPolicy(new SimpleSingletonElectionPolicy(), new NamePreference("node1/singleton")));
      
              singleton.build(new DelegatingServiceContainer(context.getServiceTarget(), context.getServiceRegistry()))
                      .setInitialMode(ServiceController.Mode.ACTIVE)
                      .install()
              ;
          }
      }
      

      Note

      The above code example uses a class, org.jboss.as.clustering.singleton.SingletonService, that is part of the JBoss EAP private API. A public API will become available in the JBoss EAP 7 release and the private class will be deprecated, but these classes will be maintained and available for the duration of the JBoss EAP 6.x release cycle.
   3. Create a ServiceActivator File
      Create a file named org.jboss.msc.service.ServiceActivator in the application's resources/META-INF/services/ directory. Add a line containing the fully qualified name of the ServiceActivator class created in the previous step.

      org.jboss.as.quickstarts.cluster.hasingleton.service.ejb.HATimerServiceActivator 

   4. Create a Singleton bean that implements a timer to be used as a cluster-wide singleton timer.
      This Singleton bean must not have a remote interface and you must not reference its local interface from another EJB in any application. This prevents a lookup by a client or other component and ensures the SingletonService has total control of the Singleton.
      1. Create the Scheduler interface

         package org.jboss.as.quickstarts.cluster.hasingleton.service.ejb;
         
         /**
          * @author <a href="mailto:wfink@redhat.com">Wolf-Dieter Fink</a>
          */
         public interface Scheduler {
         
             void initialize(String info);
         
             void stop();
         
         }
         

      2. Create the Singleton bean that implements the cluster-wide singleton timer.

         package org.jboss.as.quickstarts.cluster.hasingleton.service.ejb;
         
         import javax.annotation.Resource;
         import javax.ejb.ScheduleExpression;
         import javax.ejb.Singleton;
         import javax.ejb.Timeout;
         import javax.ejb.Timer;
         import javax.ejb.TimerConfig;
         import javax.ejb.TimerService;
         
         import org.jboss.logging.Logger;
         
         
         /**
          * A simple example to demonstrate a implementation of a cluster-wide singleton timer.
          *
          * @author <a href="mailto:wfink@redhat.com">Wolf-Dieter Fink</a>
          */
         @Singleton
         public class SchedulerBean implements Scheduler {
             private static Logger LOGGER = Logger.getLogger(SchedulerBean.class);
             @Resource
             private TimerService timerService;
         
             @Timeout
             public void scheduler(Timer timer) {
                 LOGGER.info("HASingletonTimer: Info=" + timer.getInfo());
             }
         
             @Override
             public void initialize(String info) {
                 ScheduleExpression sexpr = new ScheduleExpression();
                 // set schedule to every 10 seconds for demonstration
                 sexpr.hour("*").minute("*").second("0/10");
                 // persistent must be false because the timer is started by the HASingleton service
                 timerService.createCalendarTimer(sexpr, new TimerConfig(info, false));
             }
         
             @Override
             public void stop() {
                 LOGGER.info("Stop all existing HASingleton timers");
                 for (Timer timer : timerService.getTimers()) {
                     LOGGER.trace("Stop HASingleton timer: " + timer.getInfo());
                     timer.cancel();
                 }
             }
         }
         

2. Start each JBoss EAP 6 instance with clustering enabled.
   To enable clustering for standalone servers, you must start each server with the HA profile, using a unique node name and port offset for each instance.
   • For Linux, use the following command syntax to start the servers:

     EAP_HOME/bin/standalone.sh --server-config=standalone-ha.xml -Djboss.node.name=UNIQUE_NODE_NAME -Djboss.socket.binding.port-offset=PORT_OFFSET

     Example 3.6. Start multiple standalone servers on Linux

     $ EAP_HOME/bin/standalone.sh --server-config=standalone-ha.xml -Djboss.node.name=node1
     $ EAP_HOME/bin/standalone.sh --server-config=standalone-ha.xml -Djboss.node.name=node2 -Djboss.socket.binding.port-offset=100

   • For Microsoft Windows, use the following command syntax to start the servers:

     EAP_HOME\bin\standalone.bat --server-config=standalone-ha.xml -Djboss.node.name=UNIQUE_NODE_NAME -Djboss.socket.binding.port-offset=PORT_OFFSET

     Example 3.7. Start multiple standalone servers on Microsoft Windows

     C:> EAP_HOME\bin\standalone.bat --server-config=standalone-ha.xml -Djboss.node.name=node1
     C:> EAP_HOME\bin\standalone.bat --server-config=standalone-ha.xml -Djboss.node.name=node2 -Djboss.socket.binding.port-offset=100

   Note

   If you prefer not to use command line arguments, you can configure the standalone-ha.xml file for each server instance to bind on a separate interface.
3. Deploy the application to the servers
   The following Maven command deploys the application to a standalone server running on the default ports.

   mvn clean install jboss-as:deploy

   To deploy to additional servers, pass the server name. if it is on a different host, pass the host name and port number on the command line:

   mvn clean package jboss-as:deploy -Djboss-as.hostname=localhost -Djboss-as.port=10099

   See the cluster-ha-singleton quickstart that ships with JBoss EAP 6 for Maven configuration and deployment details.

Procedure 3.25. Add Maven Project Configuration for Remote Invocation of Session Beans

1. Add the required project dependencies
   The pom.xml for the project must be updated to include the necessary dependencies.
2. Add the jboss-ejb-client.properties file
   The JBoss EJB client API expects to find a file in the root of the project named jboss-ejb-client.properties that contains the connection information for the JNDI service. Add this file to the src/main/resources/ directory of your project with the following content.

   # In the following line, set SSL_ENABLED to true for SSL
   remote.connectionprovider.create.options.org.xnio.Options.SSL_ENABLED=false
   remote.connections=default
   # Uncomment the following line to set SSL_STARTTLS to true for SSL
   # remote.connection.default.connect.options.org.xnio.Options.SSL_STARTTLS=true
   remote.connection.default.host=localhost
   remote.connection.default.port = 4447
   remote.connection.default.connect.options.org.xnio.Options.SASL_POLICY_NOANONYMOUS=false
   # Add any of the following SASL options if required
   # remote.connection.default.connect.options.org.xnio.Options.SASL_POLICY_NOANONYMOUS=false
   # remote.connection.default.connect.options.org.xnio.Options.SASL_POLICY_NOPLAINTEXT=false
   # remote.connection.default.connect.options.org.xnio.Options.SASL_DISALLOWED_MECHANISMS=JBOSS-LOCAL-USER
   

   Change the host name and port to match your server. 4447 is the default port number. For a secure connection, set the SSL_ENABLED line to true and uncomment the SSL_STARTTLS line. The Remoting interface in the container supports secured and unsecured connections using the same port.
3. Add dependencies for the remote business interfaces
   Add the Maven dependencies to the pom.xml for the remote business interfaces of the session beans.

   <dependency>
      <groupId>org.jboss.as.quickstarts</groupId>
      <artifactId>jboss-ejb-remote-server-side</artifactId>
      <type>ejb-client</type>
      <version>${project.version}</version>
   </dependency>

Procedure 3.26. Obtain a Bean Proxy using JNDI and Invoke Methods of the Bean

1. Handle checked exceptions
   Two of the methods used in the following code (InitialContext() and lookup()) have a checked exception of type javax.naming.NamingException. These method calls must either be enclosed in a try/catch block that catches NamingException or in a method that is declared to throw NamingException. The ejb-remote quickstart uses the second technique.
2. Create a JNDI Context
   A JNDI Context object provides the mechanism for requesting resources from the server. Create a JNDI context using the following code:

   final Hashtable jndiProperties = new Hashtable();
   jndiProperties.put(Context.URL_PKG_PREFIXES, "org.jboss.ejb.client.naming");
   final Context context = new InitialContext(jndiProperties);

   The connection properties for the JNDI service are read from the jboss-ejb-client.properties file.
3. Use the JNDI Context's lookup() method to obtain a bean proxy
   Invoke the lookup() method of the bean proxy and pass it the JNDI name of the session bean you require. This will return an object that must be cast to the type of the remote business interface that contains the methods you want to invoke.

   
   final RemoteCalculator statelessRemoteCalculator = (RemoteCalculator) context.lookup(
       "ejb:/jboss-ejb-remote-server-side//CalculatorBean!" + 
       RemoteCalculator.class.getName());
   

   Session bean JNDI names are defined using a special syntax. For more information, see Section 3.2.12.3, “EJB JNDI Naming Reference” .
4. Invoke methods
   Now that you have a proxy bean object you can invoke any of the methods contained in the remote business interface.

   int a = 204;
   int b = 340;
   System.out.println("Adding " + a + " and " + b + " via the remote stateless calculator deployed on the server");
   int sum = statelessRemoteCalculator.add(a, b);
   System.out.println("Remote calculator returned sum = " + sum);

   The proxy bean passes the method invocation request to the session bean on the server, where it is executed. The result is returned to the proxy bean which then returns it to the caller. The communication between the proxy bean and the remote session bean is transparent to the caller.

Procedure 3.27. Create the Asynchronous Session Bean and Client

1. Create the Asynchronous session bean method.
   In the following example, the sayHelloAsync() method is marked as asynchronous using the @Asynchronous annotation. It returns the required Future class implementation with a result of type String.

   import javax.ejb.Remote;
   import javax.ejb.SessionContext;
   import javax.ejb.Stateless;
   import javax.ejb.TransactionAttribute;
   import javax.ejb.TransactionAttributeType;
   import javax.interceptor.Interceptors;
   
   import java.util.concurrent.Future;
   import javax.ejb.AsyncResult;
   import javax.ejb.Asynchronous;
   
   @Stateless(name="Hello")
   @Remote(Hello.class)
   public class HelloBean implements Hello {
   
       @Asynchronous
       public Future<String> sayHelloAsync() {
          return new AsyncResult<String>("Hello");
       }
   }

2. Create the client code.
   Look up the EJB and call its asynchronous method using one of the available Future.get() methods. The following example limits the wait time to the values specified by the timeout and unit arguments.

   Future<String> future = ejbObject.sayHelloAsync();
   String response = future.get(timeout, unit);

Procedure 3.28. Configure Stateful EJB Cache

1. Find the <caches> element in the ejb3 subsystem of the server configuration file. Add a <cache> element. The following example creates a cache named "my=cache".

   <cache name="my-cache" passivation-store-ref="my-cache-file" aliases="my-custom-cache"/>

2. Find the <passivation-stores> element in the ejb3 subsystem of the server configuration file. Create a <file-passivation-store> for the cache defined in the previous step.

   <file-passivation-store name="my-cache-file" idle-timeout="1260" idle-timeout-unit="SECONDS" max-size="200"/>

3. The ejb3 subsystem configuration should now look like the following example.

   <subsystem xmlns="urn:jboss:domain:ejb3:1.4">
     ...
     <caches>
       <cache name="simple" aliases="NoPassivationCache"/>
       <cache name="passivating" passivation-store-ref="file" aliases="SimpleStatefulCache"/>  
       <cache name="clustered" passivation-store-ref="infinispan" aliases="StatefulTreeCache"/>  
       <cache name="my-cache" passivation-store-ref="my-cache-file" aliases="my-custom-cache"/>               
     </caches>
     <passivation-stores>
       <file-passivation-store name="file" idle-timeout="120" idle-timeout-unit="SECONDS" max-size="500"/>
       <cluster-passivation-store name="infinispan" cache-container="ejb"/>
       <file-passivation-store name="my-cache-file" idle-timeout="1260" idle-timeout-unit="SECONDS" max-size="200"/>
     </passivation-stores>
     ...
   </subsystem>

   The passivating cache, "my-cache", passivates stateful session beans to the file system as configured in the "my-cache-file" passivation store, which has the idle-timeout, idle-timeout-unit and max-size options.
4. Create a jboss-ejb3.xml file in the EJB JAR META-INF/ directory. The following example configures the EJBs to use the cache defined in the previous steps.

   <jboss:ejb-jar xmlns:jboss="http://www.jboss.com/xml/ns/javaee"
         xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:c="urn:ejb-cache:1.0"
         xsi:schemaLocation="http://www.jboss.com/xml/ns/javaee http://www.jboss.org/j2ee/schema/jboss-ejb3-2_0.xsd http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/ejb-jar_3_1.xsd"
         version="3.1"
         impl-version="2.0">
     <assembly-descriptor>
       <c:cache>
         <ejb-name>*</ejb-name>
         <c:cache-ref>my-cache</c:cache-ref>
       </c:cache>
     </assembly-descriptor>
   </jboss:ejb-jar>

5. To method to configure a timeout value depends on whether you are implementing EJB 2 or EJB 3.
   • EJB 3 introduced annotations, so you can specify the javax.ejb.StatefulTimeout annotation in the EJB code as follows.

     @StatefulTimeout(value = 1320, unit=java.util.concurrent.TimeUnit.SECONDS) 
     @Stateful
     @Remote(MyStatefulEJBRemote.class)
     public class MyStatefulEJB implements MyStatefulEJBRemote {
       ...
     }

     The @StatefulTimeout value can be set to one of the following.

     • A value of 0 means the bean is immediately eligible for removal.
     • A value greater than 0 indicates a timeout value in the units specified by the unit parameter. The default timeout unit is MINUTES. If you are using a passivating cache configuration and the idle-timeout value is less than the StatefulTimeout value, JBoss EAP will passivate the bean when it is idle for the idle-timeout period specified. The bean is then eligible for removal after the StatefulTimeout period specified.
     • A value of -1 means the bean will never be removed due to timeout. If you are using a passivating cache configuration and the bean is idle for idle-timeout, JBoss EAP will passivate the bean instance to the passivation-store.
     • Values less than -1 are not valid.
   • For both EJB 2 and EJB 3, you can configure the stateful timeout in the ejb-jar.xml file.

     <?xml version="1.0" encoding="UTF-8"?>
     <ejb-jar xmlns="http://java.sun.com/xml/ns/javaee"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/ejb-jar_3_1.xsd"
              version="3.1">
       <enterprise-beans>
         <session>
           <ejb-name>HelloBean</ejb-name>
             <session-type>Stateful</session-type>
             <stateful-timeout>
               <timeout>1320</timeout>
               <unit>Seconds</unit>
             </stateful-timeout>
         </session>
       </enterprise-beans>
     </ejb-jar>

   • For both EJB 2 and EJB 3, you can configure the stateful timeout in the jboss-ejb3.xml file.

     <jboss:ejb-jar xmlns:jboss="http://www.jboss.com/xml/ns/javaee"
           xmlns="http://java.sun.com/xml/ns/javaee"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:c="urn:ejb-cache:1.0"
           xsi:schemaLocation="http://www.jboss.com/xml/ns/javaee http://www.jboss.org/j2ee/schema/jboss-ejb3-2_0.xsd http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/ejb-jar_3_1.xsd"
           version="3.1"
           impl-version="2.0">
       <enterprise-beans>
         <session>
           <ejb-name>HelloBean</ejb-name>
             <session-type>Stateful</session-type>
             <stateful-timeout>
               <timeout>1320</timeout>
               <unit>Seconds</unit>
             </stateful-timeout>
         </session>
       </enterprise-beans>
       <assembly-descriptor>
         <c:cache>
           <ejb-name>*</ejb-name>
           <c:cache-ref>my-cache</c:cache-ref>
         </c:cache>
       </assembly-descriptor>
     </jboss:ejb-jar>

Procedure 3.30. Migrate Seam 2.2 Archives

1. Update the datasource configuration.
   Some Seam 2.2 examples use the default JDBC datasource named java:/ExampleDS. This default datasource has changed in JBoss EAP 6 to java:jboss/datasources/ExampleDS. If your application uses the example database, you can do one of the following.

   • If you want to use the example database that ships with JBoss EAP 6, modify the META-INF/persistence.xml file to replace the existing jta-data-source element with the example database datasource JNDI name.

     <!-- <jta-data-source>java:/ExampleDS</jta-data-source> -->
     <jta-data-source>java:jboss/datasources/ExampleDS</jta-data-source>

   • If you prefer to keep your existing database, you can add the datasource definition to the EAP_HOME/standalone/configuration/standalone.xml file.

     Important

     You must stop the server before editing the server configuration file for your change to be persisted on server restart.
     The following definition is a copy of the default HSQL datasource defined in JBoss EAP 6.

     <datasource name="ExampleDS" jndi-name="java:/ExampleDS" enabled="true" jta="true" use-java-context="true" use-ccm="true">
        <connection-url>jdbc:h2:mem:test;DB_CLOSE_DELAY=-1</connection-url>
        <driver>h2</driver>
        <security>
           <user-name>sa</user-name>
           <password>sa</password>
        </security>
     </datasource>

   • You can also add the datasource definition using the Management CLI command line interface. The following is an example of the syntax you must use to add a datasource. The "\" at the end of line indicates the continuation of the command on the following line.

     Example 3.12. Example of syntax to add the datasource definition

     $ EAP_HOME/bin/jboss-cli --connect 
     [standalone@localhost:9999 /] data-source add --name=ExampleDS --jndi-name=java:/ExampleDS \ 
           --connection-url=jdbc:h2:mem:test;DB_CLOSE_DELAY=-1 --driver-name=h2 \ 
           --user-name=sa --password=sa
     

   For more information on how to configure a datasource, see Section 3.1.6.2, “Update the DataSource Configuration”.
2. Add any required dependencies.
   Because Seam 2.2 applications use JSF 1.2, you need to add dependencies for the JSF 1.2 modules and exclude the JSF 2.0 modules. To accomplish this, you need to create a jboss-deployment-structure.xml file in the EAR's META-INF/ directory that contains the following data.

   <jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.0">
     <deployment>
         <dependencies>
           <module name="javax.faces.api" slot="1.2" export="true"/>
                 <module name="com.sun.jsf-impl" slot="1.2" export="true"/>
         </dependencies>
     </deployment>
     <sub-deployment name="jboss-seam-booking.war">
       <exclusions>
           <module name="javax.faces.api" slot="main"/>
                 <module name="com.sun.jsf-impl" slot="main"/>
         </exclusions>
         <dependencies>
           <module name="javax.faces.api" slot="1.2"/>
                 <module name="com.sun.jsf-impl" slot="1.2"/>
         </dependencies>
     </sub-deployment>
   </jboss-deployment-structure>

   If your application uses any third-party logging frameworks you need to add those dependencies as described here: Section 3.1.4.1, “Modify Logging Dependencies”.
3. If your application uses Hibernate 3.x, first try to run the application using the Hibernate 4 libraries.
   If your application does not use the Seam Managed Persistence Context, Hibernate search, validation, or other features that have changed with Hibernate 4, you may be able to run with the Hibernate 4 libraries. However, if you see ClassNotFoundExceptions or ClassCastExceptions that point to Hibernate classes, or see errors similar to the following, you may have to follow the instructions in the next step and modify the application to use Hibernate 3.3 libraries.

           Caused by: java.lang.LinkageError: loader constraint violation in interface itable initialization: when resolving method "org.jboss.seam.persistence.HibernateSessionProxy.getSession(Lorg/hibernate/EntityMode;)Lorg/hibernate/Session;" the class loader (instance of org/jboss/modules/ModuleClassLoader) of the current class, org/jboss/seam/persistence/HibernateSessionProxy, and the class loader (instance of org/jboss/modules/ModuleClassLoader) for interface org/hibernate/Session have different Class objects for the type org/hibernate/Session used in the signature
   

4. Copy dependent archives from outside frameworks or other locations.
   If your application uses Hibernate 3.x and you are not able to use Hibernate 4 successfully with your application, you will need to copy the Hibernate 3.x JARs into the /lib directory and exclude the Hibernate module in the deployments section of the META-INF/jboss-deployment-structure.xml as follows.

   <jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.0">
    <deployment>
      <exclusions>
        <module name="org.hibernate"/>
      </exclusions>
    <deployment>
   </jboss-deployment-structure>

   There are additional steps you must take when you bundle Hibernate 3.x with your application. For more information, see Section 3.2.2.2, “Configure Changes for Applications That Use Hibernate and JPA”.
5. Debug and resolve Seam 2.2 JNDI errors.
   When you migrate a Seam 2.2 application, you may see javax.naming.NameNotFoundException errors in the log like the following.

   javax.naming.NameNotFoundException: Name 'jboss-seam-booking' not found in context ''

   If you don't want to modify JNDI lookups throughout the code, you can modify the application's components.xml file as follows.
   1. Replace the existing core-init element.
      First, you need to replace the existing core-init element as follows:

      <!-- <core:init jndi-pattern="jboss-seam-booking/#{ejbName}/local" debug="true" distributable="false"/>   -->
      <core:init debug="true" distributable="false"/>
      

   2. Find the JNDI binding INFO messages in the server log
      Next, find the JNDI binding INFO messages that are printed in the server log when the application is deployed. The JNDI binding messages should look similar to the following.

      INFO org.jboss.as.ejb3.deployment.processors.EjbJndiBindingsDeploymentUnitProcessor (MSC service thread 1-1) JNDI bindings for session bean
      named AuthenticatorAction in deployment unit subdeployment "jboss-seam-booking.jar" of deployment "jboss-seam-booking.ear" are as follows.
          java:global/jboss-seam-booking/jboss-seam-booking.jar/AuthenticatorAction!org.jboss.seam.example.booking.Authenticator
          java:app/jboss-seam-booking.jar/AuthenticatorAction!org.jboss.seam.example.booking.Authenticator
          java:module/AuthenticatorAction!org.jboss.seam.example.booking.Authenticator
          java:global/jboss-seam-booking/jboss-seam-booking.jar/AuthenticatorAction
          java:app/jboss-seam-booking.jar/AuthenticatorAction
          java:module/AuthenticatorAction
      

   3. Add component elements.
      For each JNDI binding INFO message in the log, add a matching component element to the components.xml file.

      <component class="org.jboss.seam.example.booking.AuthenticatorAction" jndi-name="java:app/jboss-seam-booking.jar/AuthenticatorAction" />

   For more information on how to debug and resolve migration issues, see Section 4.2.1, “Debug and Resolve Migration Issues”.
   For a list of known migration issues with Seam 2 archives, see Section 3.2.18.2, “Seam 2.2 Archive Migration Issues”.