org.glassfish.config.support.DomainXml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2008-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2016-2021] [Payara Foundation and/or its affiliates]
package org.glassfish.config.support;
import com.sun.enterprise.config.serverbeans.Cluster;
import com.sun.enterprise.config.serverbeans.Server;
import com.sun.enterprise.module.ModulesRegistry;
import com.sun.enterprise.module.bootstrap.EarlyLogHandler;
import com.sun.enterprise.module.bootstrap.StartupContext;
import com.sun.enterprise.util.LocalStringManagerImpl;
import org.glassfish.api.admin.ServerEnvironment;
import org.glassfish.api.admin.config.ConfigurationCleanup;
import org.glassfish.api.admin.config.ConfigurationUpgrade;
import org.glassfish.hk2.api.ServiceHandle;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.hk2.utilities.ServiceLocatorUtilities;
import org.glassfish.server.ServerEnvironmentImpl;
import org.jvnet.hk2.annotations.Optional;
import org.jvnet.hk2.config.ConfigParser;
import org.jvnet.hk2.config.ConfigPopulatorException;
import org.jvnet.hk2.config.DomDocument;
import org.jvnet.hk2.config.Populator;
import jakarta.inject.Inject;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLResolver;
import javax.xml.stream.XMLStreamException;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.concurrent.locks.Lock;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import static com.sun.enterprise.config.util.ConfigApiLoggerInfo.*;
/**
* Locates and parses the portion of domain.xml that we care.
*
* @author Jerome Dochez
* @author Kohsuke Kawaguchi
* @author Byron Nevins
*/
public abstract class DomainXml implements Populator {
@Inject
StartupContext context;
@Inject
protected ServiceLocator habitat;
@Inject
@Optional
private ModulesRegistry registry;
@Inject
XMLInputFactory xif;
@Inject
ServerEnvironmentImpl env;
@Inject
ConfigurationAccess configAccess;
static final LocalStringManagerImpl LOCAL_STRINGS = new LocalStringManagerImpl(DomainXml.class);
@Override
public void run(ConfigParser parser) throws ConfigPopulatorException {
LogRecord lr = new LogRecord(Level.FINE, startupClass + this.getClass().getName());
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
ClassLoader parentClassLoader;
if (registry == null){
parentClassLoader = registry.getParentClassLoader();
} else {
parentClassLoader = getClass().getClassLoader();
}
if (parentClassLoader == null) {
parentClassLoader = getClass().getClassLoader();
}
ServiceLocatorUtilities.addOneConstant(habitat, parentClassLoader, null, ClassLoader.class);
try {
parseDomainXml(parser, getDomainXml(env), env.getInstanceName());
} catch (IOException e) {
throw new ConfigPopulatorException(LOCAL_STRINGS.getLocalString("ConfigParsingFailed", "Failed to parse domain.xml"), e);
}
// run the upgrades...
if ("upgrade".equals(context.getPlatformMainServiceName())) {
upgrade();
}
// run the cleanup.
for (ServiceHandle cc : habitat.getAllServiceHandles(ConfigurationCleanup.class)) {
try {
cc.getService(); // run the upgrade
lr = new LogRecord(Level.FINE, successfulCleanupWith + cc.getClass());
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
} catch (Exception e) {
lr = new LogRecord(Level.FINE, e.toString() + e);
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
lr = new LogRecord(Level.SEVERE, cc.getClass() + cleaningDomainXmlFailed + e);
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
}
}
decorate();
}
protected void decorate() {
Server server = habitat.getService(Server.class, env.getInstanceName());
if (server == null) {
LogRecord lr = new LogRecord(Level.SEVERE, badEnv);
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
return;
}
ServiceLocatorUtilities.addOneConstant(habitat, server, ServerEnvironment.DEFAULT_INSTANCE_NAME, Server.class);
server.getConfig().addIndex(habitat, ServerEnvironment.DEFAULT_INSTANCE_NAME);
Cluster c = server.getCluster();
if (c != null) {
ServiceLocatorUtilities.addOneConstant(habitat, c, ServerEnvironment.DEFAULT_INSTANCE_NAME, Cluster.class);
}
}
protected void upgrade() {
// run the upgrades...
for (ServiceHandle cu : habitat.getAllServiceHandles(ConfigurationUpgrade.class)) {
try {
cu.getService(); // run the upgrade
LogRecord lr = new LogRecord(Level.FINE, successfulUpgrade + cu.getClass());
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
} catch (Exception e) {
LogRecord lr = new LogRecord(Level.FINE, e.toString() + e);
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
lr = new LogRecord(Level.SEVERE, cu.getClass() + failedUpgrade + e);
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
}
}
}
/**
* Determines the location of domain.xml to be parsed.
* @param env
* @return
* @throws IOException
*/
protected URL getDomainXml(ServerEnvironmentImpl env) throws IOException {
File domainXml = new File(env.getConfigDirPath(), ServerEnvironmentImpl.kConfigXMLFileName);
if (domainXml.exists() && domainXml.length() > 0) {
return domainXml.toURI().toURL();
} else {
LogRecord lr = new LogRecord(Level.SEVERE, domainXml.getAbsolutePath() + noBackupFile);
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
domainXml = new File(env.getConfigDirPath(), ServerEnvironmentImpl.kConfigXMLFileNameBackup);
if (domainXml.exists() && domainXml.length() > 0) {
return domainXml.toURI().toURL();
}
lr = new LogRecord(Level.SEVERE, noBackupFile);
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
}
throw new IOException(LOCAL_STRINGS.getLocalString("NoUsableConfigFile", "No usable configuration file at {0}", env.getConfigDirPath()));
}
/**
* Parses domain.xml
* @param parser
* @param domainXml
* @param serverName
*/
protected void parseDomainXml(ConfigParser parser, final URL domainXml, final String serverName) {
long startNano = System.nanoTime();
try {
ServerReaderFilter xsr = null;
// Set the resolver so that any external entity references, such
// as a reference to a DTD, return an empty file. The domain.xml
// file doesn't support entity references.
xif.setXMLResolver(new XMLResolver() {
@Override
public Object resolveEntity(String publicID,
String systemID,
String baseURI,
String namespace)
throws XMLStreamException {
return new ByteArrayInputStream(new byte[0]);
}
});
if (null == env.getRuntimeType()) {
throw new RuntimeException("Internal Error: Unknown server type: " + env.getRuntimeType());
} else {
switch (env.getRuntimeType()) {
case DAS:
case EMBEDDED:
case MICRO:
xsr = new DasReaderFilter(domainXml, xif);
break;
case INSTANCE:
xsr = new InstanceReaderFilter(env.getInstanceName(), domainXml, xif);
break;
default:
throw new RuntimeException("Internal Error: Unknown server type: " + env.getRuntimeType());
}
}
Lock lock = null;
try {
// lock the domain.xml for reading if not embedded
try {
lock = configAccess.accessRead();
} catch (Exception e) {
// ignore
}
parser.parse(xsr, getDomDocument());
xsr.close();
} finally {
if (lock != null) {
lock.unlock();
}
}
String errorMessage = xsr.configWasFound();
if (errorMessage != null) {
LogRecord lr = new LogRecord(Level.WARNING, errorMessage);
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
}
} catch (Exception e) {
if (e instanceof RuntimeException){
throw (RuntimeException) e;
} else {
throw new RuntimeException("Fatal Error. Unable to parse " + domainXml, e);
}
}
Long l = System.nanoTime() - startNano;
LogRecord lr = new LogRecord(Level.FINE, totalTimeToParseDomain + l.toString());
lr.setLoggerName(getClass().getName());
EarlyLogHandler.earlyMessages.add(lr);
}
protected abstract DomDocument getDomDocument();
}