org.dhatim.smooks.edi.EDIReader Maven / Gradle / Ivy
/*
Milyn - Copyright (C) 2006 - 2010
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License (version 2.1) as published by the Free Software
Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Lesser General Public License for more details:
http://www.gnu.org/licenses/lgpl.txt
*/
package org.dhatim.smooks.edi;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.Hashtable;
import java.util.List;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.dhatim.cdr.ProfileTargetingExpression;
import org.dhatim.cdr.SmooksResourceConfiguration;
import org.dhatim.cdr.annotation.AppContext;
import org.dhatim.cdr.annotation.Config;
import org.dhatim.cdr.annotation.ConfigParam;
import org.dhatim.container.ApplicationContext;
import org.dhatim.container.ExecutionContext;
import org.dhatim.edisax.EDIConfigurationException;
import org.dhatim.edisax.EDIParser;
import org.dhatim.edisax.model.EdifactModel;
import org.dhatim.resource.ContainerResourceLocator;
import org.dhatim.resource.URIResourceLocator;
import org.dhatim.xml.SmooksXMLReader;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/**
* Smooks EDI Reader.
*
* Hooks the Milyn {@link org.dhatim.edisax.EDIParser} into the Smooks framework.
* This adds EDI processing support to Smooks.
*
* Configuration
*
* <edi:reader mappingModel="edi-to-xml-order-mapping.xml" validate="false"/>
*
*
* @author tfennelly
*/
public class EDIReader extends EDIParser implements SmooksXMLReader {
/**
* Logger.
*/
private static Log logger = LogFactory.getLog(EDIReader.class);
/**
* Context lookup key for the mapping model table.
*/
private static String MAPPING_TABLE_CTX_KEY = EDIReader.class.getName() + "#MAPPING_TABLE_CTX_KEY";
/**
* Model resource configuration key.
*/
public static final String MODEL_CONFIG_KEY = "mapping-model";
/**
* The parser configuration.
*/
@Config
private SmooksResourceConfiguration configuration;
/**
* Application context.
*/
@AppContext
private ApplicationContext applicationContext;
@ConfigParam(name = MODEL_CONFIG_KEY)
private String modelConfigData;
@ConfigParam(defaultVal = "false")
private boolean ignoreNewLines;
@ConfigParam(defaultVal = "UTF-8")
private Charset encoding;
@ConfigParam(defaultVal = "false")
private Boolean validate;
public void setExecutionContext(ExecutionContext executionContext) {
}
/**
* Parse the EDI message.
*
* Overridden so as to set the EDI to XML mapping model on the parser.
*/
public void parse(InputSource ediSource) throws IOException, SAXException {
EdifactModel edi2xmlMappingModel = getMappingModel();
setMappingModel(edi2xmlMappingModel);
// Set features...
setFeature(FEATURE_VALIDATE, validate);
setFeature(FEATURE_IGNORE_NEWLINES, ignoreNewLines);
super.parse(ediSource);
}
/**
* Get the mapping model associated with the supplied SmooksResourceConfiguration.
*
* The parsed and validated model are cached in the Smooks container context, keyed
* by the SmooksResourceConfiguration instance.
* @return The Mapping Model.
* @throws IOException Error reading resource configuration data (the mapping model).
* @throws SAXException Error parsing mapping model.
*/
private EdifactModel getMappingModel() throws IOException, SAXException {
EdifactModel edifactModel;
Hashtable mappings = getMappingTable(applicationContext);
synchronized (configuration) {
edifactModel = (EdifactModel) mappings.get(configuration);
if(edifactModel == null) {
try {
ContainerResourceLocator resourceLocator = applicationContext.getResourceLocator();
if(modelConfigData.startsWith("urn:") || modelConfigData.endsWith(".jar") || modelConfigData.endsWith(".zip")) {
throw new IOException("Unsupported mapping model config URI for basic EDI Parser '" + modelConfigData + "'. Check that you are using the correct EDI parser. You may need to configure an Interchange Parser, such as the UN/EDIFACT parser.");
}
if(resourceLocator instanceof URIResourceLocator) {
// This will resolve config paths relative to the containing smooks config file....
edifactModel = EDIParser.parseMappingModel(modelConfigData, (resourceLocator).getBaseURI());
} else {
edifactModel = EDIParser.parseMappingModel(modelConfigData, URIResourceLocator.getSystemBaseURI());
}
if(edifactModel == null) {
logger.error("Invalid " + MODEL_CONFIG_KEY + " config value '" + modelConfigData + "'. Failed to locate EDI Mapping Model resource!");
}
} catch (IOException e) {
IOException newE = new IOException("Error parsing EDI mapping model [" + configuration.getStringParameter(MODEL_CONFIG_KEY) + "]. Target Profile(s) " + getTargetProfiles() + ".");
newE.initCause(e);
throw newE;
} catch (SAXException e) {
throw new SAXException("Error parsing EDI mapping model [" + configuration.getStringParameter(MODEL_CONFIG_KEY) + "]. Target Profile(s) " + getTargetProfiles() + ".", e);
} catch (EDIConfigurationException e) {
throw new SAXException("Error parsing EDI mapping model [" + configuration.getStringParameter(MODEL_CONFIG_KEY) + "]. Target Profile(s) " + getTargetProfiles() + ".", e);
}
mappings.put(configuration, edifactModel);
logger.debug("Parsed, validated and cached EDI mapping model [" + edifactModel.getEdimap().getDescription().getName() + ", Version " + edifactModel.getEdimap().getDescription().getVersion() + "]. Target Profile(s) " + getTargetProfiles() + ".");
} else if(logger.isInfoEnabled()) {
logger.debug("Found EDI mapping model [" + edifactModel.getEdimap().getDescription().getName() + ", Version " + edifactModel.getEdimap().getDescription().getVersion() + "] in the model cache. Target Profile(s) " + getTargetProfiles() + ".");
}
}
return edifactModel;
}
/**
* Get the mapping model table from the context.
* @param context The context from which to extract the mapping table.
* @return The mapping model talbe.
*/
protected static Hashtable getMappingTable(ApplicationContext context) {
Hashtable mappingModelTable = (Hashtable) context.getAttribute(MAPPING_TABLE_CTX_KEY);
if(mappingModelTable == null) {
mappingModelTable = new Hashtable();
context.setAttribute(MAPPING_TABLE_CTX_KEY, mappingModelTable);
}
return mappingModelTable;
}
private List getTargetProfiles() {
return Arrays.asList(configuration.getProfileTargetingExpressions());
}
}