Package org.jboss.as.controller

Interface OperationStepHandler

All Known Implementing Classes:
AbstractAddStepHandler, AbstractBoottimeAddStepHandler, AbstractModelUpdateHandler, AbstractRemoveStepHandler, AbstractRuntimeOnlyHandler, AbstractWriteAttributeHandler, AbstractXmlMarshallingHandler, AliasStepHandler, BaseHttpInterfaceAddStepHandler, BaseHttpInterfaceResourceDefinition.HttpUpgradeAttributeHandler, BaseNativeInterfaceAddStepHandler, BootErrorCollector.ListBootErrorsHandler, CompositeOperationHandler, ConfigurationPublishHandler, CredentialReferenceWriteAttributeHandler, ExtensionAddHandler, ExtensionRemoveHandler, GenericSubsystemDescribeHandler, GlobalInstallationReportHandler, GlobalOperationHandlers.AbstractMultiTargetHandler, InterfaceAddHandler, InterfaceCriteriaWriteHandler, ListOperations.ListAddHandler, ListOperations.ListClearHandler, ListOperations.ListGetHandler, ListOperations.ListRemoveHandler, ManagementInterfaceAddStepHandler, MapOperations.MapClearHandler, MapOperations.MapGetHandler, MapOperations.MapPutHandler, MapOperations.MapRemoveHandler, ModelOnlyAddStepHandler, ModelOnlyRemoveStepHandler, ModelOnlyWriteAttributeHandler, NamespaceAddHandler, NamespaceRemoveHandler, NoopOperationStepHandler, ParallelBootOperationStepHandler, ParallelExtensionAddHandler, PathAddHandler, PathInfoHandler, PathRemoveHandler, ProcessEnvironment.ProcessNameWriteAttributeHandler, ProcessReloadHandler, ProcessStateAttributeHandler, ProxyStepHandler, QueryOperationHandler, ReadAttributeGroupHandler, ReadAttributeGroupNamesHandler, ReadAttributeHandler, ReadChildrenNamesHandler, ReadChildrenResourcesHandler, ReadChildrenTypesHandler, ReadConfigAsFeaturesOperationHandler, ReadFeatureDescriptionHandler, ReadOperationDescriptionHandler, ReadOperationNamesHandler, ReadResourceDescriptionHandler, ReadResourceHandler, ReadResourceNameOperationStepHandler, ReloadRequiredAddStepHandler, ReloadRequiredRemoveStepHandler, ReloadRequiredWriteAttributeHandler, ResolveExpressionHandler, ResolvePathHandler, RestartParentResourceAddHandler, RestartParentResourceHandlerBase, RestartParentResourceRemoveHandler, RestartParentWriteAttributeHandler, SchemaLocationAddHandler, SchemaLocationRemoveHandler, ServiceRemoveStepHandler, SnapshotDeleteHandler, SnapshotListHandler, SnapshotTakeHandler, UndefineAttributeHandler, UnsupportedSubsystemDescribeHandler, ValidateAddressOperationHandler, ValidateOperationHandler, WriteAttributeHandler, XmlFileMarshallingHandler, XmlMarshallingHandler
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface OperationStepHandler
Handler for an individual step in the overall execution of a management operation.

A handler is associated with a single stage of operation execution and should only perform functions appropriate for that stage.

A handler registered with a ManagementResourceRegistration will execute in OperationContext.Stage.MODEL; otherwise the step will execute in the stage passed to OperationContext.addStep(OperationStepHandler, org.jboss.as.controller.OperationContext.Stage) when it was added.

Author:
David M. Lloyd

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute(OperationContext context, org.jboss.dmr.ModelNode operation)
    Execute this step.

  • Method Details

    • execute

      void execute(OperationContext context, org.jboss.dmr.ModelNode operation) throws OperationFailedException
      Execute this step. If the operation fails, context.getFailureDescription() must be called, or an OperationFailedException must be thrown. If the operation succeeded and the operation provides a return value, context.getResult() should be called and the result populated with the outcome. If the handler wishes to take further action once the result of the overall operation execution is known, one of the context.completeStep variants should be called to register a callback. The callback will not be invoked if this method throws an exception.

      When this method is invoked the thread context classloader will be set to be the defining class loader of the class that implements this interface.

      Parameters:
      context - the operation context
      operation - the operation being executed
      Throws:
      OperationFailedException - if the operation failed before calling context.completeStep()