org.glassfish.cluster.ssh.connect.NodeRunnerDcom 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) 2011 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] [Payara Foundation and/or its affiliates]
package org.glassfish.cluster.ssh.connect;
import com.sun.enterprise.util.cluster.Paths;
import com.sun.enterprise.util.cluster.windows.process.WindowsRemoteAsadmin;
import com.sun.enterprise.util.cluster.windows.io.WindowsRemoteFile;
import java.util.*;
import java.util.logging.*;
import com.sun.enterprise.util.cluster.windows.process.WindowsException;
import org.glassfish.api.admin.SSHCommandExecutionException;
import com.sun.enterprise.config.serverbeans.Node;
import com.sun.enterprise.util.cluster.windows.io.WindowsRemoteFileSystem;
import org.glassfish.cluster.ssh.util.DcomInfo;
import org.glassfish.common.util.admin.AsadminInput;
import static com.sun.enterprise.util.StringUtils.ok;
import java.security.SecureRandom;
public class NodeRunnerDcom {
private final Logger logger;
private Node node;
private WindowsRemoteFile authTokenFile;
private String authTokenFilePath;
private DcomInfo dcomInfo;
public NodeRunnerDcom(Logger logger) {
this.logger = logger;
}
/*
* return 0 is success, otherwise failure
*/
public final int runAdminCommandOnRemoteNode(Node thisNode, StringBuilder output,
List args,
List stdinLines) throws
SSHCommandExecutionException, IllegalArgumentException,
UnsupportedOperationException {
String humanreadable = null;
try {
this.node = thisNode;
dcomInfo = new DcomInfo(node);
List fullcommand = new ArrayList();
WindowsRemoteAsadmin asadmin = dcomInfo.getAsadmin();
if (stdinLines != null && !stdinLines.isEmpty())
setupAuthTokenFile(fullcommand, stdinLines);
fullcommand.addAll(args);
humanreadable = dcomInfo.getNadminPath() + " " + commandListToString(fullcommand);
// This is where the rubber meets the road...
String out = asadmin.run(fullcommand);
output.append(out);
logger.info(Strings.get("remote.command.summary", humanreadable, out));
return determineStatus(args);
}
catch (WindowsException ex) {
throw new SSHCommandExecutionException(Strings.get(
"remote.command.error", ex.getMessage(), humanreadable), ex);
}
finally {
teardownAuthTokenFile();
}
}
private void trace(String s) {
logger.fine(String.format("%s: %s", this.getClass().getSimpleName(), s));
}
private static String commandListToString(List command) {
StringBuilder fullCommand = new StringBuilder();
for (String s : command) {
fullCommand.append(" ");
fullCommand.append(s);
}
return fullCommand.toString();
}
/*
* BE CAREFUL -- Don't introduce "Distributed Concurrency Bugs"
* e.g. you have to make sure the filename is unique.
* 1. create a remote file
* 2. copy the token/auth stuff into it
* 3. add the correct args to the remote commandline
* Put the file in the same directory that nadmin lives in (lib)
*/
private void setupAuthTokenFile(List cmd, List stdin) throws WindowsException {
WindowsRemoteFileSystem wrfs = new WindowsRemoteFileSystem(dcomInfo.getCredentials());
authTokenFilePath = dcomInfo.getNadminParentPath() + "\\token_" + System.nanoTime() + new SecureRandom().nextInt(1000);
authTokenFilePath = createUniqueFilename(dcomInfo.getNadminParentPath());
authTokenFile = new WindowsRemoteFile(wrfs, authTokenFilePath);
authTokenFile.copyFrom(stdin);
cmd.add(AsadminInput.CLI_INPUT_OPTION);
cmd.add(authTokenFilePath);
}
private void teardownAuthTokenFile() {
if (authTokenFile != null)
try {
authTokenFile.delete();
}
catch (WindowsException ex) {
logger.warning(Strings.get("cant.delete", dcomInfo.getHost(), authTokenFilePath));
}
}
private String createUniqueFilename(String path) {
String random = "" + System.nanoTime();
// just use the last 16 numbers
if(random.length() > 16)
random = random.substring(random.length() - 16);
random += "" + new SecureRandom().nextInt(10000);
return path + "\\DELETE_ME_" + random;
}
/* hack TODO do not know how to get int status back from Windows
* Stick in code that handles particular commands that we can figure out
* the status.
*/
private int determineStatus(List args) {
if (args == null)
throw new NullPointerException();
if (args.size() < 2)
return 0;
String instanceName = args.get(args.size() - 1);
if (isCommand(args, "_delete-instance-filesystem")) {
try {
String dir = Paths.getInstanceDirPath(node, instanceName);
WindowsRemoteFile instanceDir = new WindowsRemoteFile(dcomInfo.getCredentials(), dir);
return instanceDir.exists() ? 1 : 0;
}
catch (WindowsException ex) {
return 0;
}
}
else if (isCommand(args, "_create-instance-filesystem")) {
try {
String dir = Paths.getDasPropsPath(node);
WindowsRemoteFile dasProps = new WindowsRemoteFile(dcomInfo.getCredentials(), dir);
if (dasProps.exists())
return 0;
// uh-oh. Wipe out the instance directory that was created
dir = Paths.getInstanceDirPath(node, instanceName);
WindowsRemoteFile instanceDir = new WindowsRemoteFile(dcomInfo.getCredentials(), dir);
instanceDir.delete();
return 1;
}
catch (WindowsException ex) {
return 1;
}
}
return 0;
}
private boolean isCommand(List args, final String cmd) {
if (!ok(cmd))
return false;
for (String arg : args)
if (arg != null && arg.equals(cmd))
return true;
return false;
}
}