Hibernate example source code file (obtaining.xml)

This example Hibernate source code file (obtaining.xml) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Hibernate tags/keywords

artifacts, hibernate, hibernate, it, jboss, jboss, maven, provides, repository, see, the, the, this, this

The Hibernate obtaining.xml source code

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">


<chapter id="hibernate-gsg-obtain">
    <title>Obtaining Hibernate

    <section id="hibernate-gsg-setup-releaseBundle">
        <title>Release Bundle Downloads
        <para>
            The Hibernate team provides release bundles hosted on the SourceForge File Release System, in
            <literal>ZIP
            and
            <literal>TGZ
            formats. Each release bundle contains<literal>JARs,
            documentation, source code, and other goodness.
        </para>
        <para>
            You can download releases of Hibernate, in your chosen format, from the list at
            <ulink url="http://sourceforge.net/projects/hibernate/files/hibernate4/"/>.
        </para>
        <itemizedlist>
            <listitem>
                <para>
                    The <filename>lib/required/ directory contains all the JARs Hibernate requires.  All the
                    jars in this directory must also be included in your project's classpath.
                </para>
            </listitem>
            <listitem>
                <para>
                    The <filename>/lib/jpa/ directory contains the
                    <systemitem>hibernate-entitymanager jar and its dependencies beyond those
                    in <filename>lib/required/.  This defines Hibernate support for
                    <ulink url="http://jcp.org/en/jsr/detail?id=317">JPA.
                </para>
            </listitem>
            <listitem>
                <para>
                    The <filename>lib/envers directory contains the hibernate-envers
                    jar and its dependencies beyond those in <filename>lib/required/
                </para>
            </listitem>
            <listitem>
                <para>
                    The <filename>lib/optional directory contains the jars needed for optional features of
                    Hibernate.
                </para>
            </listitem>
        </itemizedlist>
    </section>

    <section id="hibernate-gsg-setup-mavenRepoArtifacts">
        <title>Maven Repository Artifacts
        <note>
            <para>
                The authoritative repository for Hibernate artifacts is the JBoss Maven repository. The team responsible
                for the JBoss Maven repository maintains a number of Wiki pages that contain important information.
            </para>
            <itemizedlist>
                <title>Maven Repository Wiki Pages
                <listitem>
                    <para>
                        <ulink url="http://community.jboss.org/docs/DOC-14900"/> - General information about the repository.
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <ulink url="http://community.jboss.org/docs/DOC-15170"/> - Information about setting up the JBoss
                        repositories in order to do development work on JBoss projects themselves.
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <ulink url="http://community.jboss.org/docs/DOC-15169"/> - Information about setting up access to
                        the repository to use JBoss projects as part of your own software.
                    </para>
                </listitem>
            </itemizedlist>
        </note>

        <para>
            Hibernate produces a number of artifacts (all under the <systemitem>org.hibernate groupId):
        </para>
        <variablelist>
            <title>Hibernate Artifacts under groupId org.hibernate
            </title>
            <varlistentry>
                <term>hibernate-core
                <listitem>
                    <para>
                        The main artifact, needed to build applications using the native Hibernate APIs including
                        defining metadata in both annotations as well as Hibernate's own <filename>hbm.xml
                        format.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>hibernate-entitymanager
                <listitem>
                    <para>
                        Represents Hibernate's implementation of <phrase>JPA, as specified at
                        <ulink url="http://jcp.org/en/jsr/detail?id=317"/>.
                    </para>
                    <para>
                        This artifact depends on <systemitem>hibernate-core
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>hibernate-envers
                <listitem>
                    <para>
                        An optional module that provides historical auditing of changes to your entities.
                    </para>
                    <para>
                        This artifact depends on both <systemitem>hibernate-core
                        and <systemitem>hibernate-entitymanager.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>hibernate-c3p0
                <listitem>
                    <para>
                        Provides integration between Hibernate and the <application>C3P0 connection
                        pool library.  See <ulink url="http://sourceforge.net/projects/c3p0/"/> for information
                        about <application>C3P0.
                    </para>
                    <para>
                        This artifact depends on <systemitem>hibernate-core, but is generally included
                        in a project as a runtime dependency.  It pulls in the <application>C3P0
                        dependencies automatically.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>hibernate-proxool
                <listitem>
                    <para>
                        Provides integration between Hibernate and the <application>Proxool connection
                        pool library. See <ulink url="http://proxool.sourceforge.net/"/> for more information about
                        this library.
                    </para>
                    <para>
                        This artifact depends on <systemitem>hibernate-core, but is generally included
                        in a project as a runtime dependency. It pulls in the <application>Proxool
                        dependencies automatically..
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>hibernate-ehcache
                <listitem>
                    <para>
                        Privides integration between Hibernate and <application>EhCache, as a
                        second-level cache. See <ulink url="http://ehcache.sourceforge.net/"/> for more
                        information about<application>EhCache.
                    </para>
                    <para>
                        This artifact depends on <systemitem>hibernate-core, but is generally included
                        in a project as a runtime dependency. It pulls in the <application>Ehcache
                        dependencies automatically.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>hibernate-infinispan
                <listitem>
                    <para>
                        Provides integration between Hibernate and <application>Infinispan, as a
                        second-level cache. See <ulink url="http://jboss.org/infinispan"/> for more information
                        about <application>Infinispan.
                    </para>
                    <para>
                        This artifact depends on <systemitem>hibernate-core, but is generally included
                        in a project as a runtime dependency. It pulls in the <application>Infinispan
                        dependencies automatically.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </section>
</chapter>