|
Glassfish example source code file (ValidateNodeCommand.java)
This example Glassfish source code file (ValidateNodeCommand.java) is included in the DevDaily.com
"Java Source Code
Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.
The Glassfish ValidateNodeCommand.java source code
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010 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.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 com.sun.enterprise.util.OS;
import com.sun.enterprise.util.StringUtils;
import com.sun.enterprise.util.net.NetUtils;
import com.sun.enterprise.util.io.FileUtils;
import org.glassfish.api.admin.CommandRunner.CommandInvocation;
import org.glassfish.api.ActionReport;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.admin.*;
import org.jvnet.hk2.annotations.*;
import org.jvnet.hk2.component.*;
import java.util.logging.Logger;
import java.io.File;
import java.util.Set;
import java.util.HashSet;
/**
* Remote AdminCommand to validate a config Node. This command is run only on DAS.
* This command does the following:
*
* If the node does not exist it returns an error
*
* If parameters are passed to the command, such as nodehost, then it verifies
* the parameters passed to the command match what is in the config. If the
* config does not match the passed parameters then it is an error -- unless
* the config has no value.
*
* If the node exists, but does not have some of the attributes passed to
* the command, then the node is updated with the values passed to the command.
*
* @author Joe Di Pol
*/
@Service(name = "_validate-node")
@I18n("validate.node")
@Scoped(PerLookup.class)
@ExecuteOn({RuntimeType.DAS})
public class ValidateNodeCommand implements AdminCommand {
@Inject
private Nodes nodes;
@Inject
private CommandRunner cr;
@Param(name="name", primary = true)
private String name;
@Param(name="nodedir", optional=true)
private String nodedir;
@Param(name="nodehost", optional=true)
private String nodehost;
@Param(name = "installdir", optional=true)
private String installdir;
@Param(name="sshport", optional=true)
private String sshport;
@Param(name="sshuser", optional=true)
private String sshuser;
@Param(name="sshnodehost", optional=true)
private String sshnodehost;
@Param(name="sshkeyfile", optional=true)
private String sshkeyfile;
private Set<String> excludeFromUpdate = new HashSet();
@Override
public void execute(AdminCommandContext context) {
ActionReport report = context.getActionReport();
Logger logger= context.logger;
report.setActionExitCode(ActionReport.ExitCode.SUCCESS);
logger.fine(Strings.get("Validating node {0}", name));
Node node = nodes.getNode(name);
if (node == null) {
//node doesn't exist
String msg = Strings.get("noSuchNode", name);
logger.warning(msg);
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setMessage(msg);
return;
}
try {
validateNode(node);
} catch (CommandValidationException e) {
logger.warning(e.getMessage());
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setMessage(e.getMessage());
return;
}
logger.fine(Strings.get("Node {0} is valid. Updating if needed", name));
// What is there in the node is valid. Now go update anything that
// was not there.
CommandInvocation ci = cr.getCommandInvocation("_update-node", report);
ParameterMap map = new ParameterMap();
map.add("DEFAULT", name);
if (! excludeFromUpdate.contains("installdir"))
map.add("installdir", installdir);
if (! excludeFromUpdate.contains("nodehost"))
map.add("nodehost", nodehost);
if (! excludeFromUpdate.contains("nodedir"))
map.add("nodedir", nodedir);
if (! excludeFromUpdate.contains("sshport"))
map.add("sshport", sshport);
if (! excludeFromUpdate.contains("sshuser"))
map.add("sshuser", sshuser);
if (! excludeFromUpdate.contains("sshkeyfile"))
map.add("sshkeyfile", sshkeyfile);
// Only update if there is something to do
if ( map.size() > 1) {
ci.parameters(map);
ci.execute();
}
}
public void validateNode(final Node node) throws
CommandValidationException {
String value = null;
value = node.getNodeDir();
if (!StringUtils.ok(nodedir) && StringUtils.ok(value)) {
// If no nodedir was passed, but the config has a value, then
// consider that an error (14887)
throw new CommandValidationException(
Strings.get("attribute.mismatch", name,
"nodedir", nodedir, value));
}
validatePathSimple("nodedir", nodedir, value);
value = node.getNodeHost();
validateHostname("nodehost", nodehost, value);
value = node.getInstallDir();
validatePathSimple("installdir", installdir, value);
SshConnector sshc = node.getSshConnector();
if (sshc == null) {
return;
}
value = sshc.getSshPort();
validateString("sshport", sshport, value, false);
value = sshc.getSshHost();
validateHostname("sshnodehost", sshnodehost, value);
SshAuth ssha = sshc.getSshAuth();
if (ssha == null) {
return;
}
value = ssha.getUserName();
validateString("sshuser", sshuser, value, false);
value = ssha.getKeyfile();
validatePath("sshkeyfile", sshkeyfile, value);
}
private void validatePath(String propname, String value, String configValue)
throws CommandValidationException {
if (!StringUtils.ok(value) || !StringUtils.ok(configValue)) {
// If no value was passed via the CLI then we don't check it since
// the caller doesn't want it validated.
// If no value exists in the config, then we don't check it since
// we will update it.
return;
}
String canonicalValueFile = FileUtils.safeGetCanonicalPath(new File(value));
String canonicalConfigValueFile = FileUtils.safeGetCanonicalPath(new File(configValue));
if (canonicalConfigValueFile == null || canonicalValueFile== null) {
throw new CommandValidationException(
Strings.get("attribute.null", name,
propname, canonicalValueFile, canonicalConfigValueFile));
}
if ( !canonicalValueFile.equals(canonicalConfigValueFile) ) {
throw new CommandValidationException(
Strings.get("attribute.mismatch", name,
propname, canonicalValueFile, canonicalConfigValueFile));
}
// Don't update an attribute that is considered a match
excludeFromUpdate.add(propname);
}
private void validatePathSimple(String propname, String value, String configValue)
throws CommandValidationException {
// Compares paths by just doing a string comparison. Some of the paths
// we are comparing are valid on remote systems, so we can't do any
// path processing
if (OS.isWindows()) {
validateString(propname, value, configValue, true);
} else {
validateString(propname, value, configValue, false);
}
}
private void validateHostname(String propname,
String value, String configValue)
throws CommandValidationException {
try {
// First do a simple case insensitve string comparison. If that
// matches then it's good enough for us.
validateString(propname, value, configValue, true);
return;
} catch (CommandValidationException e) {
// Strings don't match, but we could have a case of
// "sidewinder" and "sidewinder.us.oracle.com". NetUtils
// isEqual() handles this check.
if (! NetUtils.isEqual(value, configValue)) {
// If they both refer to the localhost then consider them
// them same.
if ( ! (NetUtils.isThisHostLocal(value) &&
NetUtils.isThisHostLocal(configValue)) ) {
throw new CommandValidationException(
Strings.get("attribute.mismatch", name,
propname, value, configValue));
}
}
}
// Don't update an attribute that is considered a match
excludeFromUpdate.add(propname);
}
private void validateString(String propname,
String value, String configValue, boolean ignorecase)
throws CommandValidationException {
if (!StringUtils.ok(value) || !StringUtils.ok(configValue)) {
// If no value was passed via the CLI then we don't check it since
// the caller doesn't want it validated.
// If no value exists in the config, then we don't check it since
// we will update it.
return;
}
boolean match = false;
if (ignorecase) {
match = value.equalsIgnoreCase(configValue);
} else {
match = value.equals(configValue);
}
if ( !match ) {
throw new CommandValidationException(
Strings.get("attribute.mismatch", name,
propname, value, configValue));
}
// Don't update an attribute that is considered a match
excludeFromUpdate.add(propname);
}
}
Other Glassfish examples (source code examples)
Here is a short list of links related to this Glassfish ValidateNodeCommand.java source code file:
|