Skip to content

Commit 0b11c42

Browse files
Copilotslachiewicz
Copilot
and
slachiewicz
committed
Override getPackage/getPackages to make imported packages visible
Co-authored-by: slachiewicz <[email protected]>
1 parent 9a6e572 commit 0b11c42

File tree

2 files changed

+272
-0
lines changed

2 files changed

+272
-0
lines changed

‎src/main/java/org/codehaus/plexus/classworlds/realm/ClassRealm.java‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,107 @@ public Enumeration<URL> loadResourcesFromParent(String name) {
438438
return null;
439439
}
440440

441+
@Override
442+
protected Package getPackage(String name) {
443+
Package pkg = super.getPackage(name);
444+
445+
if (pkg == null) {
446+
// Check imported packages from foreign imports
447+
for (Entry entry : foreignImports) {
448+
if (entry.matches(name + ".Dummy")) {
449+
ClassLoader importClassLoader = entry.getClassLoader();
450+
if (importClassLoader != null) {
451+
pkg = getPackageFromClassLoader(importClassLoader, name);
452+
if (pkg != null) {
453+
return pkg;
454+
}
455+
}
456+
}
457+
}
458+
459+
// Check imported packages from parent
460+
ClassLoader parent = getParentClassLoader();
461+
if (parent != null && isImportedFromParent(name + ".Dummy")) {
462+
pkg = getPackageFromClassLoader(parent, name);
463+
}
464+
}
465+
466+
return pkg;
467+
}
468+
469+
@Override
470+
protected Package[] getPackages() {
471+
Collection<Package> packages = new LinkedHashSet<>();
472+
473+
// Add packages from parent first
474+
Collections.addAll(packages, super.getPackages());
475+
476+
// Add packages from foreign imports
477+
for (Entry entry : foreignImports) {
478+
ClassLoader importClassLoader = entry.getClassLoader();
479+
if (importClassLoader != null) {
480+
Package[] importedPackages = getPackagesFromClassLoader(importClassLoader);
481+
for (Package pkg : importedPackages) {
482+
// Only include packages that match the import pattern
483+
if (entry.matches(pkg.getName() + ".Dummy")) {
484+
packages.add(pkg);
485+
}
486+
}
487+
}
488+
}
489+
490+
// Add packages from parent classloader
491+
ClassLoader parent = getParentClassLoader();
492+
if (parent != null) {
493+
Package[] parentPackages = getPackagesFromClassLoader(parent);
494+
for (Package pkg : parentPackages) {
495+
if (isImportedFromParent(pkg.getName() + ".Dummy")) {
496+
packages.add(pkg);
497+
}
498+
}
499+
}
500+
501+
return packages.toArray(new Package[0]);
502+
}
503+
504+
private static Package getPackageFromClassLoader(ClassLoader classLoader, String name) {
505+
// Use reflection to call getDefinedPackage (Java 9+) or getPackage (pre-Java 9)
506+
try {
507+
java.lang.reflect.Method method = ClassLoader.class.getMethod("getDefinedPackage", String.class);
508+
return (Package) method.invoke(classLoader, name);
509+
} catch (NoSuchMethodException e) {
510+
// Fall back to deprecated getPackage method (Java 8 and earlier)
511+
try {
512+
java.lang.reflect.Method method = ClassLoader.class.getDeclaredMethod("getPackage", String.class);
513+
method.setAccessible(true);
514+
return (Package) method.invoke(classLoader, name);
515+
} catch (Exception ex) {
516+
return null;
517+
}
518+
} catch (Exception e) {
519+
return null;
520+
}
521+
}
522+
523+
private static Package[] getPackagesFromClassLoader(ClassLoader classLoader) {
524+
// Use reflection to call getDefinedPackages (Java 9+) or getPackages (pre-Java 9)
525+
try {
526+
java.lang.reflect.Method method = ClassLoader.class.getMethod("getDefinedPackages");
527+
return (Package[]) method.invoke(classLoader);
528+
} catch (NoSuchMethodException e) {
529+
// Fall back to deprecated getPackages method (Java 8 and earlier)
530+
try {
531+
java.lang.reflect.Method method = ClassLoader.class.getDeclaredMethod("getPackages");
532+
method.setAccessible(true);
533+
return (Package[]) method.invoke(classLoader);
534+
} catch (Exception ex) {
535+
return new Package[0];
536+
}
537+
} catch (Exception e) {
538+
return new Package[0];
539+
}
540+
}
541+
441542
static {
442543
registerAsParallelCapable();
443544
}

‎src/test/java/org/codehaus/plexus/classworlds/realm/PackageVisibilityTest.java‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
package org.codehaus.plexus.classworlds.realm;
2+
3+
import java.io.File;
4+
import java.lang.reflect.Method;
5+
6+
import org.codehaus.plexus.classworlds.AbstractClassWorldsTestCase;
7+
import org.codehaus.plexus.classworlds.ClassWorld;
8+
import org.junit.jupiter.api.Test;
9+
10+
import static org.junit.jupiter.api.Assertions.assertEquals;
11+
import static org.junit.jupiter.api.Assertions.assertNotNull;
12+
import static org.junit.jupiter.api.Assertions.assertTrue;
13+
14+
/**
15+
* Test that packages imported from other ClassLoaders are visible.
16+
*/
17+
class PackageVisibilityTest extends AbstractClassWorldsTestCase {
18+
19+
@Test
20+
void getPackageForImportedPackage() throws Exception {
21+
ClassWorld world = new ClassWorld();
22+
ClassRealm realmA = world.newRealm("realmA");
23+
ClassRealm realmB = world.newRealm("realmB");
24+
25+
// Add log4j to realmA (using absolute path since maven copies it to target/test-lib)
26+
File log4jJar = new File("target/test-lib/log4j-api-2.23.1.jar");
27+
if (!log4jJar.exists()) {
28+
// Fallback if running tests outside maven
29+
log4jJar = new File("../../target/test-lib/log4j-api-2.23.1.jar");
30+
}
31+
realmA.addURL(log4jJar.toURI().toURL());
32+
33+
// Import the package from realmA to realmB
34+
realmB.importFrom("realmA", "org.apache.logging.log4j");
35+
36+
// Load a class to ensure the package is defined
37+
Class<?> loggerClass = realmB.loadClass("org.apache.logging.log4j.Logger");
38+
assertNotNull(loggerClass);
39+
40+
// The package should be visible through the class (this is what JEXL uses)
41+
Package pkgViaClass = loggerClass.getPackage();
42+
assertNotNull(pkgViaClass, "Package should be visible via Class.getPackage()");
43+
assertEquals("org.apache.logging.log4j", pkgViaClass.getName());
44+
45+
// Try to test the protected getPackage() method we overrode (may fail on Java 9+ due to modules)
46+
try {
47+
Method getPackageMethod = ClassLoader.class.getDeclaredMethod("getPackage", String.class);
48+
getPackageMethod.setAccessible(true);
49+
Package pkgViaLoader = (Package) getPackageMethod.invoke(realmB, "org.apache.logging.log4j");
50+
assertNotNull(pkgViaLoader, "Package should be visible via ClassLoader.getPackage()");
51+
assertEquals("org.apache.logging.log4j", pkgViaLoader.getName());
52+
} catch (Exception e) {
53+
// Skip this check on Java 9+ if module system prevents access
54+
System.out.println("Skipping direct getPackage() test due to module restrictions");
55+
}
56+
}
57+
58+
@Test
59+
void getPackagesIncludesImportedPackages() throws Exception {
60+
ClassWorld world = new ClassWorld();
61+
ClassRealm realmA = world.newRealm("realmA");
62+
ClassRealm realmB = world.newRealm("realmB");
63+
64+
// Add log4j to realmA
65+
File log4jJar = new File("target/test-lib/log4j-api-2.23.1.jar");
66+
if (!log4jJar.exists()) {
67+
log4jJar = new File("../../target/test-lib/log4j-api-2.23.1.jar");
68+
}
69+
realmA.addURL(log4jJar.toURI().toURL());
70+
71+
// Import the package from realmA to realmB
72+
realmB.importFrom("realmA", "org.apache.logging.log4j");
73+
74+
// Load a class to ensure the package is defined
75+
realmB.loadClass("org.apache.logging.log4j.Logger");
76+
77+
// Try to test the protected getPackages() method we overrode (may fail on Java 9+ due to modules)
78+
try {
79+
Method getPackagesMethod = ClassLoader.class.getDeclaredMethod("getPackages");
80+
getPackagesMethod.setAccessible(true);
81+
Package[] packages = (Package[]) getPackagesMethod.invoke(realmB);
82+
83+
// Check if the imported package is included
84+
boolean found = false;
85+
for (Package pkg : packages) {
86+
if ("org.apache.logging.log4j".equals(pkg.getName())) {
87+
found = true;
88+
break;
89+
}
90+
}
91+
assertTrue(found, "Imported package should be included in getPackages()");
92+
} catch (Exception e) {
93+
// Skip this check on Java 9+ if module system prevents access
94+
System.out.println("Skipping direct getPackages() test due to module restrictions");
95+
}
96+
}
97+
98+
@Test
99+
void getPackageForParentImportedPackage() throws Exception {
100+
ClassWorld world = new ClassWorld();
101+
ClassRealm parent = world.newRealm("parent");
102+
ClassRealm child = world.newRealm("child");
103+
104+
// Add log4j to parent
105+
File log4jJar = new File("target/test-lib/log4j-api-2.23.1.jar");
106+
if (!log4jJar.exists()) {
107+
log4jJar = new File("../../target/test-lib/log4j-api-2.23.1.jar");
108+
}
109+
parent.addURL(log4jJar.toURI().toURL());
110+
111+
// Set parent and import from parent
112+
child.setParentRealm(parent);
113+
child.importFromParent("org.apache.logging.log4j");
114+
115+
// Load a class to ensure the package is defined
116+
Class<?> loggerClass = child.loadClass("org.apache.logging.log4j.Logger");
117+
assertNotNull(loggerClass);
118+
119+
// The package should be visible through the class
120+
Package pkgViaClass = loggerClass.getPackage();
121+
assertNotNull(pkgViaClass, "Package should be visible via Class.getPackage()");
122+
assertEquals("org.apache.logging.log4j", pkgViaClass.getName());
123+
124+
// Try to test the protected getPackage() method (may fail on Java 9+ due to modules)
125+
try {
126+
Method getPackageMethod = ClassLoader.class.getDeclaredMethod("getPackage", String.class);
127+
getPackageMethod.setAccessible(true);
128+
Package pkgViaLoader = (Package) getPackageMethod.invoke(child, "org.apache.logging.log4j");
129+
assertNotNull(pkgViaLoader, "Package should be visible from parent via ClassLoader.getPackage()");
130+
assertEquals("org.apache.logging.log4j", pkgViaLoader.getName());
131+
} catch (Exception e) {
132+
// Skip this check on Java 9+ if module system prevents access
133+
System.out.println("Skipping direct getPackage() test due to module restrictions");
134+
}
135+
}
136+
137+
@Test
138+
void multipleImportedPackages() throws Exception {
139+
ClassWorld world = new ClassWorld();
140+
ClassRealm realmA = world.newRealm("realmA");
141+
ClassRealm realmB = world.newRealm("realmB");
142+
ClassRealm realmC = world.newRealm("realmC");
143+
144+
// Add different jars to different realms
145+
File log4jJar = new File("target/test-lib/log4j-api-2.23.1.jar");
146+
File jaxbJar = new File("target/test-lib/jakarta.xml.bind-api-4.0.4.jar");
147+
if (!log4jJar.exists()) {
148+
log4jJar = new File("../../target/test-lib/log4j-api-2.23.1.jar");
149+
jaxbJar = new File("../../target/test-lib/jakarta.xml.bind-api-4.0.4.jar");
150+
}
151+
realmA.addURL(log4jJar.toURI().toURL());
152+
realmB.addURL(jaxbJar.toURI().toURL());
153+
154+
// Import packages from both realms to realmC
155+
realmC.importFrom("realmA", "org.apache.logging.log4j");
156+
realmC.importFrom("realmB", "jakarta.xml.bind");
157+
158+
// Load classes from both imported packages
159+
Class<?> loggerClass = realmC.loadClass("org.apache.logging.log4j.Logger");
160+
Class<?> jaxbClass = realmC.loadClass("jakarta.xml.bind.JAXBContext");
161+
162+
// Both packages should be visible
163+
Package log4jPkg = loggerClass.getPackage();
164+
assertNotNull(log4jPkg);
165+
assertEquals("org.apache.logging.log4j", log4jPkg.getName());
166+
167+
Package jaxbPkg = jaxbClass.getPackage();
168+
assertNotNull(jaxbPkg);
169+
assertEquals("jakarta.xml.bind", jaxbPkg.getName());
170+
}
171+
}

0 commit comments

Comments
 (0)