SetWebContextParamCommand.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-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.
 */

package org.glassfish.web.plugin.common;

import org.glassfish.web.config.serverbeans.WebModuleConfig;
import org.glassfish.web.config.serverbeans.ContextParam;
import com.sun.enterprise.config.serverbeans.Application;
import com.sun.enterprise.config.serverbeans.Engine;
import java.beans.PropertyVetoException;
import org.glassfish.api.ActionReport;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.admin.AdminCommandContext;
import org.glassfish.api.admin.RestEndpoint;
import org.glassfish.api.admin.RestEndpoints;
import org.glassfish.api.admin.RestParam;

import org.jvnet.hk2.annotations.Service;
import org.glassfish.hk2.api.PerLookup;
import org.jvnet.hk2.config.ConfigSupport;
import org.jvnet.hk2.config.SingleConfigCode;
import org.jvnet.hk2.config.TransactionFailure;

/**
 *
 * @author tjquinn
 */
@Service(name="set-web-context-param")
@I18n("setWebContextParam.command")
@PerLookup
@RestEndpoints({
    @RestEndpoint(configBean=Application.class,
        opType=RestEndpoint.OpType.POST, 
        path="set-web-context-param", 
        description="set-web-context-param",
        params={
            @RestParam(name="id", value="$parent")
        })
})
public class SetWebContextParamCommand extends WebModuleConfigCommand {

    @Param(name="name")
    private String name;

    @Param(name="value",optional=true)
    private String value;

    @Param(name="description", optional=true)
    private String description;

    @Param(name="ignoreDescriptorItem", optional=true)
    private Boolean ignoreDescriptorItem;

    @Override
    public void execute(AdminCommandContext context) {
        ActionReport report = context.getActionReport();

        try {
            final Engine engine = engine(report);
            if (engine != null) {
                setContextParam(engine,
                    name, value, description, ignoreDescriptorItem, report);
            }
        } catch (Exception e) {
            fail(report, e, "errSetContextParam", "Error setting context param");
        }
    }

    private void setContextParam(final Engine owningEngine,
            final String paramName,
            final String paramValue,
            final String description,
            final Boolean ignoreDescriptorItem,
            final ActionReport report) throws PropertyVetoException, TransactionFailure {

        WebModuleConfig config = WebModuleConfig.Duck.webModuleConfig(owningEngine);
        if (config == null) {
            createContextParamOnNewWMC(owningEngine, paramName, paramValue,
                    description, ignoreDescriptorItem);
        } else {
            ContextParam cp = config.getContextParam(paramName);
            if (cp == null) {
                createContextParamOnExistingWMC(config, paramName,
                        paramValue, description, ignoreDescriptorItem);
            } else {
                modifyContextParam(cp, paramValue, description,
                            ignoreDescriptorItem);
                succeed(report, "setWebContextParamOverride",
                        "Previous context-param setting of {0} for application/module {1} was overridden.",
                        name, appNameAndOptionalModuleName());
            }
        }
    }

    private void createContextParamOnNewWMC(
            final Engine owningEngine,
            final String paramName,
            final String paramValue,
            final String description,
            final Boolean ignoreDescriptorItem) throws PropertyVetoException, TransactionFailure {


        ConfigSupport.apply(new SingleConfigCode<Engine>() {

            @Override
            public Object run(Engine e) throws PropertyVetoException, TransactionFailure {
                final WebModuleConfig config = e.createChild(WebModuleConfig.class);
                e.getApplicationConfigs().add(config);
                final ContextParam newParam = config.createChild(ContextParam.class);
                config.getContextParam().add(newParam);
                set(newParam, paramName, paramValue, description, ignoreDescriptorItem);
                return config;
            }
        }, owningEngine);

    }

    private void createContextParamOnExistingWMC(
            final WebModuleConfig config,
            final String paramName,
            final String paramValue,
            final String description,
            final Boolean ignoreDescriptorItem) throws PropertyVetoException, TransactionFailure {

        ConfigSupport.apply(new SingleConfigCode<WebModuleConfig>() {

            @Override
            public Object run(WebModuleConfig cf) throws PropertyVetoException, TransactionFailure {
                final ContextParam param = cf.createChild(ContextParam.class);
                cf.getContextParam().add(param);
                set(param, paramName, paramValue, description, ignoreDescriptorItem);
                return param;
            }
        }, config);
    }

    private void modifyContextParam(
            final ContextParam param,
            final String paramValue,
            final String description,
            final Boolean ignoreDescriptorItem) throws PropertyVetoException, TransactionFailure {
        ConfigSupport.apply(new SingleConfigCode<ContextParam>() {

            @Override
            public Object run(ContextParam cp) throws PropertyVetoException, TransactionFailure {
                set(cp, cp.getParamName(), paramValue, description, ignoreDescriptorItem);
                return cp;
            }
        }, param);
    }

    private void set(final ContextParam param,
            final String paramName,
            final String paramValue,
            final String description,
            final Boolean ignoreDescriptorItem) throws PropertyVetoException, TransactionFailure {
        if (ignoreDescriptorItem != null) {
            param.setIgnoreDescriptorItem(ignoreDescriptorItem.toString());
        }
        if (description != null) {
            param.setDescription(description);
        }
        if (paramValue != null) {
            param.setParamValue(paramValue);
        }
        if (paramName != null) {
            param.setParamName(paramName);
        }
    }

 }