org.jboss.weld.config.ConfigurationKey Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2014, Red Hat, Inc., and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jboss.weld.config;
import org.jboss.weld.bean.proxy.ProxyInstantiator;
/**
* This enum lists all the supported configuration keys.
*
* @author Martin Kouba
* @see WeldConfiguration
* @see SystemPropertiesConfiguration
*/
public enum ConfigurationKey {
/**
* Indicates whether ConcurrentDeployer and ConcurrentValidator should be enabled. If enabled, ConcurrentDeployer and ConcurrentValidator execute their
* subtasks using {@link org.jboss.weld.manager.api.ExecutorServices} which can be configured separately.
*
* Otherwise, single-threaded version of Deployer and Validator are used.
*
* By default, concurrent deployment is enabled.
*/
@Description("Indicates whether the concurrent deployment is enabled.")
CONCURRENT_DEPLOYMENT("org.jboss.weld.bootstrap.concurrentDeployment", true),
/**
* The number of threads used by ContainerLifecycleEventPreloader. The ContainerLifecycleEventPreloader allows observer methods for container lifecycle
* events to be resolved upfront while the deployment is waiting for classloader or reflection API.
*
* ContainerLifecycleEventPreloader has its own thread pool whose size is configured by this property.
*
* If set to 0, ContainerLifecycleEventPreloader is not installed.
*
* If not specified, the value is set to Math.max(1, Runtime.getRuntime().availableProcessors() - 1)).
*
*/
@Description("Weld is capable of resolving observer methods for container lifecycle events in advance while bean deployer threads are blocked waiting for I/O operations. This option specifies the number of threads used for preloading. If set to 0, preloading is disabled.")
PRELOADER_THREAD_POOL_SIZE("org.jboss.weld.bootstrap.preloaderThreadPoolSize", Math.max(1, Runtime.getRuntime().availableProcessors() - 1)),
/**
* Allows an integrator to enable the non-portable mode. Non-portable mode is suggested by the specification to overcome problems with legacy applications
* not using CDI SPI properly.
*
* The non-portable mode is disabled by default.
*/
@Description("Non-portable mode is suggested by the specification to overcome problems with legacy applications not using CDI SPI properly. The non-portable mode is disabled by default.")
NON_PORTABLE_MODE("org.jboss.weld.nonPortableMode", false),
/**
* The number of threads to be used for bean loading and deployment.
*/
@Description("The number of threads to be used by the Weld thread pool. Only used by FIXED and FIXED_TIMEOUT thread pool type.")
EXECUTOR_THREAD_POOL_SIZE("org.jboss.weld.executor.threadPoolSize", Runtime.getRuntime().availableProcessors()),
/**
* If set to true, debug timing information is printed to the standard output.
*/
@Description("If set to true, some more debug information is logged when the Weld thread pool is used.")
EXECUTOR_THREAD_POOL_DEBUG("org.jboss.weld.executor.threadPoolDebug", false),
/**
* The type of the thread pool. Possible values are: FIXED, FIXED_TIMEOUT, NONE, SINGLE_THREAD.
*/
@Description("The type of the Weld thread pool. Possible values are: FIXED - Uses a fixed number of threads. The number of threads remains the same throughout the application.FIXED_TIMEOUT - Uses a fixed number of threads. A thread will be stopped after a configured period of inactivity.NONE - No dedicated thread pool used.SINGLE_THREAD - A single-threaded thread pool.COMMON - The default ForkJoinPool.commonPool() is used.FIXED_TIMEOUT thread pool type.")
EXECUTOR_THREAD_POOL_KEEP_ALIVE_TIME("org.jboss.weld.executor.threadPoolKeepAliveTime", 60L),
/**
* Weld caches resolved injection points in order to resolve them faster in the future. There exists a separate type safe resolver for beans,
* decorators, disposers, interceptors and observers. Each of them stores resolved injection points in its cache, which maximum size is bounded by a default
* value (common to all of them).
*
* @see WELD-1323
*/
@Description("Weld caches already resolved injection points in order to resolve them faster in the future. There exists a separate type safe resolver for beans, decorators, disposers, interceptors and observers. Each of them stores resolved injection points in its cache, which maximum size is bounded by a common default value.")
RESOLUTION_CACHE_SIZE("org.jboss.weld.resolution.cacheSize", 0x10000L),
/**
* For debug purposes, it's possible to dump the generated bytecode of proxies and subclasses.
*/
@Description("For debugging purposes, it’s possible to dump the generated bytecode of client proxies and enhanced subclasses to the filesystem. The value represents the file path where the files should be stored.")
PROXY_DUMP("org.jboss.weld.proxy.dump", ""),
/**
* Weld supports a non-standard workaround to be able to create client proxies for Java types that cannot be proxied by the container, using non-portable
* JVM APIs.
*/
@Description("Weld supports a non-standard workaround to be able to create client proxies for Java types that cannot be proxied by the container, using non-portable JVM APIs.")
RELAXED_CONSTRUCTION("org.jboss.weld.construction.relaxed", false),
/**
* Allows {@link ProxyInstantiator} to be selected explicitly. This is only intended for testing purposes and should never be set by an application.
*/
PROXY_INSTANTIATOR("org.jboss.weld.proxy.instantiator", ""),
/**
* Weld supports a non-standard workaround to be able to create client proxies for Java types that cannot be proxied by the container, using non-portable
* JVM APIs.
*
* @deprecated this option is deprecated. RELAXED_CONSTRUCTION should be used instead
*/
@Description("This option is deprecated - org.jboss.weld.construction.relaxed should be used instead.")
PROXY_UNSAFE("org.jboss.weld.proxy.unsafe", false),
/**
* XML descriptor validation is enabled by default.
*/
@Description("XML descriptor validation is enabled by default.")
DISABLE_XML_VALIDATION("org.jboss.weld.xml.disableValidating", false),
/**
* For certain combinations of scopes, the container is permitted to optimize an injectable reference lookup. The optimization is disabled by default as it
* does not match the {@link javax.enterprise.context.spi.AlterableContext} contract.
*/
@Description("For certain combinations of scopes, the container is permitted to optimize an injectable reference lookup. The optimization is disabled by default.")
INJECTABLE_REFERENCE_OPTIMIZATION("org.jboss.weld.injection.injectableReferenceOptimization", false),
/**
* A regular expression. If a non-empty string and the base type for an AnnotatedType or a declaring type for an AnnotatedMember matches this pattern the
* type is excluded from monitoring, i.e. the invocation monitor interceptor is not associated.
*/
@Description("DEVELOPMENT MODE - a bean whose bean class is matching this regular expression is excluded from monitoring")
PROBE_INVOCATION_MONITOR_EXCLUDE_TYPE("org.jboss.weld.probe.invocationMonitor.excludeType", ""),
/**
* If set to true the JavaBean accessor methods are not monitored.
*/
@Description("DEVELOPMENT MODE - if set to true the JavaBean accessor methods are not monitored.")
PROBE_INVOCATION_MONITOR_SKIP_JAVABEAN_PROPERTIES("org.jboss.weld.probe.invocationMonitor.skipJavaBeanProperties", true),
/**
* A regular expression. If a non-empty string and the runtime class of the event object matches this pattern the event is excluded from monitoring.
*/
@Description("DEVELOPMENT MODE - an event class matching this regular expression is excluded from monitoring.")
PROBE_EVENT_MONITOR_EXCLUDE_TYPE("org.jboss.weld.probe.eventMonitor.excludeType", ""),
/**
* This optimization is used to reduce the HTTP session replication overhead. However, the inconsistency detection mechanism may cause problems in some
* development environments.
*/
@Description("This optimization is used to reduce the HTTP session replication overhead. However, the inconsistency detection mechanism may cause problems in some development environments.")
BEAN_IDENTIFIER_INDEX_OPTIMIZATION("org.jboss.weld.serialization.beanIdentifierIndexOptimization", true),
/**
* If set to true an informative HTML snippet will be added to every response with Content-Type of value text/html.
*/
@Description("DEVELOPMENT MODE - if set to true an informative HTML snippet will be added to every response with Content-Type of value text/html.")
PROBE_EMBED_INFO_SNIPPET("org.jboss.weld.probe.embedInfoSnippet", true),
/**
* If set to true the default name follows the rules from the original JavaBean specification. Otherwise (default, portable solution), the CDI specification requirements are met.
*
* @see https://issues.jboss.org/browse/WELD-1941
*/
@Description("If set to true the default name follows the rules from the original JavaBean specification. Otherwise (default, portable solution), the CDI specification requirements are met.")
DEFAULT_BEAN_NAMES_FOLLOW_JAVABEAN_RULES("org.jboss.weld.bean.defaultNamesFollowJavaBeanRules", false),
/**
* If set to true, the attributes should be fetched lazily from the backing store for some contexts (e.g. attributes of an HTTP session for a
* session context).
*/
@Description("If set to true, the attributes should be fetched lazily from the backing store for some contexts (e.g. attributes of an HTTP session for a session context).")
CONTEXT_ATTRIBUTES_LAZY_FETCH("org.jboss.weld.context.attributes.lazyFetch", true),
/**
* If set to true one or more MBean components may be registered so that it is possible to use JMX to access the Probe development tool data.
*/
@Description("DEVELOPMENT MODE - if set to true one or more MBean components may be registered so that it is possible to use JMX to access the Probe development tool data.")
PROBE_JMX_SUPPORT("org.jboss.weld.probe.jmxSupport", false),
/**
* If set to true all the container lifecycle events are monitored during bootstrap. Note that this feature has negative impact on the bootstrap performance.
*/
@Description("DEVELOPMENT MODE - if set to true all the container lifecycle events are monitored during bootstrap. Note that this feature has negative impact on the bootstrap performance.")
PROBE_EVENT_MONITOR_CONTAINER_LIFECYCLE_EVENTS("org.jboss.weld.probe.eventMonitor.containerLifecycleEvents", false),
/**
* A regular expression used to limit access to the Probe REST API. The default value attempts to match connections from localhost only, i.e. it's matching the
* following addresses:
*
* 127.0.0.1::1, incl. zone indices (e.g. ::1%0)0:0:0:0:0:0:0:1, incl. zone indices (e.g. 0:0:0:0:0:0:0:1%eth0)
*
* Note that this might not work properly for an application behind a reverse-proxy or a load balancer. In such case we assume the web container involves
* some technique of overridding the client IP address with a value from the request headers (e.g.
* io.undertow.server.handlers.ProxyPeerAddressHandler, org.apache.catalina.valves.RemoteIpValve, etc.).
*/
@Description("DEVELOPMENT MODE - a regular expression used to limit access to Probe REST API. Matches connections from localhost by default. Might not work properly for an application behind a reverse proxy or a load balancer.")
PROBE_ALLOW_REMOTE_ADDRESS("org.jboss.weld.probe.allowRemoteAddress", "127.0.0.1|::1|::1%.+|0:0:0:0:0:0:0:1|0:0:0:0:0:0:0:1%.+"),
/**
* Weld supports a non-standard workaround to be able to create proxies for Java types which declare non-private non-static final methods. These methods are
* completely ignored during proxy generation, and should never be invoked upon the proxy instance!
*
* A regular expression. If an unproxyable type matches this pattern, the type is considered proxyable and final methods are ignored.
*/
@Description("Weld supports a non-standard workaround to be able to create proxies for Java types which declare non-private non-static final methods. A regular expression. If an unproxyable type matches this pattern, the type is considered proxyable and final methods are ignored.")
PROXY_IGNORE_FINAL_METHODS("org.jboss.weld.proxy.ignoreFinalMethods", ""),
/**
* Conversation timeout in milliseconds. Default value is 600 000 ms.
*/
@Description("The maximum inactivity time of conversation in milliseconds.")
CONVERSATION_TIMEOUT("org.jboss.weld.conversation.timeout", 10 * 60 * 1000L),
/**
* Conversation concurrent access timeout in milliseconds represents maximum time to wait on the conversation concurrent lock. Default value is 1000 ms.
*/
@Description("The maximum time to wait on the lock of conversation in milliseconds.")
CONVERSATION_CONCURRENT_ACCESS_TIMEOUT("org.jboss.weld.conversation.concurrentAccessTimeout", 1000L),
/**
* This configuration property should only be used if experiencing problems with rolling upgrades.
*
* The delimiter is used to abbreviate a bean archive identifier (which is usually derived from the archive name) before used as a part of an identifier of
* an internal component (such as bean). Note that the delimiter is used for all bean archives forming the application.
*
* The abbreviation proceeds as follows:
*
* - Try to find the first occurrence of the specified delimiter
* - If not found, the identifier is not abbreviated
* - If found, try to extract the archive suffix (`.war`, `.ear`, etc.) and the final value consists of the part before the delimiter and the archive
* suffix (if extracted)
*
*
* An example: Given an application with two versions going by the names test__1.1.war and test__1.2.war. Weld normally cannot
* support replication of @SessionScoped beans between these two deployments. Passing in this option with delimiter "__" will allow Weld to see
* both applications simply as test.war, hence allowing for session replication.
*/
@Description("The delimiter is used to abbreviate a bean archive identifier before used as a part of an identifier of an internal component (such as bean).")
ROLLING_UPGRADES_ID_DELIMITER("org.jboss.weld.clustering.rollingUpgradesIdDelimiter", ""),
/**
* A regular expression. If a non-empty string, then all annotated types whose {@code javax.enterprise.inject.spi.AnnotatedType#getJavaClass().getName()} matches this pattern are vetoed if not annotated with a bean defining annotation.
*/
@Description("A regular expression. If a non-empty string, then all annotated types whose javax.enterprise.inject.spi.AnnotatedType#getJavaClass().getName() matches this pattern are vetoed if not annotated with a bean defining annotation.")
VETO_TYPES_WITHOUT_BEAN_DEFINING_ANNOTATION("org.jboss.weld.bootstrap.vetoTypesWithoutBeanDefiningAnnotation", ""),
/**
* If a non-empty string and development mode is enabled, the Probe data will be automatically exported after deployment validation. The value represents a path of the directory where to export the data file.
*/
@Description("If a non-empty string and development mode is enabled, the Probe data will be automatically exported after deployment validation. The value represents a path of the directory where to export the data file.")
PROBE_EXPORT_DATA_AFTER_DEPLOYMENT("org.jboss.weld.probe.exportDataAfterDeployment", ""),
/**
* If true an alternative defined in beans.xml can be vetoed. If false, vetoing an alternative defined in beans.xml will cause an exception to be thrown.
*
* By default, alternatives defined in beans.xml must not be vetoed.
*/
@Description("Allows the alternatives defined in beans.xml to be vetoed.")
ALLOW_VETOED_ALTERNATIVES("org.jboss.weld.bootstrap.allowExcludedAlternatives", false),
;
/**
*
* @param key The string representation of the key
* @param defaultValue The default value
*/
ConfigurationKey(String key, Object defaultValue) {
this.key = key;
// Fail fast if a new key with unsupported value type is introduced
if (!isValueTypeSupported(defaultValue.getClass())) {
throw new IllegalArgumentException("Unsupported value type: " + defaultValue);
}
this.defaultValue = defaultValue;
}
private final String key;
private final Object defaultValue;
/**
* @return the string representation of the key
*/
public String get() {
return key;
}
/**
* @return the default value
*/
public Object getDefaultValue() {
return defaultValue;
}
/**
*
* @param value
* @return true if the given value corresponds to the type of the default value, false otherwise
*/
public boolean isValidValue(Object value) {
return isValidValueType(value.getClass());
}
/**
*
* @param valueType
* @return true if the given value type corresponds to the type of the default value, false otherwise
*/
public boolean isValidValueType(Class valueType) {
return defaultValue.getClass().isAssignableFrom(valueType);
}
/**
*
* @param value
* @return the converted value
*/
public Object convertValue(String value) {
if (defaultValue instanceof Boolean) {
return Boolean.valueOf(value);
} else if (defaultValue instanceof Long) {
return Long.valueOf(value);
} else if (defaultValue instanceof Integer) {
return Integer.valueOf(value);
} else {
return value.toString();
}
}
/**
*
* @param valueType
* @return true if the given value type is supported, false otherwise
*/
public static boolean isValueTypeSupported(Class valueType) {
return valueType.equals(String.class) || valueType.equals(Boolean.class) || valueType.equals(Integer.class) || valueType.equals(Long.class);
}
/**
*
* @param from
* @return the key with the given value, or null if no such exists
*/
public static ConfigurationKey fromString(String from) {
for (ConfigurationKey key : values()) {
if (key.get().equals(from)) {
return key;
}
}
return null;
}
}