com.sun.enterprise.v3.admin.cluster.StopInstanceCommand Maven / Gradle / Ivy
/*
* 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 [2018-2022] Payara Foundation and/or affiliates
package com.sun.enterprise.v3.admin.cluster;
import com.sun.enterprise.admin.remote.RemoteRestAdminCommand;
import com.sun.enterprise.admin.remote.ServerRemoteRestAdminCommand;
import com.sun.enterprise.admin.util.RemoteInstanceCommandHelper;
import com.sun.enterprise.admin.util.TimeoutParamDefaultCalculator;
import com.sun.enterprise.config.serverbeans.Node;
import com.sun.enterprise.config.serverbeans.Nodes;
import com.sun.enterprise.config.serverbeans.Server;
import com.sun.enterprise.module.ModulesRegistry;
import com.sun.enterprise.util.StringUtils;
import com.sun.enterprise.util.cluster.windows.io.WindowsRemoteFile;
import com.sun.enterprise.util.cluster.windows.process.WindowsException;
import com.sun.enterprise.v3.admin.StopServer;
import jakarta.inject.Inject;
import org.glassfish.api.ActionReport;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.admin.*;
import org.glassfish.cluster.ssh.launcher.SSHLauncher;
import org.glassfish.cluster.ssh.sftp.SFTPClient;
import org.glassfish.cluster.ssh.util.DcomInfo;
import org.glassfish.hk2.api.IterableProvider;
import org.glassfish.hk2.api.PerLookup;
import org.glassfish.hk2.api.PostConstruct;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.api.ServerContext;
import org.jvnet.hk2.annotations.Service;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* AdminCommand to stop the instance
* server.
* Shutdown of an instance.
* This command only runs on DAS. It calls the instance and asks it to
* kill itself
*
* @author Byron Nevins
*/
@Service(name = "stop-instance")
@PerLookup
@CommandLock(CommandLock.LockType.NONE) // allow stop-instance always
@I18n("stop.instance.command")
@ExecuteOn(RuntimeType.DAS)
@RestEndpoints({
@RestEndpoint(configBean = Server.class,
opType = RestEndpoint.OpType.POST,
path = "stop-instance",
description = "Stop Instance",
params = {
@RestParam(name = "id", value = "$parent")
})
})
public class StopInstanceCommand extends StopServer implements AdminCommand, PostConstruct {
@Inject
private ServiceLocator habitat;
@Inject
private ServerContext serverContext;
@Inject
private Nodes nodes;
@Inject
private ServerEnvironment env;
@Inject
IterableProvider nodeList;
@Inject
private ModulesRegistry registry;
@Param(optional = true, defaultValue = "true")
private Boolean force = true;
@Param(optional = true, defaultValue = "false")
private Boolean kill = false;
@Param(optional = false, primary = true)
private String instanceName;
@Param(optional = true, defaultCalculator = TimeoutParamDefaultCalculator.class)
private int timeout;
private Logger logger;
private RemoteInstanceCommandHelper helper;
private ActionReport report;
private String errorMessage = null;
private String cmdName = "stop-instance";
private Server instance;
File pidFile = null;
SFTPClient ftpClient = null;
private WindowsRemoteFile wrf;
@Override
public void execute(AdminCommandContext context) {
report = context.getActionReport();
logger = context.getLogger();
if (timeout <= 0) {
String msg = "Timeout must be at least 1 second long.";
logger.warning(msg);
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setMessage(msg);
return;
}
SSHLauncher launcher;
if (env.isDas()) {
if (kill) {
errorMessage = killInstance(context);
} else {
errorMessage = callInstance();
}
} else {
errorMessage = Strings.get("stop.instance.notDas",
env.getRuntimeType().toString());
}
if (errorMessage == null && !kill) {
errorMessage = pollForDeath();
}
if (errorMessage != null) {
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setMessage(errorMessage);
return;
}
String nodeName = instance.getNodeRef();
Node node = nodes.getNode(nodeName);
if (node.getType().equals("DOCKER")) {
stopDockerContainer(nodeName, instanceName, context);
}
if (node.getType().equals("TEMP")) {
deleteTempInstance(instanceName, context);
}
// If we've got any sub-command failures, log a warning
if (context.getActionReport().hasFailures()) {
report.setActionExitCode(ActionReport.ExitCode.WARNING);
report.setMessage(Strings.get("stop.instance.warning",
instanceName));
} else {
report.setActionExitCode(ActionReport.ExitCode.SUCCESS);
report.setMessage(Strings.get("stop.instance.success",
instanceName));
}
if (kill) {
// If we killed then stop-local-instance already waited for death
return;
}
// we think the instance is down but it might not be completely down so do further checking
// get the node name and then the node
// if localhost check if files exists
// else if SSH check if file exists on remote system
// else can't check anything else.
InstanceDirUtils insDU = new InstanceDirUtils(node, serverContext);
// this should be replaced with method from Node config bean.
if (node.isLocal()) {
try {
pidFile = new File(insDU.getLocalInstanceDir(instance.getName()), "config/pid");
} catch (java.io.IOException eio) {
// could not get the file name so can't see if it still exists. Need to exit
return;
}
if (pidFile.exists()) {
//server still not down completely, do we poll?
errorMessage = pollForRealDeath("local");
}
} else if (node.getType().equals("SSH")) {
try {
pidFile = new File(insDU.getLocalInstanceDir(instance.getName()), "config/pid");
} catch (java.io.IOException eio) {
// could not get the file name so can't see if it still exists. Need to exit
return;
}
//use SFTPClient to see if file exists.
launcher = habitat.getService(SSHLauncher.class);
launcher.init(node, logger);
try {
ftpClient = launcher.getSFTPClient();
if (ftpClient.exists(pidFile.toString())) {
// server still not down, do we poll?
errorMessage = pollForRealDeath("SSH");
}
} catch (IOException ex) {
//could not get to other host
} finally {
if (ftpClient != null) {
ftpClient.close();
}
}
} else if (node.getType().equals("DCOM")) {
DcomInfo info;
try {
info = new DcomInfo(node);
String path = info.getRemoteNodeRootDirectory() + "\\config\\pid";
wrf = new WindowsRemoteFile(info.getCredentials(), path);
if (wrf.exists())
errorMessage = pollForRealDeath("DCOM");
} catch (WindowsException ex) {
//could not get to other host
}
}
if (errorMessage != null) {
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setMessage(errorMessage);
}
}
@Override
public void postConstruct() {
helper = new RemoteInstanceCommandHelper(habitat);
}
private String initializeInstance() {
if (!StringUtils.ok(instanceName))
return Strings.get("stop.instance.noInstanceName", cmdName);
instance = helper.getServer(instanceName);
if (instance == null)
return Strings.get("stop.instance.noSuchInstance", instanceName);
return null;
}
/**
* return null if all went OK...
*/
private String callInstance() {
String msg = initializeInstance();
if (msg != null)
return msg;
String host = instance.getAdminHost();
if (host == null)
return Strings.get("stop.instance.noHost", instanceName);
int port = helper.getAdminPort(instance);
if (port < 0)
return Strings.get("stop.instance.noPort", instanceName);
if (!instance.isRunning())
return null;
try {
logger.info(Strings.get("stop.instance.init", instanceName));
RemoteRestAdminCommand rac = new ServerRemoteRestAdminCommand(habitat, "_stop-instance",
host, port, false, "admin", null, logger);
// notice how we do NOT send in the instance's name as an operand!!
ParameterMap map = new ParameterMap();
map.add("force", Boolean.toString(force));
rac.executeCommand(map);
} catch (Exception e) {
// The instance server may have died so fast we didn't have time to
// get the (always successful!!) return data. This is NOT AN ERROR!
// see: http://java.net/jira/browse/GLASSFISH-19672
// also see StopDomainCommand which does the same thing.
}
return null;
}
private String killInstance(AdminCommandContext context) {
String msg = initializeInstance();
if (msg != null)
return msg;
String nodeName = instance.getNodeRef();
Node node = nodes.getNode(nodeName);
String nodeDir = node.getNodeDirUnixStyle();
NodeUtils nodeUtils = new NodeUtils(habitat, logger);
// asadmin command to run on instances node
ArrayList command = new ArrayList();
command.add("stop-local-instance");
command.add("--kill");
if (nodeDir != null) {
command.add("--nodedir");
command.add(nodeDir);
}
command.add("--node");
command.add(nodeName);
command.add(instanceName);
String humanCommand = makeCommandHuman(command);
String firstErrorMessage = Strings.get("stop.local.instance.kill",
instanceName, nodeName, humanCommand);
if (logger.isLoggable(Level.FINE))
logger.log(Level.FINE, "stop-instance: running {0} on {1}", new Object[]{humanCommand, nodeName});
nodeUtils.runAdminCommandOnNode(node, command, context,
firstErrorMessage, humanCommand, null);
ActionReport killreport = context.getActionReport();
if (killreport.getActionExitCode() != ActionReport.ExitCode.SUCCESS) {
return killreport.getMessage();
}
return null;
}
// return null means A-OK
private String pollForDeath() {
long deadline = System.currentTimeMillis() + (timeout * 1000);
while (System.currentTimeMillis() < deadline) {
if (!instance.isRunning())
return null;
try {
Thread.sleep(500);
} catch (Exception e) {
// ignore
}
}
return Strings.get("stop.instance.timeout", instanceName);
}
private String pollForRealDeath(String mode) {
long deadline = System.currentTimeMillis() + (timeout * 1000);
while (System.currentTimeMillis() < deadline) {
try {
if (mode.equals("local")) {
if (!pidFile.exists()) {
return null;
}
} else if (mode.equals("SSH")) {
if (!ftpClient.exists(pidFile.toString()))
return null;
} else if (mode.equals("DCOM")) {
if (wrf == null || !wrf.exists())
return null;
}
// Fairly long interval between tries because checking over
// SSH is expensive.
Thread.sleep(5000);
} catch (Exception e) {
// ignore
}
}
return Strings.get("stop.instance.timeout.completely", instanceName);
}
private String makeCommandHuman(List command) {
StringBuilder fullCommand = new StringBuilder();
for (String s : command) {
fullCommand.append(" ");
fullCommand.append(s);
}
return fullCommand.toString().trim();
}
private void stopDockerContainer(String nodeName, String instanceName, AdminCommandContext adminCommandContext) {
ParameterMap parameterMap = new ParameterMap();
parameterMap.add("node", nodeName);
parameterMap.add("instanceName", instanceName);
CommandRunner commandRunner = habitat.getService(CommandRunner.class);
commandRunner.getCommandInvocation(
"_stop-docker-container", adminCommandContext.getActionReport().addSubActionsReport(),
adminCommandContext.getSubject()).parameters(parameterMap).execute();
}
private void deleteTempInstance(String instanceName, AdminCommandContext adminCommandContext) {
ParameterMap parameterMap = new ParameterMap();
parameterMap.add("instance_name", instanceName);
CommandRunner commandRunner = habitat.getService(CommandRunner.class);
commandRunner.getCommandInvocation(
"delete-instance", adminCommandContext.getActionReport().addSubActionsReport(),
adminCommandContext.getSubject()).parameters(parameterMap).execute();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy