org.glassfish.config.support.HttpServicePropertiesUpgrade Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2009-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 [2018] Payara Foundation and/or affiliates

package org.glassfish.config.support;

import com.sun.enterprise.config.serverbeans.AccessLog;
import com.sun.enterprise.config.serverbeans.Config;
import com.sun.enterprise.config.serverbeans.Configs;
import com.sun.enterprise.config.serverbeans.HttpService;
import com.sun.enterprise.config.util.ConfigApiLoggerInfo;

import org.glassfish.api.admin.AdminCommandContext;
import org.jvnet.hk2.annotations.Service;
import org.jvnet.hk2.config.ConfigSupport;
import org.jvnet.hk2.config.SingleConfigCode;
import org.jvnet.hk2.config.TransactionFailure;
import org.jvnet.hk2.config.types.Property;

import javax.inject.Inject;

import java.util.Iterator;
import java.util.List;
import java.util.logging.Level;

@Service
public class HttpServicePropertiesUpgrade extends BaseLegacyConfigurationUpgrade {
    
    @Inject
    private Configs configs;

    @Override
    public void execute(AdminCommandContext context) {
        for (Config config : configs.getConfig()) {
            HttpService service = config.getHttpService();
            if (service == null){
                continue;
            }
            boolean done = false;
            try {
                final List properties = service.getProperty();
                final Iterator iterator = properties.iterator();
                while (!done && iterator.hasNext()) {
                    final Property property = iterator.next();
                    String name = property.getName();
                    if ("accessLoggingEnabled".equals(name)
                        || "accessLogBufferSize".equals(name)
                        || "accessLogWriteInterval".equals(name)
                        || "sso-enabled".equals(name)) {
                        done = true;
                        upgrade(context, property, service);
                    }
                }
            } catch (TransactionFailure tf) {
                ConfigApiLoggerInfo.getLogger().log(Level.SEVERE, ConfigApiLoggerInfo.ERR_UPGRADE_HTTP_SVC_PROPS, tf);
                throw new RuntimeException(tf);
            }
        }
    }

    private void upgrade(final AdminCommandContext context, final Property property, final HttpService service)
            throws TransactionFailure {
        if (null != property.getName()) switch (property.getName()) {
            case "accessLoggingEnabled":
                updatePropertyToAttribute(context, service, "accessLoggingEnabled", "accessLoggingEnabled");
                break;
            case "accessLogBufferSize":
                ConfigSupport.apply(new SingleConfigCode() {
                    @Override
                    public Object run(AccessLog param) {
                        param.setBufferSizeBytes(property.getValue());
                        return param;
                    }
                }, service.getAccessLog());
                removeProperty(service, "accessLogBufferSize");
                report(context,
                        "Moved http-service.property.accessLogBufferSize to http-service.access-log.buffer-size-bytes");
                break;
            case "accessLogWriteInterval":
                ConfigSupport.apply(new SingleConfigCode() {
                    @Override
                    public Object run(AccessLog param) {
                        param.setWriteIntervalSeconds(property.getValue());
                        return param;
                    }
                }, service.getAccessLog());
                removeProperty(service, "accessLogWriteInterval");
                report(context,
                        "Moved http-service.property.accessLogWriteInterval to http-service.access-log.write-interval-seconds");
                break;
            case "sso-enabled":
                updatePropertyToAttribute(context, service, "sso-enabled", "ssoEnabled");
                break;
            default:
                break;
        }
    }

}