Nov 28 2013
docx4j 3.0 and Maven
blog/2011/10/hello-maven-central/ walks you through the basics of using docx4j in an Eclipse project with the help of m2eclipse.
This post is about the different ways you can set up docx4j 3.0 with the help of Maven.
We’ll be using the following skeleton pom.xml:
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>your.group</groupId> <artifactId>your.artifactp</artifactId> <name>nameless</name> <version>0.0.1-SNAPSHOT</version> <description> some description </description> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </properties> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <version>2.0</version> </plugin> </plugins> </build> <dependencies> <!-- dependencies go here --> </dependencies> </project>
Adding the core dependency
To use docx4j, including its LGPL XHTML import capability, just include the following dependency in your pom.xml:
<dependency> <groupId>org.docx4j</groupId> <artifactId>docx4j-ImportXHTML</artifactId> <version>3.0.0</version> </dependency>
That’ll drag in docx4j, and all the other dependencies (you should be able to see then in Eclipse under Maven Dependencies, or by running mvn dependency:tree at a command prompt).
If you don’t want the XHTML import stuff, just use:
<dependency> <groupId>org.docx4j</groupId> <artifactId>docx4j</artifactId> <version>3.0.0</version> </dependency>
(You should consider adding a docx4j.properties to your classpath)
Logging
Both of the above default to using log4j. If you are happy with log4j, you’ll want a log4j.xml file unless you already have it on your classpath. If you don’t, you can configure https://github.com/plutext/docx4j/blob/master/src/samples/_resources/log4j.xml to suit.
If you want to use something other than log4j for logging, well you can, since docx4j uses slf4j.
First you need to exclude the log4j stuff.
<dependency> <groupId>org.docx4j</groupId> <artifactId>docx4j-ImportXHTML</artifactId> <version>3.0.0</version> <exclusions> <exclusion> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> </exclusion> <exclusion> <groupId>log4j</groupId> <artifactId>log4j</artifactId> </exclusion> </exclusions> </dependency>
Then you add in the dependencies for your other logging frameworks. See further http://www.slf4j.org/ and slf4j in search.maven.org
JAXB
docx4j relies very heavily on JAXB. With Java 6 or 7, usually it’ll use the JAXB included in that (though things can be different with application servers – see the deployment forums for details).
The point here is that there is an alternative JAXB implementation, called EclipseLink MOXy (see http://www.eclipse.org/eclipselink/moxy.php), which is very well supported by its developers. You can try it with docx4j. To do so, just include the following additional dependencies:
/sourcecode]
Since using MOXy with docx4j is all quite new, you may run into some minor issues. If you do, please let us know in the docx4j forums (with sufficient info for us to reproduce what you are seeing!). Thanks.
No Responses so far
Comments are closed.
Comment RSS