org.jboss.as.controller

Class ModelOnlyAddStepHandler

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

org.jboss.as.controller.ModelOnlyAddStepHandler

All Implemented Interfaces:

OperationStepHandler

public class ModelOnlyAddStepHandler
extends AbstractAddStepHandler

A handler for the add operation that only manipulates the model. The original expected use is for resources that have been dropped from recent versions, but for which configuration manageablity is retained in order to allow use on legacy hosts in a managed domain. This handler would be used on the host controllers for the newer version nodes (particularly the master host controller.)

Author:

Brian Stansberry (c) 2012 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
ModelOnlyAddStepHandler(AttributeDefinition... attributes) Creates a new ModelOnlyStepHandler that stores the given attributes to the model.

Method Summary

Modifier and Type	Method and Description
protected void	performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model, ServiceVerificationHandler verificationHandler, List<org.jboss.msc.service.ServiceController<?>> newControllers) Throws UnsupportedOperationException.
protected void	populateModel(org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model) Call AttributeDefinition.validateAndSet(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode) for each attribute provided to the constructor Populate the given node in the persistent configuration model based on the values in the given operation.
protected boolean	requiresRuntime(OperationContext context) Returns false.
protected boolean	requiresRuntimeVerification() Returns false.
protected void	rollbackRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model, List<org.jboss.msc.service.ServiceController<?>> controllers) Throws UnsupportedOperationException.

Methods inherited from class org.jboss.as.controller.AbstractAddStepHandler

createResource, execute, populateModel, populateModel

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelOnlyAddStepHandler

public ModelOnlyAddStepHandler(AttributeDefinition... attributes)

Creates a new ModelOnlyStepHandler that stores the given attributes to the model.

Parameters:

attributes - the attributes

Method Detail

populateModel

protected void populateModel(org.jboss.dmr.ModelNode operation,
                             org.jboss.dmr.ModelNode model)
                      throws OperationFailedException

Call AttributeDefinition.validateAndSet(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode) for each attribute provided to the constructor Populate the given node in the persistent configuration model based on the values in the given operation.

Overrides:

populateModel in class AbstractAddStepHandler

Parameters:

operation - the operation

model - persistent configuration model node that corresponds to the address of operation

Throws:

OperationFailedException - if operation is invalid or populating the model otherwise fails

requiresRuntime

protected final boolean requiresRuntime(OperationContext context)

Returns false. Gets whether AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List)} should be called. This default implementation always returns true. Subclasses that perform no runtime update could override and return false.

Overrides:

requiresRuntime in class AbstractAddStepHandler

Parameters:

context - operation context

Returns:

true if performRuntime should be invoked; false otherwise.

requiresRuntimeVerification

protected final boolean requiresRuntimeVerification()

Returns false. Gets whether the ServiceVerificationHandler parameter passed to AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List) should be added to the operation context as a step.

This default implementation always returns true.

Overrides:

requiresRuntimeVerification in class AbstractAddStepHandler

Returns:

true if the service verification step should be added; false if it's not necessary.

performRuntime

protected final void performRuntime(OperationContext context,
                                    org.jboss.dmr.ModelNode operation,
                                    org.jboss.dmr.ModelNode model,
                                    ServiceVerificationHandler verificationHandler,
                                    List<org.jboss.msc.service.ServiceController<?>> newControllers)
                             throws OperationFailedException

Throws UnsupportedOperationException. Make any runtime changes necessary to effect the changes indicated by the given operation. Executes after AbstractAddStepHandler.populateModel(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode), so the given model parameter will reflect any changes made in that method.

This default implementation does nothing.

Overrides:

performRuntime in class AbstractAddStepHandler

Parameters:

context - the operation context

operation - the operation being executed

model - persistent configuration model node that corresponds to the address of operation

verificationHandler - step handler that can be added as a listener to any new services installed in order to validate the services installed correctly during the VERIFY stage

newControllers - holder for the ServiceController for any new services installed by the method. The method should add the ServiceController for any new services to this list. If the overall operation needs to be rolled back, the list will be used in AbstractAddStepHandler.rollbackRuntime(OperationContext, ModelNode, ModelNode, java.util.List) to automatically removed the newly added services

Throws:

OperationFailedException - if operation is invalid or updating the runtime otherwise fails

rollbackRuntime

protected final void rollbackRuntime(OperationContext context,
                                     org.jboss.dmr.ModelNode operation,
                                     org.jboss.dmr.ModelNode model,
                                     List<org.jboss.msc.service.ServiceController<?>> controllers)

Throws UnsupportedOperationException. Rollback runtime changes made in AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List).

This default implementation removes all services in the given list of controllers. The contents of controllers is the same as what was in the newControllers parameter passed to performRuntime() when that method returned.

Overrides:

rollbackRuntime in class AbstractAddStepHandler

Parameters:

context - the operation context

operation - the operation being executed

model - persistent configuration model node that corresponds to the address of operation

controllers - holder for the ServiceController for any new services installed by AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List)