/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-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.
*/
package com.sun.enterprise.util.cluster;
import com.sun.enterprise.admin.util.InstanceCommandExecutor;
import com.sun.enterprise.admin.util.InstanceStateService;
import com.sun.enterprise.config.serverbeans.Server;
import com.sun.enterprise.util.StringUtils;
import java.util.*;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.logging.Logger;
import org.glassfish.api.ActionReport;
import org.glassfish.api.admin.CommandException;
import org.glassfish.api.admin.FailurePolicy;
import org.glassfish.api.admin.InstanceCommandResult;
import org.glassfish.api.admin.ParameterMap;
import com.sun.enterprise.admin.util.ColumnFormatter;
import com.sun.enterprise.universal.Duration;
import org.glassfish.api.admin.InstanceState;
import org.jvnet.hk2.component.Habitat;
/**
* Used to format instance state info in a standard way.
* It also does internet work
* @author byron Nevins
*/
public final class InstanceInfo {
public InstanceInfo(Habitat habitat, Server svr, int port0, String host0, String cluster0,
Logger logger0, int timeout0, ActionReport report, InstanceStateService stateService) {
if (svr == null )
// if (svr == null || host0 == null)
throw new NullPointerException("null arguments");
this.habitat = habitat;
this.svr = svr;
name = svr.getName();
port = port0;
if (host0 == null)
host="not yet assigned";
else
host = host0;
logger = logger0;
timeoutInMsec = timeout0;
this.report = report;
this.stateService = stateService;
if (!StringUtils.ok(cluster0))
cluster = null;
else
cluster = cluster0;
future = pingInstance();
}
@Override
public final String toString() {
String cl = "";
if (cluster != null)
cl = ", cluster: " + getCluster();
return "name: " + getName()
+ ", host: " + getHost()
+ ", port: " + getPort()
+ cl
+ ", uptime: " + uptime
+ ", pid: " + pid;
}
public final String getDisplayCluster() {
return cluster == null ? NO_CLUSTER : cluster;
}
public final String getCluster() {
return cluster;
}
public final String getHost() {
return host;
}
public final int getPort() {
return port;
}
public final String getName() {
return name;
}
public final long getUptime() {
if (uptime == -1) {
getFutureResult();
}
return uptime;
}
public final int getPid() {
if (pid < 0) {
getFutureResult();
}
return pid;
}
public final String getDisplayState() {
StringBuilder display = new StringBuilder();
display.append(isRunning() ?
InstanceState.StateType.RUNNING.getDisplayString() :
InstanceState.StateType.NOT_RUNNING.getDisplayString());
if (ssState == InstanceState.StateType.RESTART_REQUIRED) {
if (isRunning()) {
display.append("; ").append(InstanceState.StateType.RESTART_REQUIRED.getDisplayString());
}
List<String> failedCmds = stateService.getFailedCommands(name);
if (!failedCmds.isEmpty()) {
StringBuilder list = new StringBuilder();
for (String z : failedCmds) list.append(z).append("; ");
display.append(" [pending config changes are: ").append(list).append("]");
}
}
return display.toString();
}
public final String getState() {
if (state == null) {
getFutureResult();
}
return state;
}
public final boolean isRunning() {
if (state == null) {
getFutureResult();
}
return running;
}
private void getFutureResult() {
try {
InstanceCommandResult r = future.get(timeoutInMsec, TimeUnit.SECONDS);
InstanceCommandExecutor res = (InstanceCommandExecutor) r.getInstanceCommand();
String instanceLocation = res.getCommandOutput();
// Remove the pesky \n out
instanceLocation = (instanceLocation == null) ? "" : instanceLocation.trim();
if ((!instanceLocation.endsWith(res.getServer().getName()))
|| (res.getReport().getActionExitCode() != ActionReport.ExitCode.SUCCESS)) {
uptime = -1;
state = NOT_RUNNING;
running = false;
pid = -1;
ssState = stateService.setState(name, InstanceState.StateType.NOT_RUNNING, false);
}
else {
Properties props = res.getReport().getTopMessagePart().getProps();
String uptimeStr = props.getProperty("Uptime");
String pidstr = props.getProperty("Pid");
String restartstr = props.getProperty("Restart-Required");
try {
pid = Integer.parseInt(pidstr);
}
catch(Exception e) {
// no I don't want to use the enclosing catch...
pid = -1;
}
ssState = stateService.setState(name,
Boolean.parseBoolean(restartstr) ?
InstanceState.StateType.RESTART_REQUIRED :
InstanceState.StateType.RUNNING,
false);
uptime = new Long(uptimeStr);
state = formatTime(uptime);
running = true;
}
}
catch (Exception e) {
uptime = -1;
state = NOT_RUNNING;
ssState = stateService.setState(name, InstanceState.StateType.NOT_RUNNING, false);
running = false;
pid = -1;
}
}
/////////////////////////////////////////////////////////////////////////
//////// static formatting stuff below ///////////////////////////////
/////////////////////////////////////////////////////////////////////////
public static String format(List<InstanceInfo> infos) {
String headings[] = {NAME, HOST, PORT, PID, CLUSTER, STATE};
ColumnFormatter cf = new ColumnFormatter(headings);
for (InstanceInfo info : infos) {
cf.addRow(new Object[]{
info.getName(),
info.getHost(),
info.getPort(),
formatPid(info),
info.getDisplayCluster(),
info.getDisplayState()
});
}
return cf.toString();
}
public static String formatBrief(List<InstanceInfo> infos) {
ColumnFormatter cf = new ColumnFormatter();
for (InstanceInfo info : infos) {
cf.addRow(new Object[]{
info.getName(),
info.getDisplayState()
});
}
return cf.toString();
}
private static String formatPid(InstanceInfo info) {
int pid = info.getPid();
return pid < 0 ? "--" : "" + pid;
}
// TODO what about security????
private Future<InstanceCommandResult> pingInstance() {
try {
ActionReport aReport = report.addSubActionsReport();
InstanceCommandResult aResult = new InstanceCommandResult();
ParameterMap map = new ParameterMap();
map.set("type", "terse");
InstanceCommandExecutor ice =
new InstanceCommandExecutor(habitat, "__locations", FailurePolicy.Error, FailurePolicy.Error,
svr, host, port, logger, map, aReport, aResult);
return stateService.submitJob(svr, ice, aResult);
/*
String ret = rac.executeCommand(map).trim();
if (ret == null || (!ret.endsWith("/" + name)))
return -1;
running = true;
String uptimeStr = rac.getAttributes().get("Uptime_value");
return Long.parseLong(uptimeStr);
*/
}
catch (CommandException ex) {
running = false;
return null;
}
}
private String formatTime(long uptime) {
return Strings.get("instanceinfo.uptime", new Duration(uptime));
}
private final Habitat habitat;
private final String host;
private final int port;
private final String name;
private long uptime = -1;
private String state = null;
private InstanceState.StateType ssState;
private final String cluster;
private final Logger logger;
private final int timeoutInMsec;
private Future<InstanceCommandResult> future;
private final ActionReport report;
private final InstanceStateService stateService;
private final Server svr;
private int pid;
private boolean running;
private static final String NOT_RUNNING = Strings.get("ListInstances.NotRunning");
private static final String NAME = Strings.get("ListInstances.name");
private static final String HOST = Strings.get("ListInstances.host");
private static final String PORT = Strings.get("ListInstances.port");
private static final String PID = Strings.get("ListInstances.pid");
private static final String STATE = Strings.get("ListInstances.state");
private static final String CLUSTER = Strings.get("ListInstances.cluster");
private static final String NO_CLUSTER = "---";
}