Package 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
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description ModelVersion
getSubsystemVersion()
Get the version of the subsystemManagementResourceRegistration
registerDeploymentModel(ResourceDefinition resourceDefinition)
Get the deployment model node registration for this subsystem.TransformersSubRegistration
registerModelTransformers(ModelVersionRange version, CombinedTransformer combinedTransformer)
Deprecated.TransformersSubRegistration
registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer)
Deprecated.TransformersSubRegistration
registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer, OperationTransformer operationTransformer)
TransformersSubRegistration
registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer, OperationTransformer operationTransformer, boolean placeholder)
Deprecated.ManagementResourceRegistration
registerSubsystemModel(ResourceDefinition resourceDefinition)
Get the model node registration for this subsystem.default void
registerXMLElementWriter(Supplier<org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext>> writer)
Registers theXMLElementWriter
that can handle marshalling the subsystem's configuration to XML.void
registerXMLElementWriter(org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext> writer)
Registers theXMLElementWriter
that can handle marshalling the subsystem's configuration to XML.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
void registerXMLElementWriter(org.jboss.staxmapper.XMLElementWriter<SubsystemMarshallingContext> writer)
Registers theXMLElementWriter
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 theXMLElementWriter
that can handle marshalling the subsystem's configuration to XML.- Parameters:
writer
- the writer
-
registerModelTransformers
@Deprecated TransformersSubRegistration registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer)
Deprecated.Register transformers for a specific model versions.- Parameters:
version
- the model version rangeresourceTransformer
- the subsystem resource transformer- Returns:
- the transformers registry
-
registerModelTransformers
@Deprecated TransformersSubRegistration registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer, OperationTransformer operationTransformer)
Deprecated.Register transformers for a given model version.- Parameters:
version
- the model versionresourceTransformer
- the subsystem resource transformeroperationTransformer
- the subsystem operation transformer- Returns:
- the transformers registry
-
registerModelTransformers
@Deprecated TransformersSubRegistration registerModelTransformers(ModelVersionRange version, ResourceTransformer resourceTransformer, OperationTransformer operationTransformer, boolean placeholder)
Deprecated.Register transformers for a given model version.- Parameters:
version
- the model versionresourceTransformer
- the subsystem resource transformeroperationTransformer
- the subsystem operation transformerplaceholder
- whether or not the transformers are placeholders- Returns:
- the transformers registry
-
registerModelTransformers
@Deprecated TransformersSubRegistration registerModelTransformers(ModelVersionRange version, CombinedTransformer combinedTransformer)
Deprecated.Register transformers for a given model version.- Parameters:
version
- the model versioncombinedTransformer
- the combined transformer- Returns:
- the subsystem registration
-
getSubsystemVersion
ModelVersion getSubsystemVersion()
Get the version of the subsystem- Returns:
- the version
-
-