org.docx4j.jaxb.JaxbValidationEventHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docx4j Show documentation
Show all versions of docx4j Show documentation
docx4j is a library which helps you to work with the Office Open
XML file format as used in docx
documents, pptx presentations, and xlsx spreadsheets.
/*
* Copyright 2007-2008, Plutext Pty Ltd.
*
* This file is part of docx4j.
docx4j is licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.docx4j.jaxb;
import java.io.IOException;
import java.lang.reflect.Field;
import javax.xml.bind.ValidationEvent;
import javax.xml.bind.ValidationEventHandler;
import javax.xml.bind.ValidationEventLocator;
import javax.xml.transform.Source;
import javax.xml.transform.Templates;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.stream.StreamSource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.docx4j.XmlUtils;
import org.docx4j.utils.ResourceUtils;
public class JaxbValidationEventHandler implements
ValidationEventHandler{
private static Logger log = LoggerFactory.getLogger(JaxbValidationEventHandler.class);
private boolean shouldContinue = false; // fail by default
public void setContinue(boolean val) {
shouldContinue = val;
}
public final static String UNEXPECTED_MC_ALTERNATE_CONTENT = "unexpected element (uri:\"http://schemas.openxmlformats.org/markup-compatibility/2006\", local:\"AlternateContent\")";
static Templates mcPreprocessorXslt;
public static Templates getMcPreprocessor() throws IOException, TransformerConfigurationException {
if (mcPreprocessorXslt==null) {
Source xsltSource = new StreamSource(
ResourceUtils.getResourceViaProperty("docx4j.jaxb.JaxbValidationEventHandler",
"org/docx4j/jaxb/mc-preprocessor.xslt")
);
mcPreprocessorXslt = XmlUtils.getTransformerTemplate(xsltSource);
}
return mcPreprocessorXslt;
}
public boolean handleEvent(ValidationEvent ve) {
if (ve.getSeverity()==ValidationEvent.FATAL_ERROR
|| ve.getSeverity()==ValidationEvent.ERROR){
ValidationEventLocator locator = ve.getLocator();
//print message from validation event
if (log.isDebugEnabled() || ve.getMessage().length() < 120 ) {
log.warn( printSeverity(ve) + ": " + ve.getMessage() );
} else {
/* These messages are long, for example:
*
* unexpected element (uri:"http://schemas.openxmlformats.org/wordprocessingml/2006/main", local:"style").
* Expected elements are <{http://schemas.openxmlformats.org/wordprocessingml/2006/main}annotationRef>,
* ....
*
* so truncate it.
*/
log.warn( printSeverity(ve) + ": " + ve.getMessage().substring(0, 120));
}
if (ve.getLinkedException()!=null && log.isDebugEnabled() ) {
ve.getLinkedException().printStackTrace();
}
// MOXy doesn't throw an exception unless we return false
// if (Context.jaxbImplementation==JAXBImplementation.ECLIPSELINK_MOXy
// && ve.getMessage().contains(UNEXPECTED_MC_ALTERNATE_CONTENT)) {
// shouldContinue = false;
// }
//output line and column number
// System.out.println("Column is " +
// locator.getColumnNumber() +
// " at line number " + locator.getLineNumber());
} else if (ve.getSeverity()==ve.WARNING) {
log.warn(printSeverity(ve) + "Message is " + ve.getMessage());
// Workaround for issue with recent non-MOXy JAXB (eg RI 2.2.11)
if (ve.getMessage().startsWith("Errors limit exceeded")) {
try {
log.warn("Resetting error counter to work around https://github.com/gf-metro/jaxb/issues/22");
Field field = null;
if (Context.getJaxbImplementation() == JAXBImplementation.ORACLE_JRE) {
field = Class.forName("com.sun.xml.internal.bind.v2.runtime.unmarshaller.UnmarshallingContext").getDeclaredField("errorsCounter");
} else {
field = Class.forName("com.sun.xml.bind.v2.runtime.unmarshaller.UnmarshallingContext").getDeclaredField("errorsCounter");
}
field.setAccessible(true);
field.set(null, 10);
log.warn(".. reset successful");
} catch (Exception e) {
log.error(e.getMessage());
log.error("Unable to reset error counter. See https://github.com/plutext/docx4j/issues/164");
}
}
}
// JAXB provider should attempt to continue its current operation.
// (Marshalling, Unmarshalling, Validating)
log.info("continuing (with possible element/attribute loss)");
return shouldContinue;
}
public String printSeverity(ValidationEvent ve) {
String errorLevel;
switch (ve.getSeverity()) {
case ValidationEvent.FATAL_ERROR: {
// FATAL_ERROR is usually not actually fatal!
errorLevel="(non)FATAL_ERROR";
break; }
case ValidationEvent.ERROR: { errorLevel="ERROR"; break; }
case ValidationEvent.WARNING: { errorLevel="WARNING"; break; }
default: errorLevel = new Integer (ve.getSeverity()).toString() ;
}
return "[" + errorLevel + "] ";
}
}