org.jboss.as.controller.extension

Class ExtensionRegistry

java.lang.Object

org.jboss.as.controller.extension.ExtensionRegistry

public class ExtensionRegistry
extends Object

A registry for information about Extensions to the core application server.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ExtensionRegistry.ExtensionContextImpl
class	ExtensionRegistry.ExtensionInfo
class	ExtensionRegistry.SubsystemRegistrationImpl

Constructor Summary

Constructors

Constructor and Description
ExtensionRegistry(ProcessType processType, RunningModeControl runningModeControl) Deprecated. Here for core-model-test and subsystem-test backwards compatibility
ExtensionRegistry(ProcessType processType, RunningModeControl runningModeControl, ManagedAuditLogger auditLogger, JmxAuthorizer authorizer)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the registry to prepare for re-registration (e.g.
Map<String,SubsystemInformation>	getAvailableSubsystems(String moduleName) Gets information about the subsystems provided by a given Extension.
ExtensionContext	getExtensionContext(String moduleName) Deprecated. Use getExtensionContext(String, boolean)
ExtensionContext	getExtensionContext(String moduleName, boolean isMasterDomainController) Gets an ExtensionContext for use when handling an add operation for a resource representing an Extension.
Set<String>	getExtensionModuleNames() Gets the module names of all known Extensions.
ExtensionParsingContext	getExtensionParsingContext(String moduleName, org.jboss.staxmapper.XMLMapper xmlMapper) Gets an ExtensionParsingContext for use when initializing the extension's parsers.
ProcessType	getProcessType() Gets the type of the current process.
Set<ProfileParsingCompletionHandler>	getProfileParsingCompletionHandlers()
ManagementResourceRegistration	getProfileRegistration()
SubsystemInformation	getSubsystemInfo(String name)
TransformerRegistry	getTransformerRegistry()
Set<String>	getUnnamedNamespaces(String moduleName) Gets the URIs (in string form) of any XML namespaces registered by an extension without an accompanying subsystem name that could not be clearly associated with a single subsystem.
void	recordSubsystemVersions(String moduleName, org.jboss.dmr.ModelNode subsystems) Records the versions of the subsystems associated with the given moduleName as properties in the provided ModelNode.
void	removeExtension(Resource rootResource, String moduleName) Cleans up a module's subsystems from the resource registration model.
void	setPathManager(PathManager pathManager) Sets the PathManager to provide via the ExtensionContext.
void	setSubsystemParentResourceRegistrations(ManagementResourceRegistration profileResourceRegistration, ManagementResourceRegistration deploymentsResourceRegistration) Sets the ManagementResourceRegistrations for the resource under which subsystem child resources should be registered.
void	setWriterRegistry(SubsystemXmlWriterRegistry writerRegistry) Sets the SubsystemXmlWriterRegistry to use for storing subsystem marshallers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtensionRegistry

public ExtensionRegistry(ProcessType processType,
                         RunningModeControl runningModeControl,
                         ManagedAuditLogger auditLogger,
                         JmxAuthorizer authorizer)

ExtensionRegistry

@Deprecated
public ExtensionRegistry(ProcessType processType,
                                     RunningModeControl runningModeControl)

Deprecated. Here for core-model-test and subsystem-test backwards compatibility

Constructor

Parameters:

processType -

runningModeControl -

Method Detail

getProcessType

public ProcessType getProcessType()

Gets the type of the current process.

Returns:

the current ProcessType.

setWriterRegistry

public void setWriterRegistry(SubsystemXmlWriterRegistry writerRegistry)

Sets the SubsystemXmlWriterRegistry to use for storing subsystem marshallers.

Parameters:

writerRegistry - the writer registry

setPathManager

public void setPathManager(PathManager pathManager)

Sets the PathManager to provide via the ExtensionContext.

Parameters:

pathManager - the path manager

setSubsystemParentResourceRegistrations

public void setSubsystemParentResourceRegistrations(ManagementResourceRegistration profileResourceRegistration,
                                                    ManagementResourceRegistration deploymentsResourceRegistration)

Sets the ManagementResourceRegistrations for the resource under which subsystem child resources should be registered.

Parameters:

profileResourceRegistration - the ManagementResourceRegistration for the resource under which subsystem child resources should be registered. Cannot be null

deploymentsResourceRegistration - the ManagementResourceRegistration for the deployments resource. May be null if deployment resources are not supported

getProfileRegistration

public ManagementResourceRegistration getProfileRegistration()

getSubsystemInfo

public SubsystemInformation getSubsystemInfo(String name)

getExtensionModuleNames

public Set<String> getExtensionModuleNames()

Gets the module names of all known Extensions.

Returns:

the names. Will not return null

getAvailableSubsystems

public Map<String,SubsystemInformation> getAvailableSubsystems(String moduleName)

Gets information about the subsystems provided by a given Extension.

Parameters:

moduleName - the name of the extension's module. Cannot be null

Returns:

map of subsystem names to information about the subsystem.

getExtensionParsingContext

public ExtensionParsingContext getExtensionParsingContext(String moduleName,
                                                          org.jboss.staxmapper.XMLMapper xmlMapper)

Gets an ExtensionParsingContext for use when initializing the extension's parsers.

Parameters:

moduleName - the name of the extension's module. Cannot be null

xmlMapper - the XMLMapper handling the extension parsing. Can be null if there won't be any actual parsing (e.g. in a slave Host Controller or in a server in a managed domain)

Returns:

the ExtensionParsingContext. Will not return null

getExtensionContext

public ExtensionContext getExtensionContext(String moduleName,
                                            boolean isMasterDomainController)

Gets an ExtensionContext for use when handling an add operation for a resource representing an Extension.

Parameters:

moduleName - the name of the extension's module. Cannot be null

isMasterDomainController - set to true if we are the master domain controller, in which case transformers get registered

Returns:

the ExtensionContext. Will not return null

Throws:

IllegalStateException - if no setSubsystemParentResourceRegistrations(ManagementResourceRegistration, ManagementResourceRegistration) profile resource registration has been set}

getExtensionContext

@Deprecated
public ExtensionContext getExtensionContext(String moduleName)

Deprecated. Use getExtensionContext(String, boolean)

Calls #getExtensionContext(String, boolean) with {@code true} for the {@code isMasterDomainControllerAttribute}

Parameters:

moduleName - the name of the extension's module. Cannot be null

Returns:

the ExtensionContext. Will not return null

getUnnamedNamespaces

public Set<String> getUnnamedNamespaces(String moduleName)

Gets the URIs (in string form) of any XML namespaces registered by an extension without an accompanying subsystem name that could not be clearly associated with a single subsystem. If an extension registers namespaces with no subsystem names but only has a single subsystem, the namespace can be clearly associated with that single subsystem and will not appear as part of the result of this method.

Parameters:

moduleName - the name of the extension's module. Cannot be null

Returns:

the namespace URIs, or an empty set if there are none. Will not return null

getProfileParsingCompletionHandlers

public Set<ProfileParsingCompletionHandler> getProfileParsingCompletionHandlers()

removeExtension

public void removeExtension(Resource rootResource,
                            String moduleName)
                     throws IllegalStateException

Cleans up a module's subsystems from the resource registration model.

Parameters:

rootResource - the model root resource

moduleName - the name of the extension's module. Cannot be null

Throws:

IllegalStateException - if the extension still has subsystems present in rootResource or its children

clear

public void clear()

Clears the registry to prepare for re-registration (e.g. as part of a reload).

recordSubsystemVersions

public void recordSubsystemVersions(String moduleName,
                                    org.jboss.dmr.ModelNode subsystems)

Records the versions of the subsystems associated with the given moduleName as properties in the provided ModelNode. Each subsystem property key will be the subsystem name and the value will be a string composed of the subsystem major version dot appended to its minor version.

Parameters:

moduleName - the name of the extension module

subsystems - a model node of type ModelType.UNDEFINED or type ModelType.OBJECT

getTransformerRegistry

public TransformerRegistry getTransformerRegistry()