/*
* JBoss, Home of Professional Open Source.
* Copyright 2015, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.cli.handlers;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.regex.Pattern;
import org.jboss.as.cli.CommandContext;
import org.jboss.as.cli.CommandFormatException;
import org.jboss.as.cli.Util;
import org.jboss.as.cli.accesscontrol.AccessRequirement;
import org.jboss.as.cli.accesscontrol.AccessRequirementBuilder;
import org.jboss.as.cli.accesscontrol.PerNodeOperationAccess;
import org.jboss.as.cli.impl.ArgumentWithValue;
import org.jboss.as.cli.impl.DefaultCompleter;
import org.jboss.as.cli.impl.DefaultCompleter.CandidatesProvider;
import org.jboss.as.cli.operation.ParsedCommandLine;
import org.jboss.as.cli.util.SimpleTable;
import org.jboss.as.cli.util.StrictSizeTable;
import org.jboss.as.controller.client.ModelControllerClient;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.Property;
/**
*
* @author Alexey Loubyansky
*/
public class DeploymentInfoHandler extends BaseOperationCommand {
private static final String ADDED = "added";
private static final String ENABLED = "ENABLED";
private static final String NAME = "NAME";
private static final String PERSISTENT = "PERSISTENT";
private static final String RUNTIME_NAME = "RUNTIME-NAME";
private static final String NOT_ADDED = "not added";
private static final String N_A = "n/a";
private static final String SERVER_GROUP = "SERVER-GROUP";
private static final String STATE = "STATE";
private static final String STATUS = "STATUS";
private final ArgumentWithValue name;
private final ArgumentWithValue serverGroup;
private List<String> addedServerGroups;
private List<String> otherServerGroups;
private PerNodeOperationAccess sgChildrenResourcesPermission;
public DeploymentInfoHandler(CommandContext ctx) {
super(ctx, "deployment-info", true);
name = new ArgumentWithValue(this, new DefaultCompleter(new CandidatesProvider(){
@Override
public Collection<String> getAllCandidates(CommandContext ctx) {
return Util.getDeployments(ctx.getModelControllerClient());
}}), "--name");
serverGroup = new ArgumentWithValue(this, new DefaultCompleter(new CandidatesProvider(){
@Override
public Collection<String> getAllCandidates(CommandContext ctx) {
return sgChildrenResourcesPermission.getAllowedOn(ctx);
}}), "--server-group") {
@Override
public boolean canAppearNext(CommandContext ctx) throws CommandFormatException {
if(!ctx.isDomainMode()) {
return false;
}
return super.canAppearNext(ctx);
}
};
}
protected AccessRequirement setupAccessRequirement(CommandContext ctx) {
sgChildrenResourcesPermission = new PerNodeOperationAccess(ctx, Util.SERVER_GROUP, null, Util.READ_CHILDREN_RESOURCES);
return AccessRequirementBuilder.Factory.create(ctx)
.any()
.standalone()
.any()
.operation(Util.READ_CHILDREN_RESOURCES)
.operation(Util.DEPLOYMENT + "=?", Util.READ_RESOURCE)
.parent()
.parent()
.domain()
.any()
.all()
.operation(Util.VALIDATE_ADDRESS)
.operation(Util.DEPLOYMENT + "=?", Util.READ_RESOURCE)
.serverGroupOperation(Util.DEPLOYMENT + "=?", Util.READ_RESOURCE)
.parent()
.all()
.operation(Util.READ_CHILDREN_RESOURCES)
.requirement(sgChildrenResourcesPermission)
.parent()
.parent()
.parent()
.build();
}
/* (non-Javadoc)
* @see org.jboss.as.cli.OperationCommand#buildRequest(org.jboss.as.cli.CommandContext)
*/
@Override
public ModelNode buildRequestWithoutHeaders(CommandContext ctx) throws CommandFormatException {
final ParsedCommandLine parsedCmd = ctx.getParsedCommandLine();
if(ctx.isDomainMode() && !name.isPresent(parsedCmd) && !serverGroup.isPresent(parsedCmd)) {
throw new CommandFormatException("Either " + name.getFullName() + " or " + serverGroup.getFullName() + " is required.");
}
final String deploymentName = name.getValue(parsedCmd);
final ModelNode request = new ModelNode();
if(ctx.isDomainMode()) {
final List<String> serverGroups = Util.getServerGroups(ctx.getModelControllerClient());
addedServerGroups = null;
otherServerGroups = null;
final String serverGroupName = serverGroup.getValue(parsedCmd);
if(serverGroupName == null) {
if(deploymentName == null || deploymentName.indexOf('*') >= 0) {
// wildcards in domain mode aren't supported
throw new CommandFormatException("If " + serverGroup.getFullName() +
" is not specified, " + name.getFullName() +
" must be set to a specific deployment name, " +
"wildcards are allowed only when " + serverGroup.getFullName() + " is provided.");
}
final ModelNode validateRequest = new ModelNode();
validateRequest.get(Util.OPERATION).set(Util.COMPOSITE);
validateRequest.get(Util.ADDRESS).setEmptyList();
ModelNode steps = validateRequest.get(Util.STEPS);
for(String serverGroup : serverGroups) {
final ModelNode step = new ModelNode();
step.get(Util.ADDRESS).setEmptyList();
step.get(Util.OPERATION).set(Util.VALIDATE_ADDRESS);
final ModelNode value = step.get(Util.VALUE);
value.add(Util.SERVER_GROUP, serverGroup);
value.add(Util.DEPLOYMENT, deploymentName);
steps.add(step);
}
final ModelControllerClient client = ctx.getModelControllerClient();
final ModelNode response;
try {
response = client.execute(validateRequest);
} catch (IOException e) {
throw new CommandFormatException("Failed to query server groups for deployment " + deploymentName, e);
}
if(!response.hasDefined(Util.RESULT)) {
throw new CommandFormatException("The validation response came back w/o result: " + response);
}
ModelNode result = response.get(Util.RESULT);
// if(!result.hasDefined(Util.DOMAIN_RESULTS)) {
// throw new CommandFormatException(Util.DOMAIN_RESULTS + " aren't available for validation request: " + result);
// }
// result = result.get(Util.DOMAIN_RESULTS);
// TODO could be this... could be that
if(result.hasDefined(Util.DOMAIN_RESULTS)) {
result = result.get(Util.DOMAIN_RESULTS);
}
final List<Property> stepResponses = result.asPropertyList();
for(int i = 0; i < serverGroups.size() ; ++i) {
final Property prop = stepResponses.get(i);
ModelNode stepResponse = prop.getValue();
if(stepResponse.has(prop.getName())) { // TODO remove when the structure is consistent
stepResponse = stepResponse.get(prop.getName());
}
if(stepResponse.hasDefined(Util.RESULT)) {
final ModelNode stepResult = stepResponse.get(Util.RESULT);
if(stepResult.hasDefined(Util.VALID) && stepResult.get(Util.VALID).asBoolean()) {
if(addedServerGroups == null) {
addedServerGroups = new ArrayList<String>();
}
addedServerGroups.add(serverGroups.get(i));
} else {
if(otherServerGroups == null) {
otherServerGroups = new ArrayList<String>();
}
otherServerGroups.add(serverGroups.get(i));
}
} else {
if(otherServerGroups == null) {
otherServerGroups = new ArrayList<String>();
}
otherServerGroups.add(serverGroups.get(i));
}
}
request.get(Util.OPERATION).set(Util.COMPOSITE);
request.get(Util.ADDRESS).setEmptyList();
steps = request.get(Util.STEPS);
ModelNode step = new ModelNode();
ModelNode address = step.get(Util.ADDRESS);
address.add(Util.DEPLOYMENT, deploymentName);
step.get(Util.OPERATION).set(Util.READ_RESOURCE);
steps.add(step);
if(addedServerGroups != null) {
for(String serverGroup : addedServerGroups) {
step = new ModelNode();
address = step.get(Util.ADDRESS);
address.add(Util.SERVER_GROUP, serverGroup);
address.add(Util.DEPLOYMENT, deploymentName);
step.get(Util.OPERATION).set(Util.READ_RESOURCE);
steps.add(step);
}
}
} else if(serverGroupName.indexOf('*') >= 0) {
throw new CommandFormatException("Wildcards are not allowed here, please give a valid server-group name.");
} else {
request.get(Util.OPERATION).set(Util.COMPOSITE);
request.get(Util.ADDRESS).setEmptyList();
final ModelNode steps = request.get(Util.STEPS);
ModelNode step = new ModelNode();
step.get(Util.OPERATION).set(Util.READ_CHILDREN_RESOURCES);
step.get(Util.CHILD_TYPE).set(Util.DEPLOYMENT);
step.get(Util.INCLUDE_RUNTIME).set(Util.TRUE);
steps.add(step);
step = new ModelNode();
step.get(Util.OPERATION).set(Util.READ_CHILDREN_RESOURCES);
step.get(Util.ADDRESS).add(Util.SERVER_GROUP, serverGroupName);
step.get(Util.CHILD_TYPE).set(Util.DEPLOYMENT);
step.get(Util.INCLUDE_RUNTIME).set(Util.TRUE);
steps.add(step);
}
} else {
if(deploymentName == null || deploymentName.indexOf('*') >= 0) {
request.get(Util.OPERATION).set(Util.READ_CHILDREN_RESOURCES);
request.get(Util.CHILD_TYPE).set(Util.DEPLOYMENT);
request.get(Util.INCLUDE_RUNTIME).set(Util.TRUE);
} else {
final ModelNode address = request.get(Util.ADDRESS);
address.add(Util.DEPLOYMENT, deploymentName);
request.get(Util.OPERATION).set(Util.READ_RESOURCE);
request.get(Util.INCLUDE_RUNTIME).set(true);
}
}
return request;
}
@Override
protected void handleResponse(CommandContext ctx, ModelNode response, boolean composite) throws CommandFormatException {
try {
if(!response.hasDefined(Util.RESULT)) {
throw new CommandFormatException("The operation response came back w/o result: " + response);
}
ModelNode result = response.get(Util.RESULT);
if(ctx.isDomainMode()) {
// if(!result.hasDefined(Util.DOMAIN_RESULTS)) {
// throw new CommandFormatException(Util.DOMAIN_RESULTS + " aren't available " + result);
// return;
// }
// TODO it could be... could be not...
if(result.hasDefined(Util.DOMAIN_RESULTS)) {
result = result.get(Util.DOMAIN_RESULTS);
}
final Iterator<Property> steps = result.asPropertyList().iterator();
if(!steps.hasNext()) {
throw new CommandFormatException("Response for the main resource info of the deployment is missing: " + result);
}
// /deployment=<name>
ModelNode step = steps.next().getValue();
if(step.has(Util.STEP_1)) { // TODO remove when the structure is consistent
step = step.get(Util.STEP_1);
}
if(!step.has(Util.RESULT)) {
throw new CommandFormatException("Failed to read the main resource info of the deployment: " + Util.getFailureDescription(step));
}
ModelNode stepResponse = step.get(Util.RESULT);
if(serverGroup.isPresent(ctx.getParsedCommandLine())) {
step = result.get(Util.STEP_1);
if(!step.isDefined()) {
throw new CommandFormatException("No step outcome for deployment resources (step-1): " + result);
}
final ModelNode allDeployments = step.get(Util.RESULT);
if(!allDeployments.isDefined()) {
throw new CommandFormatException("No result for deployment resources (step-1): " + result);
}
step = result.get(Util.STEP_2);
if(!step.isDefined()) {
throw new CommandFormatException("No step outcome for server-group deployment resources (step-2): " + result);
}
final ModelNode sgDeployments = step.get(Util.RESULT);
if(!sgDeployments.isDefined()) {
throw new CommandFormatException("No result for server-group deployment resources (step-2): " + result);
}
final String deploymentName = name.getValue(ctx.getParsedCommandLine());
final Pattern pattern = Pattern.compile(Util.wildcardToJavaRegex(deploymentName == null ? "*" : deploymentName));
final SimpleTable table = new SimpleTable(new String[] { NAME, RUNTIME_NAME, STATE });
for(String name : allDeployments.keys()) {
if(!pattern.matcher(name).matches()) {
continue;
}
if(sgDeployments.hasDefined(name)) {
final ModelNode node = sgDeployments.get(name);
table.addLine(new String[]{node.get(Util.NAME).asString(), node.get(Util.RUNTIME_NAME).asString(),
node.get(Util.ENABLED).asBoolean() ? Util.ENABLED : ADDED});
} else {
final ModelNode resource = allDeployments.get(name);
table.addLine(new String[]{resource.get(Util.NAME).asString(), resource.get(Util.RUNTIME_NAME).asString(), NOT_ADDED});
}
}
if(!table.isEmpty()) {
ctx.printLine(table.toString(true));
}
} else {
final StrictSizeTable table = new StrictSizeTable(1);
table.addCell(Util.NAME, stepResponse.get(Util.NAME).asString());
table.addCell(Util.RUNTIME_NAME, stepResponse.get(Util.RUNTIME_NAME).asString());
ctx.printLine(table.toString());
final SimpleTable groups = new SimpleTable(new String[] { SERVER_GROUP, STATE });
if (addedServerGroups == null) {
if (steps.hasNext()) {
throw new CommandFormatException("Didn't expect results for server groups but received "
+ (result.asPropertyList().size() - 1) + " more steps.");
}
} else {
for (String sg : addedServerGroups) {
final Property prop = steps.next();
stepResponse = prop.getValue();
if (stepResponse.has(prop.getName())) { // TODO remove when the structure is consistent
stepResponse = stepResponse.get(prop.getName());
}
if (stepResponse.hasDefined(Util.RESULT)) {
final ModelNode stepResult = stepResponse.get(Util.RESULT);
if (stepResult.hasDefined(Util.ENABLED)) {
groups.addLine(new String[] { sg,
stepResult.get(Util.ENABLED).asBoolean() ? Util.ENABLED : ADDED });
} else {
groups.addLine(new String[] { sg, N_A });
}
} else {
groups.addLine(new String[] { sg, "no response" });
}
}
}
if (otherServerGroups != null) {
for (String sg : otherServerGroups) {
groups.addLine(new String[] { sg, NOT_ADDED });
}
}
ctx.printLine(groups.toString(true));
}
} else {
final SimpleTable table = new SimpleTable(new String[] { NAME, RUNTIME_NAME, PERSISTENT, ENABLED, STATUS });
final String deploymentName = name.getValue(ctx.getParsedCommandLine());
if(deploymentName == null || deploymentName.indexOf('*') >= 0) {
final List<Property> list = result.asPropertyList();
if (!list.isEmpty()) {
final Pattern pattern = Pattern.compile(Util.wildcardToJavaRegex(deploymentName == null ? "*" : deploymentName));
for (Property p : list) {
final ModelNode node = p.getValue();
final String name = node.get(Util.NAME).asString();
if(pattern.matcher(name).matches()) {
table.addLine(new String[]{name, node.get(Util.RUNTIME_NAME).asString(),
node.get(Util.PERSISTENT).asString(), node.get(Util.ENABLED).asString(),
node.get(Util.STATUS).asString()});
}
}
}
} else {
table.addLine(new String[]{result.get(Util.NAME).asString(), result.get(Util.RUNTIME_NAME).asString(),
result.get(Util.PERSISTENT).asString(), result.get(Util.ENABLED).asString(),
result.get(Util.STATUS).asString()});
}
if(!table.isEmpty()) {
ctx.printLine(table.toString());
}
}
} finally {
addedServerGroups = null;
otherServerGroups = null;
}
}
}