Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/Examples/MOXy/Spring/JAXBAnnotations"
(→Spring Framework) |
(→Spring Framework) |
||
Line 9: | Line 9: | ||
The latest version of EclipseLink can be found on the [http://www.eclipse.org/eclipselink/downloads EclipseLink download] page | The latest version of EclipseLink can be found on the [http://www.eclipse.org/eclipselink/downloads EclipseLink download] page | ||
=== Spring Framework === | === Spring Framework === | ||
− | The latest version of the Spring Framework can be found on the [http://www.springsource.org/download Spring download] page. | + | The latest version of the Spring Framework can be found on the [http://www.springsource.org/download Spring download] page. The following JAR files will be required on the classpath: |
− | The following JAR files will be required on the classpath: | + | |
* ${SPRING_HOME}/dist/org.springframework.aop-3.0.2.RELEASE.jar | * ${SPRING_HOME}/dist/org.springframework.aop-3.0.2.RELEASE.jar | ||
* ${SPRING_HOME}/dist/org.springframework.asm-3.0.2.RELEASE.jar | * ${SPRING_HOME}/dist/org.springframework.asm-3.0.2.RELEASE.jar |
Revision as of 16:21, 27 July 2010
In order to use EclipseLink JAXB with the Spring Framework, you simply need a jaxb.properties
file and an eclipselink.jar
on the classpath. No other special configuration is required. This document will demonstrate how to configure Spring to use EclipseLink JAXB.
Requirements
The following are required to use EclipseLink JAXB with Spring.
EclipseLink
The latest version of EclipseLink can be found on the EclipseLink download page
Spring Framework
The latest version of the Spring Framework can be found on the Spring download page. The following JAR files will be required on the classpath:
- ${SPRING_HOME}/dist/org.springframework.aop-3.0.2.RELEASE.jar
- ${SPRING_HOME}/dist/org.springframework.asm-3.0.2.RELEASE.jar
- ${SPRING_HOME}/dist/org.springframework.aspects-3.0.2.RELEASE.jar
- ${SPRING_HOME}/dist/org.springframework.beans-3.0.2.RELEASE.jar
- ${SPRING_HOME}/dist/org.springframework.context-3.0.2.RELEASE.jar
- ${SPRING_HOME}/dist/org.springframework.context.support-3.0.2.RELEASE.jar
- ${SPRING_HOME}/dist/org.springframework.core-3.0.2.RELEASE.jar
- ${SPRING_HOME}/dist/org.springframework.expression-3.0.2.RELEASE.jar
- ${SPRING_HOME}/dist/org.springframework.oxm-3.0.2.RELEASE.jar
- ${SPRING_HOME}/dist/org.springframework.test-3.0.2.RELEASE.jar
- ${SPRING_HOME}/projects/spring-build/lib/ivy/commons-logging.jar
Model Classes
The following model classes make use of standard JAXB annotations as well as MOXy extensions:
Configuration: applicationContext.xml
The following XML file will be used to configure our beans:
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd"> <bean id="jaxbMarshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller"> <property name="contextPath" value="example.gettingstarted"/> </bean> <bean id="xmlHelper" class="example.gettingstarted.XMLHelper"> <property name="marshaller" ref="jaxbMarshaller"/> </bean> </beans>
Two beans are being defined here:
- xmlHelper
- This is the class that will do all of the work, i.e. marshal and unmarshal
- We use the "marshaller" property to indicate that we want Spring to inject an instance of
org.springframework.oxm.jaxb.Jaxb2Marshaller
- jaxbMarshaller
- This is an instance of the
org.springframework.oxm.jaxb.Jaxb2Marshaller
class that will be injected into our xmlHelper - We use the "contextPath" property to indicate the location of the model classes,
jaxb.properties
, and anObjectFactory
class orjaxb.index
file
- This is an instance of the
Following is the jaxb.properties
file that tells Spring to use EclipseLink JAXB:
javax.xml.bind.context.factory = org.eclipse.persistence.jaxb.JAXBContextFactory
Bootstrapping the Application
The standard Spring bean lookup method can be used to gain access to the xmlHelper
bean:
// initialize IoC Container ApplicationContext appContext = new ClassPathXmlApplicationContext("applicationContext.xml"); // retrieve the XMLHelper instance from the Container XMLHelper xmlHelper = (XMLHelper) appContext.getBean("xmlHelper");
Source/Config Files
This section contains the various source and configuration files for the example.
example.gettingstarted.XMLHelper.java
This is the class responsible for marshal/unmarshal operations:
package example.gettingstarted; import java.io.IOException; import javax.xml.transform.Result; import javax.xml.transform.Source; import org.springframework.oxm.XmlMappingException; import org.springframework.oxm.jaxb.Jaxb2Marshaller; public class XMLHelper { private Jaxb2Marshaller marshaller; /** * Unmarshal a given source */ public Object load(Source source) throws XmlMappingException, IOException { return marshaller.unmarshal(source); } /** * Marshal a given Object to a Result */ public void save(Object obj, Result result) throws XmlMappingException, IOException { marshaller.marshal(obj, result); } /** * This method is used by Spring to inject an instance of Jaxb2Marshaller */ public void setMarshaller(Jaxb2Marshaller marshaller) { this.marshaller = marshaller; } }
build.xml
This is the ANT build file used to run the example.
<?xml version="1.0" standalone="yes"?> <project basedir="." default="run" name="JAXB Annotation Example"> <property name="eclipselink.home" value="C:/spring/workspace/eclipselink"/> <property name="spring.home" value="C:/spring/spring-framework-3.0.2.RELEASE"/> <property name="srcdir" value="src" /> <path id="classpath"> <filelist dir="${spring.home}"> <file name="dist/org.springframework.aop-3.0.2.RELEASE.jar"/> <file name="dist/org.springframework.asm-3.0.2.RELEASE.jar"/> <file name="dist/org.springframework.aspects-3.0.2.RELEASE.jar"/> <file name="dist/org.springframework.beans-3.0.2.RELEASE.jar"/> <file name="dist/org.springframework.context-3.0.2.RELEASE.jar"/> <file name="dist/org.springframework.context.support-3.0.2.RELEASE.jar"/> <file name="dist/org.springframework.core-3.0.2.RELEASE.jar"/> <file name="dist/org.springframework.expression-3.0.2.RELEASE.jar"/> <file name="dist/org.springframework.oxm-3.0.2.RELEASE.jar"/> <file name="dist/org.springframework.test-3.0.2.RELEASE.jar"/> <file name="projects/spring-build/lib/ivy/commons-logging.jar"/> </filelist> <filelist dir="${eclipselink.home}/jlib"> <file name="eclipselink.jar"/> </filelist> </path> <target name="clean"> <delete dir="classes" includes="**/*" /> </target> <target name="compile"> <mkdir dir="classes" /> <javac destdir="classes" debug="on"> <src path="${srcdir}"/> <classpath refid="classpath" /> </javac> <copy todir="classes" description="copy resources"> <fileset dir="${srcdir}"> <exclude name="**/*.java" /> </fileset> </copy> </target> <target name="run" depends="clean, compile"> <echo>JAXB Annotation Example</echo> <java classname="example.gettingstarted.XMLHelperTest" fork="true"> <classpath refid="classpath" /> <classpath path="classes" /> </java> </target> </project>