svn commit: r1734828 - /openwebbeans/cms-site/trunk/content/owbconfig.mdtext

[st...@apache.org]

Author: struberg
Date: Sun Mar 13 17:32:11 2016
New Revision: 1734828

URL: http://svn.apache.org/viewvc?rev=1734828&view=rev
Log:
document OWB configuration

Modified:
    openwebbeans/cms-site/trunk/content/owbconfig.mdtext

Modified: openwebbeans/cms-site/trunk/content/owbconfig.mdtext
URL: http://svn.apache.org/viewvc/openwebbeans/cms-site/trunk/content/owbconfig.mdtext?rev=1734828&r1=1734827&r2=1734828&view=diff
==============================================================================
--- openwebbeans/cms-site/trunk/content/owbconfig.mdtext (original)
+++ openwebbeans/cms-site/trunk/content/owbconfig.mdtext Sun Mar 13 17:32:11 2016
@@ -22,8 +22,75 @@ Internal configuration of OpenWebBeans c
 All those files contain at single property ``configuration.ordinal`` which defines their 
 'importance'. Any setting from a property file with a higher configuration.ordinal will 
 overwrite settings from one with a lower configuration.ordinal. The internally used 
-configuration.ordinal values range from 1 to 100.
+configuration.ordinal values range from 1 to 100. The default value is 100.
 
+This trick allows us to split OpenWebBeans in different modules which automatically change the container
+configuration if you put that jar on the classpath.
+
+For overriding the default configuration with own settings simply put a ``META-INF/openwebbeans/openwebbeans.properties``
+file into your projects classpath (e.g. into a jar) and either use a ``configuration.ordinal`` higher than 100 or leave
+it empty to get the default value of 100.
+
+If you use OpenWebBeans as part of another project then you can assume that most of the values got tweaked
+by the integration regarding to the specific needs.
+
+
+## Configure SPI implementations
+
+OpenWebBeans provide a set of Service Provider Interfaces and multiple different implementations a user can choose from.
+
+You can choose the implementations you like to use for your situation by configuring them in
+``META-INF/openwebbeans/openwebbeans.properties``.
+
+Read more about our SPIs in [OpenWebBeans SPI](openwebbeans-spi.html)
+
+
+## Other Configurable Values
+
+The following configuration values can get tweaked to get tailor OWB to your specific needs.
+
+Boolean values can either be <code>true</code>, or <code>TRUE</code>, or <code>false</code>, or <code>FALSE</code>.
+
+<table>
+    <tr>
+        <th>Config Key</th>
+        <th>Description</th>
+        <th>Default and sample value</th>
+    </tr>
+    <tr>
+        <td><code>org.apache.webbeans.forceNoCheckedExceptions<code></td>
+        <td>
+             Lifycycle methods like <code>javax.annotation.PostConstruct</code> and
+             <code>javax.annotation.PreDestroy</code> must not define a checked Exception
+             regarding to the spec. But this is often unnecessary restrictive so we
+             allow to disable this check application wide.
+        </td>
+        <td>Defaults to <code>true</code>.</td>
+    </tr>
+    <tr>
+        <td><code>org.apache.webbeans.spi.deployer.useEjbMetaDataDiscoveryService<code></td>
+        <td>Whether to perform EJB discovery or not.</td>
+        <td>Defaults to <code>false</code>. In TomEE this gets automatically enabled.</td>
+    </tr>
+    <tr>
+        <td><code>org.apache.webbeans.application.jsp<code></td>
+        <td>
+            If enabled, we automatically try to register the ELResolver in the JSP engine.
+            Enable this setting if you like to access <code>@Named</code> CDI beans in JSP Expression Language.
+        </td>
+        <td>Default is <code>false</code></td>
+    </tr>
+    <tr>
+        <td><code><code></td>
+        <td></td>
+        <td></td>
+    </tr>
+    <tr>
+        <td><code><code></td>
+        <td></td>
+        <td></td>
+    </tr>
+</table>
 
 
 ##Enable FailOver / Session Replication support