Package org.jboss.as.clustering.controller

Interface AddStepHandlerDescriptor

All Superinterfaces:

OperationStepHandlerDescriptor, RemoveStepHandlerDescriptor, WriteAttributeStepHandlerDescriptor

All Known Implementing Classes:

ResourceDescriptor

public interface AddStepHandlerDescriptor
extends WriteAttributeStepHandlerDescriptor, RemoveStepHandlerDescriptor

Describes the common properties of a remove operation handler.

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method	Description
UnaryOperator<org.jboss.as.controller.OperationStepHandler>	getAddOperationTransformation()	Returns a transformer for the add operation handler.
Map<org.jboss.as.controller.AttributeDefinition,AttributeTranslation>	getAttributeTranslations()	Returns a mapping of attribute translations
Map<org.jboss.as.controller.AttributeDefinition,org.jboss.as.controller.OperationStepHandler>	getCustomAttributes()	Custom attributes of the add operation, processed using a specific write-attribute handler.
Collection<org.jboss.as.controller.AttributeDefinition>	getExtraParameters()	Extra parameters (not specified by WriteAttributeStepHandlerDescriptor.getAttributes()) for the add operation.
Set<org.jboss.as.controller.PathElement>	getRequiredChildren()	Returns the required child resources for this resource description.
Set<org.jboss.as.controller.PathElement>	getRequiredSingletonChildren()	Returns the required singleton child resources for this resource description.
UnaryOperator<org.jboss.as.controller.registry.Resource>	getResourceTransformation()	Returns a transformation for a newly created resource.

Methods inherited from interface org.jboss.as.clustering.controller.OperationStepHandlerDescriptor

getCapabilities

Methods inherited from interface org.jboss.as.clustering.controller.RemoveStepHandlerDescriptor

getDescriptionResolver, getOperationTransformation, getResourceCapabilityReferences, getRuntimeResourceRegistrations

Methods inherited from interface org.jboss.as.clustering.controller.WriteAttributeStepHandlerDescriptor

getAttributes, getIgnoredAttributes

Method Detail

getCustomAttributes

Map<org.jboss.as.controller.AttributeDefinition,org.jboss.as.controller.OperationStepHandler> getCustomAttributes()

Custom attributes of the add operation, processed using a specific write-attribute handler.

Returns:

a map of attributes and their write-attribute handler

getExtraParameters

Collection<org.jboss.as.controller.AttributeDefinition> getExtraParameters()

Extra parameters (not specified by WriteAttributeStepHandlerDescriptor.getAttributes()) for the add operation.

Returns:

a collection of attributes

getRequiredChildren

Set<org.jboss.as.controller.PathElement> getRequiredChildren()

Returns the required child resources for this resource description.

Returns:

a collection of resource paths

getRequiredSingletonChildren

Set<org.jboss.as.controller.PathElement> getRequiredSingletonChildren()

Returns the required singleton child resources for this resource description. This means only one child resource should exist for the given child type.

Returns:

a collection of resource paths

getAttributeTranslations

Map<org.jboss.as.controller.AttributeDefinition,AttributeTranslation> getAttributeTranslations()

Returns a mapping of attribute translations

Returns:

an attribute translation mapping

getAddOperationTransformation

UnaryOperator<org.jboss.as.controller.OperationStepHandler> getAddOperationTransformation()

Returns a transformer for the add operation handler. This is typically used to adapt legacy operations to conform to the current version of the model.

Returns:

an operation handler transformer.

getResourceTransformation

UnaryOperator<org.jboss.as.controller.registry.Resource> getResourceTransformation()

Returns a transformation for a newly created resource.

Returns:

a resource transformation