/*
* 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.controller.remote;
import static org.jboss.as.controller.ControllerLogger.ROOT_LOGGER;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.CALLER_TYPE;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.FAILED;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.FAILURE_DESCRIPTION;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OPERATION_HEADERS;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OUTCOME;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.USER;
import java.io.DataInput;
import java.io.IOException;
import javax.security.auth.Subject;
import org.jboss.as.controller.ModelController;
import org.jboss.as.controller.client.impl.ModelControllerProtocol;
import org.jboss.as.protocol.StreamUtils;
import org.jboss.as.protocol.mgmt.ActiveOperation;
import org.jboss.as.protocol.mgmt.FlushableDataOutput;
import org.jboss.as.protocol.mgmt.ManagementChannelAssociation;
import org.jboss.as.protocol.mgmt.ManagementProtocol;
import org.jboss.as.protocol.mgmt.ManagementRequestContext;
import org.jboss.as.protocol.mgmt.ManagementRequestHandler;
import org.jboss.as.protocol.mgmt.ManagementRequestHandlerFactory;
import org.jboss.as.protocol.mgmt.ManagementRequestHeader;
import org.jboss.as.protocol.mgmt.ManagementResponseHeader;
import org.jboss.as.protocol.mgmt.ProtocolUtils;
import org.jboss.dmr.ModelNode;
/**
* Operation handlers for the remote implementation of {@link org.jboss.as.controller.client.ModelControllerClient}
*
* @author <a href="kabir.khan@jboss.com">Kabir Khan</a>
* @author Emanuel Muckenhuber
*/
public class ModelControllerClientOperationHandler implements ManagementRequestHandlerFactory {
private final ModelController controller;
private final ManagementChannelAssociation channelAssociation;
private final Subject subject;
public ModelControllerClientOperationHandler(final ModelController controller,
final ManagementChannelAssociation channelAssociation) {
this(controller, channelAssociation, null);
}
public ModelControllerClientOperationHandler(final ModelController controller,
final ManagementChannelAssociation channelAssociation, final Subject subject) {
this.controller = controller;
this.channelAssociation = channelAssociation;
this.subject = subject;
}
@Override
public ManagementRequestHandler<?, ?> resolveHandler(final RequestHandlerChain handlers, final ManagementRequestHeader header) {
switch (header.getOperationId()) {
case ModelControllerProtocol.EXECUTE_ASYNC_CLIENT_REQUEST:
case ModelControllerProtocol.EXECUTE_CLIENT_REQUEST:
// initialize the operation ctx before executing the request handler
handlers.registerActiveOperation(header.getBatchId(), null);
return new ExecuteRequestHandler();
case ModelControllerProtocol.CANCEL_ASYNC_REQUEST:
return new CancelAsyncRequestHandler();
}
return handlers.resolveNext();
}
class ExecuteRequestHandler implements ManagementRequestHandler<ModelNode, Void> {
@Override
public void handleRequest(final DataInput input, final ActiveOperation.ResultHandler<ModelNode> resultHandler, final ManagementRequestContext<Void> context) throws IOException {
final ModelNode operation = new ModelNode();
ProtocolUtils.expectHeader(input, ModelControllerProtocol.PARAM_OPERATION);
operation.readExternal(input);
ProtocolUtils.expectHeader(input, ModelControllerProtocol.PARAM_INPUTSTREAMS_LENGTH);
final int attachmentsLength = input.readInt();
context.executeAsync(new ManagementRequestContext.AsyncTask<Void>() {
@Override
public void execute(final ManagementRequestContext<Void> context) throws Exception {
final ManagementResponseHeader response = ManagementResponseHeader.create(context.getRequestHeader());
final ModelNode result;
SecurityActions.setSecurityContextSubject(subject);
try {
result = doExecute(operation, attachmentsLength, context);
} finally {
SecurityActions.clearSubjectSecurityContext();
}
final FlushableDataOutput output = context.writeMessage(response);
try {
output.write(ModelControllerProtocol.PARAM_RESPONSE);
result.writeExternal(output);
output.writeByte(ManagementProtocol.RESPONSE_END);
output.close();
} finally {
StreamUtils.safeClose(output);
}
resultHandler.done(result);
}
});
}
protected ModelNode doExecute(final ModelNode operation, final int attachmentsLength, final ManagementRequestContext<Void> context) {
//Add a header to show that this operation comes from a user. If this is a host controller and the operation needs propagating to the
//servers it will be removed by the domain ops responsible for propagation to the servers.
operation.get(OPERATION_HEADERS, CALLER_TYPE).set(USER);
final ManagementRequestHeader header = ManagementRequestHeader.class.cast(context.getRequestHeader());
final int batchId = header.getBatchId();
final ModelNode result = new ModelNode();
final OperationMessageHandlerProxy messageHandlerProxy = new OperationMessageHandlerProxy(channelAssociation, batchId);
final OperationAttachmentsProxy attachmentsProxy = OperationAttachmentsProxy.create(channelAssociation, batchId, attachmentsLength);
try {
ROOT_LOGGER.tracef("Executing client request %d(%d)", batchId, header.getRequestId());
result.set(controller.execute(
operation,
messageHandlerProxy,
ModelController.OperationTransactionControl.COMMIT,
attachmentsProxy));
} catch (Exception e) {
final ModelNode failure = new ModelNode();
failure.get(OUTCOME).set(FAILED);
failure.get(FAILURE_DESCRIPTION).set(e.getClass().getName() + ":" + e.getMessage());
result.set(failure);
attachmentsProxy.shutdown(e);
} finally {
ROOT_LOGGER.tracef("Executed client request %d", batchId);
}
return result;
}
}
private static class CancelAsyncRequestHandler implements ManagementRequestHandler<ModelNode, Void> {
@Override
public void handleRequest(final DataInput input, final ActiveOperation.ResultHandler<ModelNode> resultHandler, final ManagementRequestContext<Void> context) throws IOException {
context.executeAsync(new ManagementRequestContext.AsyncTask<Void>() {
@Override
public void execute(ManagementRequestContext<Void> context) throws Exception {
final ManagementResponseHeader response = ManagementResponseHeader.create(context.getRequestHeader());
final FlushableDataOutput output = context.writeMessage(response);
try {
output.writeByte(ManagementProtocol.RESPONSE_END);
output.close();
} finally {
StreamUtils.safeClose(output);
}
}
});
resultHandler.cancel();
}
}
}