/*
* 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.
*/
package com.sun.enterprise.v3.admin.cluster;
import com.sun.enterprise.util.cluster.RemoteType;
import com.sun.enterprise.util.StringUtils;
import com.sun.enterprise.config.serverbeans.Node;
import com.sun.enterprise.config.serverbeans.Nodes;
import com.sun.enterprise.config.serverbeans.SshConnector;
import com.sun.enterprise.config.serverbeans.SshAuth;
import org.glassfish.api.ActionReport;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.admin.*;
import org.glassfish.api.admin.CommandRunner.CommandInvocation;
import org.glassfish.hk2.api.ServiceLocator;
import org.jvnet.hk2.annotations.Service;
import org.jvnet.hk2.component.*;
import java.util.logging.Logger;
import javax.inject.Inject;
/**
* Remote AdminCommand to update a remote node. This command is run only on DAS.
*
* @author Joe Di Pol
* @author Byron Nevins
*/
public abstract class UpdateNodeRemoteCommand implements AdminCommand {
@Inject
private CommandRunner cr;
@Inject
ServiceLocator habitat;
@Inject
private Nodes nodes;
@Param(name="name", primary = true)
private String name;
@Param(name="nodehost", optional=true)
private String nodehost;
@Param(name = "installdir", optional=true)
private String installdir;
@Param(name = "nodedir", optional=true)
private String nodedir;
// these are the variables set as parameters in subclasses
// we can't set them as parameters in this class bacause of the names
protected String remotePort;
protected String remoteUser;
protected String sshkeyfile;
protected String remotepassword;
protected String sshkeypassphrase;
protected String windowsdomain;
@Param(name = "force", optional = true, defaultValue = "false")
private boolean force;
private static final String NL = System.getProperty("line.separator");
private Logger logger = null;
protected abstract void populateParameters();
protected abstract RemoteType getType();
protected abstract String getDefaultPort();
protected final void executeInternal(AdminCommandContext context) {
ActionReport report = context.getActionReport();
StringBuilder msg = new StringBuilder();
Node node = null;
logger = context.getLogger();
// Make sure Node is valid
node = nodes.getNode(name);
if (node == null) {
String m = Strings.get("noSuchNode", name);
logger.warning(m);
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setMessage(m);
return;
}
if (node.isDefaultLocalNode()) {
String m = Strings.get("update.node.config.defaultnode", name);
logger.warning(m);
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setMessage(m);
return;
}
// Ah the problems caused by hard-coding ssh into parameter names!
populateParameters();
// First create a map that holds the parameters and reflects what
// the user passed on the command line.
ParameterMap map = new ParameterMap();
map.add("DEFAULT", name);
map.add(NodeUtils.PARAM_INSTALLDIR, installdir);
map.add(NodeUtils.PARAM_NODEHOST, nodehost);
map.add(NodeUtils.PARAM_NODEDIR, nodedir);
map.add(NodeUtils.PARAM_REMOTEPORT, remotePort);
map.add(NodeUtils.PARAM_REMOTEUSER, remoteUser);
map.add(NodeUtils.PARAM_SSHKEYFILE, sshkeyfile);
map.add(NodeUtils.PARAM_REMOTEPASSWORD, remotepassword);
map.add(NodeUtils.PARAM_SSHKEYPASSPHRASE, sshkeypassphrase);
map.add(NodeUtils.PARAM_WINDOWSDOMAINNAME, windowsdomain);
map.add(NodeUtils.PARAM_TYPE, getType().toString());
// Now init any parameters that weren't passed into the command
// using the values from the config
initFromConfig(node);
// Finally, anything that still isn't set, use the defaults.
// These should likely come from config -- but they don't
// as of now
setDefaults();
// validateMap holds the union of what the user passed and what was
// in the config so we have all the settings needed to validate what
// the node will look like after we update it.
ParameterMap validateMap = new ParameterMap();
validateMap.add(NodeUtils.PARAM_INSTALLDIR, installdir);
validateMap.add(NodeUtils.PARAM_NODEHOST, nodehost);
validateMap.add(NodeUtils.PARAM_NODEDIR, nodedir);
validateMap.add(NodeUtils.PARAM_REMOTEPORT, remotePort);
validateMap.add(NodeUtils.PARAM_REMOTEUSER, remoteUser);
validateMap.add(NodeUtils.PARAM_SSHKEYFILE, sshkeyfile);
validateMap.add(NodeUtils.PARAM_REMOTEPASSWORD, remotepassword);
validateMap.add(NodeUtils.PARAM_SSHKEYPASSPHRASE, sshkeypassphrase);
validateMap.add(NodeUtils.PARAM_WINDOWSDOMAINNAME, windowsdomain);
validateMap.add(NodeUtils.PARAM_TYPE, getType().toString());
// Validate the settings
try {
NodeUtils nodeUtils = new NodeUtils(habitat, logger);
nodeUtils.validate(validateMap);
} catch (CommandValidationException e) {
String m1 = Strings.get("node.ssh.invalid.params");
if (!force) {
String m2 = Strings.get("update.node.ssh.not.updated");
msg.append(StringUtils.cat(NL, m1, m2, e.getMessage()));
report.setMessage(msg.toString());
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
} else {
String m2 = Strings.get("update.node.ssh.continue.force");
msg.append(StringUtils.cat(NL, m1, e.getMessage(), m2));
}
}
// Settings are valid. Now use the generic update-node command to
// update the node.
CommandInvocation ci = cr.getCommandInvocation("_update-node", report);
ci.parameters(map);
ci.execute();
if (StringUtils.ok(report.getMessage())) {
if (msg.length() > 0) {
msg.append(NL);
}
msg.append(report.getMessage());
}
report.setMessage(msg.toString());
}
/**
* Initialize any parameters not provided by the user from the
* configuration.
*/
private void initFromConfig(Node node) {
if (nodehost == null) {
nodehost = node.getNodeHost();
}
if (installdir == null) {
installdir = node.getInstallDir();
}
if (nodedir == null) {
nodedir = node.getNodeDir();
}
if (windowsdomain == null) {
windowsdomain = node.getWindowsDomain();
if (windowsdomain == null) {
windowsdomain = node.getNodeHost();
}
}
SshConnector sshc = node.getSshConnector();
if (sshc == null) {
return;
}
if (remotePort == null) {
remotePort = sshc.getSshPort();
}
SshAuth ssha = sshc.getSshAuth();
if (ssha == null) {
return;
}
if (remoteUser == null) {
remoteUser = ssha.getUserName();
}
if (sshkeyfile == null) {
sshkeyfile = ssha.getKeyfile();
}
if (remotepassword == null) {
remotepassword = ssha.getPassword();
}
if (sshkeypassphrase == null) {
sshkeypassphrase = ssha.getPassword();
}
}
private void setDefaults() {
if (!StringUtils.ok(remotePort)) {
remotePort = getDefaultPort();
}
if (!StringUtils.ok(remoteUser)) {
remoteUser = NodeUtils.NODE_DEFAULT_REMOTE_USER;
}
if (!StringUtils.ok(installdir)) {
installdir = NodeUtils.NODE_DEFAULT_INSTALLDIR;
}
}
}