org.jboss.as.clustering.controller.OperationExecutor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-clustering-common Show documentation

The code in this module is not explicitly related to clustering, but rather contains resuable code used by clustering modules and any modules that integrate with clustering.

The newest version!

/*
 * Copyright The WildFly Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package org.jboss.as.clustering.controller;

import org.jboss.as.controller.OperationContext;
import org.jboss.as.controller.OperationFailedException;
import org.jboss.dmr.ModelNode;

/**
 * Encapsulates the execution of a runtime operation.
 *
 * @param  the operation execution context.
 * @author Paul Ferraro
 * @author Radoslav Husar
 */
public interface OperationExecutor {

    /**
     * Executes the specified executable against the specified operation context.
     *
     * @param context    an operation context
     * @param operation  operation model for resolving operation parameters
     * @param executable the contextual executable object
     * @return the result of the execution (possibly null).
     * @throws OperationFailedException if execution fails
     */
    ModelNode execute(OperationContext context, ModelNode operation, Operation executable) throws OperationFailedException;
}