Package org.jboss.as.controller
-
Interface Summary Interface Description AbstractControllerService.ControllerInstabilityListener Listener for notifications that theModelController
is unstable and a process restart is necessary.AbstractControllerService.PartialModelIndicator Tracks whether the controller is working with a complete model or just a partial one.AttributeMarshallers AttributeParsers BlockingTimeout Encapsulates information about how long management operation execution should block before timing out.BootContext Context used to boot a controller service.Cancellable A handle for a specific cancellable running operation.CapabilityReferenceRecorder Records information about capability reference information encoded in an attribute's value.CapabilityServiceBuilder<T> A builder for an individual service in aCapabilityServiceTarget
.CapabilityServiceTarget The target of ServiceBuilder for capability installations.ConfigurationChangesCollector Collects configuration changes.ExpressionResolver ResolvesModelType.EXPRESSION
expressions in aModelNode
.Extension An extension to the JBoss Application Server.ExtensionContext The context for registering a new extension.Feature FeatureFilter A filter for features.FeatureRegistry Implemented by objects that register features.LocalModelControllerClient AModelControllerClient
subinterface that does not throwIOException
.ManagementModel Encapsulates the elements of a management model.ModelController Controls reads of and modifications to a management model.ModelController.OperationTransaction An operation transaction.ModelController.OperationTransactionControl A callback interface for the operation's completion status.ModelControllerClientFactory Factory for obtaining aModelControllerClient
for use in the same VM as the targetModelController
.ModelControllerServiceInitialization Internal extension point for core resource registrations.ModelVersionRange NotificationDefinition.DataValueDescriptor OperationClientException Marker interface for an Exception indicating a management operation has failed due to a client mistake (e.g.OperationContext The context for an operation step execution.OperationContext.ResultHandler Handler for a callback to anOperationStepHandler
indicating that the result of the overall operation is known and the handler can take any necessary actions to deal with that result.OperationContext.RollbackHandler Handler for a callback to anOperationStepHandler
indicating that the overall operation is being rolled back and the handler should revert any change it has made.OperationDescriptor Deprecated, for removal: This API element is subject to removal in a future version. To be removed without replacement.OperationStepHandler Handler for an individual step in the overall execution of a management operation.ParameterCorrector An implementation of this interface will be invoked before a new attribute value is set, so it has a chance to adjust the new value, if and as necessary, e.g.PersistentResourceXMLDescription.AdditionalOperationsGenerator Some resources require more operations that just a simple add.PersistentResourceXMLDescription.Builder Builds aPersistentResourceXMLDescription
.PersistentResourceXMLDescription.Factory Factory for creating aPersistentResourceXMLDescription
builder.PersistentSubsystemSchema<S extends PersistentSubsystemSchema<S>> Defines a versioned schema for a subsystem defined via aPersistentResourceXMLDescription
.ProcessStateNotifier Allows callers to check the currentControlledProcessState.State
of the process and to register for notifications of state changes.ProxyController A proxy controller to be registered with a ModelController.ProxyController.ProxyOperationControl ProxyOperationAddressTranslator Used byProxyController
implementations to translate addresses to the target controller's address space.RequirementServiceBuilder<T> AServiceBuilder
that supports capability requirements.RequirementServiceTarget ServiceTarget
whose builders support capability requirements.ResourceBuilder ResourceDefinition Provides essential information defining a management resource.ResourceDefinition.Builder Builder of a minimalResourceDefinition
.ResourceDefinition.Configurator<C extends ResourceDefinition.Configurator<C>> Configures the basic characteristics of aResourceDefinition
.ResourceMarshaller ResourceParser ResourceRegistration Describes the registration of a resource.SubsystemModel Defines a subsystem management model.SubsystemRegistration A subsystem registration.SubsystemSchema<S extends SubsystemSchema<S>> Defines a versioned schema for a subsystem.TransformingProxyController AProxyController
with transformation capabilities. -
Class Summary Class Description AbstractAddStepHandler Base class forOperationStepHandler
implementations that add managed resource.AbstractAddStepHandler.Parameters Deprecated, for removal: This API element is subject to removal in a future version. Use default constructor instead.AbstractAttributeDefinitionBuilder<BUILDER extends AbstractAttributeDefinitionBuilder<BUILDER,ATTRIBUTE>,ATTRIBUTE extends AttributeDefinition> Provides a builder API for creating anAttributeDefinition
.AbstractBoottimeAddStepHandler Base class forOperationStepHandler
implementations that add managed resources and also perform runtime processing that should only occur during server boot.AbstractControllerService A base class for controller services.AbstractControllerService.ModelControllerServiceInitializationParams Parameters for initializingModelControllerServiceInitialization
instancesAbstractModelUpdateHandler Base class forOperationStepHandler
implementations for updating an existing managed resource.AbstractRemoveStepHandler Base class for handlers that remove resources.AbstractRuntimeOnlyHandler Base class for operations that do nothing inOperationContext.Stage.MODEL
except register aOperationContext.Stage.RUNTIME
step.AbstractWriteAttributeHandler<T> Abstract handler for the write aspect of aread-write attribute
.AbstractWriteAttributeHandler.HandbackHolder<T> Holder subclasses can use to pass an object betweenAbstractWriteAttributeHandler.applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder)
andAbstractWriteAttributeHandler.revertUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, Object)
.AccessAuditContext The context used to store state related to access control and auditing for the current invocation.AttributeDefinition Defining characteristics of an attribute in aResource
or a parameter or reply value type field in anOperationDefinition
, with utility methods for validation.AttributeDefinition.NameAndGroup SimpleComparable
that encapsulates the name of an attribute and any attribute group, ordering first one group (null group first) and then one attribute name.AttributeMarshaller AttributeMarshaller.AttributeElementMarshaller Version of marshaller that by default marshalls to elementAttributeMarshallers.MapAttributeMarshaller AttributeMarshallers.NamedStringListMarshaller AttributeMarshallers.ObjectMapAttributeMarshaller AttributeMarshallers.PropertiesAttributeMarshaller AttributeMarshallers.SimpleListAttributeMarshaller AttributeParser AttributeParser.DiscardOldDefaultValueParser AttributeParsers.AttributeElementParser AttributeParsers.MapParser AttributeParsers.NamedStringListParser AttributeParsers.ObjectMapParser AttributeParsers.ObjectParser AttributeParsers.PropertiesParser AttributeParsers.UnWrappedObjectListParser AttributeParsers.WrappedObjectListParser BlockingTimeout.Factory BootErrorCollector Collects boot errors.BootErrorCollector.ListBootErrorsHandler CapabilityReferenceRecorder.CompositeAttributeDependencyRecorder CapabilityReferenceRecorder
that determines the dependent capability from theOperationContext
and any additional attributes on same resource.CapabilityReferenceRecorder.ContextDependencyRecorder CapabilityReferenceRecorder
that determines the dependent capability from theOperationContext
.CapabilityReferenceRecorder.DefaultCapabilityReferenceRecorder Default implementation ofCapabilityReferenceRecorder
.CapabilityReferenceRecorder.ResourceCapabilityReferenceRecorder CapabilityReferenceRecorder
that determines the dependent and required capability from thePathAddress
of the resource registration.CapabilityRegistry Registry ofcapabilities
available in the system.CaseParameterCorrector Parameter correctors that can be used to change the case of amodel node
that is oftype string
.CompositeOperationHandler Handler for the "composite" operation; i.e.ConfigurationChangesCollector.ConfigurationChange ConfigurationChangesCollector.ConfigurationChangesCollectorImpl ControlledProcessState The overall state of a process that is being managed by aModelController
.ControlledProcessStateService Exposes the currentControlledProcessState.State
and allows services to register a listener for changes to it.CurrentOperationIdHolder Deprecated. internal usage onlyDefaultAttributeMarshaller DelegatingResourceDefinition DeprecationData Encapsulates information about the deprecation of a management resource, attribute or operation.EnvVarAttributeOverrider Utility class to override the value of an attribute by setting an env var corresponding to the address of the resource and the name of the attribute to override.ExpressionResolverImpl BasicExpressionResolver
implementation.HashUtil Utilities related to deployment content hashes.ListAttributeDefinition Defining characteristics of anModelType.LIST
attribute in aResource
, with utility methods for conversion to and from xml and for validation.ListAttributeDefinition.Builder<BUILDER extends ListAttributeDefinition.Builder<BUILDER,ATTRIBUTE>,ATTRIBUTE extends ListAttributeDefinition> MapAttributeDefinition Defining characteristics of anModelType.OBJECT
attribute in aResource
, where all children of the object have values of the same type; i.e.MapAttributeDefinition.Builder<BUILDER extends MapAttributeDefinition.Builder<BUILDER,ATTRIBUTE>,ATTRIBUTE extends MapAttributeDefinition> ModelOnlyAddStepHandler A handler for theadd
operation that only manipulates the model.ModelOnlyRemoveStepHandler A handler for theremove
operation that only manipulates the model.ModelOnlyResourceDefinition ResourceDefinition
implementation designed for use in extensions based onAbstractLegacyExtension
.ModelOnlyWriteAttributeHandler Awrite-attribute
handler that simply validates the attribute value and stores it in the model.ModelVersion ModelVersionRange.Versions NoopOperationStepHandler A handler that simply callsOperationContext.completeStep(OperationContext.RollbackHandler)
with ano-op rollback handler
.NotificationDefinition Defining characteristics of notification in aResource
NotificationDefinition.Builder ObjectListAttributeDefinition AttributeDefinition suitable for managing LISTs of OBJECTs, which takes into account recursive processing of allowed values and their value types.ObjectListAttributeDefinition.Builder ObjectMapAttributeDefinition MapAttributeDefinition
for maps with keys ofModelType.STRING
and values of typeObjectTypeAttributeDefinition
ObjectMapAttributeDefinition.Builder ObjectTypeAttributeDefinition AttributeDefinition
for attributes of typeModelType.OBJECT
that aren't simple maps, but rather a set fixed keys where each key may be associated with a value of a different type.ObjectTypeAttributeDefinition.Builder OperationContext.AttachmentKey<T> An attachment key instance.OperationDefinition Defining characteristics of operation in aResource
ParallelBootOperationStepHandler Special handler that executes subsystem boot operations in parallel.ParsedBootOp Encapsulates information about a boot operation for use during boot execution.PathAddress A path address for an operation.PathElement An element of a path specification for matching operations with addresses.PersistentResourceDefinition A persistent resource definition.PersistentResourceXMLDescription A representation of a resource as needed by the XML parser.PersistentResourceXMLDescription.PersistentResourceXMLBuilder PersistentResourceXMLDescriptionReader AnXMLElementReader
based on aPersistentResourceXMLDescription
.PersistentResourceXMLDescriptionWriter AnXMLElementWriter
based on aPersistentResourceXMLDescription
.PersistentResourceXMLParser PrimitiveListAttributeDefinition Date: 13.10.2011PrimitiveListAttributeDefinition.Builder PropagatingCorrector This implementation propagates properties present in the current attribute value but missing from the new value.PropertiesAttributeDefinition Represents simple key=value map equivalent of java.util.Map() PropertiesAttributeDefinition.Builder ProxyStepHandler Step handler that uses a proxiedModelController
to execute the step.ReadResourceNameOperationStepHandler OperationStepHandler
that reads the address of the operation and returns the value of its last element as the operation result.ReloadRequiredAddStepHandler An handler for an 'add' operation that does nothing in theruntime stage
but put the process in reload-required state.ReloadRequiredRemoveStepHandler A handler for the "remove" operation that always puts the process in "reload-required" state.ReloadRequiredWriteAttributeHandler SimpleAbstractWriteAttributeHandler
that triggers putting the process in a restart-required state if attribute that has flagAttributeAccess.Flag.RESTART_JVM
otherwise it puts process in reload-required state.ResourceBuilder.Factory ResourceDefinition.AbstractConfigurator<C extends ResourceDefinition.Configurator<C>> Configures the basic characteristics of aResourceDefinition
.ResourceDefinition.MinimalBuilder Minimal builder of aResourceDefinition
.ResourceDefinition.MinimalResourceDefinition A minimalResourceDefinition
implementation whose internal registration will be performed separately.RestartParentResourceAddHandler Simple add handler which, if allowed, restarts a parent resource when the child is added.RestartParentResourceHandlerBase Simple remove handler that, if allowed, restarts a parent resource when a child is removed.RestartParentResourceRemoveHandler Simple remove handler that, if allowed, restarts a parent resource when a child is removed.RestartParentWriteAttributeHandler SimpleAbstractWriteAttributeHandler
that, if allowed, restarts a parent resource when a change is made.RunningModeControl Provides control over the server's currentRunningMode
.ServiceNameFactory Provides a factory for creatingServiceName
instances from dot-separated strings while trying to mitigate the memory overhead of having multiple copies of elements of the name that have the samesimple name
.ServiceRemoveStepHandler Abstract remove step handler that simply removes a service.SimpleAttributeDefinition Defining characteristics of an attribute in aResource
or a parameter or reply value type field in anOperationDefinition
, with utility methods for conversion to and from xml and for validation.SimpleAttributeDefinitionBuilder Provides a builder API for creating aSimpleAttributeDefinition
.SimpleListAttributeDefinition AttributeDefinition
for attributes that represent lists with simple element types (i.e.SimpleListAttributeDefinition.Builder SimpleMapAttributeDefinition MapAttributeDefinition
for maps with keys ofModelType.STRING
and values of type ModelTypeSimpleMapAttributeDefinition.Builder SimpleOperationDefinition Defining characteristics of operation in aResource
SimpleOperationDefinition is simplest implementation that usesDefaultOperationDescriptionProvider
for generating description of operation if more complex DescriptionProvider user should extend this class orOperationDefinition
and provide its ownDescriptionProvider
SimpleOperationDefinitionBuilder Builder for helping constructSimpleOperationDefinition
SimpleResourceDefinition Basic implementation ofResourceDefinition
.SimpleResourceDefinition.Parameters Parameters object for the SimpleResourceDefinition constructorStringListAttributeDefinition StringListAttributeDefinition.Builder TransformingProxyController.Factory Factory methods for creating aTransformingProxyController
UninterruptibleCountDownLatch Enhanced CountDownLatch providing uninterruptible variants of await() methods. -
Enum Summary Enum Description ControlledProcessState.State ExtensionContext.ContextType The various types of contexts in which anExtension
can be asked to initialize.OperationContext.ExecutionStatus The current activity of an operation.OperationContext.ResultAction The result action.OperationContext.Stage The stage at which a step should apply.ProcessType Holds the possible process types.RunningMode The current running mode of the server. -
Exception Summary Exception Description ExpressionResolver.ExpressionResolutionServerException Runtime exception used to indicate a failure in someresolver extension execution
not due to problems with user input like the expression string being resolved or the configuration of resources backing the resolver extension.ExpressionResolver.ExpressionResolutionUserException Runtime exception used to indicate some user-driven problem that prevented expression resolution, for example: A flaw in a user provided expression string that results in aExpressionResolverExtension
not being able to resolve the expression.OperationFailedException Exception indicating an operation has failed due to a client mistake (e.g.UnauthorizedException OperationFailedRuntimeException
thrown when an operation is not authorized.