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

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) Deprecated. use SubsystemTransformerRegistration
TransformersSubRegistration	registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer) Deprecated. use SubsystemTransformerRegistration
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) Deprecated. use SubsystemTransformerRegistration
ManagementResourceRegistration	registerSubsystemModel(ResourceDefinition resourceDefinition) Get the model node registration for this subsystem.
default void	registerXMLElementWriter(Supplier<org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext>> writer) Registers the XMLElementWriter that can handle marshalling the subsystem's configuration to XML.
void	registerXMLElementWriter(org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext> writer) Deprecated. use the registerXMLElementWriter(Supplier) variant
void	setHostCapable() Mark a subsystem as host capable.

Method Detail

setHostCapable

void setHostCapable()

Mark a subsystem as host capable. This will only take effect if running on a HC, and be ignored on a standalone or managed server. The standard behaviour on the HC is to register the subsystem resource definitions in the domain model under the /profile=* address. If this method is called, the standard behaviour happens, but in addition the resource definitions are registered in the local host model so that the subsystem can be added there as well.

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

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

Deprecated. use the registerXMLElementWriter(Supplier) variant

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

Parameters:

writer - the writer

registerXMLElementWriter

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

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

Parameters:

writer - the writer

registerModelTransformers

@Deprecated
TransformersSubRegistration registerModelTransformers(ModelVersionRange version,
                                                                  ResourceTransformer resourceTransformer)

Deprecated. use SubsystemTransformerRegistration

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

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

Deprecated. use SubsystemTransformerRegistration

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

@Deprecated
TransformersSubRegistration registerModelTransformers(ModelVersionRange version,
                                                                  CombinedTransformer combinedTransformer)

Deprecated. use SubsystemTransformerRegistration

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