All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.glassfish.deployment.admin.CreateApplicationRefCommand Maven / Gradle / Ivy

/*
 * 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 [2017-2021] [Payara Foundation and/or its affiliates]
package org.glassfish.deployment.admin;

import com.sun.enterprise.admin.util.ClusterOperationUtil;
import com.sun.enterprise.config.serverbeans.*;
import java.util.Collection;
import org.glassfish.api.admin.AdminCommand;
import org.glassfish.api.admin.AdminCommandContext;
import org.glassfish.api.Param;
import org.glassfish.api.admin.ServerEnvironment;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.RuntimeType;
import org.glassfish.api.event.Events;
import org.glassfish.api.event.EventListener.Event;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.api.deployment.DeployCommandParameters;
import org.glassfish.api.deployment.OpsParams.Origin;
import org.glassfish.api.deployment.OpsParams.Command;
import org.glassfish.config.support.TargetType;
import org.glassfish.config.support.CommandTarget;
import org.glassfish.deployment.common.DeploymentUtils;
import org.glassfish.deployment.common.DeploymentContextImpl;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.deploy.shared.ArchiveFactory;
import fish.payara.enterprise.config.serverbeans.DeploymentGroup;
import org.glassfish.api.ActionReport;
import org.glassfish.api.I18n;
import org.glassfish.internal.deployment.Deployment;
import org.glassfish.internal.deployment.ExtendedDeploymentContext;
import jakarta.inject.Inject;
import jakarta.inject.Named;

import org.jvnet.hk2.annotations.Service;

import org.glassfish.hk2.api.PerLookup;
import org.glassfish.hk2.api.ServiceLocator;
import org.jvnet.hk2.config.TransactionFailure;
import org.jvnet.hk2.config.Transaction;

import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.Map;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import org.glassfish.api.admin.AccessRequired.AccessCheck;
import org.glassfish.api.admin.AdminCommandSecurity;
import org.glassfish.api.admin.FailurePolicy;
import org.glassfish.api.admin.ParameterMap;
import org.glassfish.api.admin.RestEndpoint;
import org.glassfish.api.admin.RestEndpoints;
import org.glassfish.deployment.common.ApplicationConfigInfo;
import org.glassfish.deployment.common.DeploymentProperties;
import org.glassfish.deployment.versioning.VersioningException;
import org.glassfish.deployment.versioning.VersioningSyntaxException;
import org.glassfish.deployment.versioning.VersioningUtils;
import org.glassfish.deployment.versioning.VersioningWildcardException;
import org.glassfish.deployment.versioning.VersioningService;

/**
 * Create application ref command
 */
@Service(name="create-application-ref")
@I18n("create.application.ref.command")
@ExecuteOn(value={RuntimeType.DAS})
@PerLookup
@TargetType(value={CommandTarget.DAS, CommandTarget.STANDALONE_INSTANCE, CommandTarget.CLUSTER, CommandTarget.DEPLOYMENT_GROUP})
@RestEndpoints({
    @RestEndpoint(configBean=Cluster.class,opType=RestEndpoint.OpType.POST, path="create-application-ref"),
    @RestEndpoint(configBean=Server.class,opType=RestEndpoint.OpType.POST, path="create-application-ref")
})
public class CreateApplicationRefCommand implements AdminCommand, AdminCommandSecurity.AccessCheckProvider {

    final private static LocalStringManagerImpl localStrings = new LocalStringManagerImpl(CreateApplicationRefCommand.class);

    @Param(primary=true)
    public String name = null;

    @Param(optional=true)
    String target = "server";

    @Param(optional=true)
    public String virtualservers = null;

    @Param(optional=true, defaultValue="true")
    public Boolean enabled = true;

    @Param(optional=true, acceptableValues="true,false")
    public String lbenabled;

    @Inject
    Deployment deployment;

    @Inject
    Domain domain;

    @Inject
    ServerEnvironment env;

    @Inject
    Applications applications;

    @Inject
    ArchiveFactory archiveFactory;

    @Inject
    VersioningService versioningService;

    @Inject @Named(ServerEnvironment.DEFAULT_INSTANCE_NAME)
    protected Server server;

    @Inject
    private ServiceLocator habitat;

    @Inject
    Events events;
    
    @Override
    public Collection getAccessChecks() {
        final List accessChecks = new ArrayList();
        accessChecks.add(new AccessCheck(DeploymentCommandUtils.getTargetResourceNameForNewAppRef(domain, target), "create"));
        return accessChecks;
    }

    /**
     * Entry point from the framework into the command execution
     * @param context context for the command.
     */
    public void execute(AdminCommandContext context) {
        final ActionReport report = context.getActionReport();
        final Logger logger = context.getLogger();
        // retrieve matched version(s) if exist
        List matchedVersions = null;

        if ( enabled ) {
            try {
                // warn users that they can use version expressions
                VersioningUtils.checkIdentifier(name);
                matchedVersions = new ArrayList(1);
                matchedVersions.add(name);
            } catch (VersioningWildcardException ex) {
                // a version expression is supplied with enabled == true
                report.setMessage(localStrings.getLocalString("wildcard.not.allowed",
                        "WARNING : version expression are available only with --enabled=false"));
                report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                return;
            } catch (VersioningSyntaxException ex) {
                report.setMessage(ex.getLocalizedMessage());
                report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                return;
            }

            if (!deployment.isRegistered(name)) {
                report.setMessage(localStrings.getLocalString("application.notreg", "Application {0} not registered", name));
                report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                return;
            }
        } else {
            // retrieve matched version(s) if exist
            try {
                matchedVersions = versioningService.getMatchedVersions(name, null);
            } catch (VersioningException e) {
                report.failure(logger, e.getMessage());
                return;
            }

            // if matched list is empty and no VersioningException thrown,
            // this is an unversioned behavior and the given application is not registered
            if(matchedVersions.isEmpty()){
                report.setMessage(localStrings.getLocalString("ref.not.referenced.target","Application {0} is not referenced by target {1}", name, target));
                report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                return;
            }
        }

        ActionReport.MessagePart part = report.getTopMessagePart();
        boolean isVersionExpression = VersioningUtils.isVersionExpression(name);

        // for each matched version
        Iterator it = matchedVersions.iterator();
        while (it.hasNext()) {
            String appName = (String) it.next();
            Application applicationInfo = applications.getApplication(appName);
            List deploymentGroups = domain.getDeploymentGroupsForInstance(target);
            boolean isAppOnDeploymentGroupInstance = false;

            if (deploymentGroups != null && deploymentGroups.isEmpty()) {
                List applicationsInTarget = domain.getApplicationsInTarget(target);
                List listOfApplications = new ArrayList<>();
                for (Application application : applicationsInTarget) {
                    listOfApplications.add(application.getName());
                }
                if (listOfApplications.contains(appName)) {
                    isAppOnDeploymentGroupInstance = true;
                    break;
                }
            }

            if (!isAppOnDeploymentGroupInstance) {
                ApplicationRef applicationRef = domain.getApplicationRefInTarget(appName, target);
                if (applicationRef != null) {
                    // we provides warning messages
                    // if a versioned name has been provided to the command
                    if (isVersionExpression) {
                        ActionReport.MessagePart childPart = part.addChild();
                        childPart.setMessage(localStrings.getLocalString("appref.already.exists",
                                "Application reference {0} already exists in target {1}.", appName, target));
                    } else {
                        // returns failure if an untagged name has been provided to the command
                        report.setMessage(localStrings.getLocalString("appref.already.exists",
                                "Application reference {0} already exists in target {1}.", name, target));
                        report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                        return;
                    }
                } else {

                    Transaction t = new Transaction();
                    if (applicationInfo.isLifecycleModule()) {
                        handleLifecycleModule(context, t);
                        return;
                    }

                    ReadableArchive archive;
                    File file = null;
                    DeployCommandParameters commandParams = null;
                    Properties contextProps;
                    Map modulePropsMap = null;
                    ApplicationConfigInfo savedAppConfig = null;
                    try {
                        commandParams = applicationInfo.getDeployParameters(null);
                        commandParams.origin = Origin.create_application_ref;
                        commandParams.command = Command.create_application_ref;
                        commandParams.target = target;
                        commandParams.virtualservers = virtualservers;
                        commandParams.enabled = enabled;
                        if (lbenabled != null) {
                            commandParams.lbenabled = lbenabled;
                        }
                        commandParams.type = applicationInfo.archiveType();

                        contextProps = applicationInfo.getDeployProperties();
                        modulePropsMap = applicationInfo.getModulePropertiesMap();
                        savedAppConfig = new ApplicationConfigInfo(applicationInfo);

                        URI uri = new URI(applicationInfo.getLocation());
                        file = new File(uri);

                        if (!file.exists()) {
                            report.setMessage(localStrings.getLocalString("fnf",
                                    "File not found", file.getAbsolutePath()));
                            report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                            return;
                        }

                        archive = archiveFactory.openArchive(file);
                    } catch (Exception e) {
                        logger.log(Level.SEVERE, "Error opening deployable artifact : " + file.getAbsolutePath(), e);
                        report.setMessage(localStrings.getLocalString("unknownarchiveformat", "Archive format not recognized"));
                        report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                        return;
                    }

                    try {
                        final ExtendedDeploymentContext deploymentContext
                                = deployment.getBuilder(logger, commandParams, report).source(archive).build();

                        Properties appProps = deploymentContext.getAppProps();
                        appProps.putAll(contextProps);

                        // relativize the location so it could be set properly in
                        // domain.xml
                        String location = DeploymentUtils.relativizeWithinDomainIfPossible(new URI(applicationInfo.getLocation()));
                        appProps.setProperty(ServerTags.LOCATION, location);

                        // relativize the URI properties so they could store in the
                        // domain.xml properly on the instances
                        String appLocation = appProps.getProperty(Application.APP_LOCATION_PROP_NAME);
                        appProps.setProperty(Application.APP_LOCATION_PROP_NAME, DeploymentUtils.relativizeWithinDomainIfPossible(new URI(appLocation)));
                        String planLocation = appProps.getProperty(Application.DEPLOYMENT_PLAN_LOCATION_PROP_NAME);
                        if (planLocation != null) {
                            appProps.setProperty(Application.DEPLOYMENT_PLAN_LOCATION_PROP_NAME, DeploymentUtils.relativizeWithinDomainIfPossible(new URI(planLocation)));
                        }
                        String altDDLocation = appProps.getProperty(Application.ALT_DD_LOCATION_PROP_NAME);
                        if (altDDLocation != null) {
                            appProps.setProperty(Application.ALT_DD_LOCATION_PROP_NAME, DeploymentUtils.relativizeWithinDomainIfPossible(new URI(altDDLocation)));
                        }
                        String runtimeAltDDLocation = appProps.getProperty(Application.RUNTIME_ALT_DD_LOCATION_PROP_NAME);
                        if (runtimeAltDDLocation != null) {
                            appProps.setProperty(Application.RUNTIME_ALT_DD_LOCATION_PROP_NAME, DeploymentUtils.relativizeWithinDomainIfPossible(new URI(runtimeAltDDLocation)));
                        }
                        savedAppConfig.store(appProps);

                        if (modulePropsMap != null) {
                            deploymentContext.setModulePropsMap(modulePropsMap);
                        }

                        if (enabled) {
                            versioningService.handleDisable(appName, target, deploymentContext.getActionReport(), context.getSubject());
                        }

                        if (domain.isCurrentInstanceMatchingTarget(target, appName, server.getName(), null)) {
                            deployment.deploy(deployment.getSniffersFromApp(applicationInfo), deploymentContext);
                        } else {
                            // send the APPLICATION_PREPARED event for DAS
                            events.send(new Event(Deployment.APPLICATION_PREPARED, deploymentContext), false);
                        }

                        final List targets
                                = new ArrayList(Arrays.asList(commandParams.target.split(",")));

                        List deploymentTarget = new ArrayList<>();

                        // If targets contains Deployment Group, check if the application is already deployed to instances in it.
                        for (String target : targets) {
                            if (isDeploymentGroup(target)) {
                                List instances = domain.getDeploymentGroupNamed(target).getInstances();
                                for (Server instance : instances) {
                                    List applications = domain.getApplicationsInTarget(instance.getName());
                                    List listOfApplications = new ArrayList<>();
                                    for (Application application : applications) {
                                        listOfApplications.add(application.getName());
                                    }
                                    if (!listOfApplications.contains(appName)) {
                                        deploymentTarget.add(instance.getName());
                                    }
                                }
                            }
                        }

                        if (report.getActionExitCode().equals(
                                ActionReport.ExitCode.SUCCESS)) {
                            try {
                                deployment.registerAppInDomainXML(null, deploymentContext, t, true);
                            } catch (TransactionFailure e) {
                                logger.warning("failed to create application ref for " + appName);
                            }
                        }

                        // if the target is DAS, we do not need to do anything more
                        if (!isVersionExpression && DeploymentUtils.isDASTarget(target)) {
                            return;
                        }

                        final ParameterMap paramMap
                                = deployment.prepareInstanceDeployParamMap(deploymentContext);

                        if (!deploymentTarget.isEmpty()) {
                            replicateCommand(deploymentTarget, context, paramMap);
                        } else {
                            replicateCommand(targets, context, paramMap);
                        }

                    } catch (Exception e) {
                        logger.log(Level.SEVERE, "Error during creating application ref ", e);
                        report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                    } finally {
                        try {
                            archive.close();
                        } catch (IOException e) {
                            logger.log(Level.INFO, "Error while closing deployable artifact : " + file.getAbsolutePath(), e);
                        }
                    }
                }
            }
        }
    }

    private void replicateCommand(List targets, AdminCommandContext context, ParameterMap paramMap) {
        ClusterOperationUtil.replicateCommand(
                "_deploy",
                FailurePolicy.Error,
                FailurePolicy.Warn,
                FailurePolicy.Ignore,
                targets,
                context,
                paramMap,
                habitat);
    }

    private boolean isDeploymentGroup(String target) {
        boolean isDeploymentGroup = false;
        List listOfDeploymentGroups = domain.getDeploymentGroups().getDeploymentGroup();

        for (DeploymentGroup deploymentGroup : listOfDeploymentGroups) {
            if (deploymentGroup.getName().equals(target)) {
                isDeploymentGroup = true;
                break;
            }
        }
        return isDeploymentGroup;
    }
    
    private void handleLifecycleModule(AdminCommandContext context, Transaction t) {
        final ActionReport report = context.getActionReport();
        final Logger logger = context.getLogger();

        Application app = applications.getApplication(name);

        // create a dummy context to hold params and props
        DeployCommandParameters commandParams = new DeployCommandParameters();
        commandParams.name = name;
        commandParams.target = target;
        commandParams.virtualservers = virtualservers;
        commandParams.enabled = enabled;

        ExtendedDeploymentContext lifecycleContext = new DeploymentContextImpl(report, null, commandParams, null);
        try  {
            deployment.registerAppInDomainXML(null, lifecycleContext, t, true);
        } catch(Exception e) {
            report.failure(logger, e.getMessage());
        }

        if (!DeploymentUtils.isDASTarget(target)) {
            final ParameterMap paramMap = new ParameterMap();
            paramMap.add("DEFAULT", name);
            paramMap.add(DeploymentProperties.TARGET, target);
            paramMap.add(DeploymentProperties.ENABLED, enabled.toString());
            if (virtualservers != null) {
                paramMap.add(DeploymentProperties.VIRTUAL_SERVERS, 
                    virtualservers);
            }
            // pass the applicationInfo props so we have the information to persist in the
            // domain.xml
            Properties appProps = app.getDeployProperties();
            paramMap.set(DeploymentProperties.APP_PROPS, DeploymentUtils.propertiesValue(appProps, ':'));

            final List targets = new ArrayList();
            targets.add(target);
            ClusterOperationUtil.replicateCommand("_lifecycle", FailurePolicy.Error, FailurePolicy.Warn, 
                    FailurePolicy.Ignore, targets, context, paramMap, habitat);
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy