com.sun.xml.ws.spi.db.BindingContextFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of webservices-osgi Show documentation
Show all versions of webservices-osgi Show documentation
Metro Web Services Runtime OSGi Bundle
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.spi.db;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.Marshaller;
import com.oracle.webservices.api.databinding.DatabindingModeFeature;
import com.sun.xml.ws.db.glassfish.JAXBRIContextFactory;
import com.sun.xml.ws.util.ServiceConfigurationError;
import com.sun.xml.ws.util.ServiceFinder;
/**
* BindingContextFactory
*
* @author [email protected]
*/
abstract public class BindingContextFactory {
public static final String DefaultDatabindingMode = DatabindingModeFeature.GLASSFISH_JAXB;
public static final String JAXB_CONTEXT_FACTORY_PROPERTY = BindingContextFactory.class.getName();
public static final Logger LOGGER = Logger.getLogger(BindingContextFactory.class.getName());
// This iterator adds exception checking for proper logging.
public static Iterator serviceIterator() {
final ServiceFinder sf = ServiceFinder
.find(BindingContextFactory.class);
final Iterator ibcf = sf.iterator();
return new Iterator() {
private BindingContextFactory bcf;
public boolean hasNext() {
while (true) {
try {
if (ibcf.hasNext()) {
bcf = ibcf.next();
return true;
} else
return false;
} catch (ServiceConfigurationError e) {
LOGGER.warning("skipping factory: ServiceConfigurationError: "
+ e.getMessage());
} catch (NoClassDefFoundError ncdfe) {
LOGGER.fine("skipping factory: NoClassDefFoundError: "
+ ncdfe.getMessage());
}
}
}
public BindingContextFactory next() {
if (LOGGER.isLoggable(Level.FINER))
LOGGER.finer("SPI found provider: " +
bcf.getClass().getName());
return bcf;
}
public void remove() {
throw new UnsupportedOperationException();
}
};
}
static private List factories() {
List factories = new java.util.ArrayList();
Iterator ibcf = serviceIterator();
while (ibcf.hasNext())
factories.add(ibcf.next());
// There should always be at least one factory available.
if (factories.isEmpty()) {
if (LOGGER.isLoggable(Level.FINER))
LOGGER.log(Level.FINER, "No SPI providers for BindingContextFactory found, adding: "
+ JAXBRIContextFactory.class.getName());
factories.add(new JAXBRIContextFactory());
}
return factories;
}
abstract protected BindingContext newContext(JAXBContext context);
abstract protected BindingContext newContext(BindingInfo bi);
/**
* Check to see if the BindingContextFactory is for the databinding mode/flavor. The
* String parameter can be the package name of the JAXBContext implementation as well.
* @param databinding mode/flavor or the package name of the JAXBContext implementation.
* @return
*/
abstract protected boolean isFor(String databinding);
/**
* @deprecated - Does jaxws need this?
*/
abstract protected BindingContext getContext(Marshaller m);
static private BindingContextFactory getFactory(String mode) {
for (BindingContextFactory f: factories()) {
if (f.isFor(mode))
return f;
}
return null;
}
static public BindingContext create(JAXBContext context) throws DatabindingException {
return getJAXBFactory(context).newContext(context);
}
static public BindingContext create(BindingInfo bi) {
// Any mode configured in AbstractSEIModelImpl trumps all.
// System property comes next, then SPI-located.
String mode = bi.getDatabindingMode();
if (mode != null) {
if (LOGGER.isLoggable(Level.FINE))
LOGGER.log(Level.FINE, "Using SEI-configured databindng mode: "
+ mode);
} else if ((mode = System.getProperty("BindingContextFactory")) != null) {
// The following is left for backward compatibility and should
// eventually be removed.
bi.setDatabindingMode(mode);
if (LOGGER.isLoggable(Level.FINE))
LOGGER.log(Level.FINE, "Using databindng: " + mode
+ " based on 'BindingContextFactory' System property");
} else if ((mode = System.getProperty(JAXB_CONTEXT_FACTORY_PROPERTY)) != null) {
bi.setDatabindingMode(mode);
if (LOGGER.isLoggable(Level.FINE))
LOGGER.log(Level.FINE, "Using databindng: " + mode
+ " based on '" + JAXB_CONTEXT_FACTORY_PROPERTY
+ "' System property");
} else {
// Find a default provider. Note we always ensure the list is always non-empty.
BindingContext factory = getBindingContextFromSpi(factories(), bi);
if (factory != null) return factory;
// Should never get here as the list is non-empty.
LOGGER.log(Level.SEVERE, "No Binding Context Factories found.");
throw new DatabindingException("No Binding Context Factories found.");
}
BindingContextFactory f = getFactory(mode);
if (f != null)
return f.newContext(bi);
LOGGER.severe("Unknown Databinding mode: " + mode);
throw new DatabindingException("Unknown Databinding mode: " + mode);
}
/**
* Creates JAXB bindingContext with one of the provided factories.
* To filter appropriate factory {@link BindingContextFactory#isFor(String)} method is used.
* Currently known 2 appropriate factories: JAXB RI and MOXY.
* In case no suitable factory is found we are trying to create context with any given factory.
*
* @param factories given collection of factories.
* @param bindingInfo will be used to create bindingContext.
* @return Created context or null. Null will be returned if we were not able to create context with any given factory.
*/
private static BindingContext getBindingContextFromSpi(List factories, BindingInfo bindingInfo) {
List fallback = new ArrayList();
BindingContext result;
for (BindingContextFactory factory : factories) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE, "Found SPI-determined databindng mode: " + factory.getClass().getName());
}
if (factory.isFor("org.eclipse.persistence.jaxb") || factory.isFor("org.glassfish.jaxb.runtime.v2.runtime")) { // filter (JAXB RI || MOXy) implementation
result = factory.newContext(bindingInfo);
if (result != null) {
return result;
}
} else {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE, "Skipped -> not JAXB.");
}
fallback.add(factory);
}
}
for (BindingContextFactory factory : fallback) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE, "Fallback. Creating from: " + factory.getClass().getName());
}
result = getContextOrNullIfError(factory, bindingInfo);
if (result != null) {
return result;
}
}
return null;
}
/**
* Factory creates new context bases on provided bindingInfo.
* @param factory given factory.
* @param bindingInfo to be used to create context.
* @return Created context or null. Null will be returned if an error happened during the creation process.
*/
private static BindingContext getContextOrNullIfError(BindingContextFactory factory, BindingInfo bindingInfo) {
try {
return factory.newContext(bindingInfo);
} catch (Exception e) {
LOGGER.log(Level.WARNING, e.getMessage(), e);
return null;
}
}
static public boolean isContextSupported(Object o) {
if (o == null) return false;
String pkgName = o.getClass().getPackage().getName();
for (BindingContextFactory f: factories()) if (f.isFor(pkgName)) return true;
return false;
}
static BindingContextFactory getJAXBFactory(Object o) {
String pkgName = o.getClass().getPackage().getName();
BindingContextFactory f = getFactory(pkgName);
if (f != null) return f;
throw new DatabindingException("Unknown JAXBContext implementation: " + o.getClass());
}
/**
* @deprecated - Does jaxws need this?
*/
static public BindingContext getBindingContext(Marshaller m) {
return getJAXBFactory(m).getContext(m);
}
}