META-INF.versions.9.jakarta.xml.bind.ModuleUtil Maven / Gradle / Ivy
/*
* Copyright (c) 2017, 2021 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 jakarta.xml.bind;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Propagates openness of Jakarta XML Binding annottated classess packages to Jakarta XML Binding impl module.
*
* @author Roman Grigoriadi
*/
class ModuleUtil {
private static Logger logger = Logger.getLogger("jakarta.xml.bind");
/**
* Resolves classes from context path.
* Only one class per package is needed to access its {@link java.lang.Module}
*/
static Class[] getClassesFromContextPath(String contextPath, ClassLoader classLoader) throws JAXBException {
List classes = new ArrayList<>();
if (contextPath == null || contextPath.isEmpty()){
return classes.toArray(new Class[]{});
}
String [] tokens = contextPath.split(":");
for (String pkg : tokens){
// look for ObjectFactory and load it
final Class o;
try {
o = classLoader.loadClass(pkg+".ObjectFactory");
classes.add(o);
continue;
} catch (ClassNotFoundException e) {
// not necessarily an error
}
// look for jaxb.index and load the list of classes
try {
final Class firstByJaxbIndex = findFirstByJaxbIndex(pkg, classLoader);
if (firstByJaxbIndex != null) {
classes.add(firstByJaxbIndex);
}
} catch (IOException e) {
throw new JAXBException(e);
}
}
if (logger.isLoggable(Level.FINE)) {
logger.log(Level.FINE, "Resolved classes from context path: {0}", classes);
}
return classes.toArray(new Class[]{});
}
/**
* Find first class in package by {@code jaxb.index} file.
*/
static Class findFirstByJaxbIndex(String pkg, ClassLoader classLoader) throws IOException, JAXBException {
final String resource = pkg.replace('.', '/') + "/jaxb.index";
final InputStream resourceAsStream = classLoader.getResourceAsStream(resource);
if (resourceAsStream == null) {
return null;
}
BufferedReader in =
new BufferedReader(new InputStreamReader(resourceAsStream, "UTF-8"));
try {
String className = in.readLine();
while (className != null) {
className = className.trim();
if (className.startsWith("#") || (className.length() == 0)) {
className = in.readLine();
continue;
}
try {
return classLoader.loadClass(pkg + '.' + className);
} catch (ClassNotFoundException e) {
throw new JAXBException(Messages.format(Messages.ERROR_LOAD_CLASS, className, pkg), e);
}
}
} finally {
in.close();
}
return null;
}
/**
* Implementation may be defined in other module than {@code jakarta.xml.bind}. In that case openness
* {@linkplain Module#isOpen open} of classes should be delegated to implementation module.
*
* @param classes used to resolve module for {@linkplain Module#addOpens(String, Module)}
* @param factorySPI used to resolve {@link Module} of the implementation.
*
* @throws JAXBException if ony of a classes package is not open to {@code jakarta.xml.bind} module.
*/
public static void delegateAddOpensToImplModule(Class[] classes, Class factorySPI) throws JAXBException {
final Module implModule = factorySPI.getModule();
Module jaxbModule = JAXBContext.class.getModule();
for (Class cls : classes) {
Class jaxbClass = cls.isArray() ?
cls.getComponentType() : cls;
final Module classModule = jaxbClass.getModule();
final String packageName = jaxbClass.getPackageName();
//no need for unnamed and java.base types
if (!classModule.isNamed() || classModule.getName().equals("java.base")) {
continue;
}
//report error if they are not open to jakarta.xml.bind
if (!classModule.isOpen(packageName, jaxbModule)) {
throw new JAXBException(Messages.format(Messages.JAXB_CLASSES_NOT_OPEN,
packageName, jaxbClass.getName(), classModule.getName()));
}
//propagate openness to impl module
classModule.addOpens(packageName, implModule);
if (logger.isLoggable(Level.FINE)) {
logger.log(Level.FINE, "Propagating openness of package {0} in {1} to {2}.",
new String[]{ packageName, classModule.getName(), implModule.getName() });
}
}
}
}