public interface Feature
A Feature
is a special type of configuration meta-provider. Once a feature is registered,
its configure(FeatureContext)
method is invoked during runtime configuration and bootstrapping
phase allowing the feature to further configure the runtime context in which it has been registered.
From within the invoked configure(...)
method a feature may provide additional runtime configuration
for the facility or conceptual domain it represents, such as registering additional contract providers,
including nested features and/or specifying domain-specific properties.
Features implementing this interface MAY be annotated with the @Provider
annotation in order to be discovered by the runtime when scanning for resources and providers.
Please note that this will only work for server side features. Features in the Client API must
be registered programmatically.
Modifier and Type | Method and Description |
---|---|
boolean |
configure(FeatureContext context)
A call-back method called when the feature is to be enabled in a given
runtime configuration scope.
|
boolean configure(FeatureContext context)
true
if the feature was successfully enabled or false
otherwise.
Note that under some circumstances the feature may decide not to enable itself, which
is indicated by returning false
. In such case the configuration context does
not add the feature to the collection of enabled features and a subsequent call to
Configuration.isEnabled(Feature)
or Configuration.isEnabled(Class)
method
would return false
.
context
- configurable context in which the feature should be enabled.true
if the feature was successfully enabled, false
otherwise.Copyright © 2021 JBoss by Red Hat. All rights reserved.