CswJAXBElementProvider.java

/**
 * Copyright (c) Codice Foundation
 *
 * This is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * This program 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. A copy of the GNU Lesser General Public License
 * is distributed along with this program and can be found at
 * <http://www.gnu.org/licenses/lgpl.html>.
 *
 **/
package org.codice.ddf.spatial.ogc.csw.catalog.common;

import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.Map;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;

import org.apache.commons.lang.StringUtils;
import org.apache.cxf.jaxrs.provider.JAXBElementProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.sun.xml.bind.marshaller.NamespacePrefixMapper;

/**
 *
 * Extends and overrides the JAXBElementProvider so that it is contextually aware of the
 * package names used in the services.
 *
 * This can be mapped in blueprint
 * by creating the bean with this class and mapping it as a jaxrs:providers element to
 * the service jaxrs:server
 *
 * @param <T> generic type
 */
public class CswJAXBElementProvider<T> extends JAXBElementProvider<T> {

    private static final Logger LOGGER = LoggerFactory.getLogger(CswJAXBElementProvider.class);

    private static final JAXBContext JAXB_CONTEXT = initJaxbContext();

    public CswJAXBElementProvider() {
        super();

        Map<String, String> prefixes = new HashMap<String, String>();
        prefixes.put(CswConstants.CSW_OUTPUT_SCHEMA, CswConstants.CSW_NAMESPACE_PREFIX);
        prefixes.put(CswConstants.OWS_NAMESPACE, CswConstants.OWS_NAMESPACE_PREFIX);
        prefixes.put(CswConstants.XML_SCHEMA_LANGUAGE, CswConstants.XML_SCHEMA_NAMESPACE_PREFIX);
        prefixes.put(CswConstants.OGC_SCHEMA, CswConstants.OGC_NAMESPACE_PREFIX);
        prefixes.put(CswConstants.GML_SCHEMA, CswConstants.GML_NAMESPACE_PREFIX);
        prefixes.put(CswConstants.DUBLIN_CORE_SCHEMA, CswConstants.DUBLIN_CORE_NAMESPACE_PREFIX);
        prefixes.put(CswConstants.DUBLIN_CORE_TERMS_SCHEMA,
                CswConstants.DUBLIN_CORE_TERMS_NAMESPACE_PREFIX);

        setNamespaceMapperPropertyName(NS_MAPPER_PROPERTY_RI);
        setNamespacePrefixes(prefixes);
    }

    private static JAXBContext initJaxbContext() {
        JAXBContext jaxbContext = null;

        // JAXB context path
        // "net.opengis.cat.csw.v_2_0_2:net.opengis.filter.v_1_1_0:net.opengis.gml.v_3_1_1:net.opengis.ows.v_1_0_0"
        String contextPath = StringUtils
                .join(new String[] {CswConstants.OGC_CSW_PACKAGE, CswConstants.OGC_FILTER_PACKAGE,
                        CswConstants.OGC_GML_PACKAGE, CswConstants.OGC_OWS_PACKAGE}, ":");

        try {
            LOGGER.debug("Creating JAXB context with context path: {}.", contextPath);
            jaxbContext = JAXBContext
                    .newInstance(contextPath, CswJAXBElementProvider.class.getClassLoader());
        } catch (JAXBException e) {
            LOGGER.error("Unable to create JAXB context using contextPath: {}.", contextPath, e);
        }

        return jaxbContext;
    }

    @Override
    public JAXBContext getJAXBContext(Class<?> type, Type genericType) throws JAXBException {
        return JAXB_CONTEXT;
    }

    @Override
    protected void setNamespaceMapper(Marshaller ms, Map<String, String> map) throws Exception {

        final Map<String, String> finalMap = map;

        NamespacePrefixMapper mapper = new NamespacePrefixMapper() {

            protected Map<String, String> prefixMap = finalMap;

            @Override
            public String getPreferredPrefix(String namespaceUri, String suggestion,
                    boolean requirePrefix) {
                return prefixMap.get(namespaceUri);
            }

        };

        ms.setProperty(NS_MAPPER_PROPERTY_RI, mapper);

    }
}