org.jboss.as.controller

Interface ExtensionContext

public interface ExtensionContext

The context for registering a new extension.

Author:

David M. Lloyd, David Bosschaert, Brian Stansberry (c) 2011 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExtensionContext.ContextType The various types of contexts in which an Extension can be asked to initialize.

Method Summary

Modifier and Type	Method and Description
PathManager	getPathManager() Gets the process' PathManager if the process is a server; throws an IllegalStateException if not.
ProcessType	getProcessType() Gets the type of the current process.
RunningMode	getRunningMode() Gets the current running mode of the process.
ExtensionContext.ContextType	getType() Gets the type of this context.
boolean	isRegisterTransformers() Deprecated. Use ExtensionTransformerRegistration
boolean	isRuntimeOnlyRegistrationValid() Gets whether it is valid for the extension to register resources, attributes or operations that do not involve the persistent configuration, but rather only involve runtime services.
SubsystemRegistration	registerSubsystem(String name, int majorVersion, int minorVersion) Deprecated. registerSubsystem(String, ModelVersion)
SubsystemRegistration	registerSubsystem(String name, int majorVersion, int minorVersion, int microVersion) Deprecated. registerSubsystem(String, ModelVersion)
SubsystemRegistration	registerSubsystem(String name, int majorVersion, int minorVersion, int microVersion, boolean deprecated) Deprecated. registerSubsystem(String, ModelVersion, boolean)
SubsystemRegistration	registerSubsystem(String name, ModelVersion version) Convenience variant of registerSubsystem(String, int, int, int) that uses 0 as the microVersion.
SubsystemRegistration	registerSubsystem(String name, ModelVersion version, boolean deprecated) Register a new subsystem type.

Method Detail

registerSubsystem

SubsystemRegistration registerSubsystem(String name,
                                        ModelVersion version)

Convenience variant of registerSubsystem(String, int, int, int) that uses 0 as the microVersion.

Parameters:

name - the name of the subsystem

version - the version of the subsystem's management interface.

Returns:

the SubsystemRegistration

Throws:

IllegalStateException - if the subsystem name has already been registered

registerSubsystem

SubsystemRegistration registerSubsystem(String name,
                                        ModelVersion version,
                                        boolean deprecated)

Register a new subsystem type. The returned registration object should be used to configure XML parsers, operation handlers, and other subsystem-specific constructs for the new subsystem. If the subsystem registration is deemed invalid by the time the extension registration is complete, the subsystem registration will be ignored, and an error message will be logged.

The new subsystem registration must register a handler and description for the add operation at its root address. The new subsystem registration must register a remove operation at its root address.

Parameters:

name - the name of the subsystem

version - the version of the subsystem's management interface.

deprecated - mark this extension as deprecated

Returns:

the SubsystemRegistration

Throws:

IllegalStateException - if the subsystem name has already been registered

registerSubsystem

@Deprecated
SubsystemRegistration registerSubsystem(String name,
                                                    int majorVersion,
                                                    int minorVersion)

Deprecated. registerSubsystem(String, ModelVersion)

Convenience variant of registerSubsystem(String, int, int, int) that uses 0 as the microVersion.

Parameters:

name - the name of the subsystem

majorVersion - the major version of the subsystem's management interface

minorVersion - the minor version of the subsystem's management interface

Returns:

the SubsystemRegistration

Throws:

IllegalStateException - if the subsystem name has already been registered

registerSubsystem

@Deprecated
SubsystemRegistration registerSubsystem(String name,
                                                    int majorVersion,
                                                    int minorVersion,
                                                    int microVersion)

Deprecated. registerSubsystem(String, ModelVersion)

Register a new subsystem type. The returned registration object should be used to configure XML parsers, operation handlers, and other subsystem-specific constructs for the new subsystem. If the subsystem registration is deemed invalid by the time the extension registration is complete, the subsystem registration will be ignored, and an error message will be logged.

The new subsystem registration must register a handler and description for the add operation at its root address. The new subsystem registration must register a remove operation at its root address.

Parameters:

name - the name of the subsystem

majorVersion - the major version of the subsystem's management interface

minorVersion - the minor version of the subsystem's management interface

microVersion - the micro version of the subsystem's management interface

Returns:

the SubsystemRegistration

Throws:

IllegalStateException - if the subsystem name has already been registered

registerSubsystem

@Deprecated
SubsystemRegistration registerSubsystem(String name,
                                                    int majorVersion,
                                                    int minorVersion,
                                                    int microVersion,
                                                    boolean deprecated)

Deprecated. registerSubsystem(String, ModelVersion, boolean)

Register a new subsystem type. The returned registration object should be used to configure XML parsers, operation handlers, and other subsystem-specific constructs for the new subsystem. If the subsystem registration is deemed invalid by the time the extension registration is complete, the subsystem registration will be ignored, and an error message will be logged.

The new subsystem registration must register a handler and description for the add operation at its root address. The new subsystem registration must register a remove operation at its root address.

Parameters:

name - the name of the subsystem

majorVersion - the major version of the subsystem's management interface

minorVersion - the minor version of the subsystem's management interface

microVersion - the micro version of the subsystem's management interface

deprecated - mark this extension as deprecated

Returns:

the SubsystemRegistration

Throws:

IllegalStateException - if the subsystem name has already been registered

getType

ExtensionContext.ContextType getType()

Gets the type of this context.

Returns:

the context type. Will not be null

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

isRuntimeOnlyRegistrationValid

boolean isRuntimeOnlyRegistrationValid()

Gets whether it is valid for the extension to register resources, attributes or operations that do not involve the persistent configuration, but rather only involve runtime services. Extensions should use this method before registering such "runtime only" resources, attributes or operations. This method is intended to avoid registering resources, attributes or operations on process types that can not install runtime services.

Returns:

whether it is valid to register runtime resources, attributes, or operations.

getPathManager

PathManager getPathManager()

Gets the process' PathManager if the process is a server; throws an IllegalStateException if not.

Returns:

the path manager. Will not return null

Throws:

IllegalStateException - if the process is not a server

isRegisterTransformers

@Deprecated
boolean isRegisterTransformers()

Deprecated. Use ExtensionTransformerRegistration

Returns true if subsystems should register transformers. This is true if #getProcessType().isHostController() is true and the process controller is the master domain controller.

Returns:

true if transformers should be registered