Package org.jboss.as.controller.parsing

Interface ExtensionParsingContext

public interface ExtensionParsingContext

Context in effect when the extension element for a given Extension is being parsed. Allows the extension to initialize the XML parsers that can be used for parsing the subsystem elements that contain the configuration for its subsystems.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method	Description
ProcessType	getProcessType()	Gets the type of the current process.
RunningMode	getRunningMode()	Gets the current running mode of the process.
void	setProfileParsingCompletionHandler(ProfileParsingCompletionHandler handler)	Registers a ProfileParsingCompletionHandler to receive a callback upon completion of parsing of a profile.
void	setSubsystemXmlMapping(String subsystemName, String namespaceUri, Supplier<org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>>> supplier)	Set the parser for the profile-wide subsystem configuration XML element.
void	setSubsystemXmlMapping(String subsystemName, String namespaceUri, org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>> reader)	Set the parser for the profile-wide subsystem configuration XML element.
default <S extends SubsystemSchema<S>> void	setSubsystemXmlMappings(String subsystemName, Set<S> schemas)	Set the parser for the profile-wide subsystem configuration XML element.

Method Detail

getProcessType

ProcessType getProcessType()

Gets the type of the current process.

Returns:

the current process type. Will not be null

getRunningMode

RunningMode getRunningMode()

Gets the current running mode of the process.

Returns:

the current running mode. Will not be null

setSubsystemXmlMapping

void setSubsystemXmlMapping(String subsystemName,
                            String namespaceUri,
                            org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>> reader)

Set the parser for the profile-wide subsystem configuration XML element. The element is always called "subsystem". The reader should populate the given model node with the appropriate "subsystem add" update, without the address or operation name as that information will be automatically populated.

Parameters:

subsystemName - the name of the subsystem. Cannot be null

namespaceUri - the URI of the subsystem's XML namespace, in string form. Cannot be null

reader - the element reader. Cannot be null

Throws:

IllegalStateException - if another Extension has already registered a subsystem with the given subsystemName

setSubsystemXmlMapping

void setSubsystemXmlMapping(String subsystemName,
                            String namespaceUri,
                            Supplier<org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>>> supplier)

Set the parser for the profile-wide subsystem configuration XML element. The element is always called "subsystem". The reader should populate the given model node with the appropriate "subsystem add" update, without the address or operation name as that information will be automatically populated. It is recommended that supplier always creates new instance of the XMLElementReader instead of caching and returning always same instance.

Parameters:

subsystemName - the name of the subsystem. Cannot be null

namespaceUri - the URI of the sussystem's XML namespace, in string form. Cannot be null

supplier - of the element reader. Cannot be null

Throws:

IllegalStateException - if another Extension has already registered a subsystem with the given subsystemName

setSubsystemXmlMappings

default <S extends SubsystemSchema<S>> void setSubsystemXmlMappings(String subsystemName,
                                                                    Set<S> schemas)

Set the parser for the profile-wide subsystem configuration XML element. The element is always called "subsystem". The reader of the schema should populate the given model node with the appropriate "subsystem add" update, without the address or operation name as that information will be automatically populated.

Type Parameters:

S - the schema type

Parameters:

subsystemName - the name of the subsystem. Cannot be null

schemas - a set of schemas to be registered

setProfileParsingCompletionHandler

void setProfileParsingCompletionHandler(ProfileParsingCompletionHandler handler)

Registers a ProfileParsingCompletionHandler to receive a callback upon completion of parsing of a profile.

Parameters:

handler - the handler. Cannot be null