/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, 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.domain.controller.operations.coordination;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ADD;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.BYTES;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.COMPOSITE;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.CONTENT;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.DEPLOYMENT;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.HASH;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.INPUT_STREAM_INDEX;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OPERATION_HEADERS;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP_ADDR;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ROLLOUT_PLAN;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.STEPS;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.URL;
import static org.jboss.as.domain.controller.DomainControllerLogger.HOST_CONTROLLER_LOGGER;
import static org.jboss.as.domain.controller.DomainControllerMessages.MESSAGES;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import org.jboss.as.controller.OperationContext;
import org.jboss.as.controller.OperationFailedException;
import org.jboss.as.controller.OperationStepHandler;
import org.jboss.as.controller.PathAddress;
import org.jboss.as.controller.ProxyController;
import org.jboss.as.controller.registry.ImmutableManagementResourceRegistration;
import org.jboss.as.domain.controller.LocalHostControllerInfo;
import org.jboss.as.domain.controller.operations.deployment.DeploymentFullReplaceHandler;
import org.jboss.as.domain.controller.operations.deployment.DeploymentUploadUtil;
import org.jboss.as.repository.ContentRepository;
import org.jboss.dmr.ModelNode;
/**
* Coordinates the overall execution of an operation on behalf of the domain.
*
* @author Brian Stansberry (c) 2011 Red Hat Inc.
*/
public class OperationCoordinatorStepHandler {
private final LocalHostControllerInfo localHostControllerInfo;
private final ContentRepository contentRepository;
private final Map<String, ProxyController> hostProxies;
private final Map<String, ProxyController> serverProxies;
private final OperationSlaveStepHandler localSlaveHandler;
private volatile ExecutorService executorService;
OperationCoordinatorStepHandler(final LocalHostControllerInfo localHostControllerInfo,
ContentRepository contentRepository,
final Map<String, ProxyController> hostProxies,
final Map<String, ProxyController> serverProxies,
final OperationSlaveStepHandler localSlaveHandler) {
this.localHostControllerInfo = localHostControllerInfo;
this.contentRepository = contentRepository;
this.hostProxies = hostProxies;
this.serverProxies = serverProxies;
this.localSlaveHandler = localSlaveHandler;
}
void execute(OperationContext context, ModelNode operation) throws OperationFailedException {
// Determine routing
ImmutableManagementResourceRegistration opRegistry = context.getResourceRegistration();
OperationRouting routing = OperationRouting.determineRouting(operation, localHostControllerInfo, opRegistry);
if (!localHostControllerInfo.isMasterDomainController()
&& !routing.isLocalOnly(localHostControllerInfo.getLocalHostName())) {
// We cannot handle this ourselves
routeToMasterDomainController(context, operation);
}
else if (routing.getSingleHost() != null && !localHostControllerInfo.getLocalHostName().equals(routing.getSingleHost())) {
if (HOST_CONTROLLER_LOGGER.isTraceEnabled()) {
HOST_CONTROLLER_LOGGER.trace("Remote single host");
}
// This host is the master, but this op is addressed specifically to another host.
// This is possibly a two step operation, but it's not coordinated by this host.
// Execute direct (which will proxy the request to the intended HC) and let the remote HC coordinate
// any two step process (if there is one)
executeDirect(context, operation);
}
else if (!routing.isTwoStep()) {
// It's a domain or host level op (probably a read) that does not require bringing in other hosts or servers
executeDirect(context, operation);
}
else {
// Else we are responsible for coordinating a two-phase op
// -- domain level op: apply to HostController models across domain and then push to servers
// -- host level op: apply to our model and then push to servers
executeTwoPhaseOperation(context, operation, routing);
}
}
public void setExecutorService(ExecutorService executorService) {
this.executorService = executorService;
}
private ExecutorService getExecutorService() {
return executorService == null ? Executors.newSingleThreadExecutor() : executorService;
}
private void routeToMasterDomainController(OperationContext context, ModelNode operation) {
// Per discussion on 2011/03/07, routing requests from a slave to the
// master may overly complicate the security infrastructure. Therefore,
// the ability to do this is being disabled until it's clear that it's
// not a problem
context.getFailureDescription().set(MESSAGES.masterDomainControllerOnlyOperation(operation.get(OP).asString(),
PathAddress.pathAddress(operation.get(OP_ADDR))));
context.completeStep();
}
/**
* Directly handles the op in the standard way the default prepare step handler would
* @param context the operation execution context
* @param operation the operation
* @throws OperationFailedException if there is no handler registered for the operation
*/
private void executeDirect(OperationContext context, ModelNode operation) throws OperationFailedException {
if (HOST_CONTROLLER_LOGGER.isTraceEnabled()) {
HOST_CONTROLLER_LOGGER.trace("Executing direct");
}
final String operationName = operation.require(OP).asString();
OperationStepHandler stepHandler = null;
final ImmutableManagementResourceRegistration registration = context.getResourceRegistration();
if (registration != null) {
stepHandler = registration.getOperationHandler(PathAddress.EMPTY_ADDRESS, operationName);
}
if(stepHandler != null) {
context.addStep(stepHandler, OperationContext.Stage.MODEL);
} else {
context.getFailureDescription().set(MESSAGES.noHandlerForOperation(operationName, PathAddress.pathAddress(operation.get(OP_ADDR))));
}
context.completeStep();
}
private void executeTwoPhaseOperation(OperationContext context, ModelNode operation, OperationRouting routing) throws OperationFailedException {
if (HOST_CONTROLLER_LOGGER.isTraceEnabled()) {
HOST_CONTROLLER_LOGGER.trace("Executing two-phase");
}
DomainOperationContext overallContext = new DomainOperationContext(localHostControllerInfo);
// Get a copy of the rollout plan so it doesn't get disrupted by any handlers
ModelNode rolloutPlan = operation.hasDefined(OPERATION_HEADERS) && operation.get(OPERATION_HEADERS).has(ROLLOUT_PLAN)
? operation.get(OPERATION_HEADERS).remove(ROLLOUT_PLAN) : new ModelNode();
// A stage that on the way out fixes up the result/failure description. On the way in it does nothing
context.addStep(new DomainFinalResultHandler(overallContext), OperationContext.Stage.MODEL);
final ModelNode slaveOp = operation.clone();
// Hackalicious approach to not streaming content to all the slaves
storeDeploymentContent(slaveOp, context);
slaveOp.get(OPERATION_HEADERS, PrepareStepHandler.EXECUTE_FOR_COORDINATOR).set(true);
slaveOp.protect();
// If necessary, execute locally first. This gets all of the Stage.MODEL, Stage.RUNTIME, Stage.VERIFY
// steps registered. A failure in those will prevent the rest of the steps below executing
String localHostName = localHostControllerInfo.getLocalHostName();
if (routing.isLocalCallNeeded(localHostName)) {
ModelNode localResponse = overallContext.getCoordinatorResult();
localSlaveHandler.addSteps(context, slaveOp.clone(), localResponse, false);
}
if (localHostControllerInfo.isMasterDomainController()) {
// Add steps to invoke on the HC for each relevant slave
Set<String> remoteHosts = new HashSet<String>(routing.getHosts());
boolean global = remoteHosts.size() == 0;
remoteHosts.remove(localHostName);
if (remoteHosts.size() > 0 || global) {
// Lock the controller to ensure there are no topology changes mid-op.
// This assumes registering/unregistering a remote proxy will involve an op and hence will block
context.acquireControllerLock();
if (global) {
remoteHosts.addAll(hostProxies.keySet());
}
Map<String, ProxyController> remoteProxies = new HashMap<String, ProxyController>();
for (String host : remoteHosts) {
ProxyController proxy = hostProxies.get(host);
if (proxy != null) {
remoteProxies.put(host, proxy);
} else if (!global) {
throw MESSAGES.invalidOperationTargetHost(host);
}
}
context.addStep(slaveOp.clone(), new DomainSlaveHandler(remoteProxies, overallContext, executorService), OperationContext.Stage.DOMAIN);
}
}
// Finally, the step to formulate and execute the 2nd phase rollout plan
context.addStep(new DomainRolloutStepHandler(hostProxies, serverProxies, overallContext, rolloutPlan, getExecutorService()), OperationContext.Stage.DOMAIN);
context.completeStep();
}
private void storeDeploymentContent(ModelNode opNode, OperationContext context) throws OperationFailedException {
try {
// A pretty painful hack. We analyze the operation for operations that include deployment content attachments; if found
// we store the content and replace the attachments
PathAddress address = PathAddress.pathAddress(opNode.get(OP_ADDR));
if (address.size() == 0) {
String opName = opNode.get(OP).asString();
if (DeploymentFullReplaceHandler.OPERATION_NAME.equals(opName) && hasStorableContent(opNode)) {
byte[] hash = DeploymentUploadUtil.storeDeploymentContent(context, opNode, contentRepository);
opNode.get(CONTENT).get(0).remove(INPUT_STREAM_INDEX);
opNode.get(CONTENT).get(0).get(HASH).set(hash);
}
else if (COMPOSITE.equals(opName) && opNode.hasDefined(STEPS)){
// Check the steps
for (ModelNode childOp : opNode.get(STEPS).asList()) {
storeDeploymentContent(childOp, context);
}
}
}
else if (address.size() == 1 && DEPLOYMENT.equals(address.getElement(0).getKey())
&& ADD.equals(opNode.get(OP).asString()) && hasStorableContent(opNode)) {
byte[] hash = DeploymentUploadUtil.storeDeploymentContent(context, opNode, contentRepository);
opNode.get(CONTENT).get(0).remove(INPUT_STREAM_INDEX);
opNode.get(CONTENT).get(0).get(HASH).set(hash);
}
} catch (IOException ioe) {
throw MESSAGES.caughtExceptionStoringDeploymentContent(ioe.getClass().getSimpleName(), ioe);
}
}
private boolean hasStorableContent(ModelNode operation) {
if (operation.hasDefined(CONTENT)) {
final ModelNode content = operation.require(CONTENT);
for (ModelNode item : content.asList()) {
if (hasValidContentAdditionParameterDefined(item)) {
return true;
}
}
}
return false;
}
private static final List<String> CONTENT_ADDITION_PARAMETERS = Arrays.asList(INPUT_STREAM_INDEX, BYTES, URL);
private static boolean hasValidContentAdditionParameterDefined(ModelNode item) {
for (String s : CONTENT_ADDITION_PARAMETERS) {
if (item.hasDefined(s)) {
return true;
}
}
return false;
}
}