org.glassfish.config.support.SystemPropertyUpgrade 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) 2010-2012 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 [2018-2021] Payara Foundation and/or affiliates
package org.glassfish.config.support;
import java.beans.PropertyVetoException;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.sun.enterprise.config.serverbeans.*;
import static com.sun.enterprise.config.util.PortConstants.*;
import org.glassfish.api.admin.config.ConfigurationUpgrade;
import org.jvnet.hk2.annotations.Optional;
import org.jvnet.hk2.annotations.Service;
import org.glassfish.hk2.api.PostConstruct;
import org.jvnet.hk2.config.ConfigSupport;
import org.jvnet.hk2.config.TransactionFailure;
import org.jvnet.hk2.config.SingleConfigCode;
import jakarta.inject.Inject;
import jakarta.inject.Named;
/**
* Upgrade service to add the new 3.1 system properties to the config elements
* (except DAS config, server-config) in existing domain.xml:
*
*
*
*
* Use the same prefix as the config's system property HTTP_LISTENER_PORT if it exists.
*
* @author Jennifer Chou
*/
@Service
public class SystemPropertyUpgrade implements ConfigurationUpgrade, PostConstruct {
@Inject
Configs configs;
@Inject
Domain domain;
@Inject
Servers servers;
/*
* Required to make gms changes before any changes to a cluster
* or config can be saved. This is because GMS changed attribute
* names from v2 to 3.1. (Issue 15195.)
*/
@Inject
@Named("gmsupgrade")
@Optional
ConfigurationUpgrade precondition = null;
private String PREFIX = "2";
private static final int DEFAULT_ADMIN_PORT = 4848;
private static final String DAS_CONFIG = "server-config";
private static final String DEFAULT_CONFIG = "default-config";
private static final String DAS = "server";
@Override
public void postConstruct() {
upgradeConfigElements();
upgradeServerElements();
}
private void upgradeConfigElements() {
int incr = 0;
for (Config c : configs.getConfig()) {
try {
if (!c.getName().equals(DAS_CONFIG)) {
SystemPropertyBag bag = c;
String httpVal = bag.getSystemProperty(HTTP).getValue();
if (httpVal != null) {
PREFIX = httpVal.substring(0, httpVal.length() - 4);
final int adminPort;
final int osgiPort;
final int debugPort;
if (!c.getName().equals(DEFAULT_CONFIG)) {
adminPort = DEFAULT_ADMIN_PORT + incr;
osgiPort = DEFAULT_OSGI_SHELL_TELNET_PORT + incr;
debugPort = DEFAULT_JAVA_DEBUGGER_PORT + incr;
incr++;
} else {
adminPort = DEFAULT_ADMIN_PORT;
osgiPort = DEFAULT_OSGI_SHELL_TELNET_PORT ;
debugPort = DEFAULT_JAVA_DEBUGGER_PORT;
}
ConfigSupport.apply(new SingleConfigCode() {
@Override
public Object run(SystemPropertyBag config) throws PropertyVetoException, TransactionFailure {
createSystemProperty(config, ADMIN, adminPort);
createSystemProperty(config, OSGI, osgiPort);
createSystemProperty(config, DEBUG, debugPort);
return null;
}
}, c);
}
}
} catch (Exception e) {
Logger.getAnonymousLogger().log(Level.SEVERE, Strings.get("SystemPropertyUpgrade.Failure", c), e);
throw new RuntimeException(e);
}
}
}
private void upgradeServerElements() {
//TODO Do this per node host - we can reuse port #s if they are on different hosts
int incr = 0;
for (Cluster c : domain.getClusters().getCluster()) {
for (Server s : c.getInstances()) {
incr = createServerSystemProperty(s, incr);
}
}
}
private int createServerSystemProperty(Server s, int incr) {
try {
if (!s.getName().equals(DAS)) {
SystemPropertyBag bag = s;
if (bag.getSystemProperty(HTTP) != null) {
final String httpVal = bag.getSystemProperty(HTTP).getValue();
if (httpVal != null) {
PREFIX = httpVal.substring(0, httpVal.length() - 5);
String configAdminSP = null;
String configOsgiSP = null;
String configDebugSP = null;
for (SystemProperty sp : s.getConfig().getSystemProperty()) {
if (sp.getName().equals(ADMIN)) {
configAdminSP = sp.getValue();
}
if (sp.getName().equals(OSGI)) {
configOsgiSP = sp.getValue();
}
if (sp.getName().equals(DEBUG)) {
configDebugSP = sp.getValue();
}
}
int baseAdmin;
if (configAdminSP == null) {
baseAdmin = DEFAULT_ADMIN_PORT;
} else {
baseAdmin = Integer.parseInt(configAdminSP);
}
int baseOsgi;
if (configOsgiSP == null) {
baseOsgi = DEFAULT_OSGI_SHELL_TELNET_PORT;
} else {
baseOsgi = Integer.parseInt(configOsgiSP);
}
int baseDebug;
if (configDebugSP == null) {
baseDebug = DEFAULT_JAVA_DEBUGGER_PORT;
} else {
baseDebug = Integer.parseInt(configDebugSP);
}
incr++;
final int adminPort = baseAdmin + incr;
final int osgiPort = baseOsgi + incr;
final int debugPort = baseDebug + incr;
ConfigSupport.apply(new SingleConfigCode() {
@Override
public Object run(SystemPropertyBag config) throws PropertyVetoException, TransactionFailure {
createSystemProperty(config, ADMIN, adminPort);
createSystemProperty(config, OSGI, osgiPort);
createSystemProperty(config, DEBUG, debugPort);
return null;
}
}, s);
}
}
}
return incr;
} catch (Exception e) {
Logger.getAnonymousLogger().log(Level.SEVERE,
Strings.get("SystemPropertyUpgrade.Failure", s), e);
throw new RuntimeException(e);
}
}
private void createSystemProperty(SystemPropertyBag spb, String portName, int portVal) throws TransactionFailure, PropertyVetoException {
if (spb.getSystemProperty(portName) == null) {
SystemProperty newSysProp = spb.createChild(SystemProperty.class);
newSysProp.setName(portName);
newSysProp.setValue(PREFIX + portVal);
spb.getSystemProperty().add(newSysProp);
}
}
}