/*
* 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;
import java.security.Permission;
import java.util.concurrent.Executor;
import org.jboss.as.controller.client.ModelControllerClient;
import org.jboss.as.controller.client.Operation;
import org.jboss.as.controller.client.OperationAttachments;
import org.jboss.as.controller.client.OperationMessageHandler;
import org.jboss.as.controller.client.OperationResponse;
import org.jboss.as.controller.registry.NotificationHandlerRegistration;
import org.jboss.as.controller.security.ControllerPermission;
import org.jboss.dmr.ModelNode;
/**
* Controls reads of and modifications to a management model.
*
* @author <a href="mailto:david.lloyd@redhat.com">David M. Lloyd</a>
*/
public interface ModelController {
/**
* A {@link org.jboss.as.controller.security.ControllerPermission} needed to access a {@link ModelController} via {@link org.jboss.msc.service.Service#getValue()} or
* to invoke its methods. The name of the permission is "{@code canAccessModelController}."
*/
Permission ACCESS_PERMISSION = ControllerPermission.CAN_ACCESS_MODEL_CONTROLLER;
/**
* Execute an operation, sending updates to the given handler. This method is not intended to be invoked directly
* by clients.
*
* @param operation the operation to execute
* @param handler the message handler
* @param control the transaction control for this operation
* @param attachments the operation attachments
* @return the operation result
*
* @throws SecurityException if the caller does not have {@link #ACCESS_PERMISSION}
*/
ModelNode execute(ModelNode operation, OperationMessageHandler handler, OperationTransactionControl control, OperationAttachments attachments);
/**
* Execute an operation, sending updates to the given handler, and making available in the return value
* any streams that may have been associated with the response. This method is not intended to be invoked directly
* by clients.
*
* @param operation the operation to execute
* @param handler the message handler
* @param control the transaction control for this operation
* @return the operation response
*
* @throws SecurityException if the caller does not have {@link #ACCESS_PERMISSION}
*/
OperationResponse execute(Operation operation, OperationMessageHandler handler, OperationTransactionControl control);
/**
* Create an in-VM client.
*
* @param executor the executor to use for asynchronous operation execution
* @return the client
*
* @throws SecurityException if the caller does not have {@link #ACCESS_PERMISSION}
*/
ModelControllerClient createClient(Executor executor);
/**
* Returns the {@code NotificationHandlerRegistration} that registers notification handlers for this model controller.
*
* @return the notification handler registration
*/
NotificationHandlerRegistration getNotificationRegistry();
/**
* A callback interface for the operation's completion status. Implemented in order to control whether a complete
* operation is committed or rolled back after it is prepared.
*/
interface OperationTransactionControl {
/**
* Notify that an operation is complete and may be committed or rolled back.
*
* <p><strong>It is the responsibility of the user of this {@code OperationTransactionControl} to ensure that
* {@link OperationTransaction#commit()} or {@link OperationTransaction#rollback()} is eventually called on
* the provided {@code transaction}.
* </strong></p>
*
* @param transaction the transaction to control the fate of the operation. Cannot be {@code null}
* @param result the result. Cannot be {@code null}
*/
void operationPrepared(OperationTransaction transaction, ModelNode result);
/**
* An operation transaction control implementation which always commits the operation.
*/
OperationTransactionControl COMMIT = new OperationTransactionControl() {
public void operationPrepared(final OperationTransaction transaction, final ModelNode result) {
transaction.commit();
}
};
}
/**
* An operation transaction.
*/
interface OperationTransaction {
/**
* Commit the operation.
*/
void commit();
/**
* Roll the operation back.
*/
void rollback();
}
}