Enterprise Java Development@TOPIC@

Chapter 98. Server-side Resources

98.1. SQL DataSource (defined in Server - standalone.xml)
98.2. Server-side Persistence Units
98.2.1. transaction-type=JTA (default)
98.2.2. transaction-type=RESOURCE_LOCAL
98.3. persistence.xml Placement
98.3.1. EJB persistence.xml Placement
98.3.2. WAR persistence.xml Placement
98.4. Reference External @Entities
98.4.1. Reference External @Entities: EAR Deploy
98.4.2. Reference External @Entities: WAR Deploy
98.5. Summary

98.1. SQL DataSource (defined in Server - standalone.xml)


<subsystem xmlns="urn:jboss:domain:datasources:1.0">

    <datasources>

        <datasource jndi-name="java:jboss/datasources/ExampleDS" pool-name="ExampleDS" enabled="true" use-java-context="true">

            <connection-url>jdbc:h2:mem:test;DB_CLOSE_DELAY=-1</connection-url>

            <driver>h2</driver>

            <security>

                <user-name>sa</user-name>

                <password></password>

            </security>

        </datasource>

        <drivers>

            <driver name="h2" module="com.h2database.h2">

                <xa-datasource-class>org.h2.jdbcx.JdbcDataSource</xa-datasource-class>

            </driver>

        </drivers>

    </datasources>

</subsystem>

98.2. Server-side Persistence Units


<?xml version="1.0" encoding="UTF-8"?>

<persistence xmlns="http://java.sun.com/xml/ns/persistence"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd" version="2.0">



    <persistence-unit name="ejbjpa-hotel" transaction-type="JTA">

        <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>

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

...

        <properties>

            <property name="hibernate.dialect" value="${hibernate.dialect}"/>

...            

        </properties>

    </persistence-unit>            

</persistence>



<?xml version="1.0" encoding="UTF-8"?>

<persistence xmlns="http://java.sun.com/xml/ns/persistence"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd" version="2.0">



    <persistence-unit name="ejbjpa-hotel-rl" transaction-type="RESOURCE_LOCAL">

        <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>

...

        <properties>

            <!-- connection properties -->

            <property name="javax.persistence.jdbc.url" value="${jdbc.url}"/>

            <property name="javax.persistence.jdbc.driver" value="${jdbc.driver}"/>

            <property name="javax.persistence.jdbc.user" value="${jdbc.user}"/>

            <property name="javax.persistence.jdbc.password" value="${jdbc.password}"/>

            

            <property name="hibernate.dialect" value="${hibernate.dialect}"/>

...

        </properties>

    </persistence-unit>            

</persistence>

Conform to JavaEE/EJB framework, don't bypass it

Use of transaction-type=RESOURCE_LOCAL bypasses a significant portion of what the application server provides (e.g., Connection Resource Pooling, Container Managed Transactions). This should only be used in limited cases and where the implementation requires. It should not be used because of lack of understanding of how to use the server-side JavaEE/EJB framework.

98.3. persistence.xml Placement

enc-config-example-ejb
|-- ejava
|   `-- ejb
|       `-- examples
|           `-- encconfig
|               |-- dto
|               |   `-- NCPair.class
|               `-- ejb
|                   |-- AnnotatedEJB.class
|                   |-- InjectedEJB.class
|                   |-- JNDIReader.class
|                   |-- JNDIReaderRemote.class
|                   `-- XMLConfiguredEJB.class
`-- META-INF
    `-- persistence.xml
ejb-jpa-example-war
|-- META-INF
`-- WEB-INF
    |-- classes
    |   |-- info
    |   |   `-- ejava
    |   |       `-- examples
    |   |           `-- ejb
    |   |               `-- ejbjpa
    |   |                   |-- dto
    |   |                   |   |-- FloorDTO.class
    |   |                   |   `-- RoomDTO.class
    |   |                   `-- ejb
    |   |                       |-- HotelInitEJB.class
    |   |                       |-- HotelInitRemote.class
    |   |                       |-- HotelMgmtEJB.class
    |   |                       |-- HotelMgmtLocal.class
    |   |                       |-- HotelMgmtRemote.class
    |   |                       |-- ReservationEJB.class
    |   |                       `-- ReservationRemote.class
    |   `-- META-INF
    |       |-- ejb-jar.xml
    |       |-- jboss-ejb3.xml
    |       `-- persistence.xml
    `-- lib
        `-- ejb-jpa-example-blimpl-4.0.0-SNAPSHOT.jar

98.4. Reference External @Entities

ejbsessionBankEAR-4.0.0-SNAPSHOT
|-- ejbsessionBankEJB.jar
|-- ejbsessionBankWAR-4.0.0-SNAPSHOT.war
|-- lib
|   |-- ejava-util-4.0.0-SNAPSHOT.jar
|   `-- ejbsessionBankImpl-4.0.0-SNAPSHOT.jar
`-- META-INF
    `-- application.xml


<?xml version="1.0" encoding="UTF-8"?>

<persistence xmlns="http://java.sun.com/xml/ns/persistence"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd" version="2.0">



    <persistence-unit name="ejbsessionbank">

        <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>

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

        

        <jar-file>lib/ejbsessionBankImpl-4.0.0-SNAPSHOT.jar</jar-file>

        

        <properties>

            <property name="hibernate.dialect" value="${hibernate.dialect}"/>

...

        </properties>

    </persistence-unit>        

</persistence>


ejb-jpa-example-war
|-- META-INF
`-- WEB-INF
...
    `-- lib
        `-- ejb-jpa-example-blimpl-5.0.0-SNAPSHOT.jar


<?xml version="1.0" encoding="UTF-8"?>

<persistence xmlns="http://java.sun.com/xml/ns/persistence"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd" version="2.0">



    <persistence-unit name="ejbjpa-hotel">

        <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>

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



        <!-- located in WEB-INF/lib/ejb-jpa-example-blimpl-${project.version}.jar -->

        <class>info.ejava.examples.ejb.ejbjpa.bo.Guest</class>

        <class>info.ejava.examples.ejb.ejbjpa.bo.Room</class>

        <class>info.ejava.examples.ejb.ejbjpa.bo.Floor</class>



        <properties>

            <property name="hibernate.dialect" value="${hibernate.dialect}"/>

...

        </properties>

    </persistence-unit>            

</persistence>

Note

There is no need to declare "class" entity references into a properly configured "jar-file" that is located in the classpath of a deployed EAR. Use "class" entity references when using a WEB-INF/classes/META-INF deployment of a WAR and classes come from externally provided JAR -- or if you really need to only include specific entities in the archive.

98.5. Summary