Skip to content

EclipseLink: allow reading persistence.xml from the filesystem #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eric-maynard merged 1 commit into from
Jan 6, 2025
Merged

EclipseLink: allow reading persistence.xml from the filesystem #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions extension/persistence/eclipselink/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,3 @@ dependencies {
testImplementation(libs.mockito.core)
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
}

tasks.register<Jar>("archiveConf") {
archiveFileName = "conf.jar"
destinationDirectory = layout.buildDirectory.dir("conf")

from("src/main/resources/META-INF/") { include("persistence.xml") }
}

tasks.named("test") { dependsOn("archiveConf") }
119 changes: 13 additions & 106 deletions ...olaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreSessionImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@
*/
package org.apache.polaris.extension.persistence.impl.eclipselink;

import static org.eclipse.persistence.config.PersistenceUnitProperties.ECLIPSELINK_PERSISTENCE_XML;
import static org.eclipse.persistence.config.PersistenceUnitProperties.JDBC_URL;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Predicates;
import jakarta.annotation.Nonnull;
Expand All @@ -29,14 +26,9 @@
import jakarta.persistence.EntityManagerFactory;
import jakarta.persistence.EntityTransaction;
import jakarta.persistence.OptimisticLockException;
import jakarta.persistence.Persistence;
import jakarta.persistence.PersistenceException;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.HashMap;
import java.io.UncheckedIOException;
import java.util.List;
import java.util.Locale;
import java.util.Map;
Expand All @@ -45,13 +37,6 @@
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpressionException;
import javax.xml.xpath.XPathFactory;
import org.apache.polaris.core.PolarisCallContext;
import org.apache.polaris.core.context.RealmContext;
import org.apache.polaris.core.entity.PolarisBaseEntity;
Expand All @@ -78,10 +63,6 @@
import org.apache.polaris.jpa.models.ModelPrincipalSecrets;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

/**
* EclipseLink implementation of a Polaris metadata store supporting persisting and retrieving all
Expand Down Expand Up @@ -141,99 +122,25 @@ private EntityManagerFactory createEntityManagerFactory(
@Nullable String confFile,
@Nullable String persistenceUnitName) {
String realm = realmContext.getRealmIdentifier();
EntityManagerFactory factory = realmFactories.getOrDefault(realm, null);
if (factory != null) {
return factory;
}

ClassLoader prevClassLoader = Thread.currentThread().getContextClassLoader();
try {
persistenceUnitName = persistenceUnitName == null ? "polaris" : persistenceUnitName;
confFile = confFile == null ? "META-INF/persistence.xml" : confFile;

// Currently eclipseLink can only support configuration as a resource inside a jar. To support
// external configuration, persistence.xml needs be placed inside a jar and here is to add the
// jar to the classpath.
// Supported configuration file: META-INF/persistence.xml, /tmp/conf.jar!/persistence.xml
int splitPosition = confFile.indexOf("!/");
if (splitPosition != -1) {
String jarPrefixPath = confFile.substring(0, splitPosition);
confFile = confFile.substring(splitPosition + 2);
URL prefixUrl = this.getClass().getClassLoader().getResource(jarPrefixPath);
if (prefixUrl == null) {
prefixUrl = new File(jarPrefixPath).toURI().toURL();
}

LOGGER.debug(
"Creating a new ClassLoader with the jar {} in classpath to load the config file",
prefixUrl);

URLClassLoader currentClassLoader =
new URLClassLoader(new URL[] {prefixUrl}, this.getClass().getClassLoader());

LOGGER.debug("Update ClassLoader in current thread temporarily");
Thread.currentThread().setContextClassLoader(currentClassLoader);
}

Map<String, String> properties = loadProperties(confFile, persistenceUnitName);
// Replace database name in JDBC URL with realm
if (properties.containsKey(JDBC_URL)) {
properties.put(JDBC_URL, properties.get(JDBC_URL).replace("{realm}", realm));
}
properties.put(ECLIPSELINK_PERSISTENCE_XML, confFile);

factory = Persistence.createEntityManagerFactory(persistenceUnitName, properties);
realmFactories.putIfAbsent(realm, factory);

return factory;
} catch (IOException e) {
throw new RuntimeException(e);
} finally {
Thread.currentThread().setContextClassLoader(prevClassLoader);
}
return realmFactories.computeIfAbsent(
realm,
key -> {
try {
PolarisEclipseLinkPersistenceUnit persistenceUnit =
PolarisEclipseLinkPersistenceUnit.locatePersistenceUnit(
confFile, persistenceUnitName);
return persistenceUnit.createEntityManagerFactory(realmContext);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
});
}

@VisibleForTesting
static void clearEntityManagerFactories() {
realmFactories.clear();
}

/** Load the persistence unit properties from a given configuration file */
private Map<String, String> loadProperties(
@Nonnull String confFile, @Nonnull String persistenceUnitName) throws IOException {
try {
InputStream input =
Thread.currentThread().getContextClassLoader().getResourceAsStream(confFile);
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = factory.newDocumentBuilder();
Document doc = builder.parse(input);
XPath xPath = XPathFactory.newInstance().newXPath();
String expression =
"/persistence/persistence-unit[@name='" + persistenceUnitName + "']/properties/property";
NodeList nodeList =
(NodeList) xPath.compile(expression).evaluate(doc, XPathConstants.NODESET);
Map<String, String> properties = new HashMap<>();
for (int i = 0; i < nodeList.getLength(); i++) {
NamedNodeMap nodeMap = nodeList.item(i).getAttributes();
properties.put(
nodeMap.getNamedItem("name").getNodeValue(),
nodeMap.getNamedItem("value").getNodeValue());
}

return properties;
} catch (XPathExpressionException
| ParserConfigurationException
| SAXException
| IOException e) {
String str =
String.format(
"Cannot find or parse the configuration file %s for persistence-unit %s",
confFile, persistenceUnitName);
LOGGER.error(str, e);
throw new IOException(str);
}
}

/** {@inheritDoc} */
@Override
public <T> T runInTransaction(
Expand Down
Loading
Loading