Package org.jboss.as.controller.services.path

Class ResolvePathHandler

java.lang.Object

org.jboss.as.controller.services.path.ResolvePathHandler

All Implemented Interfaces:

OperationStepHandler

public class ResolvePathHandler
extends Object
implements OperationStepHandler

An operation to resolve a relative-to path.

The operation should be placed on any operation that defines a relative-to path attribute.

Example usage in an extension:

          public class CustomExtension implements Extension {
              ...

              public void initialize(final ExtensionContext context) {
                  final SubsystemRegistration subsystem = context.registerSubsystem(SUBSYSTEM_NAME,
                      MANAGEMENT_API_MAJOR_VERSION, MANAGEMENT_API_MINOR_VERSION, MANAGEMENT_API_MICRO_VERSION);
                  final ManagementResourceRegistration registration = subsystem.registerSubsystemModel(CustomFileResource.INSTANCE);

                  final ResolvePathHandler resolvePathHandler = ResolvePathHandler.Builder.of(context.getPathManager()).build();
                  registration.registerOperationHandler(ResolvePathHandler.OPERATION_DEFINITION, resolvePathHandler);

                  subsystem.registerXMLElementWriter(CustomSubsystemParser.INSTANCE);
              }

              ...
          }
      

Author:

James R. Perkins

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResolvePathHandler.Builder	Build an operation to resolve the

Field Summary

Fields

Modifier and Type	Field	Description
static SimpleAttributeDefinition	RELATIVE_TO_ONLY

Method Summary

Modifier and Type	Method	Description
void	execute(OperationContext context, org.jboss.dmr.ModelNode operation)	Execute this step.
OperationDefinition	getOperationDefinition()	Returns the operation definition for the operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RELATIVE_TO_ONLY

public static final SimpleAttributeDefinition RELATIVE_TO_ONLY

Method Detail

execute

public void execute(OperationContext context,
                    org.jboss.dmr.ModelNode operation)
             throws OperationFailedException

Description copied from interface: OperationStepHandler

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.

Specified by:

execute in interface OperationStepHandler

Parameters:

context - the operation context

operation - the operation being executed

Throws:

OperationFailedException - if the operation failed before calling context.completeStep()

getOperationDefinition

public OperationDefinition getOperationDefinition()

Returns the operation definition for the operation.

Returns:

the operation definition