This mechanism is only used for artifacts like implementations of (
can not be deactivated with standard CDI mechanisms.
This interface is just a marker interface which is implemented by all pre-configured DeltaSpike artifacts which can be deactivated manually (e.g. to improve the performance if a part isis not needed, to provide a custom implementation if the default implementation isis not pluggable by default or to bypass an implementation which causes an issue (in this case please also contact us and we will fix it)).
To deactivate a class it is required to implement
ClassDeactivator. Returning 'false' or 'true' allows to
de-/activate the class in question. Retuning null means that the current class-deactivator does not have
information about the class in question and can not provide a result. Since
ClassDeactivator implementations are
configured with the low-level configuration of DeltaSpike, the class-deactivator with the highest ordinal has the final decision. DeltaSpike itself does not deactivate an implementation, however, an add-on or a third-party portable CDI extension based on DeltaSpike (Core+) can use the concept to deactivate a default implementation of DeltaSpike in favour of its own implementation.
Due to the ordinal feature of the low-level configuration approach it is possible that a class-deactivator with a higher ordinal, for example used in a concrete project, can re-activate a deactivated implementation.
Please note that you might have to deactivate the parts of the add-on or third-party CDI extension which relies on its own implementation. Therefore, you should be really careful with re-activation.) The implementation should be stateless because the result will be cached and
as soon as everything is initialized the class-deactivators will not be used any longer.
A class-deactivator allows to specify deactivated classes.
public class CustomClassDeactivator implements ClassDeactivator
public Boolean isActivated(Class<? extends Deactivatable> targetClass)
A class-deactivator will be resolved from the environment via the default resolvers or via a custom resolver which allows to use any type of configuration-format. (see
org.apache.deltaspike.core.api.config.ConfigResolver). The key is the fully qualified name of the interface (
Starting with (TBD v1.5.1), Apache DeltaSpike ships a default Class Deactivator. It is designed mostly for testing purposes, but is meant to reduce code overhead
and allow configuration to drive classes to deactivate. It is built upon the
ConfigSource paradigm, which allows for configuration based keys to deactivate your
classes. If you’re not using any other ConfigSource, you can simply add entries to
META-INF/apache-deltaspike.properties to disable classes at runtime. Here’s an
By listing the class in the properties file and setting the value to
true, the class will be deactivated. This is valid for anything where
Boolean.valueOf returns true.