org.jboss.as.controller

Interface SubsystemRegistration

public interface SubsystemRegistration

A subsystem registration.

If no XML mappings are defined, then a simple empty XML mapping is used.

Author:

David M. Lloyd

Method Summary

Methods

Modifier and Type	Method and Description
ModelVersion	getSubsystemVersion() Get the version of the subsystem
ManagementResourceRegistration	registerDeploymentModel(ResourceDefinition resourceDefinition) Get the deployment model node registration for this subsystem.
TransformersSubRegistration	registerModelTransformers(ModelVersionRange version, CombinedTransformer combinedTransformer) Register transformers for a given model version.
TransformersSubRegistration	registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer) Register transformers for a specific model versions.
TransformersSubRegistration	registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer, OperationTransformer operationTransformer) Deprecated. use registerModelTransformers(ModelVersionRange, ResourceTransformer, OperationTransformer, boolean)
TransformersSubRegistration	registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer, OperationTransformer operationTransformer, boolean placeholder) Register transformers for a given model version.
ManagementResourceRegistration	registerSubsystemModel(ResourceDefinition resourceDefinition) Get the model node registration for this subsystem.
void	registerXMLElementWriter(org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext> writer) Registers the XMLElementWriter that can handle marshalling the subsystem's configuration to XML.

Method Detail

registerSubsystemModel

ManagementResourceRegistration registerSubsystemModel(ResourceDefinition resourceDefinition)

Get the model node registration for this subsystem.

Parameters:

resourceDefinition - factory for the provider of the description of the subsystem's root management resource

Returns:

the subsystem-level model node registration

registerDeploymentModel

ManagementResourceRegistration registerDeploymentModel(ResourceDefinition resourceDefinition)

Get the deployment model node registration for this subsystem.

Parameters:

resourceDefinition - factory for the provider of the description of the subsystem's root deployment-level management resource

Returns:

the deployment-level model node registration

registerXMLElementWriter

void registerXMLElementWriter(org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext> writer)

Registers the XMLElementWriter that can handle marshalling the subsystem's configuration to XML.

Parameters:

writer - the writer

registerModelTransformers

TransformersSubRegistration registerModelTransformers(ModelVersionRange version,
                                                    ResourceTransformer resourceTransformer)

Register transformers for a specific model versions.

Parameters:

version - the model version range

resourceTransformer - the subsystem resource transformer

Returns:

the transformers registry

registerModelTransformers

@Deprecated
TransformersSubRegistration registerModelTransformers(ModelVersionRange version,
                                                               ResourceTransformer resourceTransformer,
                                                               OperationTransformer operationTransformer)

Deprecated. use registerModelTransformers(ModelVersionRange, ResourceTransformer, OperationTransformer, boolean)

Register transformers for a given model version.

Parameters:

version - the model version

resourceTransformer - the subsystem resource transformer

operationTransformer - the subsystem operation transformer

Returns:

the transformers registry

registerModelTransformers

TransformersSubRegistration registerModelTransformers(ModelVersionRange version,
                                                    ResourceTransformer resourceTransformer,
                                                    OperationTransformer operationTransformer,
                                                    boolean placeholder)

Register transformers for a given model version.

Parameters:

version - the model version

resourceTransformer - the subsystem resource transformer

operationTransformer - the subsystem operation transformer

placeholder - whether or not the transformers are placeholders

Returns:

the transformers registry

registerModelTransformers

TransformersSubRegistration registerModelTransformers(ModelVersionRange version,
                                                    CombinedTransformer combinedTransformer)

Register transformers for a given model version.

Parameters:

version - the model version

combinedTransformer - the combined transformer

Returns:

the subsystem registration

getSubsystemVersion

ModelVersion getSubsystemVersion()

Get the version of the subsystem

Returns:

the version