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

[st...@apache.org]

Author: struberg
Date: Sun Mar 13 18:47:37 2016
New Revision: 1734841

URL: http://svn.apache.org/viewvc?rev=1734841&view=rev
Log:
add documentation about our various config properties

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=1734841&r1=1734840&r2=1734841&view=diff
==============================================================================
--- openwebbeans/cms-site/trunk/content/owbconfig.mdtext (original)
+++ openwebbeans/cms-site/trunk/content/owbconfig.mdtext Sun Mar 13 18:47:37 2016
@@ -51,48 +51,106 @@ The following configuration values can g
 
 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>
+<ul>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.forceNoCheckedExceptions</code></p>
+        <p>
+            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.
+        </p>
+        <p>Defaults to <code>true</code>.</p>
+    </li>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.spi.deployer.useEjbMetaDataDiscoveryService</code></p>
+        <p>Whether to perform EJB discovery or not.</p>
+        <p>Defaults to <code>false</code>. In TomEE this gets automatically enabled.</p>
+    </li>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.application.jsp</code></p>
+        <p>
             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>
+        </p>
+        <p>Default is <code>false</code></p>
+    </li>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.application.supportsConversation</code></p>
+        <p>Enable support for the CDI <code>@ConversationScoped</code>.</p>
+        <p>Disabled by default in JavaSE, but enabled by default when adding the webbeans-web module (Servlets)</p>
+    </li>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.application.supportsProducerInterception</code></p>
+        <p>
+            Define if a CDI interceptor can be used on a producer method or field.
+            In OpenWebBeans you can use a <code>@StereoType</code> with an Interceptor to enable
+            an Interceptor on the instance returned from a Producer Method or Producer Field.
+        </p>
+        <p>Enabled by default.</p>
+    </li>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.scanExclusionPaths</code></p>
+        <p>
+            A list of known JARs/paths which should not be scanned for beans.
+            This is only used by the default ScannerService implementation.</p>
+        <p>Please refer to the openwebbeans.properties file in ``webbeans-impl.jar``</p>
+    </li>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.scanBeansXmlOnly</code></p>
+        <p>
+            Flag which indicates that only jars with an explicit META-INF/beans.xml marker file shall get parsed.
+            This basically switches OWB back to the CDI-1.0 scanning behaviour and might speed up the boot process.
+        </p>
+        <p>Default is false</p>
+    </li>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.ignoredDecoratorInterfaces</code></p>
+        <p>
+            A comma-separated list of fully qualified class names that should be ignored
+            when determining if a decorator matches its delegate.
+        </p>
+        <p>Default is an empty list</p>
+    </li>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.web.eagerSessionInitialisation</code></p>
+        <p>
+            By default we do _not_ force session creation in our WebBeansConfigurationListener. We only create the
+            Session if we really need the SessionContext. E.g. when we create a Contextual Instance in it.
+            Sometimes this creates a problem as the HttpSession can only be created BEFORE anything got written back
+            to the client.
+            With this configuration you can choose between 3 settings
+            <ul>
+                <li>&quot;true&quot; the Session will <u>always</u> eagerly be created at the begin of a request</li>
+                <li>&quot;false&quot; the Session will <u>never</u> eagerly be created but only lazily when the first &#064;SessionScoped bean gets used</li>
+                <li>any other value will be interpreted as Java regular expression for request URIs which need eager Session initialization</li>
+            </ul>
+        </p>
+        <p>Defaults to false. A session will only get created if a <code>@SessionScoped</code> bean gets accessed for the first time.</p>
+    </li>
+    <li style="border-bottom: dashed; border-width: 1px">
+        <p><code>org.apache.webbeans.generator.javaVersion</code></p>
+        <p>
+            The Java Version to use for the generated proxy classes.
+            If <code>auto</code> then we will pick the version of the current JVM.
+            <em>Attention:</em> If you like to use Java8 Lambdas in CDI bean method signatures then you need to
+            switch to either <code>auto</code> or <code>1.8</code>!
+        </p>
+        <p>
+            The default is set to <code>1.6</code> as some tools in jetty/tomcat/etc still
+            cannot properly handle Java8 (mostly due to older Eclipse JDT versions).
+        </p>
+    </li>
+</ul>
 
 
+## Proxy Mapping
+
+OpenWebBeans enables the user to define the NormalScope handlers for specific scopes.
+This allows for more aggressive caching than with the generic ``NormalScopedBeanInterceptorHandler``.
+
+TODO
+
 ##Enable FailOver / Session Replication support