com.sun.enterprise.admin.cli.ListCommandsCommand Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2010 Sun Microsystems, Inc. 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.html
* or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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.admin.cli;
import java.io.*;
import java.util.*;
import java.util.logging.*;
import java.util.regex.*;
import org.jvnet.hk2.annotations.*;
import org.jvnet.hk2.component.*;
import org.glassfish.api.Param;
import org.glassfish.api.admin.*;
import com.sun.enterprise.universal.i18n.LocalStringsImpl;
import static com.sun.enterprise.admin.cli.CLIConstants.EOL;
/**
* A local list-commands command.
*
* @author bnevins
* @author Bill Shannon
*/
@Service(name = "list-commands")
@Scoped(PerLookup.class)
public class ListCommandsCommand extends CLICommand {
@Inject
private Habitat habitat;
private String[] remoteCommands;
private String[] localCommands;
private List patterns = new ArrayList();
@Param(name = "localonly", optional = true)
private boolean localOnly;
@Param(name = "remoteonly", optional = true)
private boolean remoteOnly;
@Param(name = "command-pattern", primary = true, optional = true,
multiple = true)
private List cmds;
private static final String SPACES = " ";
private static final LocalStringsImpl strings =
new LocalStringsImpl(ListCommandsCommand.class);
@Override
protected void validate()
throws CommandException, CommandValidationException {
if (localOnly && remoteOnly) {
throw new CommandException(strings.get("listCommands.notBoth"));
}
}
@Override
public int executeCommand()
throws CommandException, CommandValidationException {
// convert the patterns to regular expressions
if (cmds != null)
for (String pat : cmds)
patterns.add(Pattern.compile(globToRegex(pat)));
/*
* If we need the remote commands, get them first so that
* we prompt for any passwords before printing anything.
*/
if (!localOnly) {
try {
remoteCommands = matchCommands(
CLIUtil.getRemoteCommands(habitat, programOpts, env));
} catch (CommandException ce) {
/*
* Hide the real cause of the remote failure (almost certainly
* a ConnectException) so that asadmin doesn't try to find the
* closest matching local command (it's "list-commands", duh!).
*/
throw new CommandException(ce.getMessage());
}
}
if (!remoteOnly) {
localCommands = matchCommands(CLIUtil.getLocalCommands(habitat));
printLocalCommands();
}
if (!localOnly && !remoteOnly)
logger.printMessage(""); // a blank line between them
if (!localOnly)
printRemoteCommands();
logger.printMessage("");
return 0;
}
/**
* Filter the command list to only those matching the patterns.
*/
private String[] matchCommands(String[] commands) {
// filter the commands
List matched = new ArrayList();
for (String cmd : commands) {
if (patterns.size() == 0) {
if (!cmd.startsWith("_"))
matched.add(cmd);
} else {
for (Pattern re : patterns)
if (re.matcher(cmd).find())
if (!cmd.startsWith("_") ||
re.pattern().startsWith("_"))
matched.add(cmd);
}
}
return matched.toArray(new String[matched.size()]);
}
/**
* Convert a shell style glob regular expression to a
* Java regular expression.
* Code from: http://stackoverflow.com/questions/1247772
*/
private String globToRegex(String line) {
line = line.trim();
int strLen = line.length();
StringBuilder sb = new StringBuilder(strLen);
// Remove beginning and ending * globs because they're useless
if (line.startsWith("*")) {
line = line.substring(1);
strLen--;
}
if (line.endsWith("*")) {
line = line.substring(0, strLen-1);
strLen--;
}
boolean escaping = false;
int inCurlies = 0;
for (char currentChar : line.toCharArray()) {
switch (currentChar) {
case '*':
if (escaping)
sb.append("\\*");
else
sb.append(".*");
escaping = false;
break;
case '?':
if (escaping)
sb.append("\\?");
else
sb.append('.');
escaping = false;
break;
case '.':
case '(':
case ')':
case '+':
case '|':
case '^':
case '$':
case '@':
case '%':
sb.append('\\');
sb.append(currentChar);
escaping = false;
break;
case '\\':
if (escaping) {
sb.append("\\\\");
escaping = false;
} else
escaping = true;
break;
case '{':
if (escaping) {
sb.append("\\{");
} else {
sb.append('(');
inCurlies++;
}
escaping = false;
break;
case '}':
if (inCurlies > 0 && !escaping) {
sb.append(')');
inCurlies--;
} else if (escaping)
sb.append("\\}");
else
sb.append("}");
escaping = false;
break;
case ',':
if (inCurlies > 0 && !escaping)
sb.append('|');
else if (escaping)
sb.append("\\,");
else
sb.append(",");
break;
default:
escaping = false;
sb.append(currentChar);
}
}
return sb.toString();
}
void printLocalCommands() {
if (localCommands.length == 0) {
logger.printMessage(
strings.get("listCommands.localCommandNoMatch"));
return;
}
logger.printMessage(strings.get("listCommands.localCommandHeader"));
for (String s : localCommands) {
logger.printMessage(s);
}
}
void printRemoteCommands() {
if (remoteCommands.length == 0) {
logger.printMessage(
strings.get("listCommands.remoteCommandNoMatch"));
return;
}
logger.printMessage(strings.get("listCommands.remoteCommandHeader"));
// there are a LOT of remote commands -- make 2 columns
int num = remoteCommands.length;
int offset = (num / 2) + (num % 2);
StringBuilder sb = new StringBuilder();
for (int i = 0; i < offset; i++) {
sb.append(remoteCommands[i]);
sb.append(justify(remoteCommands[i], 40));
if (i + offset < num) {
sb.append(remoteCommands[i + offset]);
}
if (i < offset - 1)
sb.append(EOL);
}
logger.printMessage(sb.toString());
}
private String justify(String s, int width) {
int numSpaces = width - s.length();
return SPACES.substring(0, numSpaces);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy