You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by jl...@apache.org on 2018/12/06 08:52:46 UTC
[01/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 2
Repository: tomee
Updated Branches:
refs/heads/master c5fca2f9c -> 63929301a
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/common-persistenceprovider-properties.adoc
----------------------------------------------------------------------
diff --git a/docs/common-persistenceprovider-properties.adoc b/docs/common-persistenceprovider-properties.adoc
new file mode 100644
index 0000000..53d0145
--- /dev/null
+++ b/docs/common-persistenceprovider-properties.adoc
@@ -0,0 +1,47 @@
+# Common PersistenceProvider properties
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+While not a definitive list, it
+does help to show a side-by-side view of common properties used by the
+various persistence providers out there.
+
+# TopLink
+
+....
+<properties>
+
+ <!--http://www.oracle.com/technology/products/ias/toplink/JPA/essentials/toplink-jpa-extensions.html-->
+ <property name="toplink.ddl-generation" value="drop-and-create-tables"/>
+ <property name="toplink.logging.level" value="FINEST"/>
+ <property name="toplink.ddl-generation.output-mode" value="both"/>
+ <property name="toplink.target-server" value="pl.zsk.samples.ejbservice.OpenEJBServerPlatform"/>
+</properties>
+....
+
+# OpenJPA
+
+....
+<properties>
+ <!--http://openjpa.apache.org/faq.html-->
+ <!-- does not create foreign keys, creates schema and deletes content of a database
+ (deleteTableContents - foreign keys are created twice???), use dropDB instead -->
+ <property name="openjpa.jdbc.SynchronizeMappings" value="buildSchema(foreignKeys=true,schemaAction='dropDB,add')"/>
+ <!--Resolves the problem with foreign key integrity - joined entities are persisted sometimes in wrong order??? (verify it)-->
+ <property name="openjpa.jdbc.SchemaFactory" value="native(foreignKeys=true)" />
+ <!--Create foreign keys-->
+ <property name="openjpa.jdbc.MappingDefaults" value="ForeignKeyDeleteAction=restrict, JoinForeignKeyDeleteAction=restrict"/>
+ <property name="openjpa.Log" value="DefaultLevel=TRACE,SQL=TRACE" />
+</properties>
+....
+
+# Hibernate
+
+....
+<properties>
+ <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
+ <property name="hibernate.transaction.manager_lookup_class" value="org.apache.openejb.hibernate.TransactionManagerLookup"/>
+</properties>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/common-persistenceprovider-properties.md
----------------------------------------------------------------------
diff --git a/docs/common-persistenceprovider-properties.md b/docs/common-persistenceprovider-properties.md
deleted file mode 100644
index 4445c3b..0000000
--- a/docs/common-persistenceprovider-properties.md
+++ /dev/null
@@ -1,47 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Common PersistenceProvider properties
-~~~~~~
-While not a definitive list, it does help to show a side-by-side view of
-common properties used by the various persistence providers out there.
-
-<a name="CommonPersistenceProviderproperties-TopLink"></a>
-# TopLink
-
-
- <properties>
-
- <!--http://www.oracle.com/technology/products/ias/toplink/JPA/essentials/toplink-jpa-extensions.html-->
- <property name="toplink.ddl-generation" value="drop-and-create-tables"/>
- <property name="toplink.logging.level" value="FINEST"/>
- <property name="toplink.ddl-generation.output-mode" value="both"/>
- <property name="toplink.target-server" value="pl.zsk.samples.ejbservice.OpenEJBServerPlatform"/>
- </properties>
-
-
-<a name="CommonPersistenceProviderproperties-OpenJPA"></a>
-# OpenJPA
-
-
- <properties>
- <!--http://openjpa.apache.org/faq.html-->
- <!-- does not create foreign keys, creates schema and deletes content of a database
- (deleteTableContents - foreign keys are created twice???), use dropDB instead -->
- <property name="openjpa.jdbc.SynchronizeMappings" value="buildSchema(foreignKeys=true,schemaAction='dropDB,add')"/>
- <!--Resolves the problem with foreign key integrity - joined entities are persisted sometimes in wrong order??? (verify it)-->
- <property name="openjpa.jdbc.SchemaFactory" value="native(foreignKeys=true)" />
- <!--Create foreign keys-->
- <property name="openjpa.jdbc.MappingDefaults" value="ForeignKeyDeleteAction=restrict, JoinForeignKeyDeleteAction=restrict"/>
- <property name="openjpa.Log" value="DefaultLevel=TRACE,SQL=TRACE" />
- </properties>
-
-
-<a name="CommonPersistenceProviderproperties-Hibernate"></a>
-# Hibernate
-
-
- <properties>
- <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
- <property name="hibernate.transaction.manager_lookup_class" value="org.apache.openejb.hibernate.TransactionManagerLookup"/>
- </properties>
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/comparison.adoc
----------------------------------------------------------------------
diff --git a/docs/comparison.adoc b/docs/comparison.adoc
new file mode 100644
index 0000000..b985ea3
--- /dev/null
+++ b/docs/comparison.adoc
@@ -0,0 +1,231 @@
+# Comparison
+:index-group: General Information
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+Apache OpenEJB and Apache TomEE are born from the same project and
+community. They differ in two major ways, only one of them technical:
+
+* TomEE incorporates two additional projects; Tomcat and MyFaces
+* TomEE, as a name, more easily implies the breadth of technologies
+included
+
+Effectively, TomEE is a superset of OpenEJB. They share the same code
+and TomEE grew out of OpenEJB.
+
+Note: this table is for TomEE 1.x, TomEE 7 comments are under it.
+
+Tomcat
+
+TomEE
+
+TomEE JAX-RS (~ Microprofile)
+
+TomEE+
+
+TomEE PluME
+
+OpenEJB
+
+Java Servlets
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Java ServerPages (JSP)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Java ServerFaces (JSF)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Java Transaction API (JTA)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Java Persistence API (JPA)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Java Contexts and Dependency Injection (CDI)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Java Authentication and Authorization Service (JAAS)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Java Authorization Contract for Containers (JACC)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+JavaMail API
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Bean Validation
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Enterprise JavaBeans
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Java API for RESTful Web Services (JAX-RS)
+
+(/)
+
+(/)
+
+(/)
+
+(/)
+
+Java API for XML Web Services (JAX-WS)
+
+(/)
+
+(/)
+
+(/)
+
+Java EE Connector Architecture
+
+(/)
+
+(/)
+
+(/)
+
+Java Messaging Service (JMS)
+
+(/)
+
+(/)
+
+(/)
+
+EclipseLink
+
+(/)
+
+Mojarra
+
+(/)
+
+TomEE 7 targets JavaEE 7 and implements these specifications (in
+parenthesis the distibution(s) containing it if not part of the basic
+packages):
+
+* WebSocket JSR 356
+* JSON-P JSR 353
+* Servlet 3.1 JSR 340
+* JSF 2.2 JSR 344
+* EL 3.0 JSR 341
+* JSP 2.3 JSR 245
+* JSTL 1.2 JSR 52
+* JBatch (plus) JSR 352
+* Concurrency utilities for EE JSR 236
+* CDI 1.2, DI, Interceptors 1.2, Common Annotations JSR 346 + JSR 330 +
+JSR 318 + JSR 250
+* Bean Validation 1.1 JSR 349
+* EJB 3.2 JSR 345
+* JavaEE Connector JSR 322
+* JPA 2.1 JSR 338 (WARNING: openjpa based distributions provide a JPA
+2.0 runtime)
+* JMS 2.0 JSR 343 (layer based on ActiveMQ 5 / JMS 1.1 for default
+distributions)
+* JTA 1.2 JSR 907
+* Javamail 1.4 (NOTE: EE 7 requires 1.5)
+* JAX-RS 2.0 JSR 339
+* JAX-WS 2.2 JSR 224
+* JAXB 2.2 JSR 222
+* and more inherited from TomEE 1/JavaEE 6
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/comparison.md
----------------------------------------------------------------------
diff --git a/docs/comparison.md b/docs/comparison.md
deleted file mode 100644
index e841649..0000000
--- a/docs/comparison.md
+++ /dev/null
@@ -1,222 +0,0 @@
-index-group=General Information
-type=page
-status=published
-title=Comparison
-~~~~~~
-
-Apache OpenEJB and Apache TomEE are born from the same project and community. They differ in two major ways, only one of them technical:
-
- - TomEE incorporates two additional projects; Tomcat and MyFaces
- - TomEE, as a name, more easily implies the breadth of technologies included
-
-Effectively, TomEE is a superset of OpenEJB. They share the same code and TomEE grew out of OpenEJB.
-
-Note: this table is for TomEE 1.x, TomEE 7 comments are under it.
-
-<table class="mdtable">
-<tr>
-<th></th>
-<th>Tomcat</th>
-<th>TomEE</th>
-<th>TomEE JAX-RS (~ Microprofile)</th>
-<th>TomEE+</th>
-<th>TomEE PluME</th>
-<th>OpenEJB</th>
-</tr>
-
-<tr>
-<td>Java Servlets</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td></td>
-</tr>
-
-<tr>
-<td>Java ServerPages (JSP)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td></td>
-</tr>
-
-<tr>
-<td>Java ServerFaces (JSF)</td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td></td>
-</tr>
-
-<tr>
-<td>Java Transaction API (JTA)</td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Java Persistence API (JPA)</td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Java Contexts and Dependency Injection (CDI)</td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Java Authentication and Authorization Service (JAAS)</td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Java Authorization Contract for Containers (JACC)</td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>JavaMail API</td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Bean Validation</td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Enterprise JavaBeans</td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Java API for RESTful Web Services (JAX-RS)</td>
-<td></td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Java API for XML Web Services (JAX-WS)</td>
-<td></td>
-<td></td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Java EE Connector Architecture</td>
-<td></td>
-<td></td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>Java Messaging Service (JMS)</td>
-<td></td>
-<td></td>
-<td></td>
-<td>(/)</td>
-<td>(/)</td>
-<td>(/)</td>
-</tr>
-
-<tr>
-<td>EclipseLink</td>
-<td></td>
-<td></td>
-<td></td>
-<td></td>
-<td>(/)</td>
-<td></td>
-</tr>
-
-<tr>
-<td>Mojarra</td>
-<td></td>
-<td></td>
-<td></td>
-<td></td>
-<td>(/)</td>
-<td></td>
-</tr>
-
-</table>
-
-
-TomEE 7 targets JavaEE 7 and implements these specifications (in parenthesis the distibution(s) containing it if not part of the basic packages):
-
-* WebSocket JSR 356
-* JSON-P JSR 353
-* Servlet 3.1 JSR 340
-* JSF 2.2 JSR 344
-* EL 3.0 JSR 341
-* JSP 2.3 JSR 245
-* JSTL 1.2 JSR 52
-* JBatch (plus) JSR 352
-* Concurrency utilities for EE JSR 236
-* CDI 1.2, DI, Interceptors 1.2, Common Annotations JSR 346 + JSR 330 + JSR 318 + JSR 250
-* Bean Validation 1.1 JSR 349
-* EJB 3.2 JSR 345
-* JavaEE Connector JSR 322
-* JPA 2.1 JSR 338 (WARNING: openjpa based distributions provide a JPA 2.0 runtime)
-* JMS 2.0 JSR 343 (layer based on ActiveMQ 5 / JMS 1.1 for default distributions)
-* JTA 1.2 JSR 907
-* Javamail 1.4 (NOTE: EE 7 requires 1.5)
-* JAX-RS 2.0 JSR 339
-* JAX-WS 2.2 JSR 224
-* JAXB 2.2 JSR 222
-* and more inherited from TomEE 1/JavaEE 6
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/concepts.adoc
----------------------------------------------------------------------
diff --git a/docs/concepts.adoc b/docs/concepts.adoc
new file mode 100644
index 0000000..d3374ad
--- /dev/null
+++ b/docs/concepts.adoc
@@ -0,0 +1,83 @@
+# Concepts
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+OpenEJB was founded on the idea that it would be embedded into
+third-party environments whom would likely already have three things:
+
+* their one "server" platform with existing clients and protocols
+* their own way to configure their platform
+* existing services like TransactionManager, Security, and Connector
+
+Thus the focus of OpenEJB was to create an EJB implementation that would
+be easily embeddible, configurable, and customizable.
+
+Part of achieving that is a drive to be as simple as possible as to not
+over-define and therefore restrict the ability to be embeddible,
+configurable and customizable. Smaller third-party environments could
+easily 'downscale' OpenEJB in their integrations by replacing standard
+components with lighter implementations or removing them all together
+and larger environments could 'upscale' OpenEJB by replacing and adding
+heavier implementations of those standard components likely tailored to
+their systems and infrastructure.
+
+Container and Server are mentioned in the EJB spec as being separate
+things but are never defined formally. In our world Containers, which
+implement the basic component contract and lifecycle of a bean are not
+coupled to any particular Server, which has the job of providing a
+naming service and providing a way for it's clients to reference and
+invoke components (beans) hosted in Containers. Because Containers have
+no dependence at all only Server, you can run OpenEJB without any Server
+at all in an embedded environment for example without any work or any
+extra overhead. Similarly you can add as many new Server components as
+you want without ever having to modify any Containers.
+
+There is a very strong pluggability focus in OpenEJB as it was always
+intended to be embedded and customized in other environments. As a
+result all Containers are pluggable, isolated from each other, and no
+one Container is bound to another Container and therefore removing or
+adding a Container has no repercussions on the other Containers in the
+system. TransactionManager, SecurityService and Connector also pluggable
+and are services exposed to Containers. A Container may not be dependent
+on specific implementations of those services. Service Providers define
+what services they are offering (Container, Connector, Security,
+Transaction, etc.) in a file they place in their jar called
+service-jar.xml.
+
+The service-jar.xml should be placed not in the META-INF but somewhere
+in your package hierarchy (ours is in
+/org/apache/openejb/service-jar.xml) which allows the services in your
+service-jar.xml to be referenced by name (such as
+DefaultStatefulContainer) or more specifically by package and id (such
+as org.apache.openejb#DefaultStatefulContainer).
+
+The same implementation of a service can be declared several times in a
+service-jar.xml with different ids. This allows for you to setup several
+several different profiles or pre-configured versions of the services
+you provide each with a different name and different set of default
+values for its properties.
+
+In your openejb.conf file when you declare Containers and Connectors, we
+are actually hooking you up with Service Providers automatically. You
+get what is in the org/apache/openejb/service-jar.xml by default, but
+you are able to point specifically to a specific Service Provider by the
+'provider' attribute on the Container, Connector, TransactionManager,
+SecurityService, etc. elements of the openejb.conf file. When you
+declare a service (Container, Connector, etc.) in your openejb.conf file
+the properties you supply override the properties supplied by the
+Service Provider, thus you only need to specify the properties you'd
+like to change and can have your openejb.conf file as large or as small
+as you would like it. The act of doing this can be thought of as
+essentially instantiating the Service Provider and configuring that
+instance for inclusion in the runtime system.
+
+For example Container(id=NoTimeoutStatefulContainer,
+provider=DefaultStatefulContainer) could be declared with it's Timeout
+property set to 0 for never, and a
+Container(id=ShortTimeoutStatefulContainer,
+provider=DefaultStatefulContainer) could be declared with it's Timeout
+property set to 15 minutes. Both would be instances of the
+DefaultStatefulContainer Service Provider which is a service of type
+Container.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/concepts.md
----------------------------------------------------------------------
diff --git a/docs/concepts.md b/docs/concepts.md
deleted file mode 100644
index 370992d..0000000
--- a/docs/concepts.md
+++ /dev/null
@@ -1,79 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Concepts
-~~~~~~
-OpenEJB was founded on the idea that it would be embedded into third-party
-environments whom would likely already have three things:
-
- - their one "server" platform with existing clients and protocols
- - their own way to configure their platform
- - existing services like TransactionManager, Security, and Connector
-
-Thus the focus of OpenEJB was to create an EJB implementation that would be
-easily embeddible, configurable, and customizable.
-
-Part of achieving that is a drive to be as simple as possible as to not
-over-define and therefore restrict the ability to be embeddible,
-configurable and customizable. Smaller third-party environments could
-easily 'downscale' OpenEJB in their integrations by replacing standard
-components with lighter implementations or removing them all together and
-larger environments could 'upscale' OpenEJB by replacing and adding heavier
-implementations of those standard components likely tailored to their
-systems and infrastructure.
-
-Container and Server are mentioned in the EJB spec as being separate things
-but are never defined formally. In our world Containers, which implement
-the basic component contract and lifecycle of a bean are not coupled to any
-particular Server, which has the job of providing a naming service and
-providing a way for it's clients to reference and invoke components (beans)
-hosted in Containers. Because Containers have no dependence at all only
-Server, you can run OpenEJB without any Server at all in an embedded
-environment for example without any work or any extra overhead. Similarly
-you can add as many new Server components as you want without ever having
-to modify any Containers.
-
-There is a very strong pluggability focus in OpenEJB as it was always
-intended to be embedded and customized in other environments. As a result
-all Containers are pluggable, isolated from each other, and no one
-Container is bound to another Container and therefore removing or adding a
-Container has no repercussions on the other Containers in the system.
-TransactionManager, SecurityService and Connector also pluggable and are
-services exposed to Containers. A Container may not be dependent on
-specific implementations of those services. Service Providers define what
-services they are offering (Container, Connector, Security, Transaction,
-etc.) in a file they place in their jar called service-jar.xml.
-
-The service-jar.xml should be placed not in the META-INF but somewhere in
-your package hierarchy (ours is in /org/apache/openejb/service-jar.xml)
-which allows the services in your service-jar.xml to be referenced by name
-(such as DefaultStatefulContainer) or more specifically by package and id
-(such as org.apache.openejb#DefaultStatefulContainer).
-
-The same implementation of a service can be declared several times in a
-service-jar.xml with different ids. This allows for you to setup several
-several different profiles or pre-configured versions of the services you
-provide each with a different name and different set of default values for
-its properties.
-
-In your openejb.conf file when you declare Containers and Connectors, we
-are actually hooking you up with Service Providers automatically. You get
-what is in the org/apache/openejb/service-jar.xml by default, but you are
-able to point specifically to a specific Service Provider by the 'provider'
-attribute on the Container, Connector, TransactionManager, SecurityService,
-etc. elements of the openejb.conf file. When you declare a service
-(Container, Connector, etc.) in your openejb.conf file the properties you
-supply override the properties supplied by the Service Provider, thus you
-only need to specify the properties you'd like to change and can have your
-openejb.conf file as large or as small as you would like it. The act of
-doing this can be thought of as essentially instantiating the Service
-Provider and configuring that instance for inclusion in the runtime system.
-
-For example Container(id=NoTimeoutStatefulContainer,
-provider=DefaultStatefulContainer) could be declared with it's Timeout
-property set to 0 for never, and a
-Container(id=ShortTimeoutStatefulContainer,
-provider=DefaultStatefulContainer) could be declared with it's Timeout
-property set to 15 minutes. Both would be instances of the
-DefaultStatefulContainer Service Provider which is a service of type
-Container.
[30/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 5
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 5
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/2408a950
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/2408a950
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/2408a950
Branch: refs/heads/master
Commit: 2408a95070baff814977a0f6629d8af7b9214415
Parents: 513cf17
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 23:06:55 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 23:06:55 2018 -0800
----------------------------------------------------------------------
docs/installation-drop-in-war.adoc | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/2408a950/docs/installation-drop-in-war.adoc
----------------------------------------------------------------------
diff --git a/docs/installation-drop-in-war.adoc b/docs/installation-drop-in-war.adoc
index 127d7e4..d6adcb3 100644
--- a/docs/installation-drop-in-war.adoc
+++ b/docs/installation-drop-in-war.adoc
@@ -1,9 +1,8 @@
-:index-group: Tips
-and Tricks
+# Installing TomEE using the drop-in .war approach
+:index-group: Tips and Tricks
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: Installing TomEE using the drop-in .war approach
NOTE: Licensed to the
Apache Software Foundation (ASF) under one or more contributor license
[44/44] tomee git commit: Merge branch 'master' of
https://git-wip-us.apache.org/repos/asf/tomee
Posted by jl...@apache.org.
Merge branch 'master' of https://git-wip-us.apache.org/repos/asf/tomee
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/63929301
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/63929301
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/63929301
Branch: refs/heads/master
Commit: 63929301afb223a5265d31523edeb49302775c0d
Parents: 74134bb c5fca2f
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:52:22 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:52:22 2018 +0100
----------------------------------------------------------------------
examples/cdi-basic/README.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
[35/44] tomee git commit: This closes apache/tomee#245
Posted by jl...@apache.org.
This closes apache/tomee#245
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/c044eaa1
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/c044eaa1
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/c044eaa1
Branch: refs/heads/master
Commit: c044eaa1f7e8dd458463767de4b8ae362fd19897
Parents: bf43817 d380ec1
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:51:24 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:51:24 2018 +0100
----------------------------------------------------------------------
docs/basics---getting-things.adoc | 108 +++++++++
docs/basics---getting-things.md | 107 ---------
docs/basics---security.adoc | 54 +++++
docs/basics---security.md | 55 -----
docs/basics---transactions.adoc | 67 ++++++
docs/basics---transactions.md | 60 -----
docs/bmpentitycontainer-config.adoc | 53 +++++
docs/bmpentitycontainer-config.md | 37 ---
docs/bouncy-castle.adoc | 39 ++++
docs/bouncy-castle.md | 34 ---
docs/built-in-type-converters.adoc | 98 ++++++++
docs/built-in-type-converters.md | 94 --------
docs/callbacks.adoc | 165 +++++++++++++
docs/callbacks.md | 167 --------------
docs/changing-jms-implementations.adoc | 158 +++++++++++++
docs/changing-jms-implementations.md | 136 -----------
docs/client-server-transports.adoc | 39 ++++
docs/client-server-transports.md | 22 --
docs/clients.adoc | 95 ++++++++
docs/clients.md | 104 ---------
docs/cmpentitycontainer-config.adoc | 51 ++++
docs/cmpentitycontainer-config.md | 36 ---
docs/collapsed-ear.adoc | 49 ++++
docs/collapsed-ear.md | 46 ----
docs/common-datasource-configurations.adoc | 116 ++++++++++
docs/common-datasource-configurations.md | 115 ---------
docs/common-errors.adoc | 31 +++
docs/common-errors.md | 30 ---
docs/common-persistenceprovider-properties.adoc | 47 ++++
docs/common-persistenceprovider-properties.md | 47 ----
docs/comparison.adoc | 231 +++++++++++++++++++
docs/comparison.md | 222 ------------------
docs/concepts.adoc | 83 +++++++
docs/concepts.md | 79 -------
34 files changed, 1484 insertions(+), 1391 deletions(-)
----------------------------------------------------------------------
[14/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 7
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/exec-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/exec-mojo.md b/docs/maven/exec-mojo.md
deleted file mode 100644
index 4435c7c..0000000
--- a/docs/maven/exec-mojo.md
+++ /dev/null
@@ -1,1551 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:exec<a name="tomee:exec"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:exec</p>
-
-<p><b>Description</b>:</p>
-
-<div>(no description)</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apacheRepos">apacheRepos</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>snapshots</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.apache-repos</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#appDir">appDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>apps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apps">apps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#args">args</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.args</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#attach">attach</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.attach</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#bin">bin</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/bin</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.bin</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#catalinaBase">catalinaBase</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.catalina-base</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#checkStarted">checkStarted</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.check-started</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#classifier">classifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#classpaths">classpaths</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#config">config</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/conf</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.conf</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#context">context</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>rename the current artifact<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#debug">debug</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debug</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#debugPort">debugPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>5005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debugPort</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#deployOpenEjbApplication">deployOpenEjbApplication</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#distributionName">distributionName</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>tomee.zip</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.distribution-name</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#docBases">docBases</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, which docBase to use for this war.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#ejbRemote">ejbRemote</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ejb-remote</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#execFile">execFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}-exec.jar</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exec-file</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#externalRepositories">externalRepositories</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, add some external repositories to
-classloader.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#forceReloadable">forceReloadable</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>force webapp to be reloadable<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.force-reloadable</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#javaagents">javaagents</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#keepServerXmlAsthis">keepServerXmlAsthis</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(Removed since 7.0.0)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.keep-server-xml</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#lib">lib</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/lib</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.lib</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#libDir">libDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>lib</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#libs">libs</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#mainDir">mainDir</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#quickSession">quickSession</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use a real random instead of secure random. saves few ms at
-startup.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.quick-session</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#removeDefaultWebapps">removeDefaultWebapps</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-default-webapps</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#removeTomeeWebapp">removeTomeeWebapp</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-tomee-webapps</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#runnerClass">runnerClass</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb.maven.plugin.runner.ExecRunner</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.runner-class</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#runtimeWorkingDir">runtimeWorkingDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>.distribution</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.runtime-working-dir</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#script">script</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>bin/catalina[.sh|.bat]</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.script</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#simpleLog">simpleLog</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.simple-log</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#skipCurrentProject">skipCurrentProject</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipCurrentProject</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#skipWarResources">skipWarResources</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipWarResources</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#systemVariables">systemVariables</a></b></td>
-
-<td><tt>Map</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#target">target</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeAjpPort">tomeeAjpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8009</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ajp</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeAlreadyInstalled">tomeeAlreadyInstalled</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exiting</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeArtifactId">tomeeArtifactId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.artifactId</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeClassifier">tomeeClassifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>webprofile</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeGroupId">tomeeGroupId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.groupId</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHttpsPort">tomeeHttpsPort</a></b></td>
-
-<td><tt>Integer</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.https</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeShutdownCommand">tomeeShutdownCommand</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>SHUTDOWN</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown-command</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeShutdownPort">tomeeShutdownPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeVersion">tomeeVersion</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>-1</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.version</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#useConsole">useConsole</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.use-console</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#useOpenEJB">useOpenEJB</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use openejb-standalone automatically instead of TomEE<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.openejb</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#warFile">warFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappClasses">webappClasses</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappClasses</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappDefaultConfig">webappDefaultConfig</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>forcing nice default for war development (WEB-INF/classes and web
-resources)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappDefaultConfig</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappDir">webappDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>webapps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappResources">webappResources</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/webapp</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappResources</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webapps">webapps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#zip">zip</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.zip</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#zipFile">zipFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.zip</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.zip-file</tt>.</td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="apacheRepos">apacheRepos</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.apache-repos</tt></li>
-
-<li><b>Default</b>: <tt>snapshots</tt></li>
- </ul><hr />
-<p><b><a name="appDir">appDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>apps</tt></li>
- </ul><hr />
-<p><b><a name="apps">apps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="args">args</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.args</tt></li>
- </ul><hr />
-<p><b><a name="attach">attach</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.attach</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="bin">bin</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.bin</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/bin</tt></li>
- </ul><hr />
-<p><b><a name="catalinaBase">catalinaBase</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.catalina-base</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="checkStarted">checkStarted</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.check-started</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="classifier">classifier</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li>
- </ul><hr />
-<p><b><a name="classpaths">classpaths</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="config">config</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.conf</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/conf</tt></li>
- </ul><hr />
-<p><b><a name="context">context</a>:</b></p>
-
-<div>rename the current artifact</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="debug">debug</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debug</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="debugPort">debugPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debugPort</tt></li>
-
-<li><b>Default</b>: <tt>5005</tt></li>
- </ul><hr />
-<p><b><a name="deployOpenEjbApplication">deployOpenEjbApplication</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="distributionName">distributionName</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.distribution-name</tt></li>
-
-<li><b>Default</b>: <tt>tomee.zip</tt></li>
- </ul><hr />
-<p><b><a name="docBases">docBases</a>:</b></p>
-
-<div>for TomEE and wars only, which docBase to use for this war.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="ejbRemote">ejbRemote</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ejb-remote</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="execFile">execFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.exec-file</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}-exec.jar</tt></li>
- </ul><hr />
-<p><b><a name="externalRepositories">externalRepositories</a>:</b></p>
-
-<div>for TomEE and wars only, add some external repositories to
-classloader.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="forceReloadable">forceReloadable</a>:</b></p>
-
-<div>force webapp to be reloadable</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.force-reloadable</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="javaagents">javaagents</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="keepServerXmlAsthis">keepServerXmlAsthis</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.keep-server-xml</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="lib">lib</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.lib</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/lib</tt></li>
- </ul><hr />
-<p><b><a name="libDir">libDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>lib</tt></li>
- </ul><hr />
-<p><b><a name="libs">libs</a>:</b></p>
-
-<div>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="mainDir">mainDir</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main</tt></li>
- </ul><hr />
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="quickSession">quickSession</a>:</b></p>
-
-<div>use a real random instead of secure random. saves few ms at
-startup.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.quick-session</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="removeDefaultWebapps">removeDefaultWebapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-default-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="removeTomeeWebapp">removeTomeeWebapp</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-tomee-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="runnerClass">runnerClass</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.runner-class</tt></li>
-
-<li><b>Default</b>: <tt>org.apache.openejb.maven.plugin.runner.ExecRunner</tt></li>
- </ul><hr />
-<p><b><a name="runtimeWorkingDir">runtimeWorkingDir</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.runtime-working-dir</tt></li>
-
-<li><b>Default</b>: <tt>.distribution</tt></li>
- </ul><hr />
-<p><b><a name="script">script</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.script</tt></li>
-
-<li><b>Default</b>: <tt>bin/catalina[.sh|.bat]</tt></li>
- </ul><hr />
-<p><b><a name="simpleLog">simpleLog</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.simple-log</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipCurrentProject">skipCurrentProject</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipCurrentProject</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipWarResources">skipWarResources</a>:</b></p>
-
-<div>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipWarResources</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="systemVariables">systemVariables</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="target">target</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAjpPort">tomeeAjpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ajp</tt></li>
-
-<li><b>Default</b>: <tt>8009</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAlreadyInstalled">tomeeAlreadyInstalled</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.exiting</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="tomeeArtifactId">tomeeArtifactId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.artifactId</tt></li>
-
-<li><b>Default</b>: <tt>apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="tomeeClassifier">tomeeClassifier</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li>
-
-<li><b>Default</b>: <tt>webprofile</tt></li>
- </ul><hr />
-<p><b><a name="tomeeGroupId">tomeeGroupId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.groupId</tt></li>
-
-<li><b>Default</b>: <tt>org.apache.openejb</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpsPort">tomeeHttpsPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.Integer</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.https</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownCommand">tomeeShutdownCommand</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown-command</tt></li>
-
-<li><b>Default</b>: <tt>SHUTDOWN</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownPort">tomeeShutdownPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown</tt></li>
-
-<li><b>Default</b>: <tt>8005</tt></li>
- </ul><hr />
-<p><b><a name="tomeeVersion">tomeeVersion</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.version</tt></li>
-
-<li><b>Default</b>: <tt>-1</tt></li>
- </ul><hr />
-<p><b><a name="useConsole">useConsole</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.use-console</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="useOpenEJB">useOpenEJB</a>:</b></p>
-
-<div>use openejb-standalone automatically instead of TomEE</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.openejb</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul><hr />
-<p><b><a name="warFile">warFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt></li>
- </ul><hr />
-<p><b><a name="webappClasses">webappClasses</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappClasses</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li>
- </ul><hr />
-<p><b><a name="webappDefaultConfig">webappDefaultConfig</a>:</b></p>
-
-<div>forcing nice default for war development (WEB-INF/classes and web
-resources)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappDefaultConfig</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="webappDir">webappDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>webapps</tt></li>
- </ul><hr />
-<p><b><a name="webappResources">webappResources</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappResources</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li>
- </ul><hr />
-<p><b><a name="webapps">webapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="zip">zip</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.zip</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="zipFile">zipFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.zip-file</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.zip</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/help-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/help-mojo.adoc b/docs/maven/help-mojo.adoc
new file mode 100644
index 0000000..8ade7f8
--- /dev/null
+++ b/docs/maven/help-mojo.adoc
@@ -0,0 +1,115 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:help
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:help
+
+Description:
+
+Display help information on tomee-maven-plugin. Call mvn tomee:help
+-Ddetail=true -Dgoal=<goal-name> to display parameter details.
+
+Attributes:
+
+The goal is thread-safe and supports parallel builds.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+detail
+
+boolean
+
+-
+
+If true, display all settable properties for each goal.Default value is:
+false.User property is: detail.
+
+goal
+
+String
+
+-
+
+The name of the goal for which to show help. If unspecified, all goals
+will be displayed.User property is: goal.
+
+indentSize
+
+int
+
+-
+
+The number of spaces per indentation level, should be positive.Default
+value is: 2.User property is: indentSize.
+
+lineLength
+
+int
+
+-
+
+The maximum length of a display line, should be positive.Default value
+is: 80.User property is: lineLength.
+
+Parameter Details
+
+detail:
+
+If true, display all settable properties for each goal.
+
+Type: boolean
+
+Required: No
+
+User Property: detail
+
+Default: false
+
+goal:
+
+The name of the goal for which to show help. If unspecified, all goals
+will be displayed.
+
+Type: java.lang.String
+
+Required: No
+
+User Property: goal
+
+indentSize:
+
+The number of spaces per indentation level, should be positive.
+
+Type: int
+
+Required: No
+
+User Property: indentSize
+
+Default: 2
+
+lineLength:
+
+The maximum length of a display line, should be positive.
+
+Type: int
+
+Required: No
+
+User Property: lineLength
+
+Default: 80
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/help-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/help-mojo.md b/docs/maven/help-mojo.md
deleted file mode 100644
index 430ee60..0000000
--- a/docs/maven/help-mojo.md
+++ /dev/null
@@ -1,149 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:help<a name="tomee:help"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:help</p>
-
-<p><b>Description</b>:</p>
-
-<div>Display help information on tomee-maven-plugin.<br />
-Call <tt>mvn tomee:help -Ddetail=true
--Dgoal=<goal-name></tt> to display parameter details.</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>The goal is thread-safe and supports parallel builds.</li>
- </ul>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#detail">detail</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>If <tt>true</tt>, display all settable properties for each
-goal.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>detail</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#goal">goal</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>The name of the goal for which to show help. If unspecified, all
-goals will be displayed.<br /><b>User property is</b>: <tt>goal</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#indentSize">indentSize</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>The number of spaces per indentation level, should be positive.<br /><b>Default value is</b>: <tt>2</tt>.<br /><b>User property is</b>: <tt>indentSize</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#lineLength">lineLength</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>The maximum length of a display line, should be positive.<br /><b>Default value is</b>: <tt>80</tt>.<br /><b>User property is</b>: <tt>lineLength</tt>.</td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="detail">detail</a>:</b></p>
-
-<div>If <tt>true</tt>, display all settable properties for each
-goal.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>detail</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="goal">goal</a>:</b></p>
-
-<div>The name of the goal for which to show help. If unspecified, all
-goals will be displayed.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>goal</tt></li>
- </ul><hr />
-<p><b><a name="indentSize">indentSize</a>:</b></p>
-
-<div>The number of spaces per indentation level, should be positive.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>indentSize</tt></li>
-
-<li><b>Default</b>: <tt>2</tt></li>
- </ul><hr />
-<p><b><a name="lineLength">lineLength</a>:</b></p>
-
-<div>The maximum length of a display line, should be positive.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>lineLength</tt></li>
-
-<li><b>Default</b>: <tt>80</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/index.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/index.adoc b/docs/maven/index.adoc
new file mode 100644
index 0000000..c83c30c
--- /dev/null
+++ b/docs/maven/index.adoc
@@ -0,0 +1,176 @@
+:index-group: TomEE
+Maven Plugin
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: TomEE Maven Plugin
+
+
+Inspired by the Jetty Maven Plugin, the TomEE Maven Plugin is a
+feature-rich plugin that allows for:
+
+* Easy provisioning of a TomEE server
+* Server start and stop
+* Application deployment and undeployment
+
+Simply add the following to the , and optionally the ), section of your
+`pom.xml`
+
+....
+<plugins>
+ <plugin>
+ <groupId>org.apache.openejb.maven</groupId>
+ <artifactId>tomee-maven-plugin</artifactId>
+ <version>1.7.1</version>
+ <configuration>
+ <tomeeVersion>1.7.1</tomeeVersion>
+ <tomeeClassifier>plus</tomeeClassifier>
+ </configuration>
+ </plugin>
+</plugins>
+....
+
+###Plugin Goals
+
+Goal
+
+Description
+
+tomee:build
+
+Create TomEE, but do not run it.
+
+tomee:configtest
+
+Run the Apache Tomcat `configtest` command.
+
+tomee:debug
+
+Same as `run` but with debug activated on the default or specified port.
+
+tomee:deploy
+
+Deploy an application in a running TomEE.
+
+tomee:exec
+
+Undocumented.
+
+tomee:help
+
+Display help information on the tomee-maven-plugin. Call mvn tomee:help
+-Ddetail=true -Dgoal=<goal-name> to display parameter details.
+
+tomee:list
+
+Largely inspired by the OpenEJB command helper, but with some
+differences. List deployed EJB's in a running TomEE.
+
+tomee:run
+
+Start and wait for TomEE.
+
+tomee:start
+
+Start TomEE and continue.
+
+tomee:stop
+
+Stop a TomEE started with start command.
+
+tomee:undeploy
+
+Undeploy an application in a running TomEE
+
+Note that for the tomee:deploy and tomee:undeploy goals, the path can
+either be specified within the section of the `pom.xml` using the
+parameter, or it can be passed via the user property
+tomee-plugin.archive. If a relative path is passed for the deploy path
+archive, this must be relative to the TomEE server.
+
+Note 2: running tomee maven plugin you can type 'quit' directly in the
+console to shutdown correctly the server. 'reload' is also available
+when internal openejb application is deployed.
+
+###More Tweaks
+
+The lib tag allows to enrich the container with some additional
+libraries.
+
+Some interesting patterns in addition to the default maven formats are
+supported.
+
+* remove:<some prefix of jar in lib folder>: remove all jar starting
+with the specified prefix
+* unzip:<some maven zip>: extract the zip in lib folder
+* ?name=<new-name>: rename the libary once copied in lib folder
+
+Note: the name tweak can be used to rename applications too
+
+###Provisioning Example
+
+This plugin is also usable in projects which are not war. For instance
+you can use it in a pom project to setup a TomEE install, add libraries,
+deploy apps then run the server.
+
+....
+ <plugin>
+ <groupId>org.apache.openejb.maven</groupId>
+ <artifactId>tomee-maven-plugin</artifactId>
+ <version>1.7.1</version>
+ <configuration>
+ <tomeeVersion>1.7.1</tomeeVersion>
+ <tomeeClassifier>plus</tomeeClassifier>
+ <debug>false</debug>
+ <debugPort>5005</debugPort>
+ <args>-Dfoo=bar</args>
+ <config>${project.basedir}/src/test/tomee/conf</config>
+ <libs>
+ <lib>mysql:mysql-connector-java:5.1.20</lib>
+ </libs>
+ <webapps>
+ <webapp>org.superbiz:myapp:4.3?name=ROOT</webapp>
+ <webapp>org.superbiz:api:1.1</webapp>
+ </webapps>
+ <apps>
+ <app>org.superbiz:mybugapp:3.2:ear</app>
+ </apps>
+ <libs>
+ <lib>mysql:mysql-connector-java:5.1.21</lib>
+ <lib>unzip:org.superbiz:hibernate-bundle:4.1.0.Final:zip</lib>
+ <lib>remove:openjpa-</lib>
+ </libs>
+ </configuration>
+ </plugin>
+....
+
+###Auto Reloading Example
+
+....
+<plugin>
+ <groupId>org.apache.openejb.maven</groupId>
+ <artifactId>tomee-maven-plugin</artifactId>
+ <version>1.7.1</version>
+ <configuration>
+ <synchronization>
+ <extensions>
+ <extension>.class</extension> <!-- if you want to update each time you build with mvn compile -->
+ </extensions>
+ </synchronization>
+ <reloadOnUpdate>true</reloadOnUpdate>
+ </configuration>
+</plugin>
+....
+
+The Synchronization block supports the following configuration options:
+
+* resourcesDir (default src/main/webapp)
+* binariesDir (default target/classes)
+* targetBinariesDir (default tomee/webapps/finalName/WEB-INF/classes)
+* targetResourcesDir (default tomee/webapps/finalName)
+* updateInterval (default 5 - in second)
+* extensions (default html, xhtml, js and css)
+* regex: a regex should match files to take into account when updating
+
+reloadOnUpdate means to reload the entire context (webapp). This means
+undeploying/redeploying the application.
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/index.md
----------------------------------------------------------------------
diff --git a/docs/maven/index.md b/docs/maven/index.md
deleted file mode 100644
index 1c004e7..0000000
--- a/docs/maven/index.md
+++ /dev/null
@@ -1,148 +0,0 @@
-index-group=TomEE Maven Plugin
-type=page
-status=published
-title=TomEE Maven Plugin
-~~~~~~
-
-Inspired by the Jetty Maven Plugin, the TomEE Maven Plugin is a feature-rich
-plugin that allows for:
-
- - Easy provisioning of a TomEE server
- - Server start and stop
- - Application deployment and undeployment
-
-Simply add the following to the <plugins>, and optionally the <pluginManagement>), section of your `pom.xml`
-
- <plugins>
- <plugin>
- <groupId>org.apache.openejb.maven</groupId>
- <artifactId>tomee-maven-plugin</artifactId>
- <version>1.7.1</version>
- <configuration>
- <tomeeVersion>1.7.1</tomeeVersion>
- <tomeeClassifier>plus</tomeeClassifier>
- </configuration>
- </plugin>
- </plugins>
-
-###Plugin Goals
-<table class="mdtable">
-<tr class="a">
-<th>Goal</th>
-<th>Description</th></tr>
-<tr class="b">
-<td><a href="build-mojo.html">tomee:build</a></td>
-<td>Create TomEE, but do not run it.</td></tr>
-<tr class="a">
-<td><a href="configtest-mojo.html">tomee:configtest</a></td>
-<td>Run the Apache Tomcat `configtest` command.</td></tr>
-<tr class="b">
-<td><a href="debug-mojo.html">tomee:debug</a></td>
-<td>Same as `run` but with debug activated on the default or specified port.</td></tr>
-<tr class="a">
-<td><a href="deploy-mojo.html">tomee:deploy</a></td>
-<td>Deploy an application in a running TomEE.</td></tr>
-<tr class="b">
-<td><a href="exec-mojo.html">tomee:exec</a></td>
-<td>Undocumented.</td></tr>
-<tr class="a">
-<td><a href="help-mojo.html">tomee:help</a></td>
-<td>Display help information on the tomee-maven-plugin.<br />
-Call <code>mvn tomee:help -Ddetail=true
--Dgoal=<goal-name></code> to display parameter details.</td></tr>
-<tr class="b">
-<td><a href="list-mojo.html">tomee:list</a></td>
-<td>Largely inspired by the OpenEJB command helper, but with some differences. List deployed EJB's in a running TomEE.</td></tr>
-<tr class="a">
-<td><a href="run-mojo.html">tomee:run</a></td>
-<td>Start and wait for TomEE.</td></tr>
-<tr class="b">
-<td><a href="start-mojo.html">tomee:start</a></td>
-<td>Start TomEE and continue.</td></tr>
-<tr class="a">
-<td><a href="stop-mojo.html">tomee:stop</a></td>
-<td>Stop a TomEE started with start command.</td></tr>
-<tr class="b">
-<td><a href="undeploy-mojo.html">tomee:undeploy</a></td>
-<td>Undeploy an application in a running TomEE</td></tr></table>
-
-
-Note that for the tomee:deploy and tomee:undeploy goals, the path can either be specified within the <configuration/> section of the `pom.xml` using the <path> parameter, or it can be passed via the user property tomee-plugin.archive. If a relative path is passed for the deploy path archive, this must be relative to the TomEE server.
-
-Note 2: running tomee maven plugin you can type 'quit' directly in the console to shutdown correctly the
-server. 'reload' is also available when internal openejb application is deployed.
-
-###More Tweaks
-
-The lib tag allows to enrich the container with some additional libraries.
-
-Some interesting patterns in addition to the default maven formats are supported.
-
-* remove:<some prefix of jar in lib folder>: remove all jar starting with the specified prefix
-* unzip:<some maven zip>: extract the zip in lib folder
-* ?name=<new-name>: rename the libary once copied in lib folder
-
-Note: the name tweak can be used to rename applications too
-
-###Provisioning Example
-
-This plugin is also usable in projects which are not war. For instance you can use it in a pom
-project to setup a TomEE install, add libraries, deploy apps then run the server.
-
- <plugin>
- <groupId>org.apache.openejb.maven</groupId>
- <artifactId>tomee-maven-plugin</artifactId>
- <version>1.7.1</version>
- <configuration>
- <tomeeVersion>1.7.1</tomeeVersion>
- <tomeeClassifier>plus</tomeeClassifier>
- <debug>false</debug>
- <debugPort>5005</debugPort>
- <args>-Dfoo=bar</args>
- <config>${project.basedir}/src/test/tomee/conf</config>
- <libs>
- <lib>mysql:mysql-connector-java:5.1.20</lib>
- </libs>
- <webapps>
- <webapp>org.superbiz:myapp:4.3?name=ROOT</webapp>
- <webapp>org.superbiz:api:1.1</webapp>
- </webapps>
- <apps>
- <app>org.superbiz:mybugapp:3.2:ear</app>
- </apps>
- <libs>
- <lib>mysql:mysql-connector-java:5.1.21</lib>
- <lib>unzip:org.superbiz:hibernate-bundle:4.1.0.Final:zip</lib>
- <lib>remove:openjpa-</lib>
- </libs>
- </configuration>
- </plugin>
-
-
-###Auto Reloading Example
-
- <plugin>
- <groupId>org.apache.openejb.maven</groupId>
- <artifactId>tomee-maven-plugin</artifactId>
- <version>1.7.1</version>
- <configuration>
- <synchronization>
- <extensions>
- <extension>.class</extension> <!-- if you want to update each time you build with mvn compile -->
- </extensions>
- </synchronization>
- <reloadOnUpdate>true</reloadOnUpdate>
- </configuration>
- </plugin>
-
-The Synchronization block supports the following configuration options:
-
-* resourcesDir (default src/main/webapp)
-* binariesDir (default target/classes)
-* targetBinariesDir (default tomee/webapps/finalName/WEB-INF/classes)
-* targetResourcesDir (default tomee/webapps/finalName)
-* updateInterval (default 5 - in second)
-* extensions (default html, xhtml, js and css)
-* regex: a regex should match files to take into account when updating
-
-reloadOnUpdate means to reload the entire context (webapp). This means undeploying/redeploying the application.
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/list-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/list-mojo.adoc b/docs/maven/list-mojo.adoc
new file mode 100644
index 0000000..05c6638
--- /dev/null
+++ b/docs/maven/list-mojo.adoc
@@ -0,0 +1,132 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:list
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:list
+
+Description:
+
+Highly inspired from openejb command helper but with some different
+data. List deployed EJB in a running TomEE.
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+Parameter Details
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/list-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/list-mojo.md b/docs/maven/list-mojo.md
deleted file mode 100644
index ecf6673..0000000
--- a/docs/maven/list-mojo.md
+++ /dev/null
@@ -1,169 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:list<a name="tomee:list"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:list</p>
-
-<p><b>Description</b>:</p>
-
-<div>Highly inspired from openejb command helper but with some different
-data. List deployed EJB in a running TomEE.</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/run-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/run-mojo.adoc b/docs/maven/run-mojo.adoc
new file mode 100644
index 0000000..91b909c
--- /dev/null
+++ b/docs/maven/run-mojo.adoc
@@ -0,0 +1,1139 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:run
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:run
+
+Description:
+
+Start and wait for TomEE.
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime+system.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+apacheRepos
+
+String
+
+-
+
+(no description)Default value is: snapshots.User property is:
+tomee-plugin.apache-repos.
+
+appDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: apps.
+
+apps
+
+List
+
+-
+
+(no description)
+
+args
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.args.
+
+bin
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/bin.User property is:
+tomee-plugin.bin.
+
+catalinaBase
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.build.directory}/apache-tomee.User property is:
+tomee-plugin.catalina-base.
+
+checkStarted
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.check-started.
+
+classpaths
+
+List
+
+-
+
+(no description)
+
+config
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/conf.User property is:
+tomee-plugin.conf.
+
+context
+
+String
+
+-
+
+rename the current artifact
+
+debug
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.debug.
+
+debugPort
+
+int
+
+-
+
+(no description)Default value is: 5005.User property is:
+tomee-plugin.debugPort.
+
+deployOpenEjbApplication
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.deploy-openejb-internal-application.
+
+docBases
+
+List
+
+-
+
+for TomEE and wars only, which docBase to use for this war.
+
+ejbRemote
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.ejb-remote.
+
+externalRepositories
+
+List
+
+-
+
+for TomEE and wars only, add some external repositories to classloader.
+
+forceReloadable
+
+boolean
+
+-
+
+force webapp to be reloadableDefault value is: false.User property is:
+tomee-plugin.force-reloadable.
+
+javaagents
+
+List
+
+-
+
+(no description)
+
+keepServerXmlAsthis
+
+boolean
+
+-
+
+(Removed since 7.0.0)Default value is: false.User property is:
+tomee-plugin.keep-server-xml.
+
+lib
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/lib.User property is:
+tomee-plugin.lib.
+
+libDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: lib.
+
+libs
+
+List
+
+-
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+mainDir
+
+File
+
+-
+
+(no description)Default value is: $\{project.basedir}/src/main.
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+quickSession
+
+boolean
+
+-
+
+use a real random instead of secure random. saves few ms at
+startup.Default value is: true.User property is:
+tomee-plugin.quick-session.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+reloadOnUpdate
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.reload-on-update.
+
+removeDefaultWebapps
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-default-webapps.
+
+removeTomeeWebapp
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-tomee-webapps.
+
+simpleLog
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.simple-log.
+
+skipCurrentProject
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.skipCurrentProject.
+
+skipWarResources
+
+boolean
+
+-
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.Default value is: false.User property is:
+tomee-plugin.skipWarResources.
+
+synchronization
+
+Synchronization
+
+-
+
+(no description)
+
+synchronizations
+
+List
+
+-
+
+(no description)
+
+systemVariables
+
+Map
+
+-
+
+(no description)
+
+target
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.directory}.
+
+tomeeAjpPort
+
+int
+
+-
+
+(no description)Default value is: 8009.User property is:
+tomee-plugin.ajp.
+
+tomeeAlreadyInstalled
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.exiting.
+
+tomeeArtifactId
+
+String
+
+-
+
+(no description)Default value is: apache-tomee.User property is:
+tomee-plugin.artifactId.
+
+tomeeClassifier
+
+String
+
+-
+
+(no description)Default value is: webprofile.User property is:
+tomee-plugin.classifier.
+
+tomeeGroupId
+
+String
+
+-
+
+(no description)Default value is: org.apache.openejb.User property is:
+tomee-plugin.groupId.
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+tomeeHttpsPort
+
+Integer
+
+-
+
+(no description)User property is: tomee-plugin.https.
+
+tomeeShutdownCommand
+
+String
+
+-
+
+(no description)Default value is: SHUTDOWN.User property is:
+tomee-plugin.shutdown-command.
+
+tomeeShutdownPort
+
+int
+
+-
+
+(no description)Default value is: 8005.User property is:
+tomee-plugin.shutdown.
+
+tomeeVersion
+
+String
+
+-
+
+(no description)Default value is: -1.User property is:
+tomee-plugin.version.
+
+useConsole
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.use-console.
+
+useOpenEJB
+
+boolean
+
+-
+
+use openejb-standalone automatically instead of TomEEDefault value is:
+false.User property is: tomee-plugin.openejb.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+warFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}.
+
+webappClasses
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.outputDirectory}.User
+property is: tomee-plugin.webappClasses.
+
+webappDefaultConfig
+
+boolean
+
+-
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)Default value is: false.User property is:
+tomee-plugin.webappDefaultConfig.
+
+webappDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: webapps.
+
+webappResources
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/webapp.User property is:
+tomee-plugin.webappResources.
+
+webapps
+
+List
+
+-
+
+(no description)
+
+Parameter Details
+
+apacheRepos:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.apache-repos
+
+Default: snapshots
+
+appDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: apps
+
+apps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+args:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.args
+
+bin:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.bin
+
+Default: $\{project.basedir}/src/main/tomee/bin
+
+catalinaBase:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.catalina-base
+
+Default: $\{project.build.directory}/apache-tomee
+
+checkStarted:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.check-started
+
+Default: false
+
+classpaths:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+config:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.conf
+
+Default: $\{project.basedir}/src/main/tomee/conf
+
+context:
+
+rename the current artifact
+
+Type: java.lang.String
+
+Required: No
+
+debug:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.debug
+
+Default: false
+
+debugPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.debugPort
+
+Default: 5005
+
+deployOpenEjbApplication:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.deploy-openejb-internal-application
+
+Default: false
+
+docBases:
+
+for TomEE and wars only, which docBase to use for this war.
+
+Type: java.util.List
+
+Required: No
+
+ejbRemote:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.ejb-remote
+
+Default: true
+
+externalRepositories:
+
+for TomEE and wars only, add some external repositories to classloader.
+
+Type: java.util.List
+
+Required: No
+
+forceReloadable:
+
+force webapp to be reloadable
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.force-reloadable
+
+Default: false
+
+javaagents:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+keepServerXmlAsthis:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.keep-server-xml
+
+Default: false
+
+lib:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.lib
+
+Default: $\{project.basedir}/src/main/tomee/lib
+
+libDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: lib
+
+libs:
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+Type: java.util.List
+
+Required: No
+
+mainDir:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.basedir}/src/main
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+quickSession:
+
+use a real random instead of secure random. saves few ms at startup.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.quick-session
+
+Default: true
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+reloadOnUpdate:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.reload-on-update
+
+Default: false
+
+removeDefaultWebapps:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-default-webapps
+
+Default: true
+
+removeTomeeWebapp:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-tomee-webapps
+
+Default: true
+
+simpleLog:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.simple-log
+
+Default: false
+
+skipCurrentProject:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipCurrentProject
+
+Default: false
+
+skipWarResources:
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipWarResources
+
+Default: false
+
+synchronization:
+
+(no description)
+
+Type: org.apache.openejb.maven.plugin.Synchronization
+
+Required: No
+
+synchronizations:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+systemVariables:
+
+(no description)
+
+Type: java.util.Map
+
+Required: No
+
+target:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.build.directory}
+
+tomeeAjpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.ajp
+
+Default: 8009
+
+tomeeAlreadyInstalled:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.exiting
+
+Default: false
+
+tomeeArtifactId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.artifactId
+
+Default: apache-tomee
+
+tomeeClassifier:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.classifier
+
+Default: webprofile
+
+tomeeGroupId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.groupId
+
+Default: org.apache.openejb
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+tomeeHttpsPort:
+
+(no description)
+
+Type: java.lang.Integer
+
+Required: No
+
+User Property: tomee-plugin.https
+
+tomeeShutdownCommand:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.shutdown-command
+
+Default: SHUTDOWN
+
+tomeeShutdownPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.shutdown
+
+Default: 8005
+
+tomeeVersion:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.version
+
+Default: -1
+
+useConsole:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.use-console
+
+Default: true
+
+useOpenEJB:
+
+use openejb-standalone automatically instead of TomEE
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.openejb
+
+Default: false
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
+
+warFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}
+
+webappClasses:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappClasses
+
+Default: $\{project.build.outputDirectory}
+
+webappDefaultConfig:
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.webappDefaultConfig
+
+Default: false
+
+webappDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: webapps
+
+webappResources:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappResources
+
+Default: $\{project.basedir}/src/main/webapp
+
+webapps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
[39/44] tomee git commit: This closes apache/tomee#249
Posted by jl...@apache.org.
This closes apache/tomee#249
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/2f8b7a69
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/2f8b7a69
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/2f8b7a69
Branch: refs/heads/master
Commit: 2f8b7a69f03001df2aa59f4f7f0252a96454eaa0
Parents: 18ed6f3 2408a95
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:51:48 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:51:48 2018 +0100
----------------------------------------------------------------------
docs/generating-ejb-3-annotations.adoc | 63 ++++
docs/generating-ejb-3-annotations.md | 61 ----
docs/getting-started.adoc | 170 +++++++++++
docs/getting-started.md | 172 -----------
docs/hello-world.adoc | 247 ++++++++++++++++
docs/hello-world.md | 250 ----------------
docs/hibernate.adoc | 101 +++++++
docs/hibernate.md | 98 -------
docs/initialcontext-config.adoc | 42 +++
docs/initialcontext-config.md | 26 --
docs/installation-drop-in-war.adoc | 54 ++++
docs/installation-drop-in-war.md | 45 ---
docs/installation.adoc | 35 +++
docs/installation.md | 34 ---
docs/installing-tomee.adoc | 83 ++++++
docs/installing-tomee.md | 71 -----
docs/java7.adoc | 40 +++
docs/java7.md | 40 ---
docs/javaagent-with-maven-surefire.adoc | 35 +++
docs/javaagent-with-maven-surefire.md | 57 ----
docs/javaagent.adoc | 64 ++++
docs/javaagent.md | 61 ----
docs/javaee7-status.adoc | 218 ++++++++++++++
docs/javaee7-status.md | 185 ------------
docs/javamailsession-config.adoc | 42 +++
docs/javamailsession-config.md | 26 --
docs/jms-resources-and-mdb-container.adoc | 356 ++++++++++++++++++++++
docs/jms-resources-and-mdb-container.md | 283 ------------------
docs/jmsconnectionfactory-config.adoc | 102 +++++++
docs/jmsconnectionfactory-config.md | 87 ------
docs/jndi-names.adoc | 390 +++++++++++++++++++++++++
docs/jndi-names.md | 372 -----------------------
docs/jpa-concepts.adoc | 223 ++++++++++++++
docs/jpa-concepts.md | 220 --------------
docs/jpa-usage.adoc | 48 +++
docs/jpa-usage.md | 52 ----
36 files changed, 2313 insertions(+), 2140 deletions(-)
----------------------------------------------------------------------
[33/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 10
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 10
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/cf397dee
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/cf397dee
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/cf397dee
Branch: refs/heads/master
Commit: cf397dee85a141cb8b9d369a518ec69215684dfd
Parents: de7099c
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 23:06:59 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 23:06:59 2018 -0800
----------------------------------------------------------------------
docs/spring-and-openejb-3.0.adoc | 4 ++--
docs/spring-ejb-and-jpa.adoc | 2 +-
docs/startup.adoc | 5 ++---
3 files changed, 5 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/cf397dee/docs/spring-and-openejb-3.0.adoc
----------------------------------------------------------------------
diff --git a/docs/spring-and-openejb-3.0.adoc b/docs/spring-and-openejb-3.0.adoc
index ea2c24c..563fe25 100644
--- a/docs/spring-and-openejb-3.0.adoc
+++ b/docs/spring-and-openejb-3.0.adoc
@@ -1,4 +1,4 @@
-:jbake-title: Spring and OpenEJB 3.0
+# Spring and OpenEJB 3.0
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
@@ -213,7 +213,7 @@ Spring bean definitions combined
</bean>
....
-:jbake-title: Some more useful info.} Here is a bunch of links suggested
+{title= Some more useful info.} Here is a bunch of links suggested
by a user. If anybody has time to go through them and write a doc, that
would be great. These links explain how to make available spring
components to openejb
http://git-wip-us.apache.org/repos/asf/tomee/blob/cf397dee/docs/spring-ejb-and-jpa.adoc
----------------------------------------------------------------------
diff --git a/docs/spring-ejb-and-jpa.adoc b/docs/spring-ejb-and-jpa.adoc
index 416fa4e..7ff90c0 100644
--- a/docs/spring-ejb-and-jpa.adoc
+++ b/docs/spring-ejb-and-jpa.adoc
@@ -93,7 +93,7 @@ in the Spring xml file as shown here.
\{snippet:id=resources|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
And finally our Spring beans.
\{snippet:id=pojos|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
-:jbake-title: Don't forget}
+{title= Don't forget}
\{snippet:id=annotations|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
It allows various annotations to be detected in bean classes: Spring's
@Required and @Autowired, as well as JSR 250's @PostConstruct,
http://git-wip-us.apache.org/repos/asf/tomee/blob/cf397dee/docs/startup.adoc
----------------------------------------------------------------------
diff --git a/docs/startup.adoc b/docs/startup.adoc
index 8fa8c63..efd5835 100644
--- a/docs/startup.adoc
+++ b/docs/startup.adoc
@@ -1,9 +1,8 @@
-:index-group: OpenEJB
-Standalone Server
+# Startup
+:index-group: OpenEJB Standalone Server
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: Startup
# NAME
[26/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 1
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 1
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/3e87b477
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/3e87b477
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/3e87b477
Branch: refs/heads/master
Commit: 3e87b477837a6bab15c0b008eda2fbee6edb35dd
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:17 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:08:35 2018 -0800
----------------------------------------------------------------------
docs/Configuring-in-tomee.adoc | 47 ++
docs/Configuring-in-tomee.md | 45 --
docs/activemqresourceadapter-config.adoc | 88 +++
docs/activemqresourceadapter-config.md | 69 ---
docs/admin/cluster/index.adoc | 1 +
docs/advanced/client/jndi.adoc | 1 +
docs/alternate-descriptors.adoc | 121 ++++
docs/alternate-descriptors.md | 117 ----
docs/annotations,-xml-and-defaults.adoc | 20 +
docs/annotations,-xml-and-defaults.md | 569 -------------------
docs/app-clients-and-jndi.adoc | 74 +++
docs/app-clients-and-jndi.md | 73 ---
docs/application-composer/advanced.adoc | 107 ++++
docs/application-composer/advanced.md | 90 ---
docs/application-composer/getting-started.adoc | 225 ++++++++
docs/application-composer/getting-started.md | 188 ------
docs/application-composer/history.adoc | 48 ++
docs/application-composer/history.md | 38 --
docs/application-composer/index.adoc | 20 +
docs/application-composer/index.md | 18 -
docs/application-deployment-solutions.adoc | 90 +++
docs/application-deployment-solutions.md | 78 ---
...application-discovery-via-the-classpath.adoc | 107 ++++
docs/application-discovery-via-the-classpath.md | 94 ---
docs/application-resources.adoc | 362 ++++++++++++
docs/application-resources.md | 250 --------
docs/arquillian-available-adapters.adoc | 311 ++++++++++
docs/arquillian-available-adapters.md | 264 ---------
docs/arquillian-getting-started.adoc | 41 ++
docs/arquillian-getting-started.md | 24 -
30 files changed, 1663 insertions(+), 1917 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/Configuring-in-tomee.adoc
----------------------------------------------------------------------
diff --git a/docs/Configuring-in-tomee.adoc b/docs/Configuring-in-tomee.adoc
new file mode 100644
index 0000000..bc26314
--- /dev/null
+++ b/docs/Configuring-in-tomee.adoc
@@ -0,0 +1,47 @@
+# Apache TomEE configuration
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+NOTE: Licensed to the Apache Software Foundation
+(ASF) under one or more contributor license agreements. See the NOTICE
+file distributed with this work for additional information regarding
+copyright ownership. The ASF licenses this file to you 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.
+
+###Configuring Resources:
+
+* Drivers are dropped into tomeeDir/lib
+* Resources are configured in tomeeDir/conf/tomee.xml. +
+* The configurations take a very simple (XML+Property-file) syntax.
+* Tag names match annotation names
+
+For example,
+
+....
+@Resource DataSource moviesDatabase
+....
+
+is injected with the following resource:
+
+....
+<Resource id="moviesDatabase" type="DataSource">
+JdbcDriver org.hsqldb.jdbcDriver
+JdbcUrl jdbc:mysql:localhost:3306/moviesdb
+UserName sa
+Password secret
+JtaManaged true
+</Resource>
+....
+
+For more on how to configure, read through
+link:/configuring-datasources.html[configuring-datasources],
+link:containers-and-resources.html[containers-and-resources] docs.
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/Configuring-in-tomee.md
----------------------------------------------------------------------
diff --git a/docs/Configuring-in-tomee.md b/docs/Configuring-in-tomee.md
deleted file mode 100644
index 0c798eb..0000000
--- a/docs/Configuring-in-tomee.md
+++ /dev/null
@@ -1,45 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=Apache TomEE configuration
-~~~~~~
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-###Configuring Resources:
-
-* Drivers are dropped into tomeeDir/lib
-* Resources are configured in tomeeDir/conf/tomee.xml.
-* The configurations take a very simple (XML+Property-file) syntax.
-* Tag names match annotation names
-
-For example,
-
- @Resource DataSource moviesDatabase
-
-is injected with the following resource:
-
-
- <Resource id="moviesDatabase" type="DataSource">
- JdbcDriver org.hsqldb.jdbcDriver
- JdbcUrl jdbc:mysql:localhost:3306/moviesdb
- UserName sa
- Password secret
- JtaManaged true
- </Resource>
-
-For more on how to configure, read through [configuring-datasources](/configuring-datasources.html), [containers-and-resources](containers-and-resources.html) docs.
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/activemqresourceadapter-config.adoc
----------------------------------------------------------------------
diff --git a/docs/activemqresourceadapter-config.adoc b/docs/activemqresourceadapter-config.adoc
new file mode 100644
index 0000000..1402427
--- /dev/null
+++ b/docs/activemqresourceadapter-config.adoc
@@ -0,0 +1,88 @@
+# ActiveMQResourceAdapter Configuration
+:index-group: ActiveMQ
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A ActiveMQResourceAdapter can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Resource id="myActiveMQResourceAdapter" type="ActiveMQResourceAdapter">
+ brokerXmlConfig = broker:(tcp://localhost:61616)?useJmx=false
+ dataSource = Default Unmanaged JDBC Database
+ serverUrl = vm://localhost?waitForStart=20000&async=true
+ startupTimeout = 10 seconds
+</Resource>
+....
+
+Alternatively, a ActiveMQResourceAdapter can be declared via properties
+in the `<tomee-home>/conf/system.properties` file or via Java
+VirtualMachine `-D` properties. The properties can also be used when
+embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or
+`InitialContext`
+
+....
+myActiveMQResourceAdapter = new://Resource?type=ActiveMQResourceAdapter
+myActiveMQResourceAdapter.brokerXmlConfig = broker:(tcp://localhost:61616)?useJmx=false
+myActiveMQResourceAdapter.dataSource = Default Unmanaged JDBC Database
+myActiveMQResourceAdapter.serverUrl = vm://localhost?waitForStart=20000&async=true
+myActiveMQResourceAdapter.startupTimeout = 10 seconds
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared
+ActiveMQResourceAdapter a warning will be logged. If a
+ActiveMQResourceAdapter is needed by the application and one is not
+declared, TomEE will create one dynamically using default settings.
+Multiple ActiveMQResourceAdapter declarations are allowed.
+
+== Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+brokerXmlConfig
+
+String
+
+broker:(tcp://localhost:61616)?useJmx=false
+
+Broker configuration URI as defined by ActiveMQ see
+http://activemq.apache.org/broker-configuration-uri.html BrokerXmlConfig
+xbean:file:conf/activemq.xml - Requires xbean-spring.jar and
+dependencies
+
+dataSource
+
+String
+
+Default Unmanaged JDBC Database
+
+DataSource for persistence messages
+
+serverUrl
+
+java.net.URI
+
+vm://localhost?waitForStart=20000&async=true
+
+Broker address
+
+startupTimeout
+
+time
+
+10 seconds
+
+How long to wait for broker startup
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/activemqresourceadapter-config.md
----------------------------------------------------------------------
diff --git a/docs/activemqresourceadapter-config.md b/docs/activemqresourceadapter-config.md
deleted file mode 100644
index d709310..0000000
--- a/docs/activemqresourceadapter-config.md
+++ /dev/null
@@ -1,69 +0,0 @@
-index-group=ActiveMQ
-type=page
-status=published
-title=ActiveMQResourceAdapter Configuration
-~~~~~~
-
-
-A ActiveMQResourceAdapter can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Resource id="myActiveMQResourceAdapter" type="ActiveMQResourceAdapter">
- brokerXmlConfig = broker:(tcp://localhost:61616)?useJmx=false
- dataSource = Default Unmanaged JDBC Database
- serverUrl = vm://localhost?waitForStart=20000&async=true
- startupTimeout = 10 seconds
- </Resource>
-
-Alternatively, a ActiveMQResourceAdapter can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myActiveMQResourceAdapter = new://Resource?type=ActiveMQResourceAdapter
- myActiveMQResourceAdapter.brokerXmlConfig = broker:(tcp://localhost:61616)?useJmx=false
- myActiveMQResourceAdapter.dataSource = Default Unmanaged JDBC Database
- myActiveMQResourceAdapter.serverUrl = vm://localhost?waitForStart=20000&async=true
- myActiveMQResourceAdapter.startupTimeout = 10 seconds
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared ActiveMQResourceAdapter a warning will be logged. If a ActiveMQResourceAdapter is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple ActiveMQResourceAdapter declarations are allowed.
-
-## Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td>brokerXmlConfig</td>
- <td>String</td>
- <td>broker:(tcp://localhost:61616)?useJmx=false</td>
- <td>
-Broker configuration URI as defined by ActiveMQ
-see http://activemq.apache.org/broker-configuration-uri.html
-BrokerXmlConfig xbean:file:conf/activemq.xml - Requires xbean-spring.jar and dependencies
-</td>
-</tr>
-<tr>
- <td>dataSource</td>
- <td>String</td>
- <td>Default Unmanaged JDBC Database</td>
- <td>
-DataSource for persistence messages
-</td>
-</tr>
-<tr>
- <td>serverUrl</td>
- <td>java.net.URI</td>
- <td>vm://localhost?waitForStart=20000&async=true</td>
- <td>
-Broker address
-</td>
-</tr>
-<tr>
- <td>startupTimeout</td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>10 seconds</td>
- <td>
-How long to wait for broker startup
-</td>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/admin/cluster/index.adoc
----------------------------------------------------------------------
diff --git a/docs/admin/cluster/index.adoc b/docs/admin/cluster/index.adoc
index 9893c8f..a7cc4a7 100644
--- a/docs/admin/cluster/index.adoc
+++ b/docs/admin/cluster/index.adoc
@@ -1,3 +1,4 @@
+:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
:jbake-title: Clustering and High Availability (HA)
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/advanced/client/jndi.adoc
----------------------------------------------------------------------
diff --git a/docs/advanced/client/jndi.adoc b/docs/advanced/client/jndi.adoc
index 5f2e55b..3097e69 100644
--- a/docs/advanced/client/jndi.adoc
+++ b/docs/advanced/client/jndi.adoc
@@ -1,4 +1,5 @@
:jbake-title: Java Naming and Directory Interface (JNDI)
+:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/alternate-descriptors.adoc
----------------------------------------------------------------------
diff --git a/docs/alternate-descriptors.adoc b/docs/alternate-descriptors.adoc
new file mode 100644
index 0000000..8818a72
--- /dev/null
+++ b/docs/alternate-descriptors.adoc
@@ -0,0 +1,121 @@
+# Alternate Descriptors
+:index-group: Testing Techniques
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+As of OpenEJB 3.1.1, you have the
+ability to specify an alternate set of deployment descriptors to use for
+a given environment. This is focused mostly on testing where it is often
+desirable to use a slightly different configuration for a set of tests
+or even a specific test.
+
+== When nothing else does the trick
+
+Note that this approach was added as a catch-all for when one of the
+simpler overriding techniques will not work. For the common case of
+needing to tweak your persistence.xml, see the
+link:configuring-persistenceunits-in-tests.html[Configuring
+PersistenceUnits in Tests] page for a simpler approach.
+
+For many reasons it is very inconvenient to have to maintain two sets of
+descriptors, one for production and one for testing. We aggressively add
+features based on user feedback and questions. If you are looking for a
+way to solve a problem without duplicating entire descriptors, please
+let us know. You should never have to go the long way to do something
+simple.
+
+# openejb.altdd.prefix
+
+To use this functionality, just set the new "openejb.altdd.prefix"
+system property or `InitialContext` property to something like "_test_",
+then any descriptors in your META-INF/ directory that start with
+"_test._" will override the regular descriptor. So for example with an
+app like this:
+
+* META-INF/ejb-jar.xml
+* META-INF/_test_.ejb-jar.xml
+* META-INF/persistence.xml
+* META-INF/_test_.env-entry.properties
+
+Just initialize your test case like so:
+
+....
+ Properties properties = new Properties();
+ properties.setProperty(Context.INITIAL_CONTEXT_FACTORY,
+ "org.apache.openejb.client.LocalInitialContextFactory");
+ properties.setProperty("openejb.altdd.prefix", "test");
+
+ InitialContext initialContext = new InitialContext(properties);
+....
+
+The logical result will be the prefixed file replacing the non-prefixed
+file as the active descriptor:
+
+* META-INF/ejb-jar.xml -> _test_.ejb-jar.xml
+* META-INF/persistence.xml
+* META-INF/env-entry.properties -> _test_.env-entry.properties
+
+This will work in any environment in which OpenEJB works (embedded,
+standalone, tomcat, geronimo, etc.).
+
+Note that there does _not_ have to be an equivalent non-prefixed version
+of the file. In the example above, only a "test.env-entry.properties"
+file exists and there is no equivalent plain "env-entry.properties"
+file. This prefixing works for any deployment descriptor in the
+META-INF/ directory or WEB-INF/ directory. The prefix does not have to
+be "test" and could be anything you choose. You can also have as many
+prefixed files as you need and could even go as far as to have one
+prefix per individual test.
+
+# More than one prefix
+
+It is possible to have several prefixes, specified in order of
+preference, so that it is possible to avoid duplicating descriptors that
+are used in more than one "profile". For example, the "foo" test case
+uses the same "env-entries.properties" file as the "bar" test case, but
+both have their own ejb-jar.xml files:
+
+* META-INF/ejb-jar.xml
+* META-INF/test.ejb-jar.xml
+* META-INF/footest.ejb-jar.xml
+* META-INF/bartest.ejb-jar.xml
+* META-INF/persistence.xml
+* META-INF/test.env-entry.properties
+
+The "foo" test case could set the _openejb.altdd.prefix_ as follows:
+
+....
+ //...
+ properties.setProperty("openejb.altdd.prefix", "footest, test");
+
+ InitialContext initialContext = new InitialContext(properties);
+....
+
+Resulting the following logical view of the app:
+
+* META-INF/ejb-jar.xml -> _footest_.ejb-jar.xml
+* META-INF/persistence.xml
+* META-INF/env-entry.properties -> test.env-entry.properties
+
+And the "bar" test case could set the _openejb.altdd.prefix_ as follows:
+
+....
+ //...
+ properties.setProperty("openejb.altdd.prefix", "footest, test");
+
+ InitialContext initialContext = new InitialContext(properties);
+....
+
+Resulting the following logical view of the app:
+
+* META-INF/ejb-jar.xml -> _bartest_.ejb-jar.xml
+* META-INF/persistence.xml
+* META-INF/env-entry.properties -> test.env-entry.properties
+
+In both scenarios the same env-entry.properties file
+(test.env-entry.properties) is shared.
+
+Note that there is a "test.ejb-jar.xml" file that is present, however in
+both cases it is not used as the order of preference in the list is
+"left to right" meaning most preferred first.
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/alternate-descriptors.md
----------------------------------------------------------------------
diff --git a/docs/alternate-descriptors.md b/docs/alternate-descriptors.md
deleted file mode 100644
index 1eb52fe..0000000
--- a/docs/alternate-descriptors.md
+++ /dev/null
@@ -1,117 +0,0 @@
-index-group=Testing Techniques
-type=page
-status=published
-title=Alternate Descriptors
-~~~~~~
-As of OpenEJB 3.1.1, you have the ability to specify an alternate set of
-deployment descriptors to use for a given environment. This is focused
-mostly on testing where it is often desirable to use a slightly different
-configuration for a set of tests or even a specific test.
-
-# When nothing else does the trick
-
-Note that this approach was added as a catch-all for when one of the
-simpler overriding techniques will not work. For the common case of
-needing to tweak your persistence.xml, see the [Configuring PersistenceUnits in Tests](configuring-persistenceunits-in-tests.html)
- page for a simpler approach.
-
-For many reasons it is very inconvenient to have to maintain two sets of
-descriptors, one for production and one for testing. We aggressively add
-features based on user feedback and questions. If you are looking for a
-way to solve a problem without duplicating entire descriptors, please let
-us know. You should never have to go the long way to do something simple.
-
-<a name="AlternateDescriptors-openejb.altdd.prefix"></a>
-# openejb.altdd.prefix
-
-To use this functionality, just set the new "openejb.altdd.prefix" system
-property or `InitialContext` property to something like "_test_", then any
-descriptors in your META-INF/ directory that start with "_test._" will
-override the regular descriptor. So for example with an app like this:
-
- - META-INF/ejb-jar.xml
- - META-INF/*test*.ejb-jar.xml
- - META-INF/persistence.xml
- - META-INF/*test*.env-entry.properties
-
-Just initialize your test case like so:
-
-
- Properties properties = new Properties();
- properties.setProperty(Context.INITIAL_CONTEXT_FACTORY,
- "org.apache.openejb.client.LocalInitialContextFactory");
- properties.setProperty("openejb.altdd.prefix", "test");
-
- InitialContext initialContext = new InitialContext(properties);
-
-
-The logical result will be the prefixed file replacing the non-prefixed
-file as the active descriptor:
-
- - META-INF/ejb-jar.xml -> *test*.ejb-jar.xml
- - META-INF/persistence.xml
- - META-INF/env-entry.properties -> *test*.env-entry.properties
-
-This will work in any environment in which OpenEJB works (embedded,
-standalone, tomcat, geronimo, etc.).
-
-Note that there does *not* have to be an equivalent non-prefixed version of
-the file. In the example above, only a "test.env-entry.properties" file
-exists and there is no equivalent plain "env-entry.properties" file. This
-prefixing works for any deployment descriptor in the META-INF/ directory or
-WEB-INF/ directory. The prefix does not have to be "test" and could be
-anything you choose. You can also have as many prefixed files as you need
-and could even go as far as to have one prefix per individual test.
-
-<a name="AlternateDescriptors-Morethanoneprefix"></a>
-# More than one prefix
-
-It is possible to have several prefixes, specified in order of preference,
-so that it is possible to avoid duplicating descriptors that are used in
-more than one "profile". For example, the "foo" test case uses the same
-"env-entries.properties" file as the "bar" test case, but both have their
-own ejb-jar.xml files:
-
- - META-INF/ejb-jar.xml
- - META-INF/test.ejb-jar.xml
- - META-INF/footest.ejb-jar.xml
- - META-INF/bartest.ejb-jar.xml
- - META-INF/persistence.xml
- - META-INF/test.env-entry.properties
-
-The "foo" test case could set the _openejb.altdd.prefix_ as follows:
-
-
- //...
- properties.setProperty("openejb.altdd.prefix", "footest, test");
-
- InitialContext initialContext = new InitialContext(properties);
-
-
-Resulting the following logical view of the app:
-
- - META-INF/ejb-jar.xml -> *footest*.ejb-jar.xml
- - META-INF/persistence.xml
- - META-INF/env-entry.properties -> test.env-entry.properties
-
-And the "bar" test case could set the _openejb.altdd.prefix_ as follows:
-
-
- //...
- properties.setProperty("openejb.altdd.prefix", "footest, test");
-
- InitialContext initialContext = new InitialContext(properties);
-
-
-Resulting the following logical view of the app:
-
- - META-INF/ejb-jar.xml -> *bartest*.ejb-jar.xml
- - META-INF/persistence.xml
- - META-INF/env-entry.properties -> test.env-entry.properties
-
-In both scenarios the same env-entry.properties file
-(test.env-entry.properties) is shared.
-
-Note that there is a "test.ejb-jar.xml" file that is present, however in
-both cases it is not used as the order of preference in the list is "left
-to right" meaning most preferred first.
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/annotations,-xml-and-defaults.adoc
----------------------------------------------------------------------
diff --git a/docs/annotations,-xml-and-defaults.adoc b/docs/annotations,-xml-and-defaults.adoc
new file mode 100644
index 0000000..8849c9d
--- /dev/null
+++ b/docs/annotations,-xml-and-defaults.adoc
@@ -0,0 +1,20 @@
+# Annotations, XML and Defaults
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+....
+ <p>The following is a list of all annotations and their attributes, the xml tags that correspond to them (for overriding), and what the default values are when left unspecified.</p>
+....
+
+Annotation
+
+xml element(s)
+
+default value
+
+....
+ </div>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/annotations,-xml-and-defaults.md
----------------------------------------------------------------------
diff --git a/docs/annotations,-xml-and-defaults.md b/docs/annotations,-xml-and-defaults.md
deleted file mode 100644
index bd41890..0000000
--- a/docs/annotations,-xml-and-defaults.md
+++ /dev/null
@@ -1,569 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Annotations, XML and Defaults
-~~~~~~
-
-
-
-<div id="PageContent">
- <p>The following is a list of all annotations and their attributes, the xml tags that correspond to them (for overriding), and what the default values are when left unspecified.</p>
-
-<div >
-<table class="mdtable"> <tbody>
-<tr>
-<th > Annotation </th>
-<th > xml element(s) </th>
-<th > default value </th>
-</tr>
-<tr>
-<td "> @Stateless </td>
-<td "><ul>
- <li><session></li>
- <li><ejb-class></li>
- <li><session-type>Stateless</session-type></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>name</li>
-</ul>
-</td>
-<td "> <ejb-name> </td>
-<td "> The simple name of the bean class. For <em>org.acme.superfun.WidgetBean</em> the ejb-name will be <b>WidgetBean</b> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>description</li>
-</ul>
-</td>
-<td "> <description> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>mappedName</li>
-</ul>
-</td>
-<td "> <mapped-name> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @Stateful </td>
-<td "><ul>
- <li><session></li>
- <li><ejb-class></li>
- <li><session-type>Stateful</session-type></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>name</li>
-</ul>
-</td>
-<td "> <ejb-name> </td>
-<td "> The simple name of the bean class. For <em>org.acme.superfun.WidgetBean</em> the ejb-name will be <b>WidgetBean</b> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>description</li>
-</ul>
-</td>
-<td "> <description> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>mappedName</li>
-</ul>
-</td>
-<td "> <mapped-name> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @MessageDriven </td>
-<td "><ul>
- <li><message-driven></li>
- <li><ejb-class></li>
- <li><session-type>Stateful</session-type></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>name</li>
-</ul>
-</td>
-<td "> <ejb-name> </td>
-<td "> The simple name of the bean class. For <em>org.acme.superfun.WidgetBean</em> the ejb-name will be <b>WidgetBean</b> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>description</li>
-</ul>
-</td>
-<td "> <description> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>mappedName</li>
-</ul>
-</td>
-<td "> <mapped-name> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>messageListenerInterface</li>
-</ul>
-</td>
-<td "> <messaging-type> </td>
-<td "> The interface the bean class implements. When relying upon the default is illegal for the bean to implement more than one interface </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>activationConfig[]</li>
-</ul>
-</td>
-<td "> <activation-config> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @ActivationConfigProperty </td>
-<td "> <activation-config-property> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>propertyName</li>
-</ul>
-</td>
-<td "> <activation-config-property-name> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>propertyValue</li>
-</ul>
-</td>
-<td "> <activation-config-property-value> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @RemoteHome </td>
-<td "><ul>
- <li><home></li>
- <li><remote></li>
-</ul>
-</td>
-<td "> The home is inspected to determine the value of <remote></td>
-</tr>
-<tr>
-<td "> @LocalHome </td>
-<td "><ul>
- <li><local-home></li>
- <li><local></li>
-</ul>
-</td>
-<td "> The local-home is inspected to determine the value of <local> </td>
-</tr>
-<tr>
-<td "> @TransactionManagement </td>
-<td "> <transaction-type> </td>
-<td "> TransactionManagementType.CONTAINER (xml value "Container") </td>
-</tr>
-<tr>
-<td "> @TransactionAttribute </td>
-<td "><ul>
- <li><container-transaction></li>
- <li><transaction-attribute></li>
-</ul>
-</td>
-<td "> All method default to TransactionAttributeType.REQUIRED (xml value "Required") </td>
-</tr>
-<tr>
-<td "> @RolesAllowed </td>
-<td "><ul>
- <li><method-permission></li>
- <li><role-name></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @PermitAll </td>
-<td "><ul>
- <li><method-permission></li>
- <li><unchecked></li>
-</ul>
-</td>
-<td "> All methods default to unchecked </td>
-</tr>
-<tr>
-<td "> @DenyAll </td>
-<td "> <exclude-list> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @RunAs </td>
-<td "><ul>
- <li><security-identity></li>
- <li><run-as></li>
- <li><role-name></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @DeclareRoles </td>
-<td "> <security-role-ref> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @Interceptors </td>
-<td "><ul>
- <li><interceptor></li>
- <li><interceptor-binding></li>
- <li><interceptor-class></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @ExcludeDefaultInterceptors </td>
-<td "><ul>
- <li><interceptor-binding></li>
- <li><exclude-default-interceptors></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @ExcludeClassInterceptors </td>
-<td "><ul>
- <li><interceptor-binding></li>
- <li><exclude-class-interceptors></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @AroundInvoke </td>
-<td "> <around-invoke> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @PostConstruct </td>
-<td "> <post-construct> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @PreDestroy </td>
-<td "> <pre-destroy> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @PrePassivate </td>
-<td "> <pre-passivate> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @PostActivate </td>
-<td "> <post-activate> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @Init </td>
-<td "> <init-method> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @Remove </td>
-<td "> <remove-method> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>retainIfException</li>
-</ul>
-</td>
-<td "> <retain-if-exception> </td>
-<td "> false </td>
-</tr>
-<tr>
-<td "> @Timeout </td>
-<td "> <timeout-method> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @ApplicationException </td>
-<td "><ul>
- <li><application-exception></li>
- <li><exception-class></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>rollback</li>
-</ul>
-</td>
-<td "> <rollback> </td>
-<td "> false </td>
-</tr>
-<tr>
-<td "> @EJB </td>
-<td "><ul>
- <li><ejb-ref></li>
- <li><ejb-local-ref></li>
- <li><injection-target></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>name</li>
-</ul>
-</td>
-<td "><ul>
- <li><ejb-ref-name></li>
-</ul>
-</td>
-<td "><ul>
- <li>on class: illegal to leave undefined</li>
- <li>on field: {className}/{fieldName} as in <b>org.superbiz.Widget/myEjb</b></li>
- <li>on setter: {className}/{propertyName} as in setMyEjb() defaults to <b>org.superbiz.Widget/myEjb</b></li>
-</ul>
-</td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>beanInterface</li>
-</ul>
-</td>
-<td "><ul>
- <li><home></li>
- <li><local-home></li>
- <li><remote></li>
- <li><local></li>
-</ul>
-</td>
-<td "><ul>
- <li>on class: illegal to leave undefined</li>
- <li>on field: the data type of the field</li>
- <li>on setter: the data type of the first method param</li>
-</ul>
-</td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>beanName</li>
-</ul>
-</td>
-<td "> <ejb-link> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>description</li>
-</ul>
-</td>
-<td "> <description> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>mappedName</li>
-</ul>
-</td>
-<td "> <mapped-name> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @Resource </td>
-<td "><ul>
- <li><env-entry></li>
- <li><resource-ref></li>
- <li><resource-env-ref></li>
- <li><injection-target></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>name</li>
-</ul>
-</td>
-<td "><ul>
- <li><env-entry-name></li>
- <li><res-ref-name></li>
- <li><resource-env-ref-name></li>
-</ul>
-</td>
-<td "><ul>
- <li>on class: illegal to leave undefined</li>
- <li>on field: {className}/{fieldName} as in <b>org.superbiz.Widget/myDataSource</b></li>
- <li>on setter: {className}/{propertyName} as in setMyDataSource() defaults to <b>org.superbiz.Widget/myDataSource</b></li>
-</ul>
-</td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>type</li>
-</ul>
-</td>
-<td "><ul>
- <li><env-entry-type></li>
- <li><res-type></li>
- <li><resource-env-ref-type></li>
-</ul>
-</td>
-<td "><ul>
- <li>on class: illegal to leave undefined</li>
- <li>on field: the data type of the field</li>
- <li>on setter: the data type of the first method param</li>
-</ul>
-</td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>description</li>
-</ul>
-</td>
-<td "> <description> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>mappedName</li>
-</ul>
-</td>
-<td "> <mapped-name> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>shareable</li>
-</ul>
-</td>
-<td "> <res-sharing-scope> </td>
-<td "> true (xml value "Shareable") </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>authenticationType</li>
-</ul>
-</td>
-<td "> <res-auth> </td>
-<td "> AuthenticationType.CONTAINER (xml value "Container") </td>
-</tr>
-<tr>
-<td "> @PersistenceUnit </td>
-<td "><ul>
- <li><persistence-unit-ref></li>
- <li><injection-target></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>name</li>
-</ul>
-</td>
-<td "> <persistence-unit-ref-name> </td>
-<td ">on class: illegal to leave undefined
-<ul>
- <li>on field: {className}/{fieldName} as in <b>org.superbiz.Widget/myUnit</b></li>
- <li>on setter: {className}/{propertyName} as in setMyUnit() defaults to <b>org.superbiz.Widget/myUnit</b></li>
-</ul>
-</td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>unitName</li>
-</ul>
-</td>
-<td "> <persistence-unit-name> </td>
-<td "> vendor specific </td>
-</tr>
-<tr>
-<td "> @PersistenceContext </td>
-<td "><ul>
- <li><persistence-context-ref></li>
- <li><injection-target></li>
-</ul>
-</td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>name</li>
-</ul>
-</td>
-<td "> <persistence-context-ref-name> </td>
-<td ">on class: illegal to leave undefined
-<ul>
- <li>on field: {className}/{fieldName} as in <b>org.superbiz.Widget/myContext</b></li>
- <li>on setter: {className}/{propertyName} as in setMyContext() defaults to <b>org.superbiz.Widget/myContext</b></li>
-</ul>
-</td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>unitName</li>
-</ul>
-</td>
-<td "> <persistence-unit-name> </td>
-<td "> vendor specific </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>type</li>
-</ul>
-</td>
-<td "> <persistence-context-type> </td>
-<td "> PersistenceContextType.TRANSACTION (xml value "Transaction") </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>properties[]</li>
-</ul>
-</td>
-<td "> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "> @PersistenceProperty </td>
-<td "> <persistence-property> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>name</li>
-</ul>
-</td>
-<td "> <name> </td>
-<td "> </td>
-</tr>
-<tr>
-<td "><ul type="square" class="alternate">
- <li>value</li>
-</ul>
-</td>
-<td "> <value> </td>
-<td "> </td>
-</tr>
-</tbody></table>
-</div>
-
- </div>
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/app-clients-and-jndi.adoc
----------------------------------------------------------------------
diff --git a/docs/app-clients-and-jndi.adoc b/docs/app-clients-and-jndi.adoc
new file mode 100644
index 0000000..dee6ebb
--- /dev/null
+++ b/docs/app-clients-and-jndi.adoc
@@ -0,0 +1,74 @@
+# App Clients and JNDI
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+There are some slight differences between the way OpenEJB
+does app clients and the way Geronimo does app clients
+
+Neither uses the names created via the openejb.jndiname.format. So
+changing that will (should) have no affect. The idea is that users
+should be able to set it to be whatever they want it to be and that
+should not break the App Client code. The openejb.jndiname.format is
+specifically for "plain" clients and allows them to get the names as
+they want them.
+
+Internally, we bind each EJB proxy under essentially a hardcoded and
+predictable format and then again using the user supplied format. So
+there are at minimum two JNDI trees with every EJB proxy. It used to be
+two at least. Now we have quite a few because of Java EE 6 global JNDI
+and the support we added for @LocalClient and allowing the same
+interface to be used as both @Local and @Remote.
+
+Basically we have:
+
+* openejb/Deployment/<hardcoded internal format>
+* openejb/local/<strategy format>
+* openejb/remote/<strategy format>
+
+The 'openejb/Deployment' section is the non-changing fully qualified
+name for use internally and by app clients.
+
+The 'openejb/remote' section is for "pretty" names looked up via plain
+clients using the RemoteInitialContextFactory. The protocol can tell
+the difference between app clients and plain clients and knows which
+area to look in.
+
+The 'openejb/local' section is for "pretty" names looked up via the
+LocalInitialContextFactory.
+
+The "pretty" names are defined by the openejb.jndiname.format and since
+the user has control of that formatting it's possible that not all
+proxies can be bound. Say the bean has both a local and remote
+interface and the user has just "\{deploymentId}" or "\{ejbName}" as the
+format. Hence those bind calls use the "optional" set of binding
+methods.
+
+The format of the internal names bound into openejb/Deployment is
+guaranteed to be unique. It's not pretty to look at obviously, but
+every possible proxy will be bound there guaranteed. For binding into
+'openejb/Deployment' we don't use the "optional" set of binding methods.
+ If something can't be bound it's a deployment issue.
+
+The home interface is bound, but with the name of the corresponding
+business interface rather than the home interface.
+
+To be a little bit more clear - Both OpenEJB and Geronimo build their
+own JNDI trees for the App Client. Geronimo prefers to have its own
+JNDI tree for the App Client as there are other things in it that are
+not EJB related. Either way the OpenEJB EJBd protocol can carry the
+"id" of the App Client and both Geronimo and OpenEJB rely on that.
+
+In Geronimo App Clients the id is set to "Deployments" and that tells
+OpenEJB not to look in the "openejb/remote" section of JNDI as it
+normally would. It will instead use the "openejb/Deployments" section
+of JNDI were the names follow a predictable and unchanging format.
+
+In OpenEJB App Clients the id is set to the name of the App Client and
+we instead look in "openejb/client//" where names are formatted by the
+user via the application-client.xml.
+
+When calls are made from client to server and the App Client module id
+is not present, we look in openejb/remote/ where names are formatted
+using the openejb.jndi.format
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/app-clients-and-jndi.md
----------------------------------------------------------------------
diff --git a/docs/app-clients-and-jndi.md b/docs/app-clients-and-jndi.md
deleted file mode 100644
index b6faaaa..0000000
--- a/docs/app-clients-and-jndi.md
+++ /dev/null
@@ -1,73 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=App Clients and JNDI
-~~~~~~
-There are some slight differences between the way OpenEJB does app clients
-and the way Geronimo does app clients
-
-
-Neither uses the names created via the openejb.jndiname.format. So
-changing that will (should) have no affect. The idea is that users
-should be able to set it to be whatever they want it to be and that should
-not break the App Client code. The openejb.jndiname.format is
-specifically for "plain" clients and allows them to get the names as they
-want them.
-
-Internally, we bind each EJB proxy under essentially a hardcoded and
-predictable format and then again using the user supplied format. So
-there are at minimum two JNDI trees with every EJB proxy. It used to
-be two at least. Now we have quite a few because of Java EE 6 global
-JNDI and the support we added for @LocalClient and allowing the same
-interface to be used as both @Local and @Remote.
-
-Basically we have:
-
-* openejb/Deployment/<hardcoded internal format>
-* openejb/local/<strategy format>
-* openejb/remote/<strategy format>
-
-The 'openejb/Deployment' section is the non-changing fully qualified name
-for use internally and by app clients.
-
-The 'openejb/remote' section is for "pretty" names looked up via plain
-clients using the RemoteInitialContextFactory. The protocol can tell
-the difference between app clients and plain clients and knows which area
-to look in.
-
-The 'openejb/local' section is for "pretty" names looked up via the
-LocalInitialContextFactory.
-
-The "pretty" names are defined by the openejb.jndiname.format and since the
-user has control of that formatting it's possible that not all proxies can
-be bound. Say the bean has both a local and remote interface and the
-user has just "\{deploymentId\}" or "\{ejbName\}" as the format.
- Hence those bind calls use the "optional" set of binding methods.
-
-The format of the internal names bound into openejb/Deployment is
-guaranteed to be unique. It's not pretty to look at obviously, but
-every possible proxy will be bound there guaranteed. For binding into
-'openejb/Deployment' we don't use the "optional" set of binding methods.
- If something can't be bound it's a deployment issue.
-
-The home interface is bound, but with the name of the corresponding
-business interface rather than the home interface.
-
-To be a little bit more clear - Both OpenEJB and Geronimo build their
-own JNDI trees for the App Client. Geronimo prefers to have its own
-JNDI tree for the App Client as there are other things in it that are not
-EJB related. Either way the OpenEJB EJBd protocol can carry the "id"
-of the App Client and both Geronimo and OpenEJB rely on that.
-
-In Geronimo App Clients the id is set to "Deployments" and that tells
-OpenEJB not to look in the "openejb/remote" section of JNDI as it normally
-would. It will instead use the "openejb/Deployments" section of JNDI
-were the names follow a predictable and unchanging format.
-
-In OpenEJB App Clients the id is set to the name of the App Client and we
-instead look in "openejb/client/<id>/" where names are formatted by the
-user via the application-client.xml.
-
-When calls are made from client to server and the App Client module id is
-not present, we look in openejb/remote/ where names are formatted using the
-openejb.jndi.format
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-composer/advanced.adoc
----------------------------------------------------------------------
diff --git a/docs/application-composer/advanced.adoc b/docs/application-composer/advanced.adoc
new file mode 100644
index 0000000..1ce9b66
--- /dev/null
+++ b/docs/application-composer/advanced.adoc
@@ -0,0 +1,107 @@
+== Application Composer Advanced
+
+link:getting-started.html[Getting Started] page gives you already a lot
+of inputs but you caneven go further.
+
+=== @Descriptors
+
+You can reuse existing file descriptors using `@Descriptors`. The name
+is the file name and the path either a classpath path or a file path:
+
+....
+// runner if needed etc...
+@Descriptors(@Descriptor(name = "persistence.xml", path = "META-INF/persistence.xml"))
+public class MyTest {
+ //...
+}
+....
+
+Note: this can be put in a `@Module` method as well.
+
+=== Services
+
+If you want to test a JAXRS or JAXWS service you need to activate these
+services.
+
+To do so just add the needed dependency and use `@EnableServices`:
+
+....
+// runner if needed etc...
+@EnableService("jaxrs") // jaxws supported as well
+public class MyTest {
+ //...
+}
+....
+
+=== Random port
+
+Services like JAXRS and JAXWS relies on HTTP. Often it is nice to have a
+random port to be able to deploy multiple tests/projects on the same CI
+platform at the same time.
+
+To shortcut all the needed logic you can use `@RandomPort`. It is simply
+an injection giving you either the port (`int`) or the root context
+(`URL`):
+
+....
+// runner, services if needed etc...
+public class MyTest {
+ @RandomPort("http")
+ private int port;
+}
+....
+
+Note: you can generate this way multiple ports. The value is the name of
+the service it will apply on (being said http is an alias for httpejbd
+which is our embedded http layer).
+
+=== Nice logs
+
+`@SimpleLog` annotation allows you to have one liner logs
+
+=== @JaxrsProvider
+
+`@JaxrsProvider` allows you to specify on a `@Module` method the list of
+JAXRS provider you want to use.
+
+=== Dependencies without hacky code
+
+`@Jars` allows you to add dependencies (scanned) to your application
+automatically (like CDI libraries):
+
+....
+@Module
+@Classes(cdi = true, value = { C1.class, C2.class, E1.class })
+@Jars("deltaspike-")
+public WebApp app() {
+ return new WebApp();
+}
+....
+
+=== @Default
+
+`@Default` automatically adds in the application `target/classes` as
+binaries and `src/main/webapp` as resources for maven projects.
+
+=== @CdiExtensions
+
+This annotation allows you to control which extensions are activated
+during the test.
+
+=== @AppResource
+
+This annotation allows injection of few particular test resources like:
+
+* the test `AppModule` (application meta)
+* the test `Context` (JNDI)
+* the test `ApplicationComposers` (underlying runner)
+* `ContextProvider`: allow to mock JAXRS contexts
+
+=== @MockInjector
+
+Allows to mock EJB injections. It decorates a dedicated method returning
+an instance (or Class) implementing `FallbackPropertyInjector`.
+
+=== @WebResource
+
+Allow for web application to add folders containing web resources.
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-composer/advanced.md
----------------------------------------------------------------------
diff --git a/docs/application-composer/advanced.md b/docs/application-composer/advanced.md
deleted file mode 100644
index 15c643d..0000000
--- a/docs/application-composer/advanced.md
+++ /dev/null
@@ -1,90 +0,0 @@
-# Application Composer Advanced
-
-[Getting Started](getting-started.html) page gives you already a lot of inputs but you caneven go further.
-
-## @Descriptors
-
-You can reuse existing file descriptors using `@Descriptors`. The name is the file name
-and the path either a classpath path or a file path:
-
- // runner if needed etc...
- @Descriptors(@Descriptor(name = "persistence.xml", path = "META-INF/persistence.xml"))
- public class MyTest {
- //...
- }
-
-Note: this can be put in a `@Module` method as well.
-
-## Services
-
-If you want to test a JAXRS or JAXWS service you need to activate these services.
-
-To do so just add the needed dependency and use `@EnableServices`:
-
- // runner if needed etc...
- @EnableService("jaxrs") // jaxws supported as well
- public class MyTest {
- //...
- }
-
-## Random port
-
-Services like JAXRS and JAXWS relies on HTTP. Often it is nice to have a random port
-to be able to deploy multiple tests/projects on the same CI platform at the same time.
-
-To shortcut all the needed logic you can use `@RandomPort`. It is simply an injection giving
-you either the port (`int`) or the root context (`URL`):
-
- // runner, services if needed etc...
- public class MyTest {
- @RandomPort("http")
- private int port;
- }
-
-Note: you can generate this way multiple ports. The value is the name of the service it will apply on (being said http
-is an alias for httpejbd which is our embedded http layer).
-
-## Nice logs
-
-`@SimpleLog` annotation allows you to have one liner logs
-
-## @JaxrsProvider
-
-`@JaxrsProvider` allows you to specify on a `@Module` method the list of JAXRS provider you want to use.
-
-## Dependencies without hacky code
-
-`@Jars` allows you to add dependencies (scanned) to your application automatically (like CDI libraries):
-
- @Module
- @Classes(cdi = true, value = { C1.class, C2.class, E1.class })
- @Jars("deltaspike-")
- public WebApp app() {
- return new WebApp();
- }
-
-## @Default
-
-`@Default` automatically adds in the application `target/classes` as binaries and `src/main/webapp` as resources for maven projects.
-
-## @CdiExtensions
-
-This annotation allows you to control which extensions are activated during the test.
-
-## @AppResource
-
-This annotation allows injection of few particular test resources like:
-
-* the test `AppModule` (application meta)
-* the test `Context` (JNDI)
-* the test `ApplicationComposers` (underlying runner)
-* `ContextProvider`: allow to mock JAXRS contexts
-
-## @MockInjector
-
-Allows to mock EJB injections. It decorates a dedicated method returning an instance (or Class) implementing `FallbackPropertyInjector`.
-
-## @WebResource
-
-Allow for web application to add folders containing web resources.
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-composer/getting-started.adoc
----------------------------------------------------------------------
diff --git a/docs/application-composer/getting-started.adoc b/docs/application-composer/getting-started.adoc
new file mode 100644
index 0000000..9465c97
--- /dev/null
+++ b/docs/application-composer/getting-started.adoc
@@ -0,0 +1,225 @@
+== Application Composer Getting Started
+
+ApplicationComposer API is mainly contained in
+`org.apache.openejb.testing` package (historically, today we would have
+called the package `org.apache.tomee.applicationcomposer`).
+
+=== Dependencies
+
+To start using ApplicationComposer you need to add some dependencies.
+
+The minimum required one is `openejb-core`:
+
+....
+<dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>openejb-core</artifactId>
+ <version>${openejb.version></version>
+</dependency>
+....
+
+If you need JAXRS services you'll add (or replace thanks to transitivity
+of maven) `openejb-cxf-rs`:
+
+....
+<dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>openejb-cxf-rs</artifactId>
+ <version>${openejb.version></version>
+</dependency>
+....
+
+If you need JAXWS services you'll add (or replace thanks to transitivity
+of maven) `openejb-cxf`:
+
+....
+<dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>openejb-cxf</artifactId>
+ <version>${openejb.version></version>
+</dependency>
+....
+
+etc...
+
+=== ApplicationComposer Components
+
+==== @Module
+
+An ApplicationComposer needs at minimum a module (the application you
+need to deploy).
+
+To do so you have two cases:
+
+* before TomEE 2.x: you can only write method(s) decorated with
+`@Module`
+* since TomEE 2.x: you can skip it and use `@Classes` directly on the
+ApplicationComposer class as a shortcut for:
++
+@Module public WebApp app() \{ return new WebApp(); }
+
+The expected returned type of these methods are in
+`org.apache.openejb.jee` package:
+
+* `Application`: entry point to create an ear
+* `WebApp`: a web application
+* `EjbJar`: an ejb module
+* `EnterpriseBean` children: a simple EJB
+* `Persistence`: a persistence module with multiple units
+* `PersistenceUnit`: a simple unit (automatically wrapped in a
+`Persistence`)
+* `Connector`: a JCA connector module
+* `Beans`: a CDI module,
+* `Class[]` or `Class`: a set of classes scanned to discover annotations
+
+Note that for easiness `@Classes` was added to be able to describe a
+module and some scanned classes. For instance the following snippet will
+create a web application with classes C1, C2 as CDI beans and E1 as an
+EJB automatically:
+
+....
+@Module
+@Classes(cdi = true, value = { C1.class, C2.class, E1.class })
+public WebApp app() {
+ return new WebApp();
+}
+....
+
+==== @Configuration
+
+Often you need to customize a bit the container or at least create some
+resources like test databases. To do so you can create a method
+returning `Properties` which will be the container properties.
+
+Note: to simplify writing properties you can use `PropertiesBuilder`
+util class which is just a fluent API to write properties.
+
+In these properties you can reuse OpenEJB/TomEE property syntax for
+resources.
+
+Here is a sample:
+
+....
+@Configuration
+public Properties configuration() {
+ return new PropertiesBuilder()
+ .p("db", "new://Resource?type=DataSource")
+ .p("db.JdbcUrld", "jdbc:hsqldb:mem:test")
+ .build();
+}
+....
+
+Since TomEE 2.x you can also put properties on ApplicationComposer class
+using `@ContainerProperties` API:
+
+....
+@ContainerProperties({
+ @ContainerProperties.Property(name = "db", value = "new://Resource?type=DataSource"),
+ @ContainerProperties.Property(name = "db.JdbcUrl", value = "jdbc:hsqldb:mem:test")
+})
+public class MyAppComposer() {
+ // ...
+}
+....
+
+==== @Component
+
+Sometimes you need to customize a container component. The most common
+use case is the security service to mock a little bit authorization if
+you don't care in your test.
+
+To do so just write a method decorated with `@Component` returning the
+instance you desire.
+
+Components in TomEE are stored in a container Map and the key needs to
+be a `Class`. This one is deduced from the returned type of the
+`@Component` method:
+
+....
+@Component
+public SecurityService mockSecurity() {
+ return new MySecurityService();
+}
+....
+
+=== How to run it?
+
+==== JUnit
+
+If you use JUnit you have mainly 2 solutions to run you "model" using
+the ApplicationComposer:
+
+* using `ApplicationComposer` runner:
++
+@RunWith(ApplicationComposer.class) public class MyTest \{ // ... }
+* using `ApplicationComposerRule` rule:
++
+public class MyTest \{ @Rule // or @ClassRule if you want the
+container/application lifecycle be bound to the class and not test
+methods public final ApplicationComposerRule rule = new
+ApplicationComposerRule(this); }
+
+Tip: since TomEE 2.x ApplicationComposerRule is decomposed in 2 rules if
+you need: `ContainerRule` and `DeployApplication`. Using JUnit
+`RuleChain` you can chain them to get the samebehavior as
+`ApplicationComposerRule` or better deploy multiple ApplicationComposer
+models and controlling their deployment ordering (to mock a remote
+service for instance).
+
+Finally just write `@Test` method using test class injections as if the
+test class was a managed bean!
+
+==== TestNG
+
+TestNG integration is quite simple today and mainly
+`ApplicationComposerListener` class you can configure as a listener to
+get ApplicationComposer features.
+
+Finally just write TestNG `@Test` method using test class injections as
+if the test class was a managed bean!
+
+==== Standalone
+
+Since TomEE 2.x you can also use `ApplicationComposers` to directly run
+you ApplicationComposer model as a standalone application:
+
+....
+public class MyApp {
+ public static void main(String[] args) {
+ ApplicationComposers.run(MyApp.class, args);
+ }
+
+ // @Module, @Configuration etc...
+}
+....
+
+Tip: if `MyApp` has `@PostConstruct` methods they will be respected and
+if `MyApp` has a constructor taking an array of String it will be
+instantiated getting the second parameter as argument (ie you can
+propagate your main parameter to your model to modify your application
+depending it!)
+
+=== JUnit Sample
+
+....
+@Classes(cdi = true, value = { MyService.class, MyOtherService.class })
+@ContainerProperties(@ContainerProperties.Property(name = "myDb", value = "new://Resource?type=DataSource"))
+@RunWith(ApplicationComposer.class)
+public class MyTest {
+ @Resource(name = "myDb")
+ private DataSource ds;
+
+ @Inject
+ private MyService service;
+
+ @Test
+ public void myTest() {
+ // do test using injections
+ }
+}
+....
+
+=== Going further
+
+If you want to learn more about ApplicationComposer see
+link:advanced.html[Advanced] page.
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-composer/getting-started.md
----------------------------------------------------------------------
diff --git a/docs/application-composer/getting-started.md b/docs/application-composer/getting-started.md
deleted file mode 100644
index 13ab248..0000000
--- a/docs/application-composer/getting-started.md
+++ /dev/null
@@ -1,188 +0,0 @@
-# Application Composer Getting Started
-
-ApplicationComposer API is mainly contained in `org.apache.openejb.testing` package
-(historically, today we would have called the package `org.apache.tomee.applicationcomposer`).
-
-## Dependencies
-
-To start using ApplicationComposer you need to add some dependencies.
-
-The minimum required one is `openejb-core`:
-
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>openejb-core</artifactId>
- <version>${openejb.version></version>
- </dependency>
-
-If you need JAXRS services you'll add (or replace thanks to transitivity of maven) `openejb-cxf-rs`:
-
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>openejb-cxf-rs</artifactId>
- <version>${openejb.version></version>
- </dependency>
-
-If you need JAXWS services you'll add (or replace thanks to transitivity of maven) `openejb-cxf`:
-
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>openejb-cxf</artifactId>
- <version>${openejb.version></version>
- </dependency>
-
-etc...
-
-## ApplicationComposer Components
-
-### @Module
-
-An ApplicationComposer needs at minimum a module (the application you need to deploy).
-
-To do so you have two cases:
-
-* before TomEE 2.x: you can only write method(s) decorated with `@Module`
-* since TomEE 2.x: you can skip it and use `@Classes` directly on the ApplicationComposer class as a shortcut for:
-
- @Module
- public WebApp app() {
- return new WebApp();
- }
-
-The expected returned type of these methods are in `org.apache.openejb.jee` package:
-
-* `Application`: entry point to create an ear
-* `WebApp`: a web application
-* `EjbJar`: an ejb module
-* `EnterpriseBean` children: a simple EJB
-* `Persistence`: a persistence module with multiple units
-* `PersistenceUnit`: a simple unit (automatically wrapped in a `Persistence`)
-* `Connector`: a JCA connector module
-* `Beans`: a CDI module,
-* `Class[]` or `Class`: a set of classes scanned to discover annotations
-
-Note that for easiness `@Classes` was added to be able to describe a module and some scanned classes. For instance the
-following snippet will create a web application with classes C1, C2 as CDI beans and E1 as an EJB automatically:
-
- @Module
- @Classes(cdi = true, value = { C1.class, C2.class, E1.class })
- public WebApp app() {
- return new WebApp();
- }
-
-### @Configuration
-
-Often you need to customize a bit the container or at least create some resources like test databases.
-To do so you can create a method returning `Properties` which will be the container properties.
-
-Note: to simplify writing properties you can use `PropertiesBuilder` util class which is just a fluent API
-to write properties.
-
-In these properties you can reuse OpenEJB/TomEE property syntax for resources.
-
-Here is a sample:
-
- @Configuration
- public Properties configuration() {
- return new PropertiesBuilder()
- .p("db", "new://Resource?type=DataSource")
- .p("db.JdbcUrld", "jdbc:hsqldb:mem:test")
- .build();
- }
-
-Since TomEE 2.x you can also put properties on ApplicationComposer class using `@ContainerProperties` API:
-
- @ContainerProperties({
- @ContainerProperties.Property(name = "db", value = "new://Resource?type=DataSource"),
- @ContainerProperties.Property(name = "db.JdbcUrl", value = "jdbc:hsqldb:mem:test")
- })
- public class MyAppComposer() {
- // ...
- }
-
-### @Component
-
-Sometimes you need to customize a container component. The most common use case is the security service
-to mock a little bit authorization if you don't care in your test.
-
-To do so just write a method decorated with `@Component` returning the instance you desire.
-
-Components in TomEE are stored in a container Map and the key needs to be a `Class`. This one is deduced from the returned
-type of the `@Component` method:
-
- @Component
- public SecurityService mockSecurity() {
- return new MySecurityService();
- }
-
-## How to run it?
-
-### JUnit
-
-If you use JUnit you have mainly 2 solutions to run you "model" using the ApplicationComposer:
-
-* using `ApplicationComposer` runner:
-
- @RunWith(ApplicationComposer.class)
- public class MyTest {
- // ...
- }
-
-* using `ApplicationComposerRule` rule:
-
- public class MyTest {
- @Rule // or @ClassRule if you want the container/application lifecycle be bound to the class and not test methods
- public final ApplicationComposerRule rule = new ApplicationComposerRule(this);
- }
-
-Tip: since TomEE 2.x ApplicationComposerRule is decomposed in 2 rules if you need: `ContainerRule` and `DeployApplication`.
-Using JUnit `RuleChain` you can chain them to get the samebehavior as `ApplicationComposerRule` or better deploy
-multiple ApplicationComposer models and controlling their deployment ordering (to mock a remote service for instance).
-
-Finally just write `@Test` method using test class injections as if the test class was a managed bean!
-
-### TestNG
-
-TestNG integration is quite simple today and mainly `ApplicationComposerListener` class you can configure
-as a listener to get ApplicationComposer features.
-
-Finally just write TestNG `@Test` method using test class injections as if the test class was a managed bean!
-
-### Standalone
-
-Since TomEE 2.x you can also use `ApplicationComposers` to directly run you ApplicationComposer model
-as a standalone application:
-
- public class MyApp {
- public static void main(String[] args) {
- ApplicationComposers.run(MyApp.class, args);
- }
-
- // @Module, @Configuration etc...
- }
-
-Tip: if `MyApp` has `@PostConstruct` methods they will be respected and if `MyApp` has a constructor taking an array
-of String it will be instantiated getting the second parameter as argument (ie you can propagate your main parameter
-to your model to modify your application depending it!)
-
-## JUnit Sample
-
- @Classes(cdi = true, value = { MyService.class, MyOtherService.class })
- @ContainerProperties(@ContainerProperties.Property(name = "myDb", value = "new://Resource?type=DataSource"))
- @RunWith(ApplicationComposer.class)
- public class MyTest {
- @Resource(name = "myDb")
- private DataSource ds;
-
- @Inject
- private MyService service;
-
- @Test
- public void myTest() {
- // do test using injections
- }
- }
-
-## Going further
-
-If you want to learn more about ApplicationComposer see [Advanced](advanced.html) page.
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-composer/history.adoc
----------------------------------------------------------------------
diff --git a/docs/application-composer/history.adoc b/docs/application-composer/history.adoc
new file mode 100644
index 0000000..d33eb23
--- /dev/null
+++ b/docs/application-composer/history.adoc
@@ -0,0 +1,48 @@
+== Application Composer History
+
+ApplicationComposer can look like a long story but following it you'll
+realize it is finally quite natural.
+
+=== Internal tool
+
+TomEE (former OpenEJB) is an Application Server. One of the most
+important task writing an Application Server is to ensure the
+implemented features do what is expected. However it is hard to write N
+test applications, in N modules to ensure it works smoothly. In
+particular when you want to test a small part of the whole server.
+
+So you immediately think to mocking what is not needed. It works but has
+a big pitfall: test is often a noop or hide a lot of issues.
+
+So the idea came to be able to shortcut the part we don't care much
+about runtime: the application packaging.
+
+Here what is the ApplicationComposer: an (originally test) API to create
+a EE application programmatically.
+
+=== Designs
+
+ApplicationComposer design was aligned on this simple need. An
+ApplicationComposer "test" (browsing other pages you'll see it is much
+more than test today) is composed of mainly 2 parts:
+
+* modules: methods describing a module of an application. It can be a
+persistence.xml, an ejb-jar.xml, a web.xml...but all programmatically.
+* configuration: container configuration allowing to interact with
+container (creating resources for instance)
+
+=== Test but not only
+
+ApplicationComposer was originally a JUnit only runner but was pretty
+quickly extended to TestNG too and today you can even use it to write
+`main(String[])` - even in a shade!
+
+API was greatly simplified and it allows you pretty easily to deploy
+with a simple shade a JAXRS/JAXWS/JMS service!
+
+=== Going further
+
+If you want to go further you can browse:
+
+* link:getting-started.html[Getting Started]
+* link:advanced.html[Advanced]
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-composer/history.md
----------------------------------------------------------------------
diff --git a/docs/application-composer/history.md b/docs/application-composer/history.md
deleted file mode 100644
index 3deb828..0000000
--- a/docs/application-composer/history.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# Application Composer History
-
-ApplicationComposer can look like a long story but following it you'll realize it is finally quite natural.
-
-## Internal tool
-
-TomEE (former OpenEJB) is an Application Server. One of the most important task writing an Application Server
-is to ensure the implemented features do what is expected. However it is hard to write N test applications, in N modules
-to ensure it works smoothly. In particular when you want to test a small part of the whole server.
-
-So you immediately think to mocking what is not needed. It works but has a big pitfall: test is often a noop or hide
-a lot of issues.
-
-So the idea came to be able to shortcut the part we don't care much about runtime: the application packaging.
-
-Here what is the ApplicationComposer: an (originally test) API to create a EE application programmatically.
-
-## Designs
-
-ApplicationComposer design was aligned on this simple need. An ApplicationComposer "test" (browsing other pages you'll see
-it is much more than test today) is composed of mainly 2 parts:
-
-* modules: methods describing a module of an application. It can be a persistence.xml, an ejb-jar.xml, a web.xml...but all programmatically.
-* configuration: container configuration allowing to interact with container (creating resources for instance)
-
-## Test but not only
-
-ApplicationComposer was originally a JUnit only runner but was pretty quickly extended to TestNG too and
-today you can even use it to write `main(String[])` - even in a shade!
-
-API was greatly simplified and it allows you pretty easily to deploy with a simple shade a JAXRS/JAXWS/JMS service!
-
-## Going further
-
-If you want to go further you can browse:
-
-* [Getting Started](getting-started.html)
-* [Advanced](advanced.html)
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-composer/index.adoc
----------------------------------------------------------------------
diff --git a/docs/application-composer/index.adoc b/docs/application-composer/index.adoc
new file mode 100644
index 0000000..1eea036
--- /dev/null
+++ b/docs/application-composer/index.adoc
@@ -0,0 +1,20 @@
+== Application Composer
+
+Here is the subdomain dedicated to the Application Composer.
+
+If you don't know at all what ApplicationComposer means,
+link:history.html[History] page will explain you where does it come from
+and what it can be used to today.
+
+If you are already familiar with ApplicationComposer concept and are
+just looking for a sample, link:getting-started.html[Getting Started] is
+designed for you.
+
+Finally if you already use ApplicationComposer and just desire to go
+further, link:advanced.html[Advanced] page is the one you need to look!
+
+Children:
+
+* link:history.html[History]
+* link:getting-started.html[Getting Started]
+* link:advanced.html[Advanced]
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-composer/index.md
----------------------------------------------------------------------
diff --git a/docs/application-composer/index.md b/docs/application-composer/index.md
deleted file mode 100644
index 1823808..0000000
--- a/docs/application-composer/index.md
+++ /dev/null
@@ -1,18 +0,0 @@
-# Application Composer
-
-Here is the subdomain dedicated to the Application Composer.
-
-If you don't know at all what ApplicationComposer means, [History](history.html) page
-will explain you where does it come from and what it can be used to today.
-
-If you are already familiar with ApplicationComposer concept and are just looking for a sample,
-[Getting Started](getting-started.html) is designed for you.
-
-Finally if you already use ApplicationComposer and just desire to go further, [Advanced](advanced.html)
-page is the one you need to look!
-
-Children:
-
-* [History](history.html)
-* [Getting Started](getting-started.html)
-* [Advanced](advanced.html)
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-deployment-solutions.adoc
----------------------------------------------------------------------
diff --git a/docs/application-deployment-solutions.adoc b/docs/application-deployment-solutions.adoc
new file mode 100644
index 0000000..68a06f8
--- /dev/null
+++ b/docs/application-deployment-solutions.adoc
@@ -0,0 +1,90 @@
+# Deploying An Application To TomEE Or OpenEJB
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+== Deploying An Application To TomEE Or OpenEJB
+
+=== How to deploy my application under TomEE
+
+==== Description
+
+This aims to be more dynamic in the way you deploy your applications. It
+is clearly cloud oriented.
+
+==== Webapp and TomEE deployment
+
+Webapp can be deployed as Tomcat does. Simply put it in webapps folder
+(or the one you configured) and start TomEE.
+
+==== TomEE specific deployment
+
+By default TomEE deploys applications (ear, war, jar) contained in
+$CATALINA_BASE/apps directory at start up.
+
+==== Deployer
+
+OpenEJB provides a Deployer EJB to do this task. It can be used in your
+own software looking up remotely the "openejb/DeployerBusinessRemote"
+EJB. Its interface is "org.apache.openejb.assembler.Deployer". The
+needed dependency is org.apache.openejb:openejb-core.
+
+Once you got your deployer simply invoke the "deploy" method. Give it
+the location of your application (can be a file, http, https, maven
+location depending on the way you configured your container, for more
+information have a look to TomEE provisionning).
+
+Note: the "undeploy" method exists too and take the same path.
+
+The Deployer is the base of all other solutions
+
+==== Maven plugin
+
+link:maven/index.html[org.apache.openejb:tomee-maven-plugin] can be used
+to deploy/undeploy your application. Once this plugin is added to your
+pom you have access to the following configuration:
+
+* tomeeHttpPort
+* tomeeHost
+
+Then simply run
+
+....
+mvn tomee:deploy <path>
+....
+
+or
+
+....
+mvn tomee:undeploy <path>
+....
+
+===== The Deployer through TomEE Webapp
+
+When you start TomEE you can locally access the TomEE webapps
+(http://host:ip/tomee/).
+
+Then simply go to JNDI tree, select the deployer in the tree, then click
+on "invoke this ejb", select the deploy (or undeploy) method, fill the
+path and click on "invoke".
+
+===== Cloud idea
+
+If you want to cloudify your application, you'll get a configuration
+database (or any other storage system ;)).
+
+So it means it is easy for you to get a host and a port...so it is easy
+to deploy on all your server using the deployer: simply use the maven
+provisioning then run the deployer on all your nodes and that's all!
+
+==== Doing it with camel?
+
+If you are using a route to deploy/undeploy your applications you can
+have a look to the proposed camel-openejb component:
+
+* base code:
+http://svn.apache.org/repos/asf/tomee/sandbox/camel/camel-openejb/
+* proposed to be added to camel:
+https://issues.apache.org/jira/browse/CAMEL-4935
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-deployment-solutions.md
----------------------------------------------------------------------
diff --git a/docs/application-deployment-solutions.md b/docs/application-deployment-solutions.md
deleted file mode 100644
index 6912c65..0000000
--- a/docs/application-deployment-solutions.md
+++ /dev/null
@@ -1,78 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Deploying An Application To TomEE Or OpenEJB
-~~~~~~
-
-# Deploying An Application To TomEE Or OpenEJB
-## How to deploy my application under TomEE
-### Description
-
-This aims to be more dynamic in the way you deploy your applications.
-It is clearly cloud oriented.
-
-### Webapp and TomEE deployment
-
-Webapp can be deployed as Tomcat does. Simply put it in webapps folder
-(or the one you configured) and start TomEE.
-
-### TomEE specific deployment
-
-By default TomEE deploys applications (ear, war, jar) contained in $CATALINA_BASE/apps
-directory at start up.
-
-### Deployer
-
-OpenEJB provides a Deployer EJB to do this task. It can be used
-in your own software looking up remotely the "openejb/DeployerBusinessRemote" EJB.
-Its interface is "org.apache.openejb.assembler.Deployer".
-The needed dependency is org.apache.openejb:openejb-core.
-
-Once you got your deployer simply invoke the "deploy" method. Give it the location
-of your application (can be a file, http, https, maven location depending on
-the way you configured your container, for more information
-have a look to TomEE provisionning).
-
-Note: the "undeploy" method exists too and take the same path.
-
-The Deployer is the base of all other solutions
-
-### Maven plugin
-
-[org.apache.openejb:tomee-maven-plugin](maven/index.html) can be used to deploy/undeploy your application. Once this plugin is added to your pom you have access to the following configuration:
-
-* tomeeHttpPort
-* tomeeHost
-
-Then simply run
-
- mvn tomee:deploy <path>
-
-or
-
- mvn tomee:undeploy <path>
-
-#### The Deployer through TomEE Webapp
-
-When you start TomEE you can locally access the TomEE webapps (http://host:ip/tomee/).
-
-Then simply go to JNDI tree, select the deployer in the tree, then click on "invoke this ejb",
-select the deploy (or undeploy) method, fill the path and click on "invoke".
-
-#### Cloud idea
-
-If you want to cloudify your application, you'll get a configuration database (or any
-other storage system ;)).
-
-So it means it is easy for you to get a host and a port...so it is easy
-to deploy on all your server using the deployer: simply use the maven provisioning
-then run the deployer on all your nodes and that's all!
-
-
-### Doing it with camel?
-
-If you are using a route to deploy/undeploy your applications
-you can have a look to the proposed camel-openejb component:
-
-* base code: http://svn.apache.org/repos/asf/tomee/sandbox/camel/camel-openejb/
-* proposed to be added to camel: https://issues.apache.org/jira/browse/CAMEL-4935
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-discovery-via-the-classpath.adoc
----------------------------------------------------------------------
diff --git a/docs/application-discovery-via-the-classpath.adoc b/docs/application-discovery-via-the-classpath.adoc
new file mode 100644
index 0000000..8984c24
--- /dev/null
+++ b/docs/application-discovery-via-the-classpath.adoc
@@ -0,0 +1,107 @@
+# Application discovery via the classpath
+:index-group: Testing Techniques
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+This document
+details the various ways to get OpenEJB to detect applications you would
+like deployed while in an embedded mode.
+
+# Empty ejb-jar.xml approach (recommended)
+
+Simplify the issue of searching for annotated applications by adding an
+ejb-jar.xml like this to your app:
+
+....
+<ejb-jar/>
+....
+
+OpenEJB will find the app in the classpath and deploy it along with any
+annotated beans it may contain.
+
+The ejb-jar.xml can contain more than just "" as usual.
+
+This is the recommended approach for people using OpenEJB for unit
+testing as it allows OpenEJB to find your application in the classpath
+without the need for you to specify any path information which tends to
+complicate builds.
+
+== Including/Excluding paths (advanced)
+
+If you do not like the idea of having the ejb-jar.xml in your app or an
+openejb.xml, we can search the classpath for annotated beans
+(@Stateless, @Stateful, @MessageDriven) and load them automatically just
+as if they contained an ejb-jar.xml.
+
+This form of searching, however, is very expensive as it involves
+iterating over every path in the classpath and reading in each class
+definition contained thereunder and checking it for annotations.
+
+This approach can only be made faster by helping us trim down or
+pinpoint the paths we should search via the
+_openejb.deployments.classpath.include_ property which can be specified
+as a _system property_ or a property passed into the _InitialContext_.
+
+The value of this property is a regular expression and therefore can be
+absolute or relative. For example the path
+"/Users/dblevins/work/swizzle/swizzle-stream/target/classes" which
+contains the class files of an application you wish to test could be
+included in any of the following values to the
+"openejb.deployments.classpath.include" property:
+
+* "file:///Users/dblevins/work/swizzle/swizzle-stream/target/classes/"
+_(an absolute path)_
+* "file:///Users/dblevins/work/swizzle/.*" _(relative)_
+* ".*swizzle-stream.*" _(very relative)_
+* ".*(swizzle-stream|swizzle-jira|acme-rocket-app).*" _(including
+several paths)_
+* ".*(swizzle-stream^|swizzle-jira^|acme-rocket-app).*" _(including
+several paths with Win specific escapes)_
+
+Note the filtering is done on URLs in the classpath, so forward slashes
+should always be used even on OSs using backslash ("").
+
+There are also the _openejb.deployments.classpath.exclude_ and
+_openejb.exclude-include.order_ properties if you wish to work in the
+opposite direction or change the processing order. The default values
+for the properties are as follows:
+
+....
+ openejb.exclude-include.order=include-exclude //Defines the processing order
+ openejb.deployments.classpath.include="" //Include nothing
+ openejb.deployments.classpath.exclude=".*" //Exclude everything
+....
+
+The exclude and the include are applied separately and the results of
+each are combined together to create the list of paths OpenEJB will
+scrape for annotations.
+
+....
+*Note:* by default these settings will only affect which jars OpenEJB will
+ scan for annotated components when no descriptor is found. If you would
+ like to use these settings to also filter out jars that do contain
+ descriptors, set the *openejb.deployments.classpath.filter.descriptors*
+ property to _true_. The default is _false_.
+....
+
+== Troubleshooting
+
+If the include/exclude is not being processed as you expect first try
+reversing the order to __openejb.exclude-include.order__=exclude-include
+There are a number internal filters that may result in an unexpected
+exclusion.
+
+If you're having trouble determining if the META-INF/ejb-jar.xml file
+for your ejb module is in the classpath, a little debug code like this
+in your test setup will help you see what OpenEJB sees (which may be
+nothing):
+
+....
+Enumeration<URL> ejbJars =
+this.getClass().getClassLoader().getResources("META-INF/ejb-jar.xml");
+while (ejbJars.hasMoreElements()) {
+ URL url = ejbJars.nextElement();
+ System.out.println("app = " + url);
+}
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-discovery-via-the-classpath.md
----------------------------------------------------------------------
diff --git a/docs/application-discovery-via-the-classpath.md b/docs/application-discovery-via-the-classpath.md
deleted file mode 100644
index 3754479..0000000
--- a/docs/application-discovery-via-the-classpath.md
+++ /dev/null
@@ -1,94 +0,0 @@
-index-group=Testing Techniques
-type=page
-status=published
-title=Application discovery via the classpath
-~~~~~~
-This document details the various ways to get OpenEJB to detect
-applications you would like deployed while in an embedded mode.
-
-<a name="Applicationdiscoveryviatheclasspath-Emptyejb-jar.xmlapproach(recommended)"></a>
-# Empty ejb-jar.xml approach (recommended)
-
-Simplify the issue of searching for annotated applications by adding an
-ejb-jar.xml like this to your app:
-
- <ejb-jar/>
-
-
-OpenEJB will find the app in the classpath and deploy it along with any
-annotated beans it may contain.
-
-The ejb-jar.xml can contain more than just "<ejb-jar/>" as usual.
-
-This is the recommended approach for people using OpenEJB for unit testing
-as it allows OpenEJB to find your application in the classpath without the
-need for you to specify any path information which tends to complicate
-builds.
-
-# Including/Excluding paths (advanced)
-
-If you do not like the idea of having the ejb-jar.xml in your app or an
-openejb.xml, we can search the classpath for annotated beans (@Stateless,
-@Stateful, @MessageDriven) and load them automatically just as if they
-contained an ejb-jar.xml.
-
-This form of searching, however, is very expensive as it involves iterating
-over every path in the classpath and reading in each class definition
-contained thereunder and checking it for annotations.
-
-This approach can only be made faster by helping us trim down or pinpoint
-the paths we should search via the *openejb.deployments.classpath.include*
-property which can be specified as a _system property_ or a property passed
-into the _InitialContext_.
-
-The value of this property is a regular expression and therefore can be
-absolute or relative. For example the path
-"/Users/dblevins/work/swizzle/swizzle-stream/target/classes" which contains
-the class files of an application you wish to test could be included in any
-of the following values to the "openejb.deployments.classpath.include"
-property:
-
-* "file:///Users/dblevins/work/swizzle/swizzle-stream/target/classes/" _(an absolute path)_
-* "file:///Users/dblevins/work/swizzle/.*" _(relative)_
-* ".\*swizzle-stream.\*" _(very relative)_
-* ".\*(swizzle-stream|swizzle-jira|acme-rocket-app).\*" _(including several paths)_
-* ".\*(swizzle-stream^|swizzle-jira^|acme-rocket-app).\*" _(including several paths with Win specific escapes)_
-
-Note the filtering is done on URLs in the classpath, so forward slashes
-should always be used even on OSs using backslash ("\").
-
-There are also the *openejb.deployments.classpath.exclude* and *openejb.exclude-include.order*
-properties if you wish to work in the opposite direction or change the processing order.
-The default values for the properties are as follows:
-
- openejb.exclude-include.order=include-exclude //Defines the processing order
- openejb.deployments.classpath.include="" //Include nothing
- openejb.deployments.classpath.exclude=".*" //Exclude everything
-
-The exclude and the include are applied separately and the results of each
-are combined together to create the list of paths OpenEJB will scrape for
-annotations.
-
- *Note:* by default these settings will only affect which jars OpenEJB will
- scan for annotated components when no descriptor is found. If you would
- like to use these settings to also filter out jars that do contain
- descriptors, set the *openejb.deployments.classpath.filter.descriptors*
- property to _true_. The default is _false_.
-
-# Troubleshooting
-
-If the include/exclude is not being processed as you expect first try
-reversing the order to *openejb.exclude-include.order*=exclude-include
-There are a number internal filters that may result in an unexpected exclusion.
-
-If you're having trouble determining if the META-INF/ejb-jar.xml file for
-your ejb module is in the classpath, a little debug code like this in your
-test setup will help you see what OpenEJB sees (which may be nothing):
-
-
- Enumeration<URL> ejbJars =
- this.getClass().getClassLoader().getResources("META-INF/ejb-jar.xml");
- while (ejbJars.hasMoreElements()) {
- URL url = ejbJars.nextElement();
- System.out.println("app = " + url);
- }
[21/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 9
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/security.md
----------------------------------------------------------------------
diff --git a/docs/security.md b/docs/security.md
deleted file mode 100644
index 2f39aa2..0000000
--- a/docs/security.md
+++ /dev/null
@@ -1,148 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=Security
-~~~~~~
-<a name="Security-Security-HowTo."></a>
-# Security - How To.
-
-We currently have two authentication mechanisms to choose from:
-* *PropertiesLoginModule* (a basic text file based login that looks up
-users and groups from the specified properties files)
-* *SQLLoginModule* (database based login that looks up users and groups
-in a database through SQL queries)
-
-To make your program authenticate itself to the server, simply construct
-your InitialContext with the standard javax.naming.Context properties for
-user/pass info, which is:
-
- Properties props = new Properties();
- props.setProperty(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
- props.setProperty(Context.PROVIDER_URL, "ejbd://localhost:4201");
- props.setProperty(Context.SECURITY_PRINCIPAL, "someuser");
- props.setProperty(Context.SECURITY_CREDENTIALS, "thepass");
- props.setProperty("openejb.authentication.realmName", "PropertiesLogin");
- // optional
- InitialContext ctx = new InitialContext(props);
- ctx.lookup(...);
-
-That will get you logged in and all your calls from that context should
-execute as you.
-
-*$\{openejb.base\}/conf/login.config* is a standard JAAS config file.
-Here, you can configure any number of security realms to authenticate
-against.
-To specify which of the realms you want to authenticate against, you can
-set the *openejb.authentication.realmName* property to any of the
-configured realm names in *login.config*.
-If you don't speficy a realm name, the default (currently
-*PropertiesLogin*) is used.
-For examples and more information on JAAS configuration, see the [JAAS Reference Guide](http://java.sun.com/javase/6/docs/technotes/guides/security/jaas/JAASRefGuide.html)
-.
-
-<a name="Security-PropertiesLoginModule"></a>
-## PropertiesLoginModule
-
-Supported options:
-<table class="mdtable">
-<tr><th>Option</th><th>Description</th><th>Required</th></tr>
-<tr><td>UsersFile</td><td>name of the properties file that contains the users and their
-passwords</td><td>*yes*</td></tr>
-<tr><td>GroupsFile</td><td>name of the properties file that contains the groups and their
-member lists</td><td>*yes*</td></tr>
-</table>
-
-*UsersFile* and *GroupsFile* are read in on every login, so +you can
-update them+ on a running system and those users will "show up" immediately
-+without the need for a restart+ of any kind.
-
-<a name="Security-SQLLoginModule"></a>
-## SQLLoginModule
-
-You can either use a data source or configure the JDBC URL through which
-the user/group lookups will be made.
-
-If you use a *DataSource*, you must specify its JNDI name with the
-*dataSourceName* option.
-
-If you use JDBC directly, you have to specify at least the JDBC URL of the
-database.
-The driver should be autodetected (provided the appropriate jar is on your
-classpath), but if that fails for some reason, you can force a specific
-driver using the *jdbcDriver* option.
-For more information on JDBC URLs, see the [JDBC Guide](http://java.sun.com/javase/6/docs/technotes/guides/jdbc/)
-
-The *userSelect* query must return a two-column list of user names
-(column 1) and passwords (column 2). This query should normally return a
-single row, which can be achieved by the use of a query parameter
-placeholder "?".
-Any such placeholders in both queries will be filled in with the username
-that the client is trying to log in with.
-The *groupSelect* query must return a two-column list of user names and
-their groups (or "roles" in the EJB world).
-
-Supported options:
-<table class="mdtable">
-<tr><th>Option</th><th>Description</th><th>Required</th></tr>
-<tr><td>dataSourceName</td><td>the name of a data source</td><td>*yes* (alternative 1)</td></tr>
-<tr><td>jdbcURL</td><td>a standard JDBC URL</td><td>*yes* (alternative 2)</td></tr>
-<tr><td>jdbcDriver</td><td>the fully qualified class name of the database driver</td><td>no</td></tr>
-<tr><td>jdbcUser</td><td>the user name for accessing the database</td><td>no</td></tr>
-<tr><td>jdbcPassword</td><td>the password for accessing the database</td><td>no</td></tr>
-<tr><td>userSelect</td><td>the SQL query that returns a list of users and their
-passwords</td><td>*yes*
-</tr>
-<tr><td>groupSelect</td><td>the SQL query that returns a list of users and groups
-(roles)</td><td>*yes*
-</tr>
-<tr><td>digest</td><td>the name of the digest algorithm (e.g. "MD5" or "SHA") for digest
-authentication</td><td>no</td></tr>
-<tr><td>encoding</td><td>the digest encoding, can be "hex" or "base64"</td><td>no</td></tr>
-</table>
-
-<a name="Security-PLUGPOINTS"></a>
-# PLUG POINTS
-
-There are four-five different plug points where you could customize the
-functionality. From largest to smallest:
-- *The SecurityService interface*: As before all security work
-(authentication and authorization) is behind this interface, only the
-methods on it have been updated. If you want to do something really "out
-there" or need total control, this is where you go. Plugging in your own
-SecurityService should really be a last resort. We still have our "do
-nothing" SecurityService implementation just as before, but it is no longer
-the default. +You can add a new SecurityService impl by creating a
-service-jar.xml and packing it in your jar+. You can configure OpenEJB to
-use a different SecurityService via the openejb.xml.
-
-- *JaccProvider super class*: If you want to plug in your own JACC
-implementation to perform custom authorization (maybe do some fancy
-auditing), this is one way to do it without really having to understand
-JACC too much. We will plug your provider in to all the places required by
-JACC if you simply +set the system property+
-"*org.apache.openejb.core.security.JaccProvider*" with the name of your
-JaccProvider impl.
-
-- *Regular JACC*. The JaccProvider is simply a wrapper around the many
-things you have to do to create and plugin a JACC provider, but you can
-still plugin a JACC provider in the standard ways. Read the JACC spec for
-that info.
-
-- *JAAS LoginModule*. You can setup a different JAAS LoginModule to do all
-your authentication by simply editing the conf/login.config file which is a
-plain JAAS config file. At the moment we only support username/password
-based login modules. At some point it would be nice to support any kind of
-input for a JAAS LoginModule, but username/password at least covers the
-majority. It actually *is* possible to support any LoginModule, but you
-would have to supply your clients with your own way to authenticate to it
-and write a strategy for telling the OpenEJB client what data to send to
-the server with each invocation request. See the [JAAS LoginModule Developer's Guide](http://java.sun.com/javase/6/docs/technotes/guides/security/jaas/JAASLMDevGuide.html)
- for more information.
-
-- *Client IdentityResolver*. This is the just mentioned interface you
-would have to implement to supply the OpenEJB client with alternate data to
-send to the server with each invocation request. If you're plugging in a
-new version of this it is likely that you may also want to plugin in your
-own SecurityService implementation. Reason being, the object returned from
-IdentiyResolve.getIdentity() is sent across the wire and straight in to the
-SecurityService.associate(Object) method.
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/securityservice-config.adoc
----------------------------------------------------------------------
diff --git a/docs/securityservice-config.adoc b/docs/securityservice-config.adoc
new file mode 100644
index 0000000..3b6f6cd
--- /dev/null
+++ b/docs/securityservice-config.adoc
@@ -0,0 +1,50 @@
+# SecurityService Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A SecurityService can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<SecurityService id="mySecurityService" type="SecurityService">
+ defaultUser = guest
+</SecurityService>
+....
+
+Alternatively, a SecurityService can be declared via properties in the
+`<tomee-home>/conf/system.properties` file or via Java VirtualMachine
+`-D` properties. The properties can also be used when embedding TomEE
+via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
+
+....
+mySecurityService = new://SecurityService?type=SecurityService
+mySecurityService.defaultUser = guest
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared SecurityService a
+warning will be logged. If a SecurityService is needed by the
+application and one is not declared, TomEE will create one dynamically
+using default settings. Multiple SecurityService declarations are
+allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+defaultUser
+
+String
+
+guest
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/securityservice-config.md
----------------------------------------------------------------------
diff --git a/docs/securityservice-config.md b/docs/securityservice-config.md
deleted file mode 100644
index 0856536..0000000
--- a/docs/securityservice-config.md
+++ /dev/null
@@ -1,36 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=SecurityService Configuration
-~~~~~~
-
-
-A SecurityService can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <SecurityService id="mySecurityService" type="SecurityService">
- defaultUser = guest
- </SecurityService>
-
-Alternatively, a SecurityService can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- mySecurityService = new://SecurityService?type=SecurityService
- mySecurityService.defaultUser = guest
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared SecurityService a warning will be logged. If a SecurityService is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple SecurityService declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td>defaultUser</td>
- <td>String</td>
- <td>guest </td>
- <td>
-
-</td>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/service-locator.adoc
----------------------------------------------------------------------
diff --git a/docs/service-locator.adoc b/docs/service-locator.adoc
new file mode 100644
index 0000000..e14857f
--- /dev/null
+++ b/docs/service-locator.adoc
@@ -0,0 +1,159 @@
+# Service Locator
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+The functionality of the
+link:jndi-names.html[openejb.jndiname.format] allows for writing some
+really fun service locator code. Creating the exact layout you want
+using the exact data you want means you can create robust libraries for
+pulling things out of JNDI.
+
+# Lookup examples
+
+To get the creative juices flowing here are a few examples of lookup
+methods you could create for your service locator, the jndi name formats
+that would work with those lookups, and examples of client code using
+the service locator. For simplicity, we'll assume all the lookup
+examples start with this basic class that has a built-in lookup allowing
+for a common prefix to be optionally applied to the beginning of all
+lookup strings.
+
+....
+public class MyLocator {
+ private final Context context;
+
+ public MyLocator() throws NamingException {
+ this(null);
+ }
+
+ public MyLocator(String commonPrefix) throws NamingException {
+ Properties properties = new Properties();
+ properties.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
+ properties.put(Context.PROVIDER_URL, "ejbd://localhost:4201/");
+ this.context = new InitialContext(properties);
+ }
+
+ public Object lookup(String name) {
+ try {
+ if (commonPrefix != null) name = commonPrefix + "/" +name;
+ return context.lookup(name);
+ } catch (NamingException e) {
+ throw new IllegalArgumentException(e);
+ }
+ }
+}
+....
+
+== Just the interface Usable with JNDI name formats ending in the full
+class name of the interface such as: - \{interfaceClass}
+
+....
+public <T> T lookup(Class<T> type) {
+ return (T) lookup(type.getName());
+}
+
+
+
+MyLocator locator = new MyLocator();
+Widget widget = locator.lookup(Widget.class);
+....
+
+Or with a common prefix or with a common prefix supplied in constructor
+such as: - \{moduleId}/\{interfaceClass} -
+ejb/\{moduleId}/\{interfaceClass}
+
+....
+MyLocator locator = new MyLocator("ejb/superbiz");
+Widget widget = locator.lookup(Widget.class);
+Store store = locator.lookup(Store.class);
+....
+
+== Interface class and a prefix
+
+Usable with JNDI name formats including a varying prefix such as ejbName
+or deploymentID and ending in the full class name of the interface
+
+* \{ejbName}/\{interfaceClass}
+* \{deploymentId}/\{interfaceClass}
++
+public T lookup(String prefix, Class type) \{ return (T) lookup(prefix +
+"/" + type.getName()); }
++
+MyLocator locator = new MyLocator(); Widget redWidget =
+locator.lookup("RedWidgetBean", Widget.class); +
+Widget blueWidget = locator.lookup("BlueWidgetBean", Widget.class);
+
+Or with a common prefix or with a common prefix supplied in constructor
+such as: - \{moduleId}/\{ejbName}/\{interfaceClass} -
+ejb/\{moduleId}/\{deploymentId}/\{interfaceClass}
+
+....
+MyLocator locator = new MyLocator("accountingApp");
+Widget widget = locator.lookup("RedWidgetBean", Widget.class);
+Store store = locator.lookup("StoreBean", Store.class);
+....
+
+== Interface class and ejb class
+
+Usable with JNDI name formats comprised of the interfaceClass and
+ejbClass
+
+For variation, the interface class is the prefix and the ejb class is
+the suffix. This is neat as the the prefix (the interface class name)
+becomes a jndi context with one binding in it for each implementing ejb
+class.
+
+Works with: - \{interfaceClass}/\{ejbClass}
+
+....
+public <T> T lookup(Class<T> type, Class ejbClass) {
+ return (T) lookup(type.getName() + "/" + ejbClass.getName());
+}
+
+
+
+MyLocator locator = new MyLocator();
+Widget widget = locator.lookup(Widget.class, BlueWidgetBean.class);
+....
+
+Or with a common prefix or with a common prefix supplied in constructor
+such as: - \{moduleId}/\{interfaceClass}/\{ejbClass} -
+ejb/\{moduleId}/\{interfaceClass}/\{ejbClass}
+
+....
+MyLocator locator = new MyLocator("ejb/purchasingApp");
+Widget widget = locator.lookup(Widget.class, RedWidgetBean.class);
+Store store = locator.lookup(Store.class, StoreBean.class);
+....
+
+== Interface class and ejb class with simple names
+
+Similar to the above example but using the simple name of the classes
+resulting in a JNDI tree that's a bit more human readable. -
+\{ejbClass.simpleName}/\{interfaceClass.simpleName}
+
+....
+public <T> T lookup(Class ejbClass, Class<T> type) {
+ return (T) lookup(ejbClass.getSimpleName() + "" + type.getSimpleName());
+}
+....
+
+and
+
+....
+MyLocator locator = new MyLocator();
+Widget widget = locator.lookup(RedWidgetBean.class, Widget.class);
+....
+
+Or with a common prefix or with a common prefix supplied in constructor
+such as: -
+\{moduleId}/\{ejbClass.simpleName}/\{interfaceClass.simpleName} -
+ejb/\{moduleId}/\{ejbClass.simpleName}/\{interfaceClass.simpleName}
+
+....
+MyLocator locator = new MyLocator("shippingApp");
+Widget widget = locator.lookup(GreenWidgetBean.class, Widget.class);
+Store store = locator.lookup(SuperStoreBean.class, Store.class);
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/service-locator.md
----------------------------------------------------------------------
diff --git a/docs/service-locator.md b/docs/service-locator.md
deleted file mode 100644
index b4a58e9..0000000
--- a/docs/service-locator.md
+++ /dev/null
@@ -1,171 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Service Locator
-~~~~~~
-The functionality of the [openejb.jndiname.format](jndi-names.html)
- allows for writing some really fun service locator code. Creating the
-exact layout you want using the exact data you want means you can create
-robust libraries for pulling things out of JNDI.
-
-<a name="ServiceLocator-Lookupexamples"></a>
-# Lookup examples
-
-To get the creative juices flowing here are a few examples of lookup
-methods you could create for your service locator, the jndi name formats
-that would work with those lookups, and examples of client code using the
-service locator. For simplicity, we'll assume all the lookup examples
-start with this basic class that has a built-in lookup allowing for a
-common prefix to be optionally applied to the beginning of all lookup
-strings.
-
- public class MyLocator {
- private final Context context;
-
- public MyLocator() throws NamingException {
- this(null);
- }
-
- public MyLocator(String commonPrefix) throws NamingException {
- Properties properties = new Properties();
- properties.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
- properties.put(Context.PROVIDER_URL, "ejbd://localhost:4201/");
- this.context = new InitialContext(properties);
- }
-
- public Object lookup(String name) {
- try {
- if (commonPrefix != null) name = commonPrefix + "/" +name;
- return context.lookup(name);
- } catch (NamingException e) {
- throw new IllegalArgumentException(e);
- }
- }
- }
-
-
-<a name="ServiceLocator-Justtheinterface"></a>
-## Just the interface
-Usable with JNDI name formats ending in the full class name of the
-interface such as:
- - \{interfaceClass}
-
-
- public <T> T lookup(Class<T> type) {
- return (T) lookup(type.getName());
- }
-
-
-
- MyLocator locator = new MyLocator();
- Widget widget = locator.lookup(Widget.class);
-
-
-Or with a common prefix or with a common prefix supplied in constructor
-such as:
- - \{moduleId}/\{interfaceClass}
- - ejb/\{moduleId}/\{interfaceClass}
-
-
- MyLocator locator = new MyLocator("ejb/superbiz");
- Widget widget = locator.lookup(Widget.class);
- Store store = locator.lookup(Store.class);
-
-
-
-<a name="ServiceLocator-Interfaceclassandaprefix"></a>
-## Interface class and a prefix
-
-Usable with JNDI name formats including a varying prefix such as ejbName or
-deploymentID
-and ending in the full class name of the interface
-
- - \{ejbName}/\{interfaceClass}
- - \{deploymentId}/\{interfaceClass}
-
-
- public <T> T lookup(String prefix, Class<T> type) {
- return (T) lookup(prefix + "/" + type.getName());
- }
-
-
-
- MyLocator locator = new MyLocator();
- Widget redWidget = locator.lookup("RedWidgetBean", Widget.class);
- Widget blueWidget = locator.lookup("BlueWidgetBean", Widget.class);
-
-
-Or with a common prefix or with a common prefix supplied in constructor
-such as:
- - \{moduleId}/\{ejbName}/\{interfaceClass}
- - ejb/\{moduleId}/\{deploymentId}/\{interfaceClass}
-
-
- MyLocator locator = new MyLocator("accountingApp");
- Widget widget = locator.lookup("RedWidgetBean", Widget.class);
- Store store = locator.lookup("StoreBean", Store.class);
-
-
-<a name="ServiceLocator-Interfaceclassandejbclass"></a>
-## Interface class and ejb class
-
-Usable with JNDI name formats comprised of the interfaceClass and ejbClass
-
-For variation, the interface class is the prefix and the ejb class is the
-suffix. This is neat as the the prefix (the interface class name) becomes
-a jndi context with one binding in it for each implementing ejb class.
-
-Works with:
- - \{interfaceClass}/\{ejbClass}
-
-
- public <T> T lookup(Class<T> type, Class ejbClass) {
- return (T) lookup(type.getName() + "/" + ejbClass.getName());
- }
-
-
-
- MyLocator locator = new MyLocator();
- Widget widget = locator.lookup(Widget.class, BlueWidgetBean.class);
-
-
-Or with a common prefix or with a common prefix supplied in constructor
-such as:
- - \{moduleId}/\{interfaceClass}/\{ejbClass}
- - ejb/\{moduleId}/\{interfaceClass}/\{ejbClass}
-
-
- MyLocator locator = new MyLocator("ejb/purchasingApp");
- Widget widget = locator.lookup(Widget.class, RedWidgetBean.class);
- Store store = locator.lookup(Store.class, StoreBean.class);
-
-
-
-<a name="ServiceLocator-Interfaceclassandejbclasswithsimplenames"></a>
-## Interface class and ejb class with simple names
-
-Similar to the above example but using the simple name of the classes
-resulting
-in a JNDI tree that's a bit more human readable.
- - \{ejbClass.simpleName}/\{interfaceClass.simpleName}
-
-
- public <T> T lookup(Class ejbClass, Class<T> type) {
- return (T) lookup(ejbClass.getSimpleName() + "" + type.getSimpleName());
- }
-
-and
-
- MyLocator locator = new MyLocator();
- Widget widget = locator.lookup(RedWidgetBean.class, Widget.class);
-
-
-Or with a common prefix or with a common prefix supplied in constructor
-such as:
- - \{moduleId}/\{ejbClass.simpleName}/\{interfaceClass.simpleName}
- - ejb/\{moduleId}/\{ejbClass.simpleName}/\{interfaceClass.simpleName}
-
-
- MyLocator locator = new MyLocator("shippingApp");
- Widget widget = locator.lookup(GreenWidgetBean.class, Widget.class);
- Store store = locator.lookup(SuperStoreBean.class, Store.class);
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/services.adoc
----------------------------------------------------------------------
diff --git a/docs/services.adoc b/docs/services.adoc
new file mode 100644
index 0000000..140aeba
--- /dev/null
+++ b/docs/services.adoc
@@ -0,0 +1,28 @@
+# ServicePool and Services
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+OpenEJB and TomEE services using ServicePool as wrapper - for instance
+ejbd service or all services not implementing SelfManaging interface -
+support some additional configuration due to the pooling. Here is the
+list of the additional properties (either configure them in the service
+configuration file in conf/conf.d/$\{service}.properties or in
+conf/system.properties prefixing them by “\{service}.”).
+
+Basically using ServicePool the service is associated to a
+ThreadPoolExecutor and this one is configured with these properties (see
+ThreadPoolExecutor constructor for the detail):
+
+* threadsCore (default 10)
+* threads (default 150)
+* queue (default threadCore-1)
+* block (default true)
+* keepAliveTime (default 60000)
+
+Additionally you can force the socket to be closed after each request
+(this is an advanced setting, use it with caution):
+
+* forceSocketClose (default true)
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/services.md
----------------------------------------------------------------------
diff --git a/docs/services.md b/docs/services.md
deleted file mode 100644
index 5cac11a..0000000
--- a/docs/services.md
+++ /dev/null
@@ -1,20 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=ServicePool and Services
-~~~~~~
-
-OpenEJB and TomEE services using ServicePool as wrapper - for instance ejbd service or all services not implementing SelfManaging interface - support some additional configuration due
-to the pooling. Here is the list of the additional properties (either configure them in the service configuration file in conf/conf.d/${service}.properties or in conf/system.properties prefixing them by “{service}.”).
-
-Basically using ServicePool the service is associated to a ThreadPoolExecutor and this one is configured with these properties (see ThreadPoolExecutor constructor for the detail):
-
-* threadsCore (default 10)
-* threads (default 150)
-* queue (default threadCore-1)
-* block (default true)
-* keepAliveTime (default 60000)
-
-Additionally you can force the socket to be closed after each request (this is an advanced setting, use it with caution):
-
-* forceSocketClose (default true)
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/singleton-beans.adoc
----------------------------------------------------------------------
diff --git a/docs/singleton-beans.adoc b/docs/singleton-beans.adoc
new file mode 100644
index 0000000..906b897
--- /dev/null
+++ b/docs/singleton-beans.adoc
@@ -0,0 +1,228 @@
+# Singleton Beans
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Singleton Overview For the first time in years EJB has a new
+bean type, the _@Singleton_. In my opinion, the javax.ejb.Singleton will
+replace a lot of what people are using @Stateless for today.
+
+The Singleton is essentially what you get if you take a Stateless bean
+and adjust the pool size to be exactly 1 resulting in there being
+exactly one instance of the Singleton bean in the application which can
+be invoked concurrently by multiple threads, like a servlet. It can do
+everything a Stateless can do such as support local and remote business
+interfaces, web services, security, transactions, and more.
+Additionally, the Singleton can have its @PostConstruct method called
+with the application starts up and its @PreDestroy method called when
+the application shuts down. This allows it to serve as an application
+lifecycle listener which is something only Servlets could do before. It
+has an _@Startup_ annotation which is similar in concept to the servlet
+, but unlike servlets it doesn't take a number as an argument. Instead,
+you can use an _@DependsOn_ annotation to say which other Singletons you
+need and the container will ensure they start before you.
+
+See the link:singleton-example.html[Singleton Example] for sample bean
+code and client.
+
+== Concurrency
+
+Singletons support two modes of concurrent access, Container-Managed
+Concurrency (the default) and Bean-Managed Concurrency.
+
+=== Bean-Managed Concurrency
+
+With Bean-Managed Concurrency, annotated as
+_@ConcurrencyManagement(BEAN)_, the container sends all invocations into
+the bean and lets the Singleton bean instance decide how and when to
+synchronize access, if at all. Here the 'synchronization' keyword is
+allowed as well as the full javax.util.concurrent set of libraries.
+
+=== Container-Managed Concurrency
+
+With Container-Managed Concurrency, annotated as
+_@ConcurrencyManagement(CONTAINER)_, the container will enforce
+concurrency for you via locking method access to the bean. Two modes,
+called locks exist and can be assigned to both the bean class and
+methods of the bean class.
+
+==== Lock type
+
+The first and the default is a "write" lock, annotated as
+_@Lock(WRITE)_. Essentially, with a write lock the caller holds an
+exclusive lock on the bean for the duration of the method call and all
+other threads for that or any other method must wait.
+
+The second option is a "read" lock, annotated as _@Lock(READ)_. The read
+lock allows full concurrent access to the methods (assuming no write
+locks are held). The default mode of "write" essentially makes your bean
+a single-threaded bean, which is very slow. The more conservative
+@Lock(WRITE) was chosen as the default as this is how all the other bean
+types work (only a single thread may access a bean instance at any given
+time). Those that are aware of how to handle concurrent access can
+easily put @Lock(READ) on their bean class, thus changing the default,
+and then @Lock(WRITE) on specific methods if needed.
+
+The locking modes of Container-Managed Concurrency map directly to the
+_http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/ReadWriteLock.html[java.util.concurrent.ReadWriteLock]
+_ API which looks like this:
+
+....
+public interface ReadWriteLock {
+ /**
+ * Returns the lock used for reading.
+ *
+ * @return the lock used for reading.
+ */
+ Lock readLock();
+
+ /**
+ * Returns the lock used for writing.
+ *
+ * @return the lock used for writing.
+ */
+ Lock writeLock();
+}
+....
+
+Literally 100% of the Singleton locking we're talking about is taken
+from this interface and its javadoc is a great source of information.
+It's safe to imagine that under the covers the Singleton Container has
+an instance of ReadWriteLock which it uses to enforce the locking for
+all the Singleton bean's methods. Essentially:
+
+* @Lock(READ) == theSingletonReadWriteLock.readLock().lock()
+* @Lock(WRITE) == theSingletonReadWriteLock.writeLock().lock()
+
+The EJB container may use something other than ReadWriteLock but the
+semantics of a ReadWriteLock must be followed. Internally, we use an
+instance of
+http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html[java.util.concurrent.ReentrantReadWriteLock]
+which supports correct memory synchronization, some reentrancy, lock
+downgrading, and
+[more|http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html]
+.
+
+==== Acquiring the Lock
+
+The _@AccessTimetout_ annotation can configure how long a thread will
+wait to acquire the read or write lock. This annotation can be used on
+the bean class or individual methods. The annotation maps directly to
+the
+http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/Lock.html[java.util.concurrent.locks.Lock]
+interface.
+
+....
+public interface Lock {
+
+ /**
+ * Blocks (potentially) forever
+ *
+ * @AccessTimout with a value of -1
+ */
+ void lock();
+
+ /**
+ * Non-blocking
+ *
+ * @AccessTimout with a value of 0
+ */
+ boolean tryLock();
+
+ /**
+ * Blocks (potentially) up to a limit
+ *
+ * @AccessTimout(30, TimeUnit.SECONDS)
+ */
+ boolean tryLock(long time, TimeUnit unit) throws InterruptedException;
+
+}
+....
+
+In the event it is not possible to acquire the lock a
+_javax.ejb.ConcurrentAccessException_ or
+_javax.ejb.ConcurrentAccessTimeoutException_ will be thrown.
+
+==== Default Timeout
+
+The default value of _@AccessTimeout_ annotation is vendor specific. In
+OpenEJB it defaults to the value of the _AccessTimeout_ property which
+can be configured in many different scopes. Here is the order of
+preference:
+
+[arabic]
+. bean-level in openejb-jar.xml///
+. jar-level in openejb-jar.xml//
+. container-level in openejb.xml//
+. boot-level via InitialContext(Properties) or
+EJBContainer.createEjbContainer(Map<Object,Object>)
+. system-level in System.getProperties()
+
+The value of the property can be phrased in plain english such as "1
+hour and 23 minutes and 17 seconds" see
+link:configuring-durations.html[Configuring Durations] for details.
+
+== Startup and Startup Ordering
+
+Singletons have an _@Startup_ annotation which can be applied to the
+bean class. When used, the Container will instantiate the Singleton
+instance _eagerly_ when the application starts up, otherwise the
+Container will instantiate the Singleton instance _lazily_ when the bean
+is first accessed.
+
+If one Singleton refers to another Singleton in the @PostConstruct or
+@PreDestroy method, there must be some measure taken to ensure the other
+Singleton exists and is started. This sort of ordering is achieved with
+the _@DependsOn_ annotation which can be used to list the names of
+Singleton beans that must be started before the Singleton bean using the
+annotation.
+
+....
+@DependsOn({"SingletonB", "SingletonC"})
+@Singleton
+public class SingletonA {
+
+}
+....
+
+Circular references are not supported. If BeanA uses @DependsOn to point
+to BeanB and BeanB also uses @DependsOn to point at BeanA, the result is
+a deployment exception. Be aware that circular references can happen in
+less trivial ways such as A referring to B which refers to C which
+refers to D which refers back to A. We will detect and print all
+circular dependencies (called circuits) at deploy time.
+
+Note that @DependsOn is only required (and should only be used) if a
+Singleton _uses_ another Singleton in its @PostConstruct method or
+@PreDestroy method. Simply having a reference to another Singleton and
+using it in other business methods does not require an @DependsOn
+declaration. The @DependsOn allows the Container to calculate the
+correct startup order and shutdown order so that it can guarantee the
+Singletons you need are available in your @PostConstruct or @PreDestroy
+methods. All Singletons will automatically be available to your business
+methods regardless if @DependsOn is used. Because of the greater chance
+of creating circular dependencies, it is better not to use the
+@DependsOn annotation "just in case" and should only be used when truly
+needed.
+
+# XML and Annotation Overriding
+
+Singletons can be declared in the ejb-jar.xml as follows:
+
+....
+<ejb-jar>
+ <enterprise-beans>
+ <session>
+ <ejb-name>MySingletonBean</ejb-name>
+ <ejb-class>org.superbiz.MySingletonBean</ejb-class>
+ <session-type>Singleton</session-type>
+ <load-on-startup/>
+ <depends-on>
+ <ejb-name>SingletonFoo</ejb-name>
+ <ejb-name>SingletonBar</ejb-name>
+ </depends-on>
+ </session>
+ </enterprise-beans>
+</ejb-jar>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/singleton-beans.md
----------------------------------------------------------------------
diff --git a/docs/singleton-beans.md b/docs/singleton-beans.md
deleted file mode 100644
index 1f67561..0000000
--- a/docs/singleton-beans.md
+++ /dev/null
@@ -1,226 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Singleton Beans
-~~~~~~
-<a name="SingletonBeans-SingletonOverview"></a>
-# Singleton Overview
-For the first time in years EJB has a new bean type, the *@Singleton*. In
-my opinion, the javax.ejb.Singleton will replace a lot of what people are
-using @Stateless for today.
-
-The Singleton is essentially what you get if you take a Stateless bean and
-adjust the pool size to be exactly 1 resulting in there being exactly one
-instance of the Singleton bean in the application which can be invoked
-concurrently by multiple threads, like a servlet. It can do everything a
-Stateless can do such as support local and remote business interfaces, web
-services, security, transactions, and more. Additionally, the Singleton
-can have its @PostConstruct method called with the application starts up
-and its @PreDestroy method called when the application shuts down. This
-allows it to serve as an application lifecycle listener which is something
-only Servlets could do before. It has an *@Startup* annotation which is
-similar in concept to the servlet <load-on-startup>, but unlike servlets it
-doesn't take a number as an argument. Instead, you can use an *@DependsOn*
-annotation to say which other Singletons you need and the container will
-ensure they start before you.
-
-See the [Singleton Example](singleton-example.html)
- for sample bean code and client.
-
-<a name="SingletonBeans-Concurrency"></a>
-## Concurrency
-
-Singletons support two modes of concurrent access, Container-Managed
-Concurrency (the default) and Bean-Managed Concurrency.
-
-<a name="SingletonBeans-Bean-ManagedConcurrency"></a>
-### Bean-Managed Concurrency
-
-With Bean-Managed Concurrency, annotated as *@ConcurrencyManagement(BEAN)*,
-the container sends all invocations into the bean and lets the Singleton
-bean instance decide how and when to synchronize access, if at all. Here
-the 'synchronization' keyword is allowed as well as the full
-javax.util.concurrent set of libraries.
-
-<a name="SingletonBeans-Container-ManagedConcurrency"></a>
-### Container-Managed Concurrency
-
-With Container-Managed Concurrency, annotated as
-*@ConcurrencyManagement(CONTAINER)*, the container will enforce concurrency
-for you via locking method access to the bean. Two modes, called locks
-exist and can be assigned to both the bean class and methods of the bean
-class.
-
-<a name="SingletonBeans-Locktype"></a>
-#### Lock type
-
-The first and the default is a "write" lock, annotated as *@Lock(WRITE)*.
-Essentially, with a write lock the caller holds an exclusive lock on the
-bean for the duration of the method call and all other threads for that or
-any other method must wait.
-
-The second option is a "read" lock, annotated as *@Lock(READ)*. The read
-lock allows full concurrent access to the methods (assuming no write locks
-are held). The default mode of "write" essentially makes your bean a
-single-threaded bean, which is very slow. The more conservative
-@Lock(WRITE) was chosen as the default as this is how all the other bean
-types work (only a single thread may access a bean instance at any given
-time). Those that are aware of how to handle concurrent access can easily
-put @Lock(READ) on their bean class, thus changing the default, and then
-@Lock(WRITE) on specific methods if needed.
-
-The locking modes of Container-Managed Concurrency map directly to the *[java.util.concurrent.ReadWriteLock](http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/ReadWriteLock.html)
-* API which looks like this:
-
- public interface ReadWriteLock {
- /**
- * Returns the lock used for reading.
- *
- * @return the lock used for reading.
- */
- Lock readLock();
-
- /**
- * Returns the lock used for writing.
- *
- * @return the lock used for writing.
- */
- Lock writeLock();
- }
-
-
-Literally 100% of the Singleton locking we're talking about is taken from
-this interface and its javadoc is a great source of information. It's safe
-to imagine that under the covers the Singleton Container has an instance of
-ReadWriteLock which it uses to enforce the locking for all the Singleton
-bean's methods. Essentially:
-
- - @Lock(READ) == theSingletonReadWriteLock.readLock().lock()
- - @Lock(WRITE) == theSingletonReadWriteLock.writeLock().lock()
-
-The EJB container may use something other than ReadWriteLock but the
-semantics of a ReadWriteLock must be followed. Internally, we use an
-instance of [java.util.concurrent.ReentrantReadWriteLock](http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html)
- which supports correct memory synchronization, some reentrancy, lock
-downgrading, and [more|http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html]
-.
-
-<a name="SingletonBeans-AcquiringtheLock"></a>
-#### Acquiring the Lock
-
-The *@AccessTimetout* annotation can configure how long a thread will wait
-to acquire the read or write lock. This annotation can be used on the bean
-class or individual methods. The annotation maps directly to the [java.util.concurrent.locks.Lock](http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/Lock.html)
- interface.
-
- public interface Lock {
-
- /**
- * Blocks (potentially) forever
- *
- * @AccessTimout with a value of -1
- */
- void lock();
-
- /**
- * Non-blocking
- *
- * @AccessTimout with a value of 0
- */
- boolean tryLock();
-
- /**
- * Blocks (potentially) up to a limit
- *
- * @AccessTimout(30, TimeUnit.SECONDS)
- */
- boolean tryLock(long time, TimeUnit unit) throws InterruptedException;
-
- }
-
-
-In the event it is not possible to acquire the lock a
-*javax.ejb.ConcurrentAccessException* or
-*javax.ejb.ConcurrentAccessTimeoutException* will be thrown.
-
-<a name="SingletonBeans-DefaultTimeout"></a>
-#### Default Timeout
-
-The default value of *@AccessTimeout* annotation is vendor specific. In
-OpenEJB it defaults to the value of the *AccessTimeout* property which can
-be configured in many different scopes. Here is the order of preference:
-
-1. bean-level in
-openejb-jar.xml/<openejb-jar>/<ejb-deployment>/<properties>
-1. jar-level in openejb-jar.xml/<openejb-jar>/<properties>
-1. container-level in openejb.xml/<openejb>/<Container>
-1. boot-level via InitialContext(Properties) or
-EJBContainer.createEjbContainer(Map<Object,Object>)
-1. system-level in System.getProperties()
-
-The value of the property can be phrased in plain english such as "1 hour
-and 23 minutes and 17 seconds" see [Configuring Durations](configuring-durations.html)
- for details.
-
-<a name="SingletonBeans-StartupandStartupOrdering"></a>
-## Startup and Startup Ordering
-
-Singletons have an *@Startup* annotation which can be applied to the bean
-class. When used, the Container will instantiate the Singleton instance
-_eagerly_ when the application starts up, otherwise the Container will
-instantiate the Singleton instance _lazily_ when the bean is first
-accessed.
-
-If one Singleton refers to another Singleton in the @PostConstruct or
-@PreDestroy method, there must be some measure taken to ensure the other
-Singleton exists and is started. This sort of ordering is achieved with
-the *@DependsOn* annotation which can be used to list the names of
-Singleton beans that must be started before the Singleton bean using the
-annotation.
-
-
- @DependsOn({"SingletonB", "SingletonC"})
- @Singleton
- public class SingletonA {
-
- }
-
-
-Circular references are not supported. If BeanA uses @DependsOn to point
-to BeanB and BeanB also uses @DependsOn to point at BeanA, the result is a
-deployment exception. Be aware that circular references can happen in less
-trivial ways such as A referring to B which refers to C which refers to D
-which refers back to A. We will detect and print all circular dependencies
-(called circuits) at deploy time.
-
-Note that @DependsOn is only required (and should only be used) if a
-Singleton *uses* another Singleton in its @PostConstruct method or
-@PreDestroy method. Simply having a reference to another Singleton and
-using it in other business methods does not require an @DependsOn
-declaration. The @DependsOn allows the Container to calculate the correct
-startup order and shutdown order so that it can guarantee the Singletons
-you need are available in your @PostConstruct or @PreDestroy methods. All
-Singletons will automatically be available to your business methods
-regardless if @DependsOn is used. Because of the greater chance of
-creating circular dependencies, it is better not to use the @DependsOn
-annotation "just in case" and should only be used when truly needed.
-
-<a name="SingletonBeans-XMLandAnnotationOverriding"></a>
-# XML and Annotation Overriding
-
-Singletons can be declared in the ejb-jar.xml as follows:
-
- <ejb-jar>
- <enterprise-beans>
- <session>
- <ejb-name>MySingletonBean</ejb-name>
- <ejb-class>org.superbiz.MySingletonBean</ejb-class>
- <session-type>Singleton</session-type>
- <load-on-startup/>
- <depends-on>
- <ejb-name>SingletonFoo</ejb-name>
- <ejb-name>SingletonBar</ejb-name>
- </depends-on>
- </session>
- </enterprise-beans>
- </ejb-jar>
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/singleton-ejb.adoc
----------------------------------------------------------------------
diff --git a/docs/singleton-ejb.adoc b/docs/singleton-ejb.adoc
new file mode 100644
index 0000000..689e308
--- /dev/null
+++ b/docs/singleton-ejb.adoc
@@ -0,0 +1,7 @@
+# Singleton EJB
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+\{include:OPENEJBx30:Singleton Beans}
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/singleton-ejb.md
----------------------------------------------------------------------
diff --git a/docs/singleton-ejb.md b/docs/singleton-ejb.md
deleted file mode 100644
index 38e039f..0000000
--- a/docs/singleton-ejb.md
+++ /dev/null
@@ -1,6 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Singleton EJB
-~~~~~~
-{include:OPENEJBx30:Singleton Beans}
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/singletoncontainer-config.adoc
----------------------------------------------------------------------
diff --git a/docs/singletoncontainer-config.adoc b/docs/singletoncontainer-config.adoc
new file mode 100644
index 0000000..353c841
--- /dev/null
+++ b/docs/singletoncontainer-config.adoc
@@ -0,0 +1,69 @@
+# SingletonContainer Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A SingletonContainer can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Container id="mySingletonContainer" type="SINGLETON">
+ accessTimeout = 30 seconds
+</Container>
+....
+
+Alternatively, a SingletonContainer can be declared via properties in
+the `<tomee-home>/conf/system.properties` file or via Java
+VirtualMachine `-D` properties. The properties can also be used when
+embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or
+`InitialContext`
+
+....
+mySingletonContainer = new://Container?type=SINGLETON
+mySingletonContainer.accessTimeout = 30 seconds
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared SingletonContainer a
+warning will be logged. If a SingletonContainer is needed by the
+application and one is not declared, TomEE will create one dynamically
+using default settings. Multiple SingletonContainer declarations are
+allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+accessTimeout
+
+time
+
+30 seconds
+
+Specifies the maximum time an invocation could wait for the `@Singleton`
+bean instance to become available before giving up.
+
+== accessTimeout
+
+Specifies the maximum time an invocation could wait for the `@Singleton`
+bean instance to become available before giving up.
+
+After the timeout is reached a
+`javax.ejb.ConcurrentAccessTimeoutException` will be thrown.
+
+Usable time units: nanoseconds, microsecons, milliseconds, seconds,
+minutes, hours, days. Or any combination such as
+`1 hour and 27 minutes and 10 seconds`
+
+Any usage of the `javax.ejb.AccessTimeout` annotation will override this
+setting for the bean or method where the annotation is used.
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/singletoncontainer-config.md
----------------------------------------------------------------------
diff --git a/docs/singletoncontainer-config.md b/docs/singletoncontainer-config.md
deleted file mode 100644
index c630a8d..0000000
--- a/docs/singletoncontainer-config.md
+++ /dev/null
@@ -1,56 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=SingletonContainer Configuration
-~~~~~~
-
-
-A SingletonContainer can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Container id="mySingletonContainer" type="SINGLETON">
- accessTimeout = 30 seconds
- </Container>
-
-Alternatively, a SingletonContainer can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- mySingletonContainer = new://Container?type=SINGLETON
- mySingletonContainer.accessTimeout = 30 seconds
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared SingletonContainer a warning will be logged. If a SingletonContainer is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple SingletonContainer declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td><a href="#accessTimeout">accessTimeout</a></td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>30 seconds</td>
- <td>
-Specifies the maximum time an invocation could wait for the
-`@Singleton` bean instance to become available before giving up.
-</td>
-</tr>
-</table>
-
-
-
-<a name="accessTimeout"></a>
-## accessTimeout
-
-Specifies the maximum time an invocation could wait for the
-`@Singleton` bean instance to become available before giving up.
-
-After the timeout is reached a `javax.ejb.ConcurrentAccessTimeoutException`
-will be thrown.
-
-Usable time units: nanoseconds, microsecons, milliseconds,
-seconds, minutes, hours, days. Or any combination such as
-`1 hour and 27 minutes and 10 seconds`
-
-Any usage of the `javax.ejb.AccessTimeout` annotation will
-override this setting for the bean or method where the
-annotation is used.
[32/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 8
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 8
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/05b3c837
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/05b3c837
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/05b3c837
Branch: refs/heads/master
Commit: 05b3c8378ec37d0f5d8fa55aec8f8bc3a1d87e6d
Parents: 6872001
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 23:06:57 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 23:06:57 2018 -0800
----------------------------------------------------------------------
docs/multicast-discovery.adoc | 5 ++---
docs/multipoint-considerations.adoc | 5 ++---
docs/multipoint-discovery.adoc | 5 ++---
docs/multipoint-recommendations.adoc | 5 ++---
docs/multipulse-discovery.adoc | 5 ++---
docs/new-in-openejb-3.0.adoc | 5 ++---
docs/openejb.xml.adoc | 4 ++--
docs/properties-tool.adoc | 5 ++---
8 files changed, 16 insertions(+), 23 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/05b3c837/docs/multicast-discovery.adoc
----------------------------------------------------------------------
diff --git a/docs/multicast-discovery.adoc b/docs/multicast-discovery.adoc
index 6fd67f4..fd6d530 100644
--- a/docs/multicast-discovery.adoc
+++ b/docs/multicast-discovery.adoc
@@ -1,9 +1,8 @@
-:index-group: Discovery
-and Failover
+# Multicast (UDP) Discovery
+:index-group: Discovery and Failover
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: Multicast (UDP) Discovery
Multicast is the preferred way to broadcast the heartbeat on the
http://git-wip-us.apache.org/repos/asf/tomee/blob/05b3c837/docs/multipoint-considerations.adoc
----------------------------------------------------------------------
diff --git a/docs/multipoint-considerations.adoc b/docs/multipoint-considerations.adoc
index 24d3644..e232020 100644
--- a/docs/multipoint-considerations.adoc
+++ b/docs/multipoint-considerations.adoc
@@ -1,9 +1,8 @@
-:index-group: Discovery
-and Failover
+# Multipoint Considerations
+:index-group: Discovery and Failover
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: Multipoint Considerations
== Network size
http://git-wip-us.apache.org/repos/asf/tomee/blob/05b3c837/docs/multipoint-discovery.adoc
----------------------------------------------------------------------
diff --git a/docs/multipoint-discovery.adoc b/docs/multipoint-discovery.adoc
index a8a4daa..171ee46 100644
--- a/docs/multipoint-discovery.adoc
+++ b/docs/multipoint-discovery.adoc
@@ -1,9 +1,8 @@
-:index-group: Discovery
-and Failover
+# Multipoint (TCP) Discovery
+:index-group: Discovery and Failover
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: Multipoint (TCP) Discovery
As TCP has no real broadcast functionality to speak of, communication of
http://git-wip-us.apache.org/repos/asf/tomee/blob/05b3c837/docs/multipoint-recommendations.adoc
----------------------------------------------------------------------
diff --git a/docs/multipoint-recommendations.adoc b/docs/multipoint-recommendations.adoc
index 9764479..5b93ee9 100644
--- a/docs/multipoint-recommendations.adoc
+++ b/docs/multipoint-recommendations.adoc
@@ -1,9 +1,8 @@
-:index-group: Discovery
-and Failover
+# Multipoint Recommendations
+:index-group: Discovery and Failover
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: Multipoint Recommendations
As mentioned the `initialServers` is only used for bootstrapping the
http://git-wip-us.apache.org/repos/asf/tomee/blob/05b3c837/docs/multipulse-discovery.adoc
----------------------------------------------------------------------
diff --git a/docs/multipulse-discovery.adoc b/docs/multipulse-discovery.adoc
index 63d6518..ec2fd38 100644
--- a/docs/multipulse-discovery.adoc
+++ b/docs/multipulse-discovery.adoc
@@ -1,9 +1,8 @@
-:index-group: Discovery
-and Failover
+# MultiPulse (UDP) Discovery
+:index-group: Discovery and Failover
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: MultiPulse (UDP) Discovery
MultiPulse is an alternative multicast lookup that does not use a
http://git-wip-us.apache.org/repos/asf/tomee/blob/05b3c837/docs/new-in-openejb-3.0.adoc
----------------------------------------------------------------------
diff --git a/docs/new-in-openejb-3.0.adoc b/docs/new-in-openejb-3.0.adoc
index f5d871f..2040649 100644
--- a/docs/new-in-openejb-3.0.adoc
+++ b/docs/new-in-openejb-3.0.adoc
@@ -1,10 +1,9 @@
-:jbake-title: New in OpenEJB 3.0
+# New in OpenEJB 3.0
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-
-# EJB 3.0
+## EJB 3.0
OpenEJB 3.0 supports the EJB 3.0 specification as well as the prior EJB
2.1, EJB 2.0, and EJB 1.1. New features in EJB 3.0 include:
http://git-wip-us.apache.org/repos/asf/tomee/blob/05b3c837/docs/openejb.xml.adoc
----------------------------------------------------------------------
diff --git a/docs/openejb.xml.adoc b/docs/openejb.xml.adoc
index 00dd7f6..258c49d 100644
--- a/docs/openejb.xml.adoc
+++ b/docs/openejb.xml.adoc
@@ -1,10 +1,10 @@
-:jbake-title: openejb.xml
+# openejb.xml
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-# Overview
+## Overview
The openejb.xml is the main configuration file for the container system
and its services such as transaction, security, and data sources.
http://git-wip-us.apache.org/repos/asf/tomee/blob/05b3c837/docs/properties-tool.adoc
----------------------------------------------------------------------
diff --git a/docs/properties-tool.adoc b/docs/properties-tool.adoc
index aa37683..90fa8ec 100644
--- a/docs/properties-tool.adoc
+++ b/docs/properties-tool.adoc
@@ -1,9 +1,8 @@
-:index-group: OpenEJB
-Standalone Server
+# Properties Tool
+:index-group: OpenEJB Standalone Server
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: Properties Tool
# Properties Command line Tool
[07/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 5
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/embedded-and-remotable.md
----------------------------------------------------------------------
diff --git a/docs/embedded-and-remotable.md b/docs/embedded-and-remotable.md
deleted file mode 100644
index 23158c8..0000000
--- a/docs/embedded-and-remotable.md
+++ /dev/null
@@ -1,181 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Embedded and Remotable
-~~~~~~
-<a name="EmbeddedandRemotable-Overview"></a>
-# Overview
-
-This example shows how to use OpenEJB3's remoting capabilities in an
-embedded scenario. By remoting we mean that you wish to allow *clients in
-other vms* access your ejbs. _Note, you do not need to go to this extreme
-to unit test ejbs with remote interfaces._
-
-The basic recipe is the same for a standard embedded scenario but with
-these added ingreditents:
-
- * *openejb.embedded.remotable* property
- * *openejb-ejbd* jar
-
-While creating the InitialContext, pass in the openejb.embedded.remotable
-property with the value of "true". When this is seen by the
-LocalInitialContextFactory, it will boot up the Server ServiceManager in
-the VM which will in turn look for ServerServices in the classpath.
-
-Provided you have the openejb-ejbd jar in your classpath along with it's
-dependencies (openejb-server, openejb-client, openejb-core), then those
-services will be brought online and remote clients will be able to connect
-into your vm and invoke beans.
-
-If you want to add more ServerServices such as the http version of the ejbd
-protocol you'd simply add the openejb-httpejbd jar to your classpath. A
-number of ServerServices are available currently:
-
- * openejb-ejbd
- * openejb-http
- * openejb-telnet
- * openejb-derbynet
- * openejb-hsql
- * openejb-activemq
-
-_The source for this example is in the "telephone-stateful" directory
-located in the [openejb-examples.zip](openejb:download.html)
- available on the [download page](http://tomee.apache.org/downloads.html)._
-
-{note}
-If your goal is simply to unit test beans with remote interfaces, this is
-*not* the right example for you. The LocalInitialContextFactory completely
-supports remote interfaces and all spec required pass-by-value
-(serialization) semantics without the need for network sockets. This
-example shows the use of OpenEJB in an embedded environment where
-connection *outside* the
-vm is required.{note}
-
-<a name="EmbeddedandRemotable-TheCode"></a>
-# The Code
-
-For this example we have a simple Stateful bean called TelephoneBean as
-defined below. As a simple way of demonstrating the state we have to
-methods: speak and listen. You call _speak_ and pass in some text, then
-you call _listen_ to get your answer.
-
-<a name="EmbeddedandRemotable-bean"></a>
-## bean
-
-{snippet:id=code|url=openejb3/examples/telephone-stateful/src/main/java/org/superbiz/telephone/TelephoneBean.java|lang=java}
-
-<a name="EmbeddedandRemotable-businessinterface"></a>
-## business interface
-
-{snippet:id=code|url=openejb3/examples/telephone-stateful/src/main/java/org/superbiz/telephone/Telephone.java|lang=java}
-
-{tip:title=EJB3 Notes}
-The bean class uses the annotation *@Remote* but does not specify a list of
-interfaces as is normally required. Per EJB3 rules, if the bean implements
-exactly *one business interface* it may use @Remote with no other values
-and that business interface is then implied to be a remote business
-interface. The same rule applies to identical usage of @Local.
-
-The critical thing to know is that if you add another interface the rules
-change and require that you specify both interfaces in the @Remote
-annotation as in @Remote(\{Telephone.class, SecondInterface.class\}).
-{tip}
-
-<a name="EmbeddedandRemotable-Embedding"></a>
-# Embedding
-
-We're going to embed OpenEJB3 into a plain JUnit TestCase as a simple means
-of demonstrating the remote capabilities. We'll do the embedding in our
-test setUp method, then will make two test methods:
- - one for invoking the bean's remote interface via the
-*LocalInitialContextFactory* which goes straight against the embedded
-container system
- - one for invoking the bean's remote interface via the
-*RemoteInitialContextFactory* which connects to a Socket and communicates
-to the embedded container system over the ejbd protocol.
-
-<a name="EmbeddedandRemotable-setUp"></a>
-## setUp
-
-{snippet:id=setup|url=openejb3/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java|lang=java}
-
-## LocalInitialContextFactory: making in-vm calls to a remote business
-interface
-
-{snippet:id=localcontext|url=openejb3/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java|lang=java}
-
-## RemoteInitialContextFactory: making networked calls to a remote
-business interface
-
-This is the part you would want to do in apps that are running a different
-VM than the one in which the ejb container is embedded. These "client" VMs
-need only have the the *openejb-client jar* in their classpath and connect
-to OpenEJB via the RemoteInitialContextFactory like any other remote EJB
-client.
-
-{snippet:id=remotecontext|url=openejb3/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java|lang=java}
-
-<a name="EmbeddedandRemotable-Mavensetup"></a>
-# Maven setup
-
-{snippet:id=desc|url=openejb3/examples/telephone-stateful/pom.xml}
-
-{snippet:id=openejbdep|url=openejb3/examples/telephone-stateful/pom.xml|lang=xml}
-
-
-<a name="EmbeddedandRemotable-Running"></a>
-# Running
-
-Running the example is fairly simple. In the "telephone-stateful"
-directory of the [examples zip](openejb:download.html)
-, just run:
-
-$ mvn clean install
-
-Which should create output like the following.
-
-
- -------------------------------------------------------
- T E S T S
- -------------------------------------------------------
- Running org.superbiz.telephone.TelephoneTest
- Apache OpenEJB 3.0 build: 20080408-04:13
- http://tomee.apache.org/
- INFO - openejb.home =
-/Users/dblevins/work/openejb-3.0/examples/telephone-stateful
- INFO - openejb.base =
-/Users/dblevins/work/openejb-3.0/examples/telephone-stateful
- INFO - Configuring Service(id=Default Security Service,
-type=SecurityService, provider-id=Default Security Service)
- INFO - Configuring Service(id=Default Transaction Manager,
-type=TransactionManager, provider-id=Default Transaction Manager)
- INFO - Configuring Service(id=Default JDK 1.3 ProxyFactory,
-type=ProxyFactory, provider-id=Default JDK 1.3 ProxyFactory)
- INFO - Found EjbModule in classpath:
-/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes
- INFO - Configuring app:
-/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes
- INFO - Configuring Service(id=Default Stateful Container, type=Container,
-provider-id=Default Stateful Container)
- INFO - Auto-creating a container for bean TelephoneBean:
-Container(type=STATEFUL, id=Default Stateful Container)
- INFO - Loaded Module:
-/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes
- INFO - Assembling app:
-/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes
- INFO - Jndi(name=TelephoneBeanRemote) --> Ejb(deployment-id=TelephoneBean)
- INFO - Created Ejb(deployment-id=TelephoneBean, ejb-name=TelephoneBean,
-container=Default Stateful Container)
- INFO - Deployed
-Application(path=/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes)
- ** Starting Services **
- NAME IP PORT
- ejbd 127.0.0.1 4201
- admin thread 127.0.0.1 4200
- -------
- Ready!
- Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.89 sec
-
- Results :
-
- Tests run: 2, Failures: 0, Errors: 0, Skipped: 0
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/embedded-configuration.adoc
----------------------------------------------------------------------
diff --git a/docs/embedded-configuration.adoc b/docs/embedded-configuration.adoc
new file mode 100644
index 0000000..47c4356
--- /dev/null
+++ b/docs/embedded-configuration.adoc
@@ -0,0 +1,135 @@
+# Embedded Configuration
+:index-group: Testing Techniques
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# Defaults, Overrides and Order
+
+When booting up OpenEJB for testing via the `LocalInitialContextFactory`
+or the newer `EJBContainer.createEJBContainer()` API part of EJB 3.1
+there is quite a bit of flexibility to how things are configured.
+
+OpenEJB will function fine with no configuration at all and will happily
+create things as needed and select defaults for everything. So in a real
+sense configuration is all about overriding those defaults. There are
+several places to put your overrides and an a specific order how they
+are applied. Here they are in order of preference; 1 = highest, 5 =
+lowest.
+
+\{row \{span8 *InitialContext*
+
+[arabic]
+. InitialContext properties
+. jndi.properties from the classpath
+. System properties
+. openejb.xml declarations/properties
+. service-jar.xml declarations/properties (internal concept) }
+
+\{span8 *EJBContainer API* 1. EJBContainer.createEJBContainer(Map)
+entries 1. System properties 1. openejb.xml declarations/properties 1.
+service-jar.xml declarations/properties (internal concept)
+
+} }
+
+It opens up some interesting possibilities in how you configure your
+environment. You could do 100% of your configuration in your test case
+via InitialContext propertes, or you could do say 80% in a
+jndi.properties file or openejb.xml file and 20% in your test case via
+InitialContext properties. You can put 100% of your configuration in a
+`jndi.properties` or `openejb.xml` file and override them via
+`InitialContext` properties.
+
+You can manage the properties how you wish and there is no need for
+redundant definitions if you do not want them.
+
+# What is configurable?
+
+Everything you can configure via an openejb.xml (minus the element) can
+be configured/overridden via properties. See
+link:configuring-containers-in-tests.html[Configuring Containers in
+Tests] and link:configuring-datasources-in-tests.html[Configuring
+DataSources in Tests].
+
+Everything in your logging.properties can be configured/overridden via
+properties. See link:configuring-logging-in-tests.html[Configuring
+Logging in Tests].
+
+The properties of persistence units declared in a persistence.xml can be
+configured/overridden via properties. See
+link:configuring-persistenceunits-in-tests.html[Configuring
+PersistenceUnits in Tests].
+
+OpenEJB has many flags that can also be set as properties. See
+link:properties-listing.html[OpenEJB Properties] for details on those.
+
+# Example of using InitialContext properties
+
+....
+Properties p = new Properties();
+
+// set the initial context factory
+p.put("java.naming.factory.initial ", "org.apache.openejb.client.LocalInitialContextFactory");
+
+// change some logging
+p.put("log4j.category.OpenEJB.options ", " debug");
+p.put("log4j.category.OpenEJB.startup ", " debug");
+p.put("log4j.category.OpenEJB.startup.config ", " debug");
+
+// create some resources
+p.put("movieDatabase", "new://Resource?type=DataSource");
+p.put("movieDatabase.JdbcDriver ", " org.hsqldb.jdbcDriver");
+p.put("movieDatabase.JdbcUrl ", " jdbc:hsqldb:mem:moviedb");
+
+// override properties on your "movie-unit" persistence unit
+p.put("movie-unit.hibernate.dialect ", "org.hibernate.dialect.HSQLDialect");
+
+// set some openejb flags
+p.put("openejb.jndiname.format ", " {ejbName}/{interfaceClass}");
+p.put("openejb.descriptors.output ", " true");
+p.put("openejb.validation.output.level ", " verbose");
+
+InitialContext initialContext = new InitialContext(p);
+....
+
+# Example of using jndi.properties
+
+Here's an example of the same properties being specified via a
+`jndi.properties file`. This file just needs to be placed in the
+classpath, not in a subdirectory of a path in the classpath such as
+META-INF, but at the root of any of the paths in the classpath.
+
+....
+# set the initial context factory
+java.naming.factory.initial = org.apache.openejb.client.LocalInitialContextFactory
+
+# change some logging
+log4j.category.OpenEJB.options = debug
+log4j.category.OpenEJB.startup = debug
+log4j.category.OpenEJB.startup.config = debug
+
+# create some resources
+movieDatabase = new://Resource?type=DataSource
+movieDatabase.JdbcDriver = org.hsqldb.jdbcDriver
+movieDatabase.JdbcUrl = jdbc:hsqldb:mem:moviedb
+
+# override properties on your "movie-unit" persistence unit
+movie-unit.hibernate.dialect = org.hibernate.dialect.HSQLDialect
+
+# set some openejb flags
+openejb.jndiname.format = {ejbName}/{interfaceClass}
+openejb.descriptors.output = true
+openejb.validation.output.level = verbose
+....
+
+Then OpenEJB can be booted via the `InitialContext` as normal.
+Properties can still be used to override any of the above properties:
+
+....
+Properties p = new Properties();
+
+p.put("openejb.validation.output.level ", " medium");
+
+InitialContext initialContext = new InitialContext(p);
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/embedded-configuration.md
----------------------------------------------------------------------
diff --git a/docs/embedded-configuration.md b/docs/embedded-configuration.md
deleted file mode 100644
index 00117a3..0000000
--- a/docs/embedded-configuration.md
+++ /dev/null
@@ -1,135 +0,0 @@
-index-group=Testing Techniques
-type=page
-status=published
-title=Embedded Configuration
-~~~~~~
-
-<a name="EmbeddedConfiguration-Defaults,OverridesandOrder"></a>
-# Defaults, Overrides and Order
-
-When booting up OpenEJB for testing via the `LocalInitialContextFactory`
-or the newer `EJBContainer.createEJBContainer()` API part of EJB 3.1 there
-is quite a bit of flexibility to how things are configured.
-
-OpenEJB will function fine with no configuration at all and will happily
-create things as needed and select defaults for everything. So in a real
-sense configuration is all about overriding those defaults. There are
-several places to put your overrides and an a specific order how they are
-applied. Here they are in order of preference; 1 = highest, 5 = lowest.
-
-{row
-{span8
-**InitialContext**
-
-1. InitialContext properties
-1. jndi.properties from the classpath
-1. System properties
-1. openejb.xml declarations/properties
-1. service-jar.xml declarations/properties (internal concept)
-}
-
-{span8
-**EJBContainer API**
-1. EJBContainer.createEJBContainer(Map) entries
-1. System properties
-1. openejb.xml declarations/properties
-1. service-jar.xml declarations/properties (internal concept)
-
-}
-}
-
-It opens up some interesting possibilities in how you configure your
-environment. You could do 100% of your configuration in your test case via
-InitialContext propertes, or you could do say 80% in a jndi.properties file
-or openejb.xml file and 20% in your test case via InitialContext
-properties. You can put 100% of your configuration in a `jndi.properties` or
-`openejb.xml` file and override them via `InitialContext` properties.
-
-You can manage the properties how you wish and there is no need for
-redundant definitions if you do not want them.
-
-<a name="EmbeddedConfiguration-Whatisconfigurable?"></a>
-# What is configurable?
-
-Everything you can configure via an openejb.xml (minus the <Deployment>
-element) can be configured/overridden via properties. See [Configuring Containers in Tests](configuring-containers-in-tests.html)
- and [Configuring DataSources in Tests](configuring-datasources-in-tests.html).
-
-Everything in your logging.properties can be configured/overridden via
-properties. See [Configuring Logging in Tests](configuring-logging-in-tests.html).
-
-The properties of persistence units declared in a persistence.xml can be
-configured/overridden via properties. See [Configuring PersistenceUnits in Tests](configuring-persistenceunits-in-tests.html).
-
-OpenEJB has many flags that can also be set as properties. See [OpenEJB Properties](properties-listing.html)
- for details on those.
-
-<a name="EmbeddedConfiguration-ExampleofusingInitialContextproperties"></a>
-# Example of using InitialContext properties
-
-
- Properties p = new Properties();
-
- // set the initial context factory
- p.put("java.naming.factory.initial ", "org.apache.openejb.client.LocalInitialContextFactory");
-
- // change some logging
- p.put("log4j.category.OpenEJB.options ", " debug");
- p.put("log4j.category.OpenEJB.startup ", " debug");
- p.put("log4j.category.OpenEJB.startup.config ", " debug");
-
- // create some resources
- p.put("movieDatabase", "new://Resource?type=DataSource");
- p.put("movieDatabase.JdbcDriver ", " org.hsqldb.jdbcDriver");
- p.put("movieDatabase.JdbcUrl ", " jdbc:hsqldb:mem:moviedb");
-
- // override properties on your "movie-unit" persistence unit
- p.put("movie-unit.hibernate.dialect ", "org.hibernate.dialect.HSQLDialect");
-
- // set some openejb flags
- p.put("openejb.jndiname.format ", " {ejbName}/{interfaceClass}");
- p.put("openejb.descriptors.output ", " true");
- p.put("openejb.validation.output.level ", " verbose");
-
- InitialContext initialContext = new InitialContext(p);
-
-
-<a name="EmbeddedConfiguration-Exampleofusingjndi.properties"></a>
-# Example of using jndi.properties
-
-Here's an example of the same properties being specified via a
-`jndi.properties file`. This file just needs to be placed in the classpath,
-not in a subdirectory of a path in the classpath such as META-INF, but at
-the root of any of the paths in the classpath.
-
- # set the initial context factory
- java.naming.factory.initial = org.apache.openejb.client.LocalInitialContextFactory
-
- # change some logging
- log4j.category.OpenEJB.options = debug
- log4j.category.OpenEJB.startup = debug
- log4j.category.OpenEJB.startup.config = debug
-
- # create some resources
- movieDatabase = new://Resource?type=DataSource
- movieDatabase.JdbcDriver = org.hsqldb.jdbcDriver
- movieDatabase.JdbcUrl = jdbc:hsqldb:mem:moviedb
-
- # override properties on your "movie-unit" persistence unit
- movie-unit.hibernate.dialect = org.hibernate.dialect.HSQLDialect
-
- # set some openejb flags
- openejb.jndiname.format = {ejbName}/{interfaceClass}
- openejb.descriptors.output = true
- openejb.validation.output.level = verbose
-
-
-Then OpenEJB can be booted via the `InitialContext` as normal. Properties
-can still be used to override any of the above properties:
-
-
- Properties p = new Properties();
-
- p.put("openejb.validation.output.level ", " medium");
-
- InitialContext initialContext = new InitialContext(p);
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/embedding.adoc
----------------------------------------------------------------------
diff --git a/docs/embedding.adoc b/docs/embedding.adoc
new file mode 100644
index 0000000..516826d
--- /dev/null
+++ b/docs/embedding.adoc
@@ -0,0 +1,34 @@
+# Embedding
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+The basic process for embedding OpenEJB:
+
+[arabic]
+. Add the OpenEJB libraries to your classpath
+. Ensure your EJB modules are discoverable
+. Use the LocalInitialContextFactory to boot OpenEJB
+
+== Important docs
+
+* link:application-discovery-via-the-classpath.html[Application
+discovery via the classpath]
+* link:embedded-configuration.html[Embedded Configuration]
+* link:configuring-datasources-in-tests.html[Configuring DataSources in
+Tests]
+* link:configuring-persistenceunits-in-tests.html[Configuring
+PersistenceUnits in Tests]
+* link:configuring-containers-in-tests.html[Configuring Containers in
+Tests]
+* link:configuring-logging-in-tests.html[Configuring Logging in Tests]
+* link:alternate-descriptors.html[Alternate Descriptors]
+* link:unit-testing-transactions.html[Unit Testing Transactions]
+* link:testcase-with-testbean-inner-class.html[TestCase with TestBean
+inner-class]
+* [TestCase Injection (@LocalClient)](local-client-injection.html)
+
+== Examples
+
+\{include:Examples Table}
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/embedding.md
----------------------------------------------------------------------
diff --git a/docs/embedding.md b/docs/embedding.md
deleted file mode 100644
index aa8e32b..0000000
--- a/docs/embedding.md
+++ /dev/null
@@ -1,30 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Embedding
-~~~~~~
-The basic process for embedding OpenEJB:
-
-1. Add the OpenEJB libraries to your classpath
-1. Ensure your EJB modules are discoverable
-1. Use the LocalInitialContextFactory to boot OpenEJB
-
-
-<a name="Embedding-Importantdocs"></a>
-## Important docs
-
-- [Application discovery via the classpath](application-discovery-via-the-classpath.html)
-- [Embedded Configuration](embedded-configuration.html)
-- [Configuring DataSources in Tests](configuring-datasources-in-tests.html)
-- [Configuring PersistenceUnits in Tests](configuring-persistenceunits-in-tests.html)
-- [Configuring Containers in Tests](configuring-containers-in-tests.html)
-- [Configuring Logging in Tests](configuring-logging-in-tests.html)
-- [Alternate Descriptors](alternate-descriptors.html)
-- [Unit Testing Transactions](unit-testing-transactions.html)
-- [TestCase with TestBean inner-class](testcase-with-testbean-inner-class.html)
-- [TestCase Injection (@LocalClient)](local-client-injection.html)
-
-<a name="Embedding-Examples"></a>
-## Examples
-
-{include:Examples Table}
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/failover-logging.adoc
----------------------------------------------------------------------
diff --git a/docs/failover-logging.adoc b/docs/failover-logging.adoc
new file mode 100644
index 0000000..76c23a9
--- /dev/null
+++ b/docs/failover-logging.adoc
@@ -0,0 +1,54 @@
+:index-group: Discovery
+and Failover
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+Setting the following logging category to "debug" will open up some new
+logging information.
+
+....
+log4j.category.OpenEJB.server.discovery = debug
+....
+
+Or more specifically as:
+
+....
+log4j.category.OpenEJB.server.discovery.multipoint = debug
+log4j.category.OpenEJB.server.discovery.multicast = debug
+....
+
+The nature of the debug output is to display all configuration
+information at startup:
+
+....
+DEBUG - Using default 'heart_rate=500'
+DEBUG - Using default 'max_missed_heartbeats=10'
+DEBUG - Using default 'max_reconnect_delay=30000'
+DEBUG - Using default 'reconnect_delay=5000'
+DEBUG - Using default 'exponential_backoff=0'
+DEBUG - Using default 'max_reconnect_attempts=10'
+INFO - Created Tracker{group='default', groupPrefix='default:', heartRate=500, maxMissedHeartbeats=10, reconnectDelay=5000, maxReconnectDelay=30000, maxReconnectAttempts=10, exponentialBackoff=0, useExponentialBackOff=false, registeredServices=0, discoveredServices=0}
+....
+
+Changing the configuration should reflect in the logging as follows:
+
+....
+INFO - Using 'heart_rate=200'
+INFO - Using 'max_missed_heartbeats=2'
+DEBUG - Using default 'max_reconnect_delay=30000'
+DEBUG - Using default 'reconnect_delay=5000'
+DEBUG - Using default 'exponential_backoff=0'
+DEBUG - Using default 'max_reconnect_attempts=10'
+INFO - Created Tracker{group='default', groupPrefix='default:', heartRate=200, maxMissedHeartbeats=2, reconnectDelay=5000, maxReconnectDelay=30000, maxReconnectAttempts=10, exponentialBackoff=0, useExponentialBackOff=false, registeredServices=0, discoveredServices=0}
+....
+
+As well as any events at runtime:
+
+....
+DEBUG - Expired Service{uri=green://localhost:0, broadcastString='default:green://localhost:0'} Timeout{lastSeen=-5005, threshold=5000}
+
+DEBUG - Added Service{uri=green://localhost:0}
+
+DEBUG - Removed Service{uri=green://localhost:0}
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/failover-logging.md
----------------------------------------------------------------------
diff --git a/docs/failover-logging.md b/docs/failover-logging.md
deleted file mode 100644
index a21addd..0000000
--- a/docs/failover-logging.md
+++ /dev/null
@@ -1,42 +0,0 @@
-index-group=Discovery and Failover
-type=page
-status=published
-~~~~~~
-Setting the following logging category to "debug" will open up some new logging information.
-
- log4j.category.OpenEJB.server.discovery = debug
-
-Or more specifically as:
-
- log4j.category.OpenEJB.server.discovery.multipoint = debug
- log4j.category.OpenEJB.server.discovery.multicast = debug
-
-The nature of the debug output is to display all configuration information at startup:
-
- DEBUG - Using default 'heart_rate=500'
- DEBUG - Using default 'max_missed_heartbeats=10'
- DEBUG - Using default 'max_reconnect_delay=30000'
- DEBUG - Using default 'reconnect_delay=5000'
- DEBUG - Using default 'exponential_backoff=0'
- DEBUG - Using default 'max_reconnect_attempts=10'
- INFO - Created Tracker{group='default', groupPrefix='default:', heartRate=500, maxMissedHeartbeats=10, reconnectDelay=5000, maxReconnectDelay=30000, maxReconnectAttempts=10, exponentialBackoff=0, useExponentialBackOff=false, registeredServices=0, discoveredServices=0}
-
-Changing the configuration should reflect in the logging as follows:
-
- INFO - Using 'heart_rate=200'
- INFO - Using 'max_missed_heartbeats=2'
- DEBUG - Using default 'max_reconnect_delay=30000'
- DEBUG - Using default 'reconnect_delay=5000'
- DEBUG - Using default 'exponential_backoff=0'
- DEBUG - Using default 'max_reconnect_attempts=10'
- INFO - Created Tracker{group='default', groupPrefix='default:', heartRate=200, maxMissedHeartbeats=2, reconnectDelay=5000, maxReconnectDelay=30000, maxReconnectAttempts=10, exponentialBackoff=0, useExponentialBackOff=false, registeredServices=0, discoveredServices=0}
-
-As well as any events at runtime:
-
- DEBUG - Expired Service{uri=green://localhost:0, broadcastString='default:green://localhost:0'} Timeout{lastSeen=-5005, threshold=5000}
-
- DEBUG - Added Service{uri=green://localhost:0}
-
- DEBUG - Removed Service{uri=green://localhost:0}
-
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/faq.adoc
----------------------------------------------------------------------
diff --git a/docs/faq.adoc b/docs/faq.adoc
new file mode 100644
index 0000000..d02d971
--- /dev/null
+++ b/docs/faq.adoc
@@ -0,0 +1,105 @@
+# FAQ
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+##
+ General
+
+
+
+=== What spec version does OpenEJB support?
+
+OpenEJB supports the Enterprise JavaBeans 3.0 specification and previous
+versions 2.1, 2.0 and 1.1.
+
+=== I don't plan to use EJBs, so why would I embed OpenEJB into Tomcat.
+
+Adding OpenEJB to Tomcat gives servlets several new Java EE 5
+capabilities such as JPA, JAX-WS, JMS, J2EE Connectors, transactions,
+and more as well as enhancing the injection features of Tomcat 6 to now
+support injection of JavaEE objects like Topics, Queues, EntityManagers,
+JMS ConnectionFactories, JavaMail Sessions, as well as simpler data
+types such as Dates, Classes, URI, URL, List, Map, Set, Properties, and
+more. In the case of Tomcat 5.5 which doesn't support dependency
+injection at all, even more is gained.
+
+=== Can I run OpenEJB with a JVM for any vendor?
+
+The Sun, Mac, and IBM vms are regularly tested, however any vm should
+work.
+
+=== Which version of Java is required to run OpenEJB?
+
+Java versions 5 or 6, aka Java 1.5 or 1.6.
+
+=== Do I need Apache Maven to work with OpenEJB?
+
+Definitely not. Most of the examples include both Maven and Ant build
+files. OpenEJB is usable as a plain library, much like an embedded
+database like Derby, so it is usable in any application regardless if
+that application is run via Maven, Ant, Intellij, Eclipse, NetBeans,
+JUnit, TestNG, etc.
+
+== Can I start and stop OpenEJB from an IDE? If yes, which IDE is
+
+supported by OpenEJB?
+
+The short answer is yes. The basic approach for all embedding scenarios
+is to 1) add OpenEJB to your classpath, and 2) construct your
+InitialContext using
+org.apache.openejb.client.LocalInitialContextFactory. The
+LocalInitialContextFactory will boot OpenEJB in your vm and all ejb
+applications visible in the classpath will be deployed. See
+http://tomee.apache.org/embedding-openejb.html for details on how to
+embed openejb in your application and IDE. See
+openejbx30:application-discovery-via-the-classpath.html[Application
+discovery via the classpath] for various ways to have your applications
+discovered.
+
+== During embedded testing, how can I externalize all my DataSource
+
+configuration?
+
+Create an openejb.xml file in any directory that gets added to your test
+classpath. For maven, something that winds up directly under
+"target/classes/" or "target/test-classes/" will work just fine. Then in
+your test case do this:
+
+....
+ protected void setUp() throws Exception {
+ Properties properties = new Properties();
+ properties.setProperty(Context.INITIAL_CONTEXT_FACTORY,
+....
+
+"org.apache.openejb.client.LocalInitialContextFactory");
+
+....
+ URL config =
+....
+
+this.getClass().getClassLoader().getResource("openejb.xml");
+properties.setProperty("openejb.configuration",
+config.toExternalForm());
+
+....
+ initialContext = new InitialContext(properties);
+ }
+....
+
+The file itself doesn't have to be called "openejb.xml", you could have
+a few different files like that for different testing scenarios each
+with a name that describes the basic setup.
+
+== Container-Managed Persistence
+
+=== What engine does OpenEJB use for CMP?
+
+The CMP engine is written as a layer over JPA with OpenJPA doing the
+persistence work.
+
+=== What is the format for the CMP mapping files?
+
+The standard JPA mapping file and annotations are also used for CMP
+mappings.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/faq.md
----------------------------------------------------------------------
diff --git a/docs/faq.md b/docs/faq.md
deleted file mode 100644
index 5753125..0000000
--- a/docs/faq.md
+++ /dev/null
@@ -1,99 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=FAQ
-~~~~~~
-<a name="FAQ- General"></a>
-## General
-
-
-
-<a name="FAQ-WhatspecversiondoesOpenEJBsupport?"></a>
-### What spec version does OpenEJB support?
-
-OpenEJB supports the Enterprise JavaBeans 3.0 specification and previous
-versions 2.1, 2.0 and 1.1.
-
-<a name="FAQ-Idon'tplantouseEJBs,sowhywouldIembedOpenEJBintoTomcat."></a>
-### I don't plan to use EJBs, so why would I embed OpenEJB into Tomcat.
-
-Adding OpenEJB to Tomcat gives servlets several new Java EE 5 capabilities
-such as JPA, JAX-WS, JMS, J2EE Connectors, transactions, and more as well
-as enhancing the injection features of Tomcat 6 to now support injection of
-JavaEE objects like Topics, Queues, EntityManagers, JMS
-ConnectionFactories, JavaMail Sessions, as well as simpler data types such
-as Dates, Classes, URI, URL, List, Map, Set, Properties, and more. In the
-case of Tomcat 5.5 which doesn't support dependency injection at all, even
-more is gained.
-
-<a name="FAQ-CanIrunOpenEJBwithaJVMforanyvendor?"></a>
-### Can I run OpenEJB with a JVM for any vendor?
-
-The Sun, Mac, and IBM vms are regularly tested, however any vm should work.
-
-<a name="FAQ-WhichversionofJavaisrequiredtorunOpenEJB?"></a>
-### Which version of Java is required to run OpenEJB?
-
-Java versions 5 or 6, aka Java 1.5 or 1.6.
-
-<a name="FAQ-DoIneedApacheMaventoworkwithOpenEJB?"></a>
-### Do I need Apache Maven to work with OpenEJB?
-
-Definitely not. Most of the examples include both Maven and Ant build
-files. OpenEJB is usable as a plain library, much like an embedded
-database like Derby, so it is usable in any application regardless if that
-application is run via Maven, Ant, Intellij, Eclipse, NetBeans, JUnit,
-TestNG, etc.
-
-### Can I start and stop OpenEJB from an IDE? If yes, which IDE is
-supported by OpenEJB?
-
-The short answer is yes. The basic approach for all embedding scenarios is
-to 1) add OpenEJB to your classpath, and 2) construct your InitialContext
-using org.apache.openejb.client.LocalInitialContextFactory. The
-LocalInitialContextFactory will boot OpenEJB in your vm and all ejb
-applications visible in the classpath will be deployed. See
-http://tomee.apache.org/embedding-openejb.html for details on how to
-embed openejb in your application and IDE. See [Application discovery via the classpath](openejbx30:application-discovery-via-the-classpath.html)
- for various ways to have your applications discovered.
-
-
-### During embedded testing, how can I externalize all my DataSource
-configuration?
-
-Create an openejb.xml file in any directory that gets added to your test
-classpath. For maven, something that winds up directly under
-"target/classes/" or "target/test-classes/" will work just fine. Then in
-your test case do this:
-
- protected void setUp() throws Exception {
- Properties properties = new Properties();
- properties.setProperty(Context.INITIAL_CONTEXT_FACTORY,
-"org.apache.openejb.client.LocalInitialContextFactory");
-
- URL config =
-this.getClass().getClassLoader().getResource("openejb.xml");
- properties.setProperty("openejb.configuration",
-config.toExternalForm());
-
- initialContext = new InitialContext(properties);
- }
-
-The file itself doesn't have to be called "openejb.xml", you could have a
-few different files like that for different testing scenarios each with a
-name that describes the basic setup.
-
-<a name="FAQ-Container-ManagedPersistence"></a>
-## Container-Managed Persistence
-
-<a name="FAQ-WhatenginedoesOpenEJBuseforCMP?"></a>
-### What engine does OpenEJB use for CMP?
-
-The CMP engine is written as a layer over JPA with OpenJPA doing the
-persistence work.
-
-<a name="FAQ-WhatistheformatfortheCMPmappingfiles?"></a>
-### What is the format for the CMP mapping files?
-
-The standard JPA mapping file and annotations are also used for CMP
-mappings.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/features.adoc
----------------------------------------------------------------------
diff --git a/docs/features.adoc b/docs/features.adoc
new file mode 100644
index 0000000..a07b216
--- /dev/null
+++ b/docs/features.adoc
@@ -0,0 +1,6 @@
+# Features
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/features.md
----------------------------------------------------------------------
diff --git a/docs/features.md b/docs/features.md
deleted file mode 100644
index 7486ee3..0000000
--- a/docs/features.md
+++ /dev/null
@@ -1,6 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Features
-~~~~~~
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/from-glassfish-to-tomee.adoc
----------------------------------------------------------------------
diff --git a/docs/from-glassfish-to-tomee.adoc b/docs/from-glassfish-to-tomee.adoc
new file mode 100644
index 0000000..2e1dcc9
--- /dev/null
+++ b/docs/from-glassfish-to-tomee.adoc
@@ -0,0 +1,11 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# From Glassfish
+Application Server to TomEE (plus)
+
+This page aims at reporting feedback from users while migrating from
+Glassfish to Apache TomEE.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/from-glassfish-to-tomee.md
----------------------------------------------------------------------
diff --git a/docs/from-glassfish-to-tomee.md b/docs/from-glassfish-to-tomee.md
deleted file mode 100644
index e41719b..0000000
--- a/docs/from-glassfish-to-tomee.md
+++ /dev/null
@@ -1,7 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-# From Glassfish Application Server to TomEE (plus)
-
-This page aims at reporting feedback from users while migrating from Glassfish to Apache TomEE.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/functional-testing-with-openejb,-jetty-and-selenium.adoc
----------------------------------------------------------------------
diff --git a/docs/functional-testing-with-openejb,-jetty-and-selenium.adoc b/docs/functional-testing-with-openejb,-jetty-and-selenium.adoc
new file mode 100644
index 0000000..2e64527
--- /dev/null
+++ b/docs/functional-testing-with-openejb,-jetty-and-selenium.adoc
@@ -0,0 +1,243 @@
+# Functional testing with OpenEJB, Jetty and Selenium
+:index-group: Testing Techniques
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+Obviously, OpenEJB is
+great for unit testing EJBs, but I wondered whether I might also be able
+to use this embedded functionality to functionally test my application.
+You can use tools like Selenium, or HtmlUnit to run functional tests as
+if the user were sat at their browser typing text, and clicking links
+and buttons. This however means you have to have your app running on
+your app server, and you need to have consistent test data - otherwise a
+test might pass on one developers machine, but fail on another. Here's
+one approach that you could take to completely deploy your webapp within
+a test, and functionally test it with a tool like Selenium. There's also
+some sample code demonstrating this, available
+http://people.apache.org/~jgallimore/PersonApp.zip[here] .
+
+=== Creating an embedded server
+
+I created a class to start my embedded OpenEJB and Jetty instances and
+configure them to see the EJB and WAR modules of my application:
+
+....
+public class EmbeddedServer {
+ private static EmbeddedServer instance = new EmbeddedServer();
+ private Server server;
+
+ private EmbeddedServer() {
+ try {
+ // initialize OpenEJB & add some test data
+ Properties properties = new Properties();
+ properties.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.LocalInitialContextFactory");
+ InitialContext ic = new InitialContext(properties);
+ PeopleFacade facade = (PeopleFacade) ic.lookup("PeopleFacadeEJBRemote");
+ new TestFixture(facade).addTestData();
+
+ // setup web app
+ WebAppContext context = new WebAppContext();
+ context.setWar(computeWarPath());
+ InitialContext initialContext = setupJndi(context);
+
+ // start the server
+ context.setServletHandler(new EmbeddedServerServletHandler(initialContext));
+ context.setContextPath("/");
+ server = new Server(9091);
+ server.addHandler(context);
+
+ server.start();
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+ }
+
+ private InitialContext setupJndi(WebAppContext context) throws NamingException {
+ // setup local JNDI
+ InitialContext initialContext = new InitialContext();
+ WebApp webApp = getWebApp(context);
+ Collection<EjbRef> refs = webApp.getEjbRef();
+ for (EjbRef ref : refs) {
+ String ejbLink = ref.getEjbLink();
+
+ // get enterprise bean info
+ EnterpriseBeanInfo beanInfo = new EJBHelper().getEJBInfo(ejbLink);
+ if (beanInfo.jndiNames != null && beanInfo.jndiNames.size() > 0) {
+ String jndiName = "java:openejb/ejb/" + beanInfo.jndiNames.get(0);
+ initialContext.bind("java:comp/env/" + ref.getEjbRefName(), new LinkRef(jndiName));
+ }
+ }
+ return initialContext;
+ }
+
+ private String computeWarPath() {
+ String currentPath = new File(".").getAbsolutePath();
+ String warPath;
+
+ String[] pathParts = currentPath.split("(\\\\|/)+");
+
+ int webPart = Arrays.asList(pathParts).indexOf("PersonWEB");
+ if (webPart == -1) {
+ warPath = "PersonWEB/src/main/webapp";
+ } else {
+ StringBuffer buffer = new StringBuffer();
+
+ for (int i = 0; i < webPart; i++) {
+ buffer.append(pathParts[i]);
+ buffer.append(File.separator);
+ }
+
+ buffer.append("PersonWEB/src/main/webapp");
+ warPath = buffer.toString();
+ }
+ return warPath;
+ }
+
+ public static EmbeddedServer getInstance() {
+ return instance;
+ }
+
+ public Server getServer() {
+ return server;
+ }
+
+ public static void main(String[] args) {
+ try {
+ EmbeddedServer.getInstance().getServer().join();
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+ }
+
+ private WebApp getWebApp(WebAppContext context) {
+ WebApp webApp = null;
+
+ try {
+ FileInputStream is = new FileInputStream(new File(context.getWar() + "/WEB-INF/web.xml").getAbsolutePath());
+ webApp = (WebApp) JaxbJavaee.unmarshal(WebApp.class, is);
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+ return webApp;
+ }
+}
+....
+
+This class sets up an embedded instance of Jetty, running on port 9091.
+You'll notice the setupJndi() method. This looks through the ejb-ref
+entries in web.xml (which we deserialize using the openejb-jee library),
+and adds relevant LinkRefs to the JNDI tree, so you can lookup beans
+using the java:comp/env/bean format. I've added a main() method here for
+convenience, so you can run this straight from an IDE, and record tests
+using tools like the Selenium Firefox plugin.
+
+=== Supporting @EJB Dependency injection
+
+In the last code sample, we also set up a custom ServletHandler in Jetty
+- this is to perform dependency injection. The custom ServletHandler
+looks like this:
+
+....
+public class EmbeddedServerServletHandler extends ServletHandler {
+ private InitialContext initialContext;
+
+ public EmbeddedServerServletHandler(InitialContext initialContext) {
+ this.initialContext = initialContext;
+ }
+
+ public Servlet customizeServlet(Servlet servlet) throws Exception {
+ Class<? extends Servlet> servletClass = servlet.getClass();
+ Field[]
+....
+
+declaredFields = servletClass.getDeclaredFields();
+
+....
+ for (Field declaredField : declaredFields) {
+ Annotation[]
+....
+
+annotations = declaredField.getAnnotations();
+
+....
+ for (Annotation annotation : annotations) {
+ if (EJB.class.equals(annotation.annotationType())) {
+ // inject into this field
+ Class<?> fieldType = declaredField.getType();
+ EnterpriseBeanInfo beanInfo = getBeanFor(fieldType);
+ if (beanInfo == null) {
+ continue;
+ }
+
+ String jndiName = "java:openejb/ejb/" + beanInfo.jndiNames.get(0);
+ Object o = initialContext.lookup(jndiName);
+
+ declaredField.setAccessible(true);
+ declaredField.set(servlet, o);
+ }
+ }
+ }
+
+ return super.customizeServlet(servlet);
+ }
+
+ private EnterpriseBeanInfo getBeanFor(Class<?> fieldType) {
+ return new EJBHelper().getBeanInfo(fieldType);
+ }
+}
+....
+
+This looks up deployed beans that match the field type, and uses
+reflection to set the field.
+
+=== Writing a Functional test
+
+We can now write a functional test. I use a base abstract class to make
+sure the Embedded server is running, and start Selenium:
+
+....
+public abstract class FunctionalTestCase extends TestCase {
+ protected DefaultSelenium selenium;
+
+ protected void setUp() throws Exception {
+ super.setUp();
+ EmbeddedServer.getInstance();
+ selenium = new DefaultSelenium("localhost", 4444, "*iexplore", "http://localhost:9091/");
+ selenium.start();
+ }
+
+ protected void tearDown() throws Exception {
+ selenium.stop();
+ }
+}
+....
+
+and I can then I write a test like this:
+
+....
+public class AddPersonTest extends FunctionalTestCase {
+ public void testShouldAddAPerson() throws Exception {
+ selenium.open("/People");
+ selenium.type("firstname", "Jonathan");
+ selenium.type("lastname", "Gallimore");
+ selenium.click("//input[@name='add' and @value='Add']");
+ selenium.waitForPageToLoad("30000");
+ selenium.type("filter", "gallimore");
+ selenium.click("submit");
+ selenium.waitForPageToLoad("30000");
+ assertEquals(1, selenium.getXpathCount("//div[@id='people']/ul/li").intValue());
+ assertEquals("Jonathan Gallimore", selenium.getText("//div[@id='people']/ul/li[1]"));
+
+ }
+}
+....
+
+=== Sample code
+
+I've made a sample project which demonstrates this, source is available
+http://people.apache.org/~jgallimore/PersonApp.zip[here] . You'll need
+Maven to build it, and you can build it and run the tests by running
+'mvn clean install'. If want to run the tests from your IDE, you'll need
+to have a Selenium server running, which you can do by running 'mvn
+selenium:start-server'.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/functional-testing-with-openejb,-jetty-and-selenium.md
----------------------------------------------------------------------
diff --git a/docs/functional-testing-with-openejb,-jetty-and-selenium.md b/docs/functional-testing-with-openejb,-jetty-and-selenium.md
deleted file mode 100644
index 218848b..0000000
--- a/docs/functional-testing-with-openejb,-jetty-and-selenium.md
+++ /dev/null
@@ -1,240 +0,0 @@
-index-group=Testing Techniques
-type=page
-status=published
-title=Functional testing with OpenEJB, Jetty and Selenium
-~~~~~~
-Obviously, OpenEJB is great for unit testing EJBs, but I wondered whether I
-might also be able to use this embedded functionality to functionally test
-my application. You can use tools like Selenium, or HtmlUnit to run
-functional tests as if the user were sat at their browser typing text, and
-clicking links and buttons. This however means you have to have your app
-running on your app server, and you need to have consistent test data -
-otherwise a test might pass on one developers machine, but fail on another.
-Here's one approach that you could take to completely deploy your webapp
-within a test, and functionally test it with a tool like Selenium. There's
-also some sample code demonstrating this, available [here](http://people.apache.org/~jgallimore/PersonApp.zip)
-.
-
-
-<a name="FunctionaltestingwithOpenEJB,JettyandSelenium-Creatinganembeddedserver"></a>
-### Creating an embedded server
-
-I created a class to start my embedded OpenEJB and Jetty instances and
-configure them to see the EJB and WAR modules of my application:
-
-
- public class EmbeddedServer {
- private static EmbeddedServer instance = new EmbeddedServer();
- private Server server;
-
- private EmbeddedServer() {
- try {
- // initialize OpenEJB & add some test data
- Properties properties = new Properties();
- properties.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.LocalInitialContextFactory");
- InitialContext ic = new InitialContext(properties);
- PeopleFacade facade = (PeopleFacade) ic.lookup("PeopleFacadeEJBRemote");
- new TestFixture(facade).addTestData();
-
- // setup web app
- WebAppContext context = new WebAppContext();
- context.setWar(computeWarPath());
- InitialContext initialContext = setupJndi(context);
-
- // start the server
- context.setServletHandler(new EmbeddedServerServletHandler(initialContext));
- context.setContextPath("/");
- server = new Server(9091);
- server.addHandler(context);
-
- server.start();
- } catch (Exception e) {
- e.printStackTrace();
- }
- }
-
- private InitialContext setupJndi(WebAppContext context) throws NamingException {
- // setup local JNDI
- InitialContext initialContext = new InitialContext();
- WebApp webApp = getWebApp(context);
- Collection<EjbRef> refs = webApp.getEjbRef();
- for (EjbRef ref : refs) {
- String ejbLink = ref.getEjbLink();
-
- // get enterprise bean info
- EnterpriseBeanInfo beanInfo = new EJBHelper().getEJBInfo(ejbLink);
- if (beanInfo.jndiNames != null && beanInfo.jndiNames.size() > 0) {
- String jndiName = "java:openejb/ejb/" + beanInfo.jndiNames.get(0);
- initialContext.bind("java:comp/env/" + ref.getEjbRefName(), new LinkRef(jndiName));
- }
- }
- return initialContext;
- }
-
- private String computeWarPath() {
- String currentPath = new File(".").getAbsolutePath();
- String warPath;
-
- String[] pathParts = currentPath.split("(\\\\|/)+");
-
- int webPart = Arrays.asList(pathParts).indexOf("PersonWEB");
- if (webPart == -1) {
- warPath = "PersonWEB/src/main/webapp";
- } else {
- StringBuffer buffer = new StringBuffer();
-
- for (int i = 0; i < webPart; i++) {
- buffer.append(pathParts[i]);
- buffer.append(File.separator);
- }
-
- buffer.append("PersonWEB/src/main/webapp");
- warPath = buffer.toString();
- }
- return warPath;
- }
-
- public static EmbeddedServer getInstance() {
- return instance;
- }
-
- public Server getServer() {
- return server;
- }
-
- public static void main(String[] args) {
- try {
- EmbeddedServer.getInstance().getServer().join();
- } catch (Exception e) {
- e.printStackTrace();
- }
- }
-
- private WebApp getWebApp(WebAppContext context) {
- WebApp webApp = null;
-
- try {
- FileInputStream is = new FileInputStream(new File(context.getWar() + "/WEB-INF/web.xml").getAbsolutePath());
- webApp = (WebApp) JaxbJavaee.unmarshal(WebApp.class, is);
- } catch (Exception e) {
- e.printStackTrace();
- }
- return webApp;
- }
- }
-
-
-This class sets up an embedded instance of Jetty, running on port 9091.
-You'll notice the setupJndi() method. This looks through the ejb-ref
-entries in web.xml (which we deserialize using the openejb-jee library),
-and adds relevant LinkRefs to the JNDI tree, so you can lookup beans using
-the java:comp/env/bean format. I've added a main() method here for
-convenience, so you can run this straight from an IDE, and record tests
-using tools like the Selenium Firefox plugin.
-
-<a name="FunctionaltestingwithOpenEJB,JettyandSelenium-Supporting@EJBDependencyinjection"></a>
-### Supporting @EJB Dependency injection
-
-In the last code sample, we also set up a custom ServletHandler in Jetty -
-this is to perform dependency injection. The custom ServletHandler looks
-like this:
-
-
- public class EmbeddedServerServletHandler extends ServletHandler {
- private InitialContext initialContext;
-
- public EmbeddedServerServletHandler(InitialContext initialContext) {
- this.initialContext = initialContext;
- }
-
- public Servlet customizeServlet(Servlet servlet) throws Exception {
- Class<? extends Servlet> servletClass = servlet.getClass();
- Field[]
- declaredFields = servletClass.getDeclaredFields();
-
- for (Field declaredField : declaredFields) {
- Annotation[]
- annotations = declaredField.getAnnotations();
-
- for (Annotation annotation : annotations) {
- if (EJB.class.equals(annotation.annotationType())) {
- // inject into this field
- Class<?> fieldType = declaredField.getType();
- EnterpriseBeanInfo beanInfo = getBeanFor(fieldType);
- if (beanInfo == null) {
- continue;
- }
-
- String jndiName = "java:openejb/ejb/" + beanInfo.jndiNames.get(0);
- Object o = initialContext.lookup(jndiName);
-
- declaredField.setAccessible(true);
- declaredField.set(servlet, o);
- }
- }
- }
-
- return super.customizeServlet(servlet);
- }
-
- private EnterpriseBeanInfo getBeanFor(Class<?> fieldType) {
- return new EJBHelper().getBeanInfo(fieldType);
- }
- }
-
-
-
-This looks up deployed beans that match the field type, and uses reflection
-to set the field.
-
-<a name="FunctionaltestingwithOpenEJB,JettyandSelenium-WritingaFunctionaltest"></a>
-### Writing a Functional test
-
-We can now write a functional test. I use a base abstract class to make
-sure the Embedded server is running, and start Selenium:
-
-
- public abstract class FunctionalTestCase extends TestCase {
- protected DefaultSelenium selenium;
-
- protected void setUp() throws Exception {
- super.setUp();
- EmbeddedServer.getInstance();
- selenium = new DefaultSelenium("localhost", 4444, "*iexplore", "http://localhost:9091/");
- selenium.start();
- }
-
- protected void tearDown() throws Exception {
- selenium.stop();
- }
- }
-
-
-and I can then I write a test like this:
-
-
- public class AddPersonTest extends FunctionalTestCase {
- public void testShouldAddAPerson() throws Exception {
- selenium.open("/People");
- selenium.type("firstname", "Jonathan");
- selenium.type("lastname", "Gallimore");
- selenium.click("//input[@name='add' and @value='Add']");
- selenium.waitForPageToLoad("30000");
- selenium.type("filter", "gallimore");
- selenium.click("submit");
- selenium.waitForPageToLoad("30000");
- assertEquals(1, selenium.getXpathCount("//div[@id='people']/ul/li").intValue());
- assertEquals("Jonathan Gallimore", selenium.getText("//div[@id='people']/ul/li[1]"));
-
- }
- }
-
-
-<a name="FunctionaltestingwithOpenEJB,JettyandSelenium-Samplecode"></a>
-### Sample code
-
-I've made a sample project which demonstrates this, source is available [here](http://people.apache.org/~jgallimore/PersonApp.zip)
-. You'll need Maven to build it, and you can build it and run the tests by
-running 'mvn clean install'. If want to run the tests from your IDE, you'll
-need to have a Selenium server running, which you can do by running 'mvn
-selenium:start-server'.
[02/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 2
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 2
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/d380ec18
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/d380ec18
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/d380ec18
Branch: refs/heads/master
Commit: d380ec1882d75415b288c831797fdbcb09d79c44
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:18 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:07:18 2018 -0800
----------------------------------------------------------------------
docs/basics---getting-things.adoc | 108 +++++++++
docs/basics---getting-things.md | 107 ---------
docs/basics---security.adoc | 54 +++++
docs/basics---security.md | 55 -----
docs/basics---transactions.adoc | 67 ++++++
docs/basics---transactions.md | 60 -----
docs/bmpentitycontainer-config.adoc | 53 +++++
docs/bmpentitycontainer-config.md | 37 ---
docs/bouncy-castle.adoc | 39 ++++
docs/bouncy-castle.md | 34 ---
docs/built-in-type-converters.adoc | 98 ++++++++
docs/built-in-type-converters.md | 94 --------
docs/callbacks.adoc | 165 +++++++++++++
docs/callbacks.md | 167 --------------
docs/changing-jms-implementations.adoc | 158 +++++++++++++
docs/changing-jms-implementations.md | 136 -----------
docs/client-server-transports.adoc | 39 ++++
docs/client-server-transports.md | 22 --
docs/clients.adoc | 95 ++++++++
docs/clients.md | 104 ---------
docs/cmpentitycontainer-config.adoc | 51 ++++
docs/cmpentitycontainer-config.md | 36 ---
docs/collapsed-ear.adoc | 49 ++++
docs/collapsed-ear.md | 46 ----
docs/common-datasource-configurations.adoc | 116 ++++++++++
docs/common-datasource-configurations.md | 115 ---------
docs/common-errors.adoc | 31 +++
docs/common-errors.md | 30 ---
docs/common-persistenceprovider-properties.adoc | 47 ++++
docs/common-persistenceprovider-properties.md | 47 ----
docs/comparison.adoc | 231 +++++++++++++++++++
docs/comparison.md | 222 ------------------
docs/concepts.adoc | 83 +++++++
docs/concepts.md | 79 -------
34 files changed, 1484 insertions(+), 1391 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/basics---getting-things.adoc
----------------------------------------------------------------------
diff --git a/docs/basics---getting-things.adoc b/docs/basics---getting-things.adoc
new file mode 100644
index 0000000..e166d37
--- /dev/null
+++ b/docs/basics---getting-things.adoc
@@ -0,0 +1,108 @@
+# Basics - Getting Things
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Getting Stuff from the Container
+
+Generally speaking the only way to get a
+link:container-managed-resource.html[Container-Managed Resource] is via
+_dependency injection_ or _lookup_ from within a [Container-Managed
+Component] .
+
+The _unbreakable rules_. Read these over and over again when things
+don't work.
+
+[arabic]
+. java:comp/env is the spec defined namespace for lookup of any
+link:container-managed-resource.html[Container-Managed Resource]
+. java:comp/env is _empty_ by default
+. java:comp/env is _read-only_ at runtime
+. java:comp/env is populated by link:declaring-references.html[Declaring
+References] to [Container-Managed Resource] via xml or annotation
+. only link:container-managed-component.html[Container-Managed
+Component] s, _not_ their libraries, can [Declare References|Declaring
+References] via xml or annotation
+. only link:container-managed-component.html[Container-Managed
+Component] s, _not_ their libraries, can get dependency injection of
+[Container-Managed Resource] s
+. only link:container-managed-component.html[Container-Managed
+Component] s, _and_ their libraries, may lookup from java:comp/env
+. you _must_ use the _no-arg_ 'new InitialContext()' constructor to
+lookup something from java:comp/env
+. the annotations and xml for link:declaring-references.html[Declaring
+References] are _identical_ in functionality, both _always_ configure
+lookup with _optional_ dependency injection
+
+== Common mistakes, misunderstandings, and myths
+
+* __"I tried it via annotation and it didn't work, so I used xml and
+then it did work"__
+
+See rule 9. If one form worked and the other didn't, it means you simply
+made a mistake in using one versus the other. Use what works for you,
+but understand both annotations or xml will work for either lookup or
+injection if used correctly.
+
+* __"I need to use lookups, so I can't use the annotation"__
+
+See rule 9. Annotations are not just for injection, that is just how
+they are typically used. Know that when you use an annotation for
+injection, it will _always_ create an entry in java:comp/env. As well
+you can use the annotation at the _class level_ and it will cause no
+dependency injection and only the entry creation in java:comp/env.
+
+* __"I don't want injection, so I can't use the annotation"__
+
+See rule 9 and the above. You can use the annotation at the _class
+level_ and it will cause no dependency injection and only the entry
+creation in java:comp/env.
+
+* __"I tried to list java:comp/env but it's empty?!"__
+
+See rule 2 and rule 4. There will be nothing in java:comp/env unless you
+link:declaring-references.html[Declare a Reference] to it. It does not
+matter if is a DataSource configured at the server level, etc. Nothing
+is bound into java:comp/env unless you explicitly declare a reference to
+it. The Java EE 5 TCK (Technology Compatibility Kit) tests for this
+extensively and is a rule we cannot break. Java EE 6 does finally offer
+some new namesaces (java:global, java:app, and java:module) which will
+offer some great new options for more global-style lookups.
+
+* __"I deployed the EJB but can't look it up, it's name is Foo"__
+
+See rule 2 and the above. Just creating an EJB doesn't cause it to be
+added to java:comp/env. If a
+link:container-managed-component.html[Container-Managed Component] wants
+to lookup the EJB they must [Declare a Reference|Declaring References]
+to it via the @EJB annotionation or <ejb-local-ref> or <ejb-ref> in xml.
+In Java EE 6, however, EJBs will be automatically bound to
+"java:global[/<app-name>]/<module-name>/<bean-name>[!<fully-qualified-interface-name>]"
+and can be looked up without declaring a reference first.
+
+* __"Which InitialContextFactory do I use for java:comp/env?"__
+
+See rule 8. You are not allowed to use an InitialContextFactory for
+java:comp/env lookups. Setting an InitialContextFactory via
+'java.naming.factory.initial' in either System properties,
+InitialContext properties, or a jndi.properties file is illegal and will
+cause java:comp/env lookups to fail.
+
+* __"My Client can't lookup the EJB from java:comp/env"__
+
+See rule 7. A plain, standalone, Java application cannot use
+java:comp/env. There is the official concept of a Java EE Application
+Client which can be packaged in an ear and deployed into the Container.
+In practice, most people find them restrictive, cumbersome, and hard to
+use and are therefore rarely employed in "real world" projects. Most
+people opt to use the non-standard, vendor-specific, approach to looking
+up EJBs from their plain java clients. In OpenEJB this can be done via
+either the RemoteInitialContextFactory (for remote clients) or the
+LocalInitialContextFactory (for local clients of an embedded container).
+The JNDI names can be configured as link:jndi-names.html[shown here] .
+
+* __"I declared the reference, but still can't look it up"__
+
+See all of the above and reread the rules a few times. Always check the
+log output as well.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/basics---getting-things.md
----------------------------------------------------------------------
diff --git a/docs/basics---getting-things.md b/docs/basics---getting-things.md
deleted file mode 100644
index 2f3a691..0000000
--- a/docs/basics---getting-things.md
+++ /dev/null
@@ -1,107 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Basics - Getting Things
-~~~~~~
-<a name="Basics-GettingThings-GettingStufffromtheContainer"></a>
-# Getting Stuff from the Container
-
-Generally speaking the only way to get a [Container-Managed Resource](container-managed-resource.html)
- is via *dependency injection* or *lookup* from within a [Container-Managed Component]
-.
-
-The *unbreakable rules*. Read these over and over again when things don't
-work.
-
-1. java:comp/env is the spec defined namespace for lookup of any [Container-Managed Resource](container-managed-resource.html)
-1. java:comp/env is *empty* by default
-1. java:comp/env is *read-only* at runtime
-1. java:comp/env is populated by [Declaring References](declaring-references.html)
- to [Container-Managed Resource]
- via xml or annotation
-1. only [Container-Managed Component](container-managed-component.html)
-s, *not* their libraries, can [Declare References|Declaring References]
- via xml or annotation
-1. only [Container-Managed Component](container-managed-component.html)
-s, *not* their libraries, can get dependency injection of [Container-Managed Resource]
-s
-1. only [Container-Managed Component](container-managed-component.html)
-s, *and* their libraries, may lookup from java:comp/env
-1. you *must* use the *no-arg* 'new InitialContext()' constructor to
-lookup something from java:comp/env
-1. the annotations and xml for [Declaring References](declaring-references.html)
- are *identical* in functionality, both *always* configure lookup with
-*optional* dependency injection
-
-<a name="Basics-GettingThings-Commonmistakes,misunderstandings,andmyths"></a>
-## Common mistakes, misunderstandings, and myths
-
-- *_"I tried it via annotation and it didn't work, so I used xml and then
-it did work"_*
-
-See rule 9. If one form worked and the other didn't, it means you simply
-made a mistake in using one versus the other. Use what works for you, but
-understand both annotations or xml will work for either lookup or injection
-if used correctly.
-
-- *_"I need to use lookups, so I can't use the annotation"_*
-
-See rule 9. Annotations are not just for injection, that is just how they
-are typically used. Know that when you use an annotation for injection, it
-will *always* create an entry in java:comp/env. As well you can use the
-annotation at the *class level* and it will cause no dependency injection
-and only the entry creation in java:comp/env.
-
-- *_"I don't want injection, so I can't use the annotation"_*
-
-See rule 9 and the above. You can use the annotation at the *class level*
-and it will cause no dependency injection and only the entry creation in
-java:comp/env.
-
-- *_"I tried to list java:comp/env but it's empty?!"_*
-
-See rule 2 and rule 4. There will be nothing in java:comp/env unless you [Declare a Reference](declaring-references.html)
- to it. It does not matter if is a DataSource configured at the server
-level, etc. Nothing is bound into java:comp/env unless you explicitly
-declare a reference to it. The Java EE 5 TCK (Technology Compatibility
-Kit) tests for this extensively and is a rule we cannot break. Java EE 6
-does finally offer some new namesaces (java:global, java:app, and
-java:module) which will offer some great new options for more global-style
-lookups.
-
-- *_"I deployed the EJB but can't look it up, it's name is Foo"_*
-
-See rule 2 and the above. Just creating an EJB doesn't cause it to be
-added to java:comp/env. If a [Container-Managed Component](container-managed-component.html)
- wants to lookup the EJB they must [Declare a Reference|Declaring References]
- to it via the @EJB annotionation or <ejb-local-ref> or <ejb-ref> in xml.
-In Java EE 6, however, EJBs will be automatically bound to
-"java:global[/<app-name>]/<module-name>/<bean-name>[!<fully-qualified-interface-name>]"
-and can be looked up without declaring a reference first.
-
-- *_"Which InitialContextFactory do I use for java:comp/env?"_*
-
-See rule 8. You are not allowed to use an InitialContextFactory for
-java:comp/env lookups. Setting an InitialContextFactory via
-'java.naming.factory.initial' in either System properties, InitialContext
-properties, or a jndi.properties file is illegal and will cause
-java:comp/env lookups to fail.
-
-- *_"My Client can't lookup the EJB from java:comp/env"_*
-
-See rule 7. A plain, standalone, Java application cannot use
-java:comp/env. There is the official concept of a Java EE Application
-Client which can be packaged in an ear and deployed into the Container. In
-practice, most people find them restrictive, cumbersome, and hard to use
-and are therefore rarely employed in "real world" projects. Most people
-opt to use the non-standard, vendor-specific, approach to looking up EJBs
-from their plain java clients. In OpenEJB this can be done via either the
-RemoteInitialContextFactory (for remote clients) or the
-LocalInitialContextFactory (for local clients of an embedded container).
-The JNDI names can be configured as [shown here](jndi-names.html)
-.
-
-- *_"I declared the reference, but still can't look it up"_*
-
-See all of the above and reread the rules a few times. Always check the
-log output as well.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/basics---security.adoc
----------------------------------------------------------------------
diff --git a/docs/basics---security.adoc b/docs/basics---security.adoc
new file mode 100644
index 0000000..56b5ec6
--- /dev/null
+++ b/docs/basics---security.adoc
@@ -0,0 +1,54 @@
+# Basics - Security
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+This section is under construction, please check back later.
+
+== Related Documents
+
+link:security.html[Security] - login module configuration
+link:security-annotations.html[Security Annotations] - EJB3 related
+annotation based security.
+
+== Server Side Security
+
+There's a few things that should be noted about security from the server
+side perspective.
+
+=== Security Propagation Note, this is partially documented in the EJB 3
+spec section 14.8.1.1.
+
+[arabic]
+. Once a remote bean has been instantiated, from within the container,
+it inherits the entire security context, and all roles will be inherited
+the same as the method where the bean is being looked up.
+. Looking up a bean via an `InitialContext`, or via injection, will
+inherit the security context (user, roles, etc), thereby propagating the
+security through to any container bean in the chain of method calls.
+. No properties are allowed for the `InitialContext`, and you _MUST_ be
+calling the no args constructor only. There are documents elsewhere that
+describe using the OpenEJB initial context factories and such, with
+usernames and passwords, etc; it should be noted that this method of
+using the factories is OpenEJB specific, to facilitate non-standard
+clients not running in an EJB container, etc.
+
+For example, here is an EJB that returns another bean, through a remote
+method call. In this case, the _OtherBean_ instance, will have the same
+security as _MyBean_, including the principal (username), roles, etc.
+
+....
+import javax.ejb.EJB;
+import javax.naming.InitialContext;
+
+@EJB(name = "otherBean", beanInterface = IOtherBean.class)
+public class MyBean
+{
+ public IOtherBean getOtherBean()
+ {
+ InitialContext context = new InitialContext();
+ return (IOtherBean) context.lookup("java:comp/env/otherBean");
+ }
+}
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/basics---security.md
----------------------------------------------------------------------
diff --git a/docs/basics---security.md b/docs/basics---security.md
deleted file mode 100644
index 135cfa5..0000000
--- a/docs/basics---security.md
+++ /dev/null
@@ -1,55 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Basics - Security
-~~~~~~
-This section is under construction, please check back later.
-
-<a name="Basics-Security-RelatedDocuments"></a>
-## Related Documents
-
-[Security](security.html)
- \- login module configuration
-[Security Annotations](security-annotations.html)
- \- EJB3 related annotation based security.
-
-<a name="Basics-Security-ServerSideSecurity"></a>
-## Server Side Security
-
-There's a few things that should be noted about security from the server
-side perspective.
-
-<a name="Basics-Security-SecurityPropagation"></a>
-### Security Propagation
-Note, this is partially documented in the EJB 3 spec section 14.8.1.1.
-
-1. Once a remote bean has been instantiated, from within the container, it
-inherits the entire security context, and all roles will be inherited the
-same as the method where the bean is being looked up.
-1. Looking up a bean via an `InitialContext`, or via injection, will inherit
-the security context (user, roles, etc), thereby propagating the security
-through to any container bean in the chain of method calls.
-1. No properties are allowed for the `InitialContext`, and you *MUST* be
-calling the no args constructor only. There are documents elsewhere that
-describe using the OpenEJB initial context factories and such, with
-usernames and passwords, etc; it should be noted that this method of using
-the factories is OpenEJB specific, to facilitate non-standard clients not
-running in an EJB container, etc.
-
-For example, here is an EJB that returns another bean, through a remote
-method call. In this case, the *OtherBean* instance, will have the same
-security as *MyBean*, including the principal (username), roles, etc.
-
-
- import javax.ejb.EJB;
- import javax.naming.InitialContext;
-
- @EJB(name = "otherBean", beanInterface = IOtherBean.class)
- public class MyBean
- {
- public IOtherBean getOtherBean()
- {
- InitialContext context = new InitialContext();
- return (IOtherBean) context.lookup("java:comp/env/otherBean");
- }
- }
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/basics---transactions.adoc
----------------------------------------------------------------------
diff --git a/docs/basics---transactions.adoc b/docs/basics---transactions.adoc
new file mode 100644
index 0000000..3441f84
--- /dev/null
+++ b/docs/basics---transactions.adoc
@@ -0,0 +1,67 @@
+# Basics - Transactions
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+One of the many benefits of EJB, is that
+transactions within the EJB container are generally managed entirely
+automatically. Any EJB component will, by default, partake in that
+transaction.
+
+Here are some basic rules to understand about transactions. Keep note
+that this is the default behaviour, and the system can be configured to
+behave differently, depending on the needs of your system, bean, or
+individual methods of your beans.
+
+== Participants
+
+Various components and parts of the EJB system can be part of a
+transaction. Examples are
+
+[arabic]
+. Session bean
+. Message Driven Bean
+. EntityManager (a.k.a. Persistence context)
+
+== Behaviour
+
+The basic default behaviours are 1. A transaction starts at the
+beginning of the first EJB method call, in a chain of calls that are
+participating in the given transaction 1. A transaction ends at the end
+of the first EJB method, in the same chain 1. If a bean that has started
+a transaction, uses another bean, that bean will automatically use the
+same transaction as the calling bean.
+
+== Configuration
+
+You can configure your beans in a variety of ways. Generally speaking, a
+transaction is started when a method is called, but can be configured
+using @TransactionAttribute(value = TransactionAttributeType.X), where X
+is one of...
+
+[arabic]
+. REQUIRED - the default, which is to start a transaction if one does
+not exist, but to use the existing one if it has already been started.
+. REQUIRES_NEW - the transaction is created on every call, and ends when
+the call is completed. Beans don't partake in transactions created by
+other parts of the system.
+. MANDATORY - a transaction must always exist prior to the call, and it
+will be used. It is an error otherwise
+. NOT_SUPPORTED - component not included in the transaction
+. SUPPORTS - transaction will be used if it exists, but will not be
+created if it does not exist
+. NEVER - if a transaction exists, it is an error to call the method
+
+@TransactionAttribute applies to both methods and entire beans. You may
+set one type of transaction behaviour (as seen above) on the bean, and a
+different one on a specific method of that same bean, which overrides
+the one configured for the overall bean. For instance, maybe you want to
+make an audit entry in the database that you are about to attempt a
+credit card payment. It really needs to be in it's own transaction so
+that it is IMMEDIATELY committed for audit purposes, if something goes
+wrong with the credit card payment. So, perhaps you use MANDATORY on the
+bean, and REQUIRES_NEW on the method for audit logging. As soon as the
+method that does the audit logging is complete, the transaction is
+committed, and the credit card payment transaction continues on it's
+way.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/basics---transactions.md
----------------------------------------------------------------------
diff --git a/docs/basics---transactions.md b/docs/basics---transactions.md
deleted file mode 100644
index a173c5f..0000000
--- a/docs/basics---transactions.md
+++ /dev/null
@@ -1,60 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Basics - Transactions
-~~~~~~
-One of the many benefits of EJB, is that transactions within the EJB
-container are generally managed entirely automatically. Any EJB component
-will, by default, partake in that transaction.
-
-Here are some basic rules to understand about transactions. Keep note that
-this is the default behaviour, and the system can be configured to behave
-differently, depending on the needs of your system, bean, or individual
-methods of your beans.
-
-<a name="Basics-Transactions-Participants"></a>
-## Participants
-
-Various components and parts of the EJB system can be part of a
-transaction. Examples are
-
-1. Session bean
-1. Message Driven Bean
-1. EntityManager (a.k.a. Persistence context)
-
-<a name="Basics-Transactions-Behaviour"></a>
-## Behaviour
-
-The basic default behaviours are
-1. A transaction starts at the beginning of the first EJB method call, in a
-chain of calls that are participating in the given transaction
-1. A transaction ends at the end of the first EJB method, in the same chain
-1. If a bean that has started a transaction, uses another bean, that bean
-will automatically use the same transaction as the calling bean.
-
-<a name="Basics-Transactions-Configuration"></a>
-## Configuration
-
-You can configure your beans in a variety of ways. Generally speaking, a
-transaction is started when a method is called, but can be configured using
-@TransactionAttribute(value = TransactionAttributeType.X), where X is one
-of...
-
-1. REQUIRED - the default, which is to start a transaction if one does not exist, but to use the existing one if it has already been started.
-1. REQUIRES_NEW - the transaction is created on every call, and ends when the call is completed. Beans don't partake in transactions created by other parts of the system.
-1. MANDATORY - a transaction must always exist prior to the call, and it will be used. It is an error otherwise
-1. NOT_SUPPORTED - component not included in the transaction
-1. SUPPORTS - transaction will be used if it exists, but will not be created if it does not exist
-1. NEVER - if a transaction exists, it is an error to call the method
-
-@TransactionAttribute applies to both methods and entire beans. You may
-set one type of transaction behaviour (as seen above) on the bean, and a
-different one on a specific method of that same bean, which overrides the
-one configured for the overall bean. For instance, maybe you want to make
-an audit entry in the database that you are about to attempt a credit card
-payment. It really needs to be in it's own transaction so that it is
-IMMEDIATELY committed for audit purposes, if something goes wrong with the
-credit card payment. So, perhaps you use MANDATORY on the bean, and
-REQUIRES_NEW on the method for audit logging. As soon as the method that
-does the audit logging is complete, the transaction is committed, and the
-credit card payment transaction continues on it's way.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/bmpentitycontainer-config.adoc
----------------------------------------------------------------------
diff --git a/docs/bmpentitycontainer-config.adoc b/docs/bmpentitycontainer-config.adoc
new file mode 100644
index 0000000..977b873
--- /dev/null
+++ b/docs/bmpentitycontainer-config.adoc
@@ -0,0 +1,53 @@
+# BmpEntityContainer Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A BmpEntityContainer can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Container id="myBmpEntityContainer" type="BMP_ENTITY">
+ poolSize = 10
+</Container>
+....
+
+Alternatively, a BmpEntityContainer can be declared via properties in
+the `<tomee-home>/conf/system.properties` file or via Java
+VirtualMachine `-D` properties. The properties can also be used when
+embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or
+`InitialContext`
+
+....
+myBmpEntityContainer = new://Container?type=BMP_ENTITY
+myBmpEntityContainer.poolSize = 10
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared BmpEntityContainer a
+warning will be logged. If a BmpEntityContainer is needed by the
+application and one is not declared, TomEE will create one dynamically
+using default settings. Multiple BmpEntityContainer declarations are
+allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+poolSize
+
+int
+
+10
+
+Specifies the size of the bean pools for this bmp entity container.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/bmpentitycontainer-config.md
----------------------------------------------------------------------
diff --git a/docs/bmpentitycontainer-config.md b/docs/bmpentitycontainer-config.md
deleted file mode 100644
index 5223e35..0000000
--- a/docs/bmpentitycontainer-config.md
+++ /dev/null
@@ -1,37 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=BmpEntityContainer Configuration
-~~~~~~
-
-
-A BmpEntityContainer can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Container id="myBmpEntityContainer" type="BMP_ENTITY">
- poolSize = 10
- </Container>
-
-Alternatively, a BmpEntityContainer can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myBmpEntityContainer = new://Container?type=BMP_ENTITY
- myBmpEntityContainer.poolSize = 10
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared BmpEntityContainer a warning will be logged. If a BmpEntityContainer is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple BmpEntityContainer declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td>poolSize</td>
- <td>int</td>
- <td>10</td>
- <td>
-Specifies the size of the bean pools for this
-bmp entity container.
-</td>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/bouncy-castle.adoc
----------------------------------------------------------------------
diff --git a/docs/bouncy-castle.adoc b/docs/bouncy-castle.adoc
new file mode 100644
index 0000000..f8288d0
--- /dev/null
+++ b/docs/bouncy-castle.adoc
@@ -0,0 +1,39 @@
+# Installing Bouncy Castle
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+NOTE: Licensed to the Apache Software Foundation (ASF)
+under one or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information regarding
+copyright ownership. The ASF licenses this file to you 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.
+
+Installation of Bouncy Castle for use in TomEE itself is done in two
+steps:
+
+[arabic]
+. Add the Bouncy Castle provider jar to the `$JAVA_HOME/jre/lib/ext`
+directory
+. Create a Bouncy Castle provider entry in the
+`$JAVA_HOME/jre/lib/security/java.security` file
+
+The entry to `java.security` will look something like the following:
+
+....
+security.provider.N=org.bouncycastle.jce.provider.BouncyCastleProvider
+....
+
+Replace `N` with the order of precedence you would like to give Bouncy
+Castle in comparison to the other providers in the file. *Recommended*
+would be the last entry in the list -- `N` being the higest number in
+the list. *Warning* that configuring Bouncy Castle as the first
+provider, `security.provider.1`, may cause JVM errors.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/bouncy-castle.md
----------------------------------------------------------------------
diff --git a/docs/bouncy-castle.md b/docs/bouncy-castle.md
deleted file mode 100644
index d2fff7b..0000000
--- a/docs/bouncy-castle.md
+++ /dev/null
@@ -1,34 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Installing Bouncy Castle
-~~~~~~
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-Installation of Bouncy Castle for use in TomEE itself is done in two steps:
-
- 1. Add the Bouncy Castle provider jar to the `$JAVA_HOME/jre/lib/ext` directory
- 1. Create a Bouncy Castle provider entry in the `$JAVA_HOME/jre/lib/security/java.security` file
-
-The entry to `java.security` will look something like the following:
-
- security.provider.N=org.bouncycastle.jce.provider.BouncyCastleProvider
-
-Replace `N` with the order of precedence you would like to give Bouncy Castle in comparison to the
-other providers in the file. **Recommended** would be the last entry in the list -- `N` being the higest number in the list.
-**Warning** that configuring Bouncy Castle as the first provider, `security.provider.1`, may cause JVM errors.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/built-in-type-converters.adoc
----------------------------------------------------------------------
diff --git a/docs/built-in-type-converters.adoc b/docs/built-in-type-converters.adoc
new file mode 100644
index 0000000..b8ab7c5
--- /dev/null
+++ b/docs/built-in-type-converters.adoc
@@ -0,0 +1,98 @@
+# Built-in Type Converters
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+The following built-in types are supported for
+@Resource injection in EJBs via elements in a META-INF/ejb-jar.xml or
+via plain properties in a META-INF/env-entries.properties file.
+
+EJB 3.0 required types:
+
+* java.lang.Boolean
+* java.lang.Byte
+* java.lang.Character
+* java.lang.Double
+* java.lang.Float
+* java.lang.Integer
+* java.lang.Long
+* java.lang.Short
+* java.lang.String
+
+OpenEJB 3.0 additional types:
+
+* java.lang.Class
+* java.lang.Enum (any subclass of)
+* java.io.File
+* java.math.BigDecimal
+* java.math.BigInteger
+* java.net.Inet4Address
+* java.net.Inet6Address
+* java.net.InetAddress
+* java.net.URI
+* java.net.URL
+* java.util.ArrayList
+* java.util.Date
+* java.util.HashMap
+* java.util.Hashtable
+* java.util.IdentityHashMap
+* java.util.LinkedHashMap
+* java.util.LinkedHashSet
+* java.util.LinkedList
+* java.util.List
+* java.util.Map
+* java.util.Properties
+* java.util.Set
+* java.util.SortedMap
+* java.util.TreeMap
+* java.util.TreeSet
+* java.util.Vector
+* java.util.WeakHashMap
+* java.util.logging.Logger
+* java.util.regex.Pattern
+* javax.management.ObjectName
+* javax.naming.Context
+* org.apache.commons.logging.Log
+* org.apache.log4j.Logger
+
+To use an OpenEJB additional type in xml, simply declare it as
+java.lang.String and it will be converted on the fly to the field/setter
+type used by the bean class. For example:
+
+....
+package org.superbiz.foo;
+
+import java.util.Date;
+
+@Stateless
+public class MyBean {
+
+ @Resource
+ private Date myDate;
+}
+....
+
+Works with an ejb-jar.xml as follows:
+
+....
+<ejb-jar xmlns="http://java.sun.com/xml/ns/javaee" version="3.0"
+metadata-complete="false">
+ <enterprise-beans>
+ <session>
+ <ejb-name>MyBean</ejb-name>
+ <env-entry>
+ <env-entry-name>org.superbiz.foo.MyBean/myDate</env-entry-name>
+ <env-entry-value>2008-04-19</env-entry-value>
+ <env-entry-type>java.lang.String</env-entry-type>
+ </env-entry>
+ </session>
+ </enterprise-beans>
+</ejb-jar>
+....
+
+Or with an env-entries.properties file as follows:
+
+....
+org.superbiz.foo.MyBean/myDate = 2008-04-19
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/built-in-type-converters.md
----------------------------------------------------------------------
diff --git a/docs/built-in-type-converters.md b/docs/built-in-type-converters.md
deleted file mode 100644
index b94a545..0000000
--- a/docs/built-in-type-converters.md
+++ /dev/null
@@ -1,94 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Built-in Type Converters
-~~~~~~
-The following built-in types are supported for @Resource injection in EJBs
-via <env-entry> elements in a META-INF/ejb-jar.xml or via plain properties
-in a META-INF/env-entries.properties file.
-
-EJB 3.0 required types:
-
- - java.lang.Boolean
- - java.lang.Byte
- - java.lang.Character
- - java.lang.Double
- - java.lang.Float
- - java.lang.Integer
- - java.lang.Long
- - java.lang.Short
- - java.lang.String
-
-OpenEJB 3.0 additional types:
-
- - java.lang.Class
- - java.lang.Enum (any subclass of)
- - java.io.File
- - java.math.BigDecimal
- - java.math.BigInteger
- - java.net.Inet4Address
- - java.net.Inet6Address
- - java.net.InetAddress
- - java.net.URI
- - java.net.URL
- - java.util.ArrayList
- - java.util.Date
- - java.util.HashMap
- - java.util.Hashtable
- - java.util.IdentityHashMap
- - java.util.LinkedHashMap
- - java.util.LinkedHashSet
- - java.util.LinkedList
- - java.util.List
- - java.util.Map
- - java.util.Properties
- - java.util.Set
- - java.util.SortedMap
- - java.util.TreeMap
- - java.util.TreeSet
- - java.util.Vector
- - java.util.WeakHashMap
- - java.util.logging.Logger
- - java.util.regex.Pattern
- - javax.management.ObjectName
- - javax.naming.Context
- - org.apache.commons.logging.Log
- - org.apache.log4j.Logger
-
-To use an OpenEJB additional type in xml, simply declare it as
-<env-entry-type>java.lang.String</env-entry-type> and it will be converted
-on the fly to the field/setter type used by the bean class. For example:
-
-
- package org.superbiz.foo;
-
- import java.util.Date;
-
- @Stateless
- public class MyBean {
-
- @Resource
- private Date myDate;
- }
-
-
-Works with an ejb-jar.xml as follows:
-
- <ejb-jar xmlns="http://java.sun.com/xml/ns/javaee" version="3.0"
- metadata-complete="false">
- <enterprise-beans>
- <session>
- <ejb-name>MyBean</ejb-name>
- <env-entry>
- <env-entry-name>org.superbiz.foo.MyBean/myDate</env-entry-name>
- <env-entry-value>2008-04-19</env-entry-value>
- <env-entry-type>java.lang.String</env-entry-type>
- </env-entry>
- </session>
- </enterprise-beans>
- </ejb-jar>
-
-
-Or with an env-entries.properties file as follows:
-
- org.superbiz.foo.MyBean/myDate = 2008-04-19
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/callbacks.adoc
----------------------------------------------------------------------
diff --git a/docs/callbacks.adoc b/docs/callbacks.adoc
new file mode 100644
index 0000000..0e227b6
--- /dev/null
+++ b/docs/callbacks.adoc
@@ -0,0 +1,165 @@
+# Callbacks
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+Correct usage of PostConstruct, PreDestroy, PrePassivate, PostActivate,
+and AroundInvoke for EJBs and Interceptors.
+
+For Stateful, Stateless, and MessageDriven, the syntax is as follows:
+
+* @PostConstruct <any-scope> void <method-name>()
+* @PreDestroy <any-scope> void <method-name>()
+* @PrePassivate <any-scope> void <method-name>()
+* @PostActivate <any-scope> void <method-name>()
+
+For an Interceptor, the syntax includes InvocationContext as follows:
+
+* @PostConstruct <any-scope> void <method-name>(InvocationContext)
+* @PreDestroy <any-scope> void <method-name>(InvocationContext)
+* @PrePassivate <any-scope> void <method-name>(InvocationContext)
+* @PostActivate <any-scope> void <method-name>(InvocationContext)
+
+The AroundInvoke syntax for an EJB or Interceptor is the same:
+
+* @AroundInvoke <any-scope> Object <method-name>(InvocationContext)
+throws Exception
+
+== Stateless
+
+....
+import javax.ejb.Stateless;
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+import javax.interceptor.AroundInvoke;
+import javax.interceptor.InvocationContext;
+
+@Stateless
+public class MyStatelessBean implements MyBusinessInterface {
+
+ @PostConstruct
+ public void constructed(){
+
+ }
+
+ @PreDestroy
+ public void destroy(){
+
+ }
+
+ @AroundInvoke
+ public Object invoke(InvocationContext invocationContext) throws Exception {
+ return invocationContext.proceed();
+ }
+}
+....
+
+== Stateful
+
+....
+import javax.ejb.Stateful;
+import javax.ejb.PostActivate;
+import javax.ejb.PrePassivate;
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+import javax.interceptor.AroundInvoke;
+import javax.interceptor.InvocationContext;
+
+@Stateful
+public class MyStatefulBean implements MyBusinessInterface {
+
+ @PostConstruct
+ public void constructed(){
+
+ }
+
+ @PreDestroy
+ public void destroy(){
+
+ }
+
+ @AroundInvoke
+ public Object invoke(InvocationContext invocationContext) throws Exception {
+ return invocationContext.proceed();
+ }
+
+ @PostActivate
+ public void activated(){
+
+ }
+
+ @PrePassivate
+ public void passivate(){
+
+ }
+}
+....
+
+== MessageDriven
+
+....
+import javax.ejb.MessageDriven;
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+import javax.interceptor.AroundInvoke;
+import javax.interceptor.InvocationContext;
+
+@MessageDriven
+public class MyMessageDrivenBean implements MyListenerInterface {
+
+ @PostConstruct
+ public void constructed(){
+
+ }
+
+ @PreDestroy
+ public void destroy(){
+
+ }
+
+ @AroundInvoke
+ public Object invoke(InvocationContext invocationContext) throws Exception {
+ return invocationContext.proceed();
+ }
+}
+....
+
+== Interceptor
+
+....
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+import javax.interceptor.InvocationContext;
+import javax.interceptor.AroundInvoke;
+import javax.ejb.PostActivate;
+import javax.ejb.PrePassivate;
+
+public class MyInterceptor {
+
+ @PostConstruct
+ public void constructed(InvocationContext invocationContext){
+
+ }
+
+ @PreDestroy
+ public void destroy(InvocationContext invocationContext){
+
+ }
+
+ @AroundInvoke
+ public Object invoke(InvocationContext invocationContext) throws Exception {
+ return invocationContext.proceed();
+ }
+
+ @PostActivate
+ public void activated(InvocationContext invocationContext){
+
+ }
+
+ @PrePassivate
+ public void passivate(InvocationContext invocationContext){
+
+ }
+}
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/callbacks.md
----------------------------------------------------------------------
diff --git a/docs/callbacks.md b/docs/callbacks.md
deleted file mode 100644
index d8016b1..0000000
--- a/docs/callbacks.md
+++ /dev/null
@@ -1,167 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Callbacks
-~~~~~~
-Correct usage of PostConstruct, PreDestroy, PrePassivate, PostActivate, and
-AroundInvoke for EJBs and Interceptors.
-
-For Stateful, Stateless, and MessageDriven, the syntax is as follows:
-
- - @PostConstruct <any-scope> void <method-name>()
- - @PreDestroy <any-scope> void <method-name>()
- - @PrePassivate <any-scope> void <method-name>()
- - @PostActivate <any-scope> void <method-name>()
-
-For an Interceptor, the syntax includes InvocationContext as follows:
-
- - @PostConstruct <any-scope> void <method-name>(InvocationContext)
- - @PreDestroy <any-scope> void <method-name>(InvocationContext)
- - @PrePassivate <any-scope> void <method-name>(InvocationContext)
- - @PostActivate <any-scope> void <method-name>(InvocationContext)
-
-The AroundInvoke syntax for an EJB or Interceptor is the same:
-
- - @AroundInvoke <any-scope> Object <method-name>(InvocationContext) throws Exception
-
-
-<a name="Callbacks-Stateless"></a>
-## Stateless
-
-
- import javax.ejb.Stateless;
- import javax.annotation.PostConstruct;
- import javax.annotation.PreDestroy;
- import javax.interceptor.AroundInvoke;
- import javax.interceptor.InvocationContext;
-
- @Stateless
- public class MyStatelessBean implements MyBusinessInterface {
-
- @PostConstruct
- public void constructed(){
-
- }
-
- @PreDestroy
- public void destroy(){
-
- }
-
- @AroundInvoke
- public Object invoke(InvocationContext invocationContext) throws Exception {
- return invocationContext.proceed();
- }
- }
-
-
-<a name="Callbacks-Stateful"></a>
-## Stateful
-
-
- import javax.ejb.Stateful;
- import javax.ejb.PostActivate;
- import javax.ejb.PrePassivate;
- import javax.annotation.PostConstruct;
- import javax.annotation.PreDestroy;
- import javax.interceptor.AroundInvoke;
- import javax.interceptor.InvocationContext;
-
- @Stateful
- public class MyStatefulBean implements MyBusinessInterface {
-
- @PostConstruct
- public void constructed(){
-
- }
-
- @PreDestroy
- public void destroy(){
-
- }
-
- @AroundInvoke
- public Object invoke(InvocationContext invocationContext) throws Exception {
- return invocationContext.proceed();
- }
-
- @PostActivate
- public void activated(){
-
- }
-
- @PrePassivate
- public void passivate(){
-
- }
- }
-
-
-<a name="Callbacks-MessageDriven"></a>
-## MessageDriven
-
-
- import javax.ejb.MessageDriven;
- import javax.annotation.PostConstruct;
- import javax.annotation.PreDestroy;
- import javax.interceptor.AroundInvoke;
- import javax.interceptor.InvocationContext;
-
- @MessageDriven
- public class MyMessageDrivenBean implements MyListenerInterface {
-
- @PostConstruct
- public void constructed(){
-
- }
-
- @PreDestroy
- public void destroy(){
-
- }
-
- @AroundInvoke
- public Object invoke(InvocationContext invocationContext) throws Exception {
- return invocationContext.proceed();
- }
- }
-
-
-<a name="Callbacks-Interceptor"></a>
-## Interceptor
-
-
- import javax.annotation.PostConstruct;
- import javax.annotation.PreDestroy;
- import javax.interceptor.InvocationContext;
- import javax.interceptor.AroundInvoke;
- import javax.ejb.PostActivate;
- import javax.ejb.PrePassivate;
-
- public class MyInterceptor {
-
- @PostConstruct
- public void constructed(InvocationContext invocationContext){
-
- }
-
- @PreDestroy
- public void destroy(InvocationContext invocationContext){
-
- }
-
- @AroundInvoke
- public Object invoke(InvocationContext invocationContext) throws Exception {
- return invocationContext.proceed();
- }
-
- @PostActivate
- public void activated(InvocationContext invocationContext){
-
- }
-
- @PrePassivate
- public void passivate(InvocationContext invocationContext){
-
- }
- }
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/changing-jms-implementations.adoc
----------------------------------------------------------------------
diff --git a/docs/changing-jms-implementations.adoc b/docs/changing-jms-implementations.adoc
new file mode 100644
index 0000000..b1dde18
--- /dev/null
+++ b/docs/changing-jms-implementations.adoc
@@ -0,0 +1,158 @@
+# Changing JMS Implementations
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+NOTE: Licensed to the Apache Software
+Foundation (ASF) under one or more contributor license agreements. See
+the NOTICE file distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file to you 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.
+
+ActiveMQ is the default JMS provider in Apache TomEE and OpenEJB.
+
+Changing JMS implementation is as simple as using that implementation's
+Java EE Connector. The connector which will be a `.rar` file should be
+bundled with the application in a `.ear` file. All JMS usage in that
+`.ear` will favor the JMS ConnectionFactory and Topic and Queue
+implementations that are configured in the `.rar` file rather than
+ActiveMQ.
+
+If the JMS implementation does not have a `.rar` file, there are still
+some options for wiring in an alternate implementation.
+
+== Generic JMS Resource Adapter
+
+If the JMS implementation does not have a Resource Archive (`.rar` file)
+that defines a compliant Resource Adapter, the
+http://genericjmsra.java.net/[Generic Resource Adapter for JMS] should
+work fine.
+
+To use this Adapter in TomEE or OpenEJB you'll need to create a
+`service-jar.xml` file and include that in a jar file and add it to the
+`<tomee.home>/lib/` directory. Then you can declare `ConnectionFactory`,
+`Topic`, and `Queue` and more via the `tomee.xml` file.
+
+The one below should be considered boiler plate. Updating it to contain
+some useful default values for your JMS implementation would be good.
+These values can be overridden in the `tomee.xml` or `openejb.xml`
+
+Let's say that the following file lives in the jar at
+`META-INF/org.superbiz/service-jar.xml`
+
+....
+<?xml version="1.0" encoding="UTF-8"?>
+<ServiceJar>
+ <ServiceProvider
+ id="genericra"
+ service="Resource"
+ types="GenericJMSRA"
+ class-name="com.sun.genericra.GenericJMSRA">
+ UserName
+ Password
+ ProviderIntegrationMode
+ ConnectionFactoryClassName
+ QueueConnectionFactoryClassName
+ TopicConnectionFactoryClassName
+ XAConnectionFactoryClassName
+ XAQueueConnectionFactoryClassName
+ XATopicConnectionFactoryClassName
+ UnifiedDestinationClassName
+ TopicClassName
+ QueueClassName
+ SupportsXA
+ ConnectionFactoryProperties
+ JndiProperties
+ CommonSetterMethodName
+ RMPolicy
+ LogLevel
+ DeliveryType
+ UseFirstXAForRedelivery
+ </ServiceProvider>
+
+ <ServiceProvider
+ id="ConnectionFactory"
+ service="Resource"
+ types="javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory, QueueConnectionFactory, TopicConnectionFactory"
+ class-name="com.sun.genericra.outbound.ManagedJMSConnectionFactory">
+ ConnectionFactoryJndiName
+ ClientId
+ ConnectionValidationEnabled
+ ResourceAdapter
+ </ServiceProvider>
+
+ <ServiceProvider
+ id="Queue"
+ service="Resource"
+ types="javax.jms.Queue, Queue"
+ class-name="com.sun.genericra.outbound.QueueProxy">
+ DestinationJndiName
+ ResourceAdapter
+ UserName
+ Password
+ JndiProperties
+ QueueClassName
+ </ServiceProvider>
+
+ <ServiceProvider
+ id="Topic"
+ service="Resource"
+ types="javax.jms.Topic, Topic"
+ class-name="com.sun.genericra.outbound.TopicProxy">
+ DestinationJndiName
+ ResourceAdapter
+ UserName
+ Password
+ JndiProperties
+ TopicClassName
+ </ServiceProvider>
+</ServiceJar>
+....
+
+It is strongly recommended to not leave the values in the
+service-jar.xml file blank as shown above. It is possible to setup
+several sets of defaults in a `service-jar.xml` or via several
+`service-jar.xml` files.
+
+Once this file is packed in a jar and added to the `<tomee.home>/lib` or
+`<openejb.home>/lib` directory, you can then declare and configure
+"instances" of these things in your `tomee.xml` or `openejb.xml` config
+file as follows:
+
+....
+<Resource id="My Generic Adapter" type="GenericJMSRA" provider="org.superbiz:genericra">
+AdapterProperty1 PropertyValue1
+AdapterProperty2 PropertyValue2
+...
+</Resource>
+....
+
+Or in properties like so:
+
+....
+myGenericAdapter = new://Resource?type=GenericJMSRA&provider=org.superbiz:genericra
+myGenericAdapter.AdapterProperty1 = PropertyValue1
+myGenericAdapter.AdapterProperty2 = PropertyValue2
+....
+
+This is basically the same as all configuration in TomEE/OpenEJB, but
+with the addition that you must specify the `provider` attribute so the
+server knows where to look for the `service-jar.xml` file that defines
+the resource and all its defaults.
+
+In this example:
+
+* the file is `META-INF/org.superbiz/service-jar.xml`
+* so the `provider` attribute is `org.superbiz`
+
+You can use whatever prefix you like for the `provider` id, though for
+obvious reasons we'd advise not using `org.apache.openejb` or
+`org.apache.tomee` in the prefix.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/changing-jms-implementations.md
----------------------------------------------------------------------
diff --git a/docs/changing-jms-implementations.md b/docs/changing-jms-implementations.md
deleted file mode 100644
index ab95410..0000000
--- a/docs/changing-jms-implementations.md
+++ /dev/null
@@ -1,136 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=Changing JMS Implementations
-~~~~~~
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-ActiveMQ is the default JMS provider in Apache TomEE and OpenEJB.
-
-Changing JMS implementation is as simple as using that implementation's Java EE Connector. The connector which will be a `.rar` file should be bundled with the application in a `.ear`
-file. All JMS usage in that `.ear` will favor the JMS ConnectionFactory and Topic and Queue implementations
-that are configured in the `.rar` file rather than ActiveMQ.
-
-If the JMS implementation does not have a `.rar` file, there are still some options for wiring in an alternate implementation.
-
-# Generic JMS Resource Adapter
-
-If the JMS implementation does not have a Resource Archive (`.rar` file) that defines a compliant Resource Adapter, the [Generic Resource Adapter for JMS](http://genericjmsra.java.net/) should work fine.
-
-To use this Adapter in TomEE or OpenEJB you'll need to create a `service-jar.xml` file and include that in a jar file and add it to the `<tomee.home>/lib/` directory.
-Then you can declare `ConnectionFactory`, `Topic`, and `Queue` and more via the `tomee.xml` file.
-
-The one below should be considered boiler plate. Updating it to contain some useful default values for your JMS implementation would be good. These values can be overridden in the `tomee.xml` or `openejb.xml`
-
-Let's say that the following file lives in the jar at `META-INF/org.superbiz/service-jar.xml`
-
- <?xml version="1.0" encoding="UTF-8"?>
- <ServiceJar>
- <ServiceProvider
- id="genericra"
- service="Resource"
- types="GenericJMSRA"
- class-name="com.sun.genericra.GenericJMSRA">
- UserName
- Password
- ProviderIntegrationMode
- ConnectionFactoryClassName
- QueueConnectionFactoryClassName
- TopicConnectionFactoryClassName
- XAConnectionFactoryClassName
- XAQueueConnectionFactoryClassName
- XATopicConnectionFactoryClassName
- UnifiedDestinationClassName
- TopicClassName
- QueueClassName
- SupportsXA
- ConnectionFactoryProperties
- JndiProperties
- CommonSetterMethodName
- RMPolicy
- LogLevel
- DeliveryType
- UseFirstXAForRedelivery
- </ServiceProvider>
-
- <ServiceProvider
- id="ConnectionFactory"
- service="Resource"
- types="javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory, QueueConnectionFactory, TopicConnectionFactory"
- class-name="com.sun.genericra.outbound.ManagedJMSConnectionFactory">
- ConnectionFactoryJndiName
- ClientId
- ConnectionValidationEnabled
- ResourceAdapter
- </ServiceProvider>
-
- <ServiceProvider
- id="Queue"
- service="Resource"
- types="javax.jms.Queue, Queue"
- class-name="com.sun.genericra.outbound.QueueProxy">
- DestinationJndiName
- ResourceAdapter
- UserName
- Password
- JndiProperties
- QueueClassName
- </ServiceProvider>
-
- <ServiceProvider
- id="Topic"
- service="Resource"
- types="javax.jms.Topic, Topic"
- class-name="com.sun.genericra.outbound.TopicProxy">
- DestinationJndiName
- ResourceAdapter
- UserName
- Password
- JndiProperties
- TopicClassName
- </ServiceProvider>
- </ServiceJar>
-
-It is strongly recommended to not leave the values in the service-jar.xml file blank as shown above. It is
-possible to setup several sets of defaults in a `service-jar.xml` or via several `service-jar.xml` files.
-
-Once this file is packed in a jar and added to the `<tomee.home>/lib` or `<openejb.home>/lib` directory, you can
-then declare and configure "instances" of these things in your `tomee.xml` or `openejb.xml` config file as follows:
-
- <Resource id="My Generic Adapter" type="GenericJMSRA" provider="org.superbiz:genericra">
- AdapterProperty1 PropertyValue1
- AdapterProperty2 PropertyValue2
- ...
- </Resource>
-
-Or in properties like so:
-
- myGenericAdapter = new://Resource?type=GenericJMSRA&provider=org.superbiz:genericra
- myGenericAdapter.AdapterProperty1 = PropertyValue1
- myGenericAdapter.AdapterProperty2 = PropertyValue2
-
-This is basically the same as all configuration in TomEE/OpenEJB, but with the addition that you must
-specify the `provider` attribute so the server knows where to look for the `service-jar.xml` file that
-defines the resource and all its defaults.
-
-In this example:
-
- - the file is `META-INF/org.superbiz/service-jar.xml`
- - so the `provider` attribute is `org.superbiz`
-
-You can use whatever prefix you like for the `provider` id, though for obvious reasons we'd advise not using `org.apache.openejb` or `org.apache.tomee` in the prefix.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/client-server-transports.adoc
----------------------------------------------------------------------
diff --git a/docs/client-server-transports.adoc b/docs/client-server-transports.adoc
new file mode 100644
index 0000000..6106a43
--- /dev/null
+++ b/docs/client-server-transports.adoc
@@ -0,0 +1,39 @@
+# Client-Server Transports
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Client/Server transports
+
+jar
+
+transport description
+
+openejb-ejbd-3.0.jar
+
+provides the 'ejbd' protocol. A binary protocol traveling over a socket
+
+openejb-http-3.0.jar
+
+supports the ejbd protocol over http
+
+openejb-derbynet-3.0.jar
+
+allows for derby to accessed via it's network driver
+
+openejb-hsql-3.0.jar
+
+allows for hsqldb to be accessed via it's network driver
+
+openejb-cxf-3.0.jar
+
+turns on webservice ability, soap/http, via cxf
+
+openejb-activemq-3.0.jar
+
+supports remote jms clients via activemq
+
+openejb-telnet-3.0.jar
+
+allows for connecting to the server via telnet for monitoring
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/client-server-transports.md
----------------------------------------------------------------------
diff --git a/docs/client-server-transports.md b/docs/client-server-transports.md
deleted file mode 100644
index d77c048..0000000
--- a/docs/client-server-transports.md
+++ /dev/null
@@ -1,22 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Client-Server Transports
-~~~~~~
-<a name="Client-ServerTransports-Client/Servertransports"></a>
-# Client/Server transports
-
-<table class="mdtable">
-<tr><th> jar </th><th> transport description </th></tr>
-<tr><td> openejb-ejbd-3.0.jar </td><td> provides the 'ejbd' protocol. A binary protocol
-traveling over a socket </td></tr>
-<tr><td> openejb-http-3.0.jar </td><td> supports the ejbd protocol over http </td></tr>
-<tr><td> openejb-derbynet-3.0.jar </td><td> allows for derby to accessed via it's network
-driver </td></tr>
-<tr><td> openejb-hsql-3.0.jar </td><td> allows for hsqldb to be accessed via it's network
-driver </td></tr>
-<tr><td> openejb-cxf-3.0.jar </td><td> turns on webservice ability, soap/http, via cxf </td></tr>
-<tr><td> openejb-activemq-3.0.jar </td><td> supports remote jms clients via activemq </td></tr>
-<tr><td> openejb-telnet-3.0.jar </td><td> allows for connecting to the server via telnet
-for monitoring </td></tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/clients.adoc
----------------------------------------------------------------------
diff --git a/docs/clients.adoc b/docs/clients.adoc
new file mode 100644
index 0000000..48571ce
--- /dev/null
+++ b/docs/clients.adoc
@@ -0,0 +1,95 @@
+# Clients
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+=== Local Client (embedded container)
+
+....
+Properties p = new Properties();
+p.put("java.naming.factory.initial", "org.apache.openejb.client.LocalInitialContextFactory");
+
+InitialContext ctx = new InitialContext(p);
+
+MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
+....
+
+=== Local Client (non-default realm name)
+
+=== Login configuration file (conf/login.config)
+
+....
+PropertiesLogin {
+ org.apache.openejb.core.security.jaas.PropertiesLoginModule required
+ Debug=true
+ UsersFile="users.properties"
+ GroupsFile="groups.properties";
+};
+MyApp {
+ org.apache.openejb.core.security.jaas.SQLLoginModule required
+ dataSourceName="MyDataSource"
+ userSelect="SELECT username, password FROM users WHERE username=?"
+ groupSelect="SELECT username, grp FROM users WHERE username=?";
+};
+....
+
+=== Code
+
+....
+Properties p = new Properties();
+p.put("java.naming.factory.initial", "org.apache.openejb.client.LocalInitialContextFactory");
+p.put("openejb.authentication.realmName", "MyApp");
+
+InitialContext ctx = new InitialContext(p);
+
+MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
+....
+
+=== Remote Client (openejb standalone)
+
+....
+Properties p = new Properties();
+p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put("java.naming.provider.url", "ejbd://localhost:4201");
+// user and pass optional
+p.put("java.naming.security.principal", "myuser");
+p.put("java.naming.security.credentials", "mypass");
+
+InitialContext ctx = new InitialContext(p);
+
+MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
+....
+
+=== Remote Client with HTTP (openejb standalone)
+
+....
+Properties p = new Properties();
+p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put("java.naming.provider.url", "http://localhost:4204/ejb");
+// user and pass optional
+p.put("java.naming.security.principal", "myuser");
+p.put("java.naming.security.credentials", "mypass");
+
+InitialContext ctx = new InitialContext(p);
+
+MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
+....
+
+=== Remote Client with HTTP (in TomEE)
+
+....
+Properties p = new Properties();
+p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put("java.naming.provider.url", "http://127.0.0.1:8080/tomee/ejb");
+// user and pass optional
+p.put("java.naming.security.principal", "myuser");
+p.put("java.naming.security.credentials", "mypass");
+
+InitialContext ctx = new InitialContext(p);
+
+MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
+....
+
+=== Remote Client using @EJB Injection see here: ejb-refs
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/clients.md
----------------------------------------------------------------------
diff --git a/docs/clients.md b/docs/clients.md
deleted file mode 100644
index 19acf6a..0000000
--- a/docs/clients.md
+++ /dev/null
@@ -1,104 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=Clients
-~~~~~~
-
-<a name="Clients-LocalClient(embeddedcontainer)"></a>
-### Local Client (embedded container)
-
-
- Properties p = new Properties();
- p.put("java.naming.factory.initial", "org.apache.openejb.client.LocalInitialContextFactory");
-
- InitialContext ctx = new InitialContext(p);
-
- MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
-
-
-<a name="Clients-LocalClient(non-defaultrealmname)"></a>
-### Local Client (non-default realm name)
-
-<a name="Clients-Loginconfigurationfile(conf/login.config)"></a>
-### Login configuration file (conf/login.config)
-
-
- PropertiesLogin {
- org.apache.openejb.core.security.jaas.PropertiesLoginModule required
- Debug=true
- UsersFile="users.properties"
- GroupsFile="groups.properties";
- };
- MyApp {
- org.apache.openejb.core.security.jaas.SQLLoginModule required
- dataSourceName="MyDataSource"
- userSelect="SELECT username, password FROM users WHERE username=?"
- groupSelect="SELECT username, grp FROM users WHERE username=?";
- };
-
-
-<a name="Clients-Programcode"></a>
-### Code
-
-
- Properties p = new Properties();
- p.put("java.naming.factory.initial", "org.apache.openejb.client.LocalInitialContextFactory");
- p.put("openejb.authentication.realmName", "MyApp");
-
- InitialContext ctx = new InitialContext(p);
-
- MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
-
-
-<a name="Clients-RemoteClient(openejbstandalone)"></a>
-### Remote Client (openejb standalone)
-
-
- Properties p = new Properties();
- p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put("java.naming.provider.url", "ejbd://localhost:4201");
- // user and pass optional
- p.put("java.naming.security.principal", "myuser");
- p.put("java.naming.security.credentials", "mypass");
-
- InitialContext ctx = new InitialContext(p);
-
- MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
-
-
-<a name="Clients-RemoteClientwithHTTP(openejbstandalone)"></a>
-### Remote Client with HTTP (openejb standalone)
-
-
- Properties p = new Properties();
- p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put("java.naming.provider.url", "http://localhost:4204/ejb");
- // user and pass optional
- p.put("java.naming.security.principal", "myuser");
- p.put("java.naming.security.credentials", "mypass");
-
- InitialContext ctx = new InitialContext(p);
-
- MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
-
-
-
-<a name="Clients-RemoteClientwithHTTP(intomcat)"></a>
-### Remote Client with HTTP (in TomEE)
-
-
- Properties p = new Properties();
- p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put("java.naming.provider.url", "http://127.0.0.1:8080/tomee/ejb");
- // user and pass optional
- p.put("java.naming.security.principal", "myuser");
- p.put("java.naming.security.credentials", "mypass");
-
- InitialContext ctx = new InitialContext(p);
-
- MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
-
-<a name="RemoteClientUsingEjbInjection)"></a>
-### Remote Client using @EJB Injection
-see here:
-<a href="http://tomee.apache.org/ejb-refs.html">ejb-refs</a>
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/cmpentitycontainer-config.adoc
----------------------------------------------------------------------
diff --git a/docs/cmpentitycontainer-config.adoc b/docs/cmpentitycontainer-config.adoc
new file mode 100644
index 0000000..c3aa59a
--- /dev/null
+++ b/docs/cmpentitycontainer-config.adoc
@@ -0,0 +1,51 @@
+# CmpEntityContainer Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A CmpEntityContainer can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Container id="myCmpEntityContainer" type="CMP_ENTITY">
+ cmpEngineFactory = org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory
+</Container>
+....
+
+Alternatively, a CmpEntityContainer can be declared via properties in
+the `<tomee-home>/conf/system.properties` file or via Java
+VirtualMachine `-D` properties. The properties can also be used when
+embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or
+`InitialContext`
+
+....
+myCmpEntityContainer = new://Container?type=CMP_ENTITY
+myCmpEntityContainer.cmpEngineFactory = org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared CmpEntityContainer a
+warning will be logged. If a CmpEntityContainer is needed by the
+application and one is not declared, TomEE will create one dynamically
+using default settings. Multiple CmpEntityContainer declarations are
+allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+cmpEngineFactory
+
+String
+
+org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/cmpentitycontainer-config.md
----------------------------------------------------------------------
diff --git a/docs/cmpentitycontainer-config.md b/docs/cmpentitycontainer-config.md
deleted file mode 100644
index 5a91989..0000000
--- a/docs/cmpentitycontainer-config.md
+++ /dev/null
@@ -1,36 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=CmpEntityContainer Configuration
-~~~~~~
-
-
-A CmpEntityContainer can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Container id="myCmpEntityContainer" type="CMP_ENTITY">
- cmpEngineFactory = org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory
- </Container>
-
-Alternatively, a CmpEntityContainer can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myCmpEntityContainer = new://Container?type=CMP_ENTITY
- myCmpEntityContainer.cmpEngineFactory = org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared CmpEntityContainer a warning will be logged. If a CmpEntityContainer is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple CmpEntityContainer declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td>cmpEngineFactory</td>
- <td>String</td>
- <td>org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory</td>
- <td>
-
-</td>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/collapsed-ear.adoc
----------------------------------------------------------------------
diff --git a/docs/collapsed-ear.adoc b/docs/collapsed-ear.adoc
new file mode 100644
index 0000000..8e003ad
--- /dev/null
+++ b/docs/collapsed-ear.adoc
@@ -0,0 +1,49 @@
+# Collapsed EAR
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# One archive
+
+The basic idea of this approach is that your Servlets and EJBs are
+together in your WAR file as one app.
+
+* No classloader boundries between Servlets and EJBs
+* EJBs and Servlets can share all third-party libraries (like Spring!) -
+no EAR required.
+* Can put the web.xml and ejb-jar.xml in the same archive (the WAR
+file).
+* EJBs can see Servlet classes and vice versa.
+
+# Not quite J2EE (it is truly Java EE6)
+
+This is very different than J2EE or Java EE 5 as there aren't several
+levels of separation and classloader hierarchy. This is going to take
+some getting used to and it should be understood that this style of
+packaging isn't J2EE compliant. Who would care tough as it is a feature
+of Java EE 6 we would've been waiting for so long.
+
+J2EE classloading rules:
+
+* You cannot ever have EJBs and servlets in the same classloader.
+* Three classloader minimum; a classloader for the ear, one for each
+ejb-jar, and one for each WAR file.
+* Servlets can see EJBs, but EJBs cannot see servlets.
+
+To pull that off, J2EE has to kill you on packaging: * You cannot have
+EJB classes and Servlet classes in the same archive. * You need at least
+three archives to combine servlets and ejbs; 1 EAR containing 1 EJB jar
+and 1 servlet WAR. * Shared libraries must go in the EAR and be included
+in a specially formatted 'Class-Path' entry in the EAR's MANIFEST file.
+
+Critically speaking, forcing more than one classloader on an application
+is where J2EE "jumps the shark" for a large majority of people's needs.
+
+# Example with Tomcat
+
+If you want to try to work with Servlets/JSP and OpenEJB using Tomcat,
+see the openejbx30:tomcat.html[setup page] and the
+"/webapps/ejb-examples" section of the
+link:downloads.html[openejb-examples.zip] available on the
+http://tomee.apache.org/downloads.html[download page].
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/collapsed-ear.md
----------------------------------------------------------------------
diff --git a/docs/collapsed-ear.md b/docs/collapsed-ear.md
deleted file mode 100644
index a481a4c..0000000
--- a/docs/collapsed-ear.md
+++ /dev/null
@@ -1,46 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Collapsed EAR
-~~~~~~
-<a name="CollapsedEAR-Onearchive"></a>
-# One archive
-
-The basic idea of this approach is that your Servlets and EJBs are together
-in your WAR file as one app.
-
-* No classloader boundries between Servlets and EJBs
-* EJBs and Servlets can share all third-party libraries (like Spring\!) - no EAR required.
-* Can put the web.xml and ejb-jar.xml in the same archive (the WAR file).
-* EJBs can see Servlet classes and vice versa.
-
-<a name="CollapsedEAR-NotquiteJ2EE(itistrulyJava EE6)"></a>
-# Not quite J2EE (it is truly Java EE6)
-
-This is very different than J2EE or Java EE 5 as there aren't several
-levels of separation and classloader hierarchy. This is going to take some
-getting used to and it should be understood that this style of packaging
-isn't J2EE compliant. Who would care tough as it is a feature of Java EE 6
-we would've been waiting for so long.
-
- J2EE classloading rules:
-
-* You cannot ever have EJBs and servlets in the same classloader.
-* Three classloader minimum; a classloader for the ear, one for each ejb-jar, and one for each WAR file.
-* Servlets can see EJBs, but EJBs cannot see servlets.
-
- To pull that off, J2EE has to kill you on packaging:
-* You cannot have EJB classes and Servlet classes in the same archive.
-* You need at least three archives to combine servlets and ejbs; 1 EAR containing 1 EJB jar and 1 servlet WAR.
-* Shared libraries must go in the EAR and be included in a specially formatted 'Class-Path' entry in the EAR's MANIFEST file.
-
- Critically speaking, forcing more than one classloader on an application
-is where J2EE "jumps the shark" for a large majority of people's needs.
-
-<a name="CollapsedEAR-ExamplewithTomcat"></a>
-# Example with Tomcat
-
-If you want to try to work with Servlets/JSP and OpenEJB using Tomcat, see
-the [setup page](openejbx30:tomcat.html)
- and the "/webapps/ejb-examples" section of the [openejb-examples.zip](downloads.html)
- available on the [download page](http://tomee.apache.org/downloads.html).
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/common-datasource-configurations.adoc
----------------------------------------------------------------------
diff --git a/docs/common-datasource-configurations.adoc b/docs/common-datasource-configurations.adoc
new file mode 100644
index 0000000..872b9cd
--- /dev/null
+++ b/docs/common-datasource-configurations.adoc
@@ -0,0 +1,116 @@
+# Common DataSource Configurations
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+See the link:datasource-config.html[DataSource Configuration] for
+details on all configuration options for DataSources.
+
+== HSQLDB
+
+The drivers are included with OpenEJB 3.0 and HSQLDB is the default
+database.
+
+....
+<Resource id="HSQLDB Database" type="DataSource">
+ JdbcDriver org.hsqldb.jdbcDriver
+ JdbcUrl jdbc:hsqldb:file:hsqldb
+ UserName sa
+ Password
+</Resource>
+....
+
+== Derby (Embedded)
+
+....
+<Resource id="Derby Database" type="DataSource">
+ #Embedded Derby example
+
+ JdbcDriver org.apache.derby.jdbc.EmbeddedDriver
+ JdbcUrl jdbc:derby:derbyDB;create=true
+ UserName admin
+ Password pass
+</Resource>
+....
+
+== MySQL
+
+....
+<Resource id="MySQL Database" type="DataSource">
+ # MySQL example
+ #
+ # This connector will not work until you download the driver at:
+ # http://www.mysql.com/downloads/api-jdbc-stable.html
+
+ JdbcDriver com.mysql.jdbc.Driver
+ JdbcUrl jdbc:mysql://localhost/test
+ UserName test
+</Resource>
+....
+
+== Oracle
+
+....
+<Resource id="Oracle Database" type="DataSource">
+ # Oracle example
+ #
+ # This connector will not work until you download the driver at:
+ # http://otn.oracle.com/software/tech/java/sqlj_jdbc/content.html
+ JdbcDriver oracle.jdbc.OracleDriver
+ JdbcUrl jdbc:oracle:thin:@localhost:1521:orcl
+ UserName scott
+ Password tiger
+</Resource>
+....
+
+== OracleXA
+
+....
+<Resource id="OracleXA Database" type="DataSource">
+ # OracleXA example
+ #
+ # This connector will not work until you download the driver at:
+ # http://otn.oracle.com/software/tech/java/sqlj_jdbc/content.html
+ JdbcDriver oracle.jdbc.xa.client.OracleXADataSource
+ JdbcUrl jdbc:oracle:thin:@localhost:1521:orcl
+ UserName scott
+ Password tiger
+</Resource>
+....
+
+== PosgreSQL
+
+....
+<Resource id="PostgreSQL Database" type="DataSource">
+ # PostgreSQL example
+ #
+ # This connector will not work until you download the driver at:
+ # http://jdbc.postgresql.org/download.html
+ JdbcDriver org.postgresql.Driver
+ JdbcUrl jdbc:postgresql://localhost/test
+ UserName postgres
+ Password pass
+</Resource>
+....
+
+== InstantDB
+
+....
+<Resource id="InstantDB Database" type="DataSource">
+ # InstantDB example
+ #
+ JdbcDriver org.enhydra.instantdb.jdbc.idbDriver
+ JdbcUrl jdbc:idb:conf/instantdb.properties
+ UserName Admin
+ Password pass
+</Resource>
+....
+
+Internally, from TomEE 1.5.0, JDBC pools are managed via Tomcat-pool.
+You can still switch back to Apache Commons DBCP by adding the following
+property: DataSourceCreator dbcp. To get the full list of available
+configuration properties, have a look to
+http://commons.apache.org/dbcp/configuration.html[Apache Commons DBCP
+configuration].
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/common-datasource-configurations.md
----------------------------------------------------------------------
diff --git a/docs/common-datasource-configurations.md b/docs/common-datasource-configurations.md
deleted file mode 100644
index 64aa60e..0000000
--- a/docs/common-datasource-configurations.md
+++ /dev/null
@@ -1,115 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=Common DataSource Configurations
-~~~~~~
-
-See the [DataSource Configuration](datasource-config.html) for details on all configuration options for DataSources.
-
-<a name="CommonDataSourceConfigurations-HSQLDB"></a>
-## HSQLDB
-
-The drivers are included with OpenEJB 3.0 and HSQLDB is the default
-database.
-
- <Resource id="HSQLDB Database" type="DataSource">
- JdbcDriver org.hsqldb.jdbcDriver
- JdbcUrl jdbc:hsqldb:file:hsqldb
- UserName sa
- Password
- </Resource>
-
-
-<a name="CommonDataSourceConfigurations-Derby(Embedded)"></a>
-## Derby (Embedded)
-
-
- <Resource id="Derby Database" type="DataSource">
- #Embedded Derby example
-
- JdbcDriver org.apache.derby.jdbc.EmbeddedDriver
- JdbcUrl jdbc:derby:derbyDB;create=true
- UserName admin
- Password pass
- </Resource>
-
-
-<a name="CommonDataSourceConfigurations-MySQL"></a>
-## MySQL
-
-
- <Resource id="MySQL Database" type="DataSource">
- # MySQL example
- #
- # This connector will not work until you download the driver at:
- # http://www.mysql.com/downloads/api-jdbc-stable.html
-
- JdbcDriver com.mysql.jdbc.Driver
- JdbcUrl jdbc:mysql://localhost/test
- UserName test
- </Resource>
-
-
-<a name="CommonDataSourceConfigurations-Oracle"></a>
-## Oracle
-
-
- <Resource id="Oracle Database" type="DataSource">
- # Oracle example
- #
- # This connector will not work until you download the driver at:
- # http://otn.oracle.com/software/tech/java/sqlj_jdbc/content.html
- JdbcDriver oracle.jdbc.OracleDriver
- JdbcUrl jdbc:oracle:thin:@localhost:1521:orcl
- UserName scott
- Password tiger
- </Resource>
-
-<a name="CommonDataSourceConfigurations-OracleXA"></a>
-## OracleXA
-
-
- <Resource id="OracleXA Database" type="DataSource">
- # OracleXA example
- #
- # This connector will not work until you download the driver at:
- # http://otn.oracle.com/software/tech/java/sqlj_jdbc/content.html
- JdbcDriver oracle.jdbc.xa.client.OracleXADataSource
- JdbcUrl jdbc:oracle:thin:@localhost:1521:orcl
- UserName scott
- Password tiger
- </Resource>
-
-<a name="CommonDataSourceConfigurations-PosgreSQL"></a>
-## PosgreSQL
-
-
- <Resource id="PostgreSQL Database" type="DataSource">
- # PostgreSQL example
- #
- # This connector will not work until you download the driver at:
- # http://jdbc.postgresql.org/download.html
- JdbcDriver org.postgresql.Driver
- JdbcUrl jdbc:postgresql://localhost/test
- UserName postgres
- Password pass
- </Resource>
-
-
-<a name="CommonDataSourceConfigurations-InstantDB"></a>
-## InstantDB
-
-
- <Resource id="InstantDB Database" type="DataSource">
- # InstantDB example
- #
- JdbcDriver org.enhydra.instantdb.jdbc.idbDriver
- JdbcUrl jdbc:idb:conf/instantdb.properties
- UserName Admin
- Password pass
- </Resource>
-
-
-
-Internally, from TomEE 1.5.0, JDBC pools are managed via Tomcat-pool. You can still switch back to Apache Commons DBCP by adding the following property: DataSourceCreator dbcp. To
-get the full list of available configuration properties, have a look to [Apache Commons DBCP configuration](http://commons.apache.org/dbcp/configuration.html).
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/common-errors.adoc
----------------------------------------------------------------------
diff --git a/docs/common-errors.adoc b/docs/common-errors.adoc
new file mode 100644
index 0000000..8eda5b6
--- /dev/null
+++ b/docs/common-errors.adoc
@@ -0,0 +1,31 @@
+# Common Errors
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+<a name="CommonErrors-Cannotfindcontainer"FOO"forbean"BAR""> # Cannot
+find container "FOO" for bean "BAR"
+
+When a bean gets deployed in OpenEJB, it gets associated with a
+particular container. Subsequently, that container may not be configured
+in that instance of the server. When the server loads the Jar with the
+deployed beans, it places beans in the containers that the beans were
+configured with. Here, the bean BAR wants to go into the container FOO,
+which is not currently configured.
+
+This message is displayed when the server is starting up. <a
+name="CommonErrors-Cannotfindbean"FOO"referencedbybean"BAR"."> # Cannot
+find bean "FOO" referenced by bean "BAR".
+
+When a bean gets deployed in OpenEJB, it may contain references to other
+beans. Subsequently, those beans may not be configured in that instance
+of the server. When the server loads the Jar with the deployed beans, it
+stores those references to those beans. Here, the bean BAR references
+FOO, which is not currently configured in the JNDI namespace.
+
+This message is displayed when the server is starting up.
+
+This message is usally the result of a deployment descriptor that has
+been created by hand.
http://git-wip-us.apache.org/repos/asf/tomee/blob/d380ec18/docs/common-errors.md
----------------------------------------------------------------------
diff --git a/docs/common-errors.md b/docs/common-errors.md
deleted file mode 100644
index dbf992b..0000000
--- a/docs/common-errors.md
+++ /dev/null
@@ -1,30 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Common Errors
-~~~~~~
-
-<a name="CommonErrors-Cannotfindcontainer"FOO"forbean"BAR""></a>
-# Cannot find container "FOO" for bean "BAR"
-
-When a bean gets deployed in OpenEJB, it gets associated with a particular
-container. Subsequently, that container may not be configured in that
-instance of the server. When the server loads the Jar with the deployed
-beans, it places beans in the containers that the beans were configured
-with. Here, the bean BAR wants to go into the container FOO, which is not
-currently configured.
-
-This message is displayed when the server is starting up.
-<a name="CommonErrors-Cannotfindbean"FOO"referencedbybean"BAR"."></a>
-# Cannot find bean "FOO" referenced by bean "BAR".
-
-When a bean gets deployed in OpenEJB, it may contain references to other
-beans. Subsequently, those beans may not be configured in that instance of
-the server. When the server loads the Jar with the deployed beans, it
-stores those references to those beans. Here, the bean BAR references FOO,
-which is not currently configured in the JNDI namespace.
-
-This message is displayed when the server is starting up.
-
-This message is usally the result of a deployment descriptor that has been
-created by hand.
[42/44] tomee git commit: This closes apache/tomee#252
Posted by jl...@apache.org.
This closes apache/tomee#252
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/d52a46d3
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/d52a46d3
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/d52a46d3
Branch: refs/heads/master
Commit: d52a46d37737ea5f47ed3abedbe29e5f852a707d
Parents: 74a26ae 9b209c9
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:52:05 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:52:05 2018 +0100
----------------------------------------------------------------------
docs/queue-config.adoc | 48 ++++
docs/queue-config.md | 36 ---
docs/quickstart.adoc | 69 +++++
docs/quickstart.md | 71 -----
docs/remote-server.adoc | 69 +++++
docs/remote-server.md | 64 -----
docs/resource-injection.adoc | 201 ++++++++++++++
docs/resource-injection.md | 184 -------------
docs/resource-ref-for-datasource.adoc | 53 ++++
docs/resource-ref-for-datasource.md | 46 ----
docs/running-a-standalone-openejb-server.adoc | 77 ++++++
docs/running-a-standalone-openejb-server.md | 95 -------
docs/securing-a-web-service.adoc | 235 ++++++++++++++++
docs/securing-a-web-service.md | 242 -----------------
docs/security-annotations.adoc | 292 ++++++++++++++++++++
docs/security-annotations.md | 296 ---------------------
docs/security.adoc | 200 ++++++++++++++
docs/security.md | 148 -----------
docs/securityservice-config.adoc | 50 ++++
docs/securityservice-config.md | 36 ---
docs/service-locator.adoc | 159 +++++++++++
docs/service-locator.md | 171 ------------
docs/services.adoc | 28 ++
docs/services.md | 20 --
docs/singleton-beans.adoc | 228 ++++++++++++++++
docs/singleton-beans.md | 226 ----------------
docs/singleton-ejb.adoc | 7 +
docs/singleton-ejb.md | 6 -
docs/singletoncontainer-config.adoc | 69 +++++
docs/singletoncontainer-config.md | 56 ----
30 files changed, 1785 insertions(+), 1697 deletions(-)
----------------------------------------------------------------------
[13/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 7
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/run-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/run-mojo.md b/docs/maven/run-mojo.md
deleted file mode 100644
index 6b2ef6a..0000000
--- a/docs/maven/run-mojo.md
+++ /dev/null
@@ -1,1395 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:run<a name="tomee:run"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:run</p>
-
-<p><b>Description</b>:</p>
-
-<div>Start and wait for TomEE.</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apacheRepos">apacheRepos</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>snapshots</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.apache-repos</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#appDir">appDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>apps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apps">apps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#args">args</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.args</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#bin">bin</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/bin</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.bin</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#catalinaBase">catalinaBase</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.catalina-base</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#checkStarted">checkStarted</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.check-started</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#classpaths">classpaths</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#config">config</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/conf</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.conf</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#context">context</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>rename the current artifact<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#debug">debug</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debug</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#debugPort">debugPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>5005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debugPort</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#deployOpenEjbApplication">deployOpenEjbApplication</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#docBases">docBases</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, which docBase to use for this war.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#ejbRemote">ejbRemote</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ejb-remote</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#externalRepositories">externalRepositories</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, add some external repositories to
-classloader.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#forceReloadable">forceReloadable</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>force webapp to be reloadable<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.force-reloadable</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#javaagents">javaagents</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#keepServerXmlAsthis">keepServerXmlAsthis</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(Removed since 7.0.0)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.keep-server-xml</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#lib">lib</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/lib</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.lib</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#libDir">libDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>lib</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#libs">libs</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#mainDir">mainDir</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#quickSession">quickSession</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use a real random instead of secure random. saves few ms at
-startup.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.quick-session</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#reloadOnUpdate">reloadOnUpdate</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.reload-on-update</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#removeDefaultWebapps">removeDefaultWebapps</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-default-webapps</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#removeTomeeWebapp">removeTomeeWebapp</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-tomee-webapps</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#simpleLog">simpleLog</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.simple-log</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#skipCurrentProject">skipCurrentProject</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipCurrentProject</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#skipWarResources">skipWarResources</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipWarResources</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#synchronization">synchronization</a></b></td>
-
-<td><tt>Synchronization</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#synchronizations">synchronizations</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#systemVariables">systemVariables</a></b></td>
-
-<td><tt>Map</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#target">target</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeAjpPort">tomeeAjpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8009</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ajp</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeAlreadyInstalled">tomeeAlreadyInstalled</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exiting</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeArtifactId">tomeeArtifactId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.artifactId</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeClassifier">tomeeClassifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>webprofile</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeGroupId">tomeeGroupId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.groupId</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHttpsPort">tomeeHttpsPort</a></b></td>
-
-<td><tt>Integer</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.https</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeShutdownCommand">tomeeShutdownCommand</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>SHUTDOWN</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown-command</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeShutdownPort">tomeeShutdownPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeVersion">tomeeVersion</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>-1</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.version</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#useConsole">useConsole</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.use-console</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#useOpenEJB">useOpenEJB</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use openejb-standalone automatically instead of TomEE<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.openejb</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#warFile">warFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappClasses">webappClasses</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappClasses</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappDefaultConfig">webappDefaultConfig</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>forcing nice default for war development (WEB-INF/classes and web
-resources)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappDefaultConfig</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappDir">webappDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>webapps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappResources">webappResources</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/webapp</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappResources</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webapps">webapps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="apacheRepos">apacheRepos</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.apache-repos</tt></li>
-
-<li><b>Default</b>: <tt>snapshots</tt></li>
- </ul><hr />
-<p><b><a name="appDir">appDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>apps</tt></li>
- </ul><hr />
-<p><b><a name="apps">apps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="args">args</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.args</tt></li>
- </ul><hr />
-<p><b><a name="bin">bin</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.bin</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/bin</tt></li>
- </ul><hr />
-<p><b><a name="catalinaBase">catalinaBase</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.catalina-base</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="checkStarted">checkStarted</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.check-started</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="classpaths">classpaths</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="config">config</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.conf</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/conf</tt></li>
- </ul><hr />
-<p><b><a name="context">context</a>:</b></p>
-
-<div>rename the current artifact</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="debug">debug</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debug</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="debugPort">debugPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debugPort</tt></li>
-
-<li><b>Default</b>: <tt>5005</tt></li>
- </ul><hr />
-<p><b><a name="deployOpenEjbApplication">deployOpenEjbApplication</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="docBases">docBases</a>:</b></p>
-
-<div>for TomEE and wars only, which docBase to use for this war.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="ejbRemote">ejbRemote</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ejb-remote</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="externalRepositories">externalRepositories</a>:</b></p>
-
-<div>for TomEE and wars only, add some external repositories to
-classloader.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="forceReloadable">forceReloadable</a>:</b></p>
-
-<div>force webapp to be reloadable</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.force-reloadable</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="javaagents">javaagents</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="keepServerXmlAsthis">keepServerXmlAsthis</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.keep-server-xml</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="lib">lib</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.lib</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/lib</tt></li>
- </ul><hr />
-<p><b><a name="libDir">libDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>lib</tt></li>
- </ul><hr />
-<p><b><a name="libs">libs</a>:</b></p>
-
-<div>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="mainDir">mainDir</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main</tt></li>
- </ul><hr />
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="quickSession">quickSession</a>:</b></p>
-
-<div>use a real random instead of secure random. saves few ms at
-startup.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.quick-session</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="reloadOnUpdate">reloadOnUpdate</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.reload-on-update</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="removeDefaultWebapps">removeDefaultWebapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-default-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="removeTomeeWebapp">removeTomeeWebapp</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-tomee-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="simpleLog">simpleLog</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.simple-log</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipCurrentProject">skipCurrentProject</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipCurrentProject</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipWarResources">skipWarResources</a>:</b></p>
-
-<div>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipWarResources</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="synchronization">synchronization</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>org.apache.openejb.maven.plugin.Synchronization</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="synchronizations">synchronizations</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="systemVariables">systemVariables</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="target">target</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAjpPort">tomeeAjpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ajp</tt></li>
-
-<li><b>Default</b>: <tt>8009</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAlreadyInstalled">tomeeAlreadyInstalled</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.exiting</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="tomeeArtifactId">tomeeArtifactId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.artifactId</tt></li>
-
-<li><b>Default</b>: <tt>apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="tomeeClassifier">tomeeClassifier</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li>
-
-<li><b>Default</b>: <tt>webprofile</tt></li>
- </ul><hr />
-<p><b><a name="tomeeGroupId">tomeeGroupId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.groupId</tt></li>
-
-<li><b>Default</b>: <tt>org.apache.openejb</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpsPort">tomeeHttpsPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.Integer</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.https</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownCommand">tomeeShutdownCommand</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown-command</tt></li>
-
-<li><b>Default</b>: <tt>SHUTDOWN</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownPort">tomeeShutdownPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown</tt></li>
-
-<li><b>Default</b>: <tt>8005</tt></li>
- </ul><hr />
-<p><b><a name="tomeeVersion">tomeeVersion</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.version</tt></li>
-
-<li><b>Default</b>: <tt>-1</tt></li>
- </ul><hr />
-<p><b><a name="useConsole">useConsole</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.use-console</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="useOpenEJB">useOpenEJB</a>:</b></p>
-
-<div>use openejb-standalone automatically instead of TomEE</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.openejb</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul><hr />
-<p><b><a name="warFile">warFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt></li>
- </ul><hr />
-<p><b><a name="webappClasses">webappClasses</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappClasses</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li>
- </ul><hr />
-<p><b><a name="webappDefaultConfig">webappDefaultConfig</a>:</b></p>
-
-<div>forcing nice default for war development (WEB-INF/classes and web
-resources)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappDefaultConfig</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="webappDir">webappDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>webapps</tt></li>
- </ul><hr />
-<p><b><a name="webappResources">webappResources</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappResources</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li>
- </ul><hr />
-<p><b><a name="webapps">webapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul>
- </div>
- </div>
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/start-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/start-mojo.adoc b/docs/maven/start-mojo.adoc
new file mode 100644
index 0000000..46785f9
--- /dev/null
+++ b/docs/maven/start-mojo.adoc
@@ -0,0 +1,1139 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:start
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:start
+
+Description:
+
+Start and forget TomEE.
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime+system.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+apacheRepos
+
+String
+
+-
+
+(no description)Default value is: snapshots.User property is:
+tomee-plugin.apache-repos.
+
+appDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: apps.
+
+apps
+
+List
+
+-
+
+(no description)
+
+args
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.args.
+
+bin
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/bin.User property is:
+tomee-plugin.bin.
+
+catalinaBase
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.build.directory}/apache-tomee.User property is:
+tomee-plugin.catalina-base.
+
+checkStarted
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.check-started.
+
+classpaths
+
+List
+
+-
+
+(no description)
+
+config
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/conf.User property is:
+tomee-plugin.conf.
+
+context
+
+String
+
+-
+
+rename the current artifact
+
+debug
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.debug.
+
+debugPort
+
+int
+
+-
+
+(no description)Default value is: 5005.User property is:
+tomee-plugin.debugPort.
+
+deployOpenEjbApplication
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.deploy-openejb-internal-application.
+
+docBases
+
+List
+
+-
+
+for TomEE and wars only, which docBase to use for this war.
+
+ejbRemote
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.ejb-remote.
+
+externalRepositories
+
+List
+
+-
+
+for TomEE and wars only, add some external repositories to classloader.
+
+forceReloadable
+
+boolean
+
+-
+
+force webapp to be reloadableDefault value is: false.User property is:
+tomee-plugin.force-reloadable.
+
+javaagents
+
+List
+
+-
+
+(no description)
+
+keepServerXmlAsthis
+
+boolean
+
+-
+
+(Removed since 7.0.0)Default value is: false.User property is:
+tomee-plugin.keep-server-xml.
+
+lib
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/lib.User property is:
+tomee-plugin.lib.
+
+libDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: lib.
+
+libs
+
+List
+
+-
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+mainDir
+
+File
+
+-
+
+(no description)Default value is: $\{project.basedir}/src/main.
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+quickSession
+
+boolean
+
+-
+
+use a real random instead of secure random. saves few ms at
+startup.Default value is: true.User property is:
+tomee-plugin.quick-session.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+reloadOnUpdate
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.reload-on-update.
+
+removeDefaultWebapps
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-default-webapps.
+
+removeTomeeWebapp
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-tomee-webapps.
+
+simpleLog
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.simple-log.
+
+skipCurrentProject
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.skipCurrentProject.
+
+skipWarResources
+
+boolean
+
+-
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.Default value is: false.User property is:
+tomee-plugin.skipWarResources.
+
+synchronization
+
+Synchronization
+
+-
+
+(no description)
+
+synchronizations
+
+List
+
+-
+
+(no description)
+
+systemVariables
+
+Map
+
+-
+
+(no description)
+
+target
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.directory}.
+
+tomeeAjpPort
+
+int
+
+-
+
+(no description)Default value is: 8009.User property is:
+tomee-plugin.ajp.
+
+tomeeAlreadyInstalled
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.exiting.
+
+tomeeArtifactId
+
+String
+
+-
+
+(no description)Default value is: apache-tomee.User property is:
+tomee-plugin.artifactId.
+
+tomeeClassifier
+
+String
+
+-
+
+(no description)Default value is: webprofile.User property is:
+tomee-plugin.classifier.
+
+tomeeGroupId
+
+String
+
+-
+
+(no description)Default value is: org.apache.openejb.User property is:
+tomee-plugin.groupId.
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+tomeeHttpsPort
+
+Integer
+
+-
+
+(no description)User property is: tomee-plugin.https.
+
+tomeeShutdownCommand
+
+String
+
+-
+
+(no description)Default value is: SHUTDOWN.User property is:
+tomee-plugin.shutdown-command.
+
+tomeeShutdownPort
+
+int
+
+-
+
+(no description)Default value is: 8005.User property is:
+tomee-plugin.shutdown.
+
+tomeeVersion
+
+String
+
+-
+
+(no description)Default value is: -1.User property is:
+tomee-plugin.version.
+
+useConsole
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.use-console.
+
+useOpenEJB
+
+boolean
+
+-
+
+use openejb-standalone automatically instead of TomEEDefault value is:
+false.User property is: tomee-plugin.openejb.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+warFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}.
+
+webappClasses
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.outputDirectory}.User
+property is: tomee-plugin.webappClasses.
+
+webappDefaultConfig
+
+boolean
+
+-
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)Default value is: false.User property is:
+tomee-plugin.webappDefaultConfig.
+
+webappDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: webapps.
+
+webappResources
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/webapp.User property is:
+tomee-plugin.webappResources.
+
+webapps
+
+List
+
+-
+
+(no description)
+
+Parameter Details
+
+apacheRepos:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.apache-repos
+
+Default: snapshots
+
+appDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: apps
+
+apps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+args:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.args
+
+bin:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.bin
+
+Default: $\{project.basedir}/src/main/tomee/bin
+
+catalinaBase:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.catalina-base
+
+Default: $\{project.build.directory}/apache-tomee
+
+checkStarted:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.check-started
+
+Default: false
+
+classpaths:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+config:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.conf
+
+Default: $\{project.basedir}/src/main/tomee/conf
+
+context:
+
+rename the current artifact
+
+Type: java.lang.String
+
+Required: No
+
+debug:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.debug
+
+Default: false
+
+debugPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.debugPort
+
+Default: 5005
+
+deployOpenEjbApplication:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.deploy-openejb-internal-application
+
+Default: false
+
+docBases:
+
+for TomEE and wars only, which docBase to use for this war.
+
+Type: java.util.List
+
+Required: No
+
+ejbRemote:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.ejb-remote
+
+Default: true
+
+externalRepositories:
+
+for TomEE and wars only, add some external repositories to classloader.
+
+Type: java.util.List
+
+Required: No
+
+forceReloadable:
+
+force webapp to be reloadable
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.force-reloadable
+
+Default: false
+
+javaagents:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+keepServerXmlAsthis:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.keep-server-xml
+
+Default: false
+
+lib:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.lib
+
+Default: $\{project.basedir}/src/main/tomee/lib
+
+libDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: lib
+
+libs:
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+Type: java.util.List
+
+Required: No
+
+mainDir:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.basedir}/src/main
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+quickSession:
+
+use a real random instead of secure random. saves few ms at startup.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.quick-session
+
+Default: true
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+reloadOnUpdate:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.reload-on-update
+
+Default: false
+
+removeDefaultWebapps:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-default-webapps
+
+Default: true
+
+removeTomeeWebapp:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-tomee-webapps
+
+Default: true
+
+simpleLog:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.simple-log
+
+Default: false
+
+skipCurrentProject:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipCurrentProject
+
+Default: false
+
+skipWarResources:
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipWarResources
+
+Default: false
+
+synchronization:
+
+(no description)
+
+Type: org.apache.openejb.maven.plugin.Synchronization
+
+Required: No
+
+synchronizations:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+systemVariables:
+
+(no description)
+
+Type: java.util.Map
+
+Required: No
+
+target:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.build.directory}
+
+tomeeAjpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.ajp
+
+Default: 8009
+
+tomeeAlreadyInstalled:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.exiting
+
+Default: false
+
+tomeeArtifactId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.artifactId
+
+Default: apache-tomee
+
+tomeeClassifier:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.classifier
+
+Default: webprofile
+
+tomeeGroupId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.groupId
+
+Default: org.apache.openejb
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+tomeeHttpsPort:
+
+(no description)
+
+Type: java.lang.Integer
+
+Required: No
+
+User Property: tomee-plugin.https
+
+tomeeShutdownCommand:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.shutdown-command
+
+Default: SHUTDOWN
+
+tomeeShutdownPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.shutdown
+
+Default: 8005
+
+tomeeVersion:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.version
+
+Default: -1
+
+useConsole:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.use-console
+
+Default: true
+
+useOpenEJB:
+
+use openejb-standalone automatically instead of TomEE
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.openejb
+
+Default: false
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
+
+warFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}
+
+webappClasses:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappClasses
+
+Default: $\{project.build.outputDirectory}
+
+webappDefaultConfig:
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.webappDefaultConfig
+
+Default: false
+
+webappDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: webapps
+
+webappResources:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappResources
+
+Default: $\{project.basedir}/src/main/webapp
+
+webapps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
[20/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 8
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 8
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/68720016
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/68720016
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/68720016
Branch: refs/heads/master
Commit: 68720016fa1ecc08890ac7241cb82dab9e424d1c
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:24 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:07:24 2018 -0800
----------------------------------------------------------------------
docs/messagedrivencontainer-config.adoc | 85 +++
docs/messagedrivencontainer-config.md | 67 --
docs/multicast-discovery.adoc | 91 +++
docs/multicast-discovery.md | 83 ---
docs/multiple-business-interface-hazzards.adoc | 200 ++++++
docs/multiple-business-interface-hazzards.md | 202 ------
docs/multipoint-considerations.adoc | 32 +
docs/multipoint-considerations.md | 30 -
docs/multipoint-discovery.adoc | 85 +++
docs/multipoint-discovery.md | 75 --
docs/multipoint-recommendations.adoc | 153 ++++
docs/multipoint-recommendations.md | 141 ----
docs/multipulse-discovery.adoc | 109 +++
docs/multipulse-discovery.md | 94 ---
docs/new-in-openejb-3.0.adoc | 154 +++++
docs/new-in-openejb-3.0.md | 179 -----
docs/openejb-3.adoc | 69 ++
docs/openejb-3.md | 72 --
docs/openejb-binaries.adoc | 32 +
docs/openejb-binaries.md | 27 -
docs/openejb-eclipse-plugin.adoc | 22 +
docs/openejb-eclipse-plugin.md | 22 -
docs/openejb-jsr-107-integration.adoc | 24 +
docs/openejb-jsr-107-integration.md | 25 -
docs/openejb.xml.adoc | 96 +++
docs/openejb.xml.md | 96 ---
docs/openjpa.adoc | 125 ++++
docs/openjpa.md | 113 ---
docs/orb-config.adoc | 40 ++
docs/orb-config.md | 26 -
docs/persistence-context.adoc | 59 ++
docs/persistence-context.md | 57 --
docs/persistence-unit-ref.adoc | 91 +++
docs/persistence-unit-ref.md | 91 ---
docs/properties-listing.adoc | 729 ++++++++++++++++++++
docs/properties-listing.md | 94 ---
docs/properties-tool.adoc | 219 ++++++
docs/properties-tool.md | 216 ------
docs/property-overriding.adoc | 64 ++
docs/property-overriding.md | 65 --
docs/provisioning.adoc | 96 +++
docs/provisioning.md | 78 ---
docs/proxyfactory-config.adoc | 42 ++
docs/proxyfactory-config.md | 26 -
44 files changed, 2617 insertions(+), 1879 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/messagedrivencontainer-config.adoc
----------------------------------------------------------------------
diff --git a/docs/messagedrivencontainer-config.adoc b/docs/messagedrivencontainer-config.adoc
new file mode 100644
index 0000000..10a9109
--- /dev/null
+++ b/docs/messagedrivencontainer-config.adoc
@@ -0,0 +1,85 @@
+# MessageDrivenContainer Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A MessageDrivenContainer can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Container id="myMessageDrivenContainer" type="MESSAGE">
+ activationSpecClass = org.apache.activemq.ra.ActiveMQActivationSpec
+ instanceLimit = 10
+ messageListenerInterface = javax.jms.MessageListener
+ resourceAdapter = Default JMS Resource Adapter
+</Container>
+....
+
+Alternatively, a MessageDrivenContainer can be declared via properties
+in the `<tomee-home>/conf/system.properties` file or via Java
+VirtualMachine `-D` properties. The properties can also be used when
+embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or
+`InitialContext`
+
+....
+myMessageDrivenContainer = new://Container?type=MESSAGE
+myMessageDrivenContainer.activationSpecClass = org.apache.activemq.ra.ActiveMQActivationSpec
+myMessageDrivenContainer.instanceLimit = 10
+myMessageDrivenContainer.messageListenerInterface = javax.jms.MessageListener
+myMessageDrivenContainer.resourceAdapter = Default JMS Resource Adapter
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared
+MessageDrivenContainer a warning will be logged. If a
+MessageDrivenContainer is needed by the application and one is not
+declared, TomEE will create one dynamically using default settings.
+Multiple MessageDrivenContainer declarations are allowed. # Supported
+Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+activationSpecClass
+
+String
+
+org.apache.activemq.ra.ActiveMQActivationSpec
+
+Specifies the activation spec class
+
+instanceLimit
+
+int
+
+10
+
+Specifies the maximum number of bean instances that are allowed to exist
+for each MDB deployment.
+
+messageListenerInterface
+
+String
+
+javax.jms.MessageListener
+
+Specifies the message listener interface handled by this container
+
+resourceAdapter
+
+String
+
+Default JMS Resource Adapter
+
+The resource adapter delivers messages to the container
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/messagedrivencontainer-config.md
----------------------------------------------------------------------
diff --git a/docs/messagedrivencontainer-config.md b/docs/messagedrivencontainer-config.md
deleted file mode 100644
index 3362a4f..0000000
--- a/docs/messagedrivencontainer-config.md
+++ /dev/null
@@ -1,67 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=MessageDrivenContainer Configuration
-~~~~~~
-
-
-A MessageDrivenContainer can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Container id="myMessageDrivenContainer" type="MESSAGE">
- activationSpecClass = org.apache.activemq.ra.ActiveMQActivationSpec
- instanceLimit = 10
- messageListenerInterface = javax.jms.MessageListener
- resourceAdapter = Default JMS Resource Adapter
- </Container>
-
-Alternatively, a MessageDrivenContainer can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myMessageDrivenContainer = new://Container?type=MESSAGE
- myMessageDrivenContainer.activationSpecClass = org.apache.activemq.ra.ActiveMQActivationSpec
- myMessageDrivenContainer.instanceLimit = 10
- myMessageDrivenContainer.messageListenerInterface = javax.jms.MessageListener
- myMessageDrivenContainer.resourceAdapter = Default JMS Resource Adapter
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared MessageDrivenContainer a warning will be logged. If a MessageDrivenContainer is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple MessageDrivenContainer declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td>activationSpecClass</td>
- <td>String</td>
- <td>org.apache.activemq.ra.ActiveMQActivationSpec</td>
- <td>
-Specifies the activation spec class
-</td>
-</tr>
-<tr>
- <td>instanceLimit</td>
- <td>int</td>
- <td>10</td>
- <td>
-Specifies the maximum number of bean instances that are
-allowed to exist for each MDB deployment.
-</td>
-</tr>
-<tr>
- <td>messageListenerInterface</td>
- <td>String</td>
- <td>javax.jms.MessageListener</td>
- <td>
-Specifies the message listener interface handled by this container
-</td>
-</tr>
-<tr>
- <td>resourceAdapter</td>
- <td>String</td>
- <td>Default JMS Resource Adapter</td>
- <td>
-The resource adapter delivers messages to the container
-</td>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multicast-discovery.adoc
----------------------------------------------------------------------
diff --git a/docs/multicast-discovery.adoc b/docs/multicast-discovery.adoc
new file mode 100644
index 0000000..6fd67f4
--- /dev/null
+++ b/docs/multicast-discovery.adoc
@@ -0,0 +1,91 @@
+:index-group: Discovery
+and Failover
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: Multicast (UDP) Discovery
+
+
+Multicast is the preferred way to broadcast the heartbeat on the
+network. The simple technique of broadcasting a non-changing service URI
+on the network has specific advantages to multicast. The URI itself is
+essentially stateless and there is no "i'm alive" URI or an "i'm dead"
+URI.
+
+In this way the issues with UDP being unordered and unreliable melt away
+as state is no longer a concern and packet sizes are always small.
+Complicated libraries that ride atop UDP and attempt to offer
+reliability (retransmission) and ordering on UDP can be avoided. As well
+the advantages UDP has over TCP are retained as there are no java layers
+attempting to force UDP communication to be more TCP-like. The simple
+design means UDP/Multicast is only used for discovery and from there on
+out critical information is transmitted over TCP/IP which is obviously
+going to do a better job at ensuring reliability and ordering.
+
+== Server Configuration
+
+When you boot the server there should be a `conf/multicast.properties`
+file containing:
+
+....
+server = org.apache.openejb.server.discovery.MulticastDiscoveryAgent
+bind = 239.255.2.3
+port = 6142
+disabled = true
+group = default
+....
+
+Just need to enable that by setting `disabled=false`. All of the above
+settings except `server` can be changed. The `port` and `bind` must be
+valid for general multicast/udp network communication.
+
+The `group` setting can be changed to further group servers that may use
+the same multicast channel. As shown below the client also has a `group`
+setting which can be used to select an appropriate server from the
+multicast channel.
+
+== Multicast Client
+
+The multicast functionality is not just for servers to find each other
+in a cluster, it can also be used for EJB clients to discover a server.
+A special `multicast://` URL can be used in the `InitialContext`
+properties to signify that multicast should be used to seed the
+connection process. Such as:
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY,
+"org.apache.openejb.client.RemoteInitialContextFactory");
+p.put(Context.PROVIDER_URL, "multicast://239.255.2.3:6142?group=default");
+InitialContext remoteContext = new InitialContext(p);
+....
+
+The URL has optional query parameters such as `schemes` and `group` and
+`timeout` which allow you to zero in on a particular type of service of
+a particular cluster group as well as set how long you are willing to
+wait in the discovery process till finally giving up. The first matching
+service that it sees "flowing" around on the UDP stream is the one it
+picks and sticks to for that and subsequent requests, ensuring UDP is
+only used when there are no other servers to talk to.
+
+Note that EJB clients do not need to use multicast to find a server. If
+the client knows the URL of a server in the cluster, it may use it and
+connect directly to that server, at which point that server will share
+the full list of its peers.
+
+== Multicast Servers with TCP Clients
+
+Note that clients do not need to use multicast to communicate with
+servers. Servers can use multicast to discover each other, but clients
+are still free to connect to servers in the network using the server's
+TCP address.
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put(Context.PROVIDER_URL, "ejbd://192.168.1.30:4201");
+InitialContext remoteContext = new InitialContext(p);
+....
+
+When the client connects, the server will send the URLs of all the
+servers in the group and failover will take place normally.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multicast-discovery.md
----------------------------------------------------------------------
diff --git a/docs/multicast-discovery.md b/docs/multicast-discovery.md
deleted file mode 100644
index 10f1692..0000000
--- a/docs/multicast-discovery.md
+++ /dev/null
@@ -1,83 +0,0 @@
-index-group=Discovery and Failover
-type=page
-status=published
-title=Multicast (UDP) Discovery
-~~~~~~
-
-Multicast is the preferred way to broadcast the heartbeat on the network.
-The simple technique of broadcasting a non-changing service URI on the
-network has specific advantages to multicast. The URI itself is
-essentially stateless and there is no "i'm alive" URI or an "i'm dead" URI.
-
-In this way the issues with UDP being unordered and unreliable melt away as
-state is no longer a concern and packet sizes are always small.
-Complicated libraries that ride atop UDP and attempt to offer reliability
-(retransmission) and ordering on UDP can be avoided. As well the
-advantages UDP has over TCP are retained as there are no java layers
-attempting to force UDP communication to be more TCP-like. The simple
-design means UDP/Multicast is only used for discovery and from there on out
-critical information is transmitted over TCP/IP which is obviously going to
-do a better job at ensuring reliability and ordering.
-
-# Server Configuration
-
-When you boot the server there should be a `conf/multicast.properties` file
-containing:
-
-
- server = org.apache.openejb.server.discovery.MulticastDiscoveryAgent
- bind = 239.255.2.3
- port = 6142
- disabled = true
- group = default
-
-
-Just need to enable that by setting `disabled=false`. All of the above
-settings except `server` can be changed. The `port` and `bind` must
-be valid for general multicast/udp network communication.
-
-The `group` setting can be changed to further group servers that may use
-the same multicast channel. As shown below the client also has a `group`
-setting which can be used to select an appropriate server from the
-multicast channel.
-
-# Multicast Client
-
-The multicast functionality is not just for servers to find each other in a
-cluster, it can also be used for EJB clients to discover a server. A
-special `multicast://` URL can be used in the `InitialContext` properties to
-signify that multicast should be used to seed the connection process. Such
-as:
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY,
- "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put(Context.PROVIDER_URL, "multicast://239.255.2.3:6142?group=default");
- InitialContext remoteContext = new InitialContext(p);
-
-The URL has optional query parameters such as `schemes` and `group` and
-`timeout` which allow you to zero in on a particular type of service of a
-particular cluster group as well as set how long you are willing to wait in
-the discovery process till finally giving up. The first matching service
-that it sees "flowing" around on the UDP stream is the one it picks and
-sticks to for that and subsequent requests, ensuring UDP is only used when
-there are no other servers to talk to.
-
-Note that EJB clients do not need to use multicast to find a server. If
-the client knows the URL of a server in the cluster, it may use it and
-connect directly to that server, at which point that server will share the
-full list of its peers.
-
-# Multicast Servers with TCP Clients
-
-Note that clients do not need to use multicast to communicate with servers.
-Servers can use multicast to discover each other, but clients are still
-free to connect to servers in the network using the server's TCP address.
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put(Context.PROVIDER_URL, "ejbd://192.168.1.30:4201");
- InitialContext remoteContext = new InitialContext(p);
-
-When the client connects, the server will send the URLs of all the servers
-in the group and failover will take place normally.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multiple-business-interface-hazzards.adoc
----------------------------------------------------------------------
diff --git a/docs/multiple-business-interface-hazzards.adoc b/docs/multiple-business-interface-hazzards.adoc
new file mode 100644
index 0000000..caeae43
--- /dev/null
+++ b/docs/multiple-business-interface-hazzards.adoc
@@ -0,0 +1,200 @@
+# Multiple Business Interface Hazzards
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# UndeclaredThrowableException
+
+When two java interfaces are implemented by a proxy and those two
+interfaces declare the _same method_ but with _different throws clauses_
+some very nasty side effects happen, namely you loose the ability to
+throw any checked exceptions that are not in the throws clause of both
+methods.
+
+....
+import junit.framework.TestCase;
+
+import java.lang.reflect.InvocationHandler;
+import java.lang.reflect.Method;
+import java.lang.reflect.UndeclaredThrowableException;
+
+/**
+ * @version $Rev$ $Date$
+ */
+public class ExceptionTest extends TestCase {
+
+ public void test() throws Exception {
+ ClassLoader classLoader = this.getClass().getClassLoader();
+ Class[]
+....
+
+interfaces = new Class[]\{One.class, Two.class};
+
+....
+ InvocationHandler h = new TestInvocationHandler();
+
+ Object proxy =
+....
+
+java.lang.reflect.Proxy.newProxyInstance(classLoader, interfaces, h);
+
+....
+ One one = (One) proxy;
+
+ try {
+ one.run(new CommonException());
+ } catch (CommonException e) {
+ // this will work
+ } catch(UndeclaredThrowableException u) {
+ Throwable t = u.getCause();
+ fail("Undeclared: "+t);
+ } catch(Throwable t){
+ fail("Caught: "+t);
+ }
+
+ try {
+ one.run(new OneException());
+ } catch (OneException e) {
+ } catch(UndeclaredThrowableException u) {
+ Throwable t = u.getCause();
+ fail("Undeclared: "+t); // This will always be the code that
+....
+
+executes } catch(Throwable t)\{ fail("Caught: "+t); }
+
+....
+ Two two = (Two) proxy;
+ try {
+ two.run(new CommonException());
+ } catch (TwoException e) {
+ } catch(UndeclaredThrowableException u) {
+ Throwable t = u.getCause();
+ fail("Undeclared: "+t); // This will always be the code that
+....
+
+executes } catch(Throwable t)\{ fail("Caught: "+t); }
+
+....
+ }
+
+ public static class CommonException extends Exception {
+ public CommonException() {
+ }
+ }
+
+ public static interface One {
+ void run(Object o) throws OneException, CommonException;
+ }
+
+ public static class OneException extends Exception {
+ public OneException() {
+ }
+ }
+
+ public static interface Two {
+ void run(Object o) throws TwoException, CommonException;
+ }
+
+ public static class TwoException extends Exception {
+ public TwoException() {
+ }
+ }
+
+ private static class TestInvocationHandler implements InvocationHandler
+....
+
+\{ public Object invoke(Object proxy, Method method, Object[] args)
+throws Throwable \{ throw (Throwable)args[0] ; } } }
+
+# IllegalArgumentException
+
+This one is less of a runtime problem as doing this will cause things to
+fail up front. When two java interfaces are implemented by a proxy and
+those two interfaces declare the _same method_ but with _different
+return types_ the VM proxy code will refuse to create a proxy at all.
+Take this code example:
+
+....
+import junit.framework.TestCase;
+
+import java.lang.reflect.InvocationHandler;
+import java.lang.reflect.Method;
+
+/**
+ * @version $Rev$ $Date$
+ */
+public class ReturnTest extends TestCase {
+
+ public void test() throws Exception {
+ ClassLoader classLoader = this.getClass().getClassLoader();
+ Class[]
+....
+
+interfaces = new Class[]\{ReturnTest.One.class, ReturnTest.Two.class};
+
+....
+ InvocationHandler h = new ReturnTest.TestInvocationHandler();
+
+ Object proxy =
+....
+
+java.lang.reflect.Proxy.newProxyInstance(classLoader, interfaces, h);
+
+....
+ One one = (One) proxy;
+ try {
+ Object object = one.run(new ThingOne());
+ } catch (Throwable t) {
+ fail("Caught: " + t);
+ }
+
+ Two two = (Two) proxy;
+ try {
+ Object object = two.run(new ThingTwo());
+ } catch (Throwable t) {
+ fail("Caught: " + t);
+ }
+
+ }
+
+ public static interface One {
+ ThingOne run(Object o);
+ }
+
+ public static class ThingOne {
+ }
+
+ public static interface Two {
+ ThingTwo run(Object o);
+ }
+
+ public static class ThingTwo {
+ }
+
+ private static class TestInvocationHandler implements InvocationHandler
+....
+
+\{ public Object invoke(Object proxy, Method method, Object[] args)
+throws Throwable \{ return args[0] ; } } }
+
+Running this code will result in the following exception:
+
+....
+java.lang.IllegalArgumentException: methods with same signature
+....
+
+run(java.lang.Object) but incompatible return types: [class
+ReturnTestlatexmath:[$ThingOne, class ReturnTest$]ThingTwo] at
+sun.misc.ProxyGenerator.checkReturnTypes(ProxyGenerator.java:669) at
+sun.misc.ProxyGenerator.generateClassFile(ProxyGenerator.java:420) at
+sun.misc.ProxyGenerator.generateProxyClass(ProxyGenerator.java:306) at
+java.lang.reflect.Proxy.getProxyClass(Proxy.java:501) at
+java.lang.reflect.Proxy.newProxyInstance(Proxy.java:581) at
+ReturnTest.test(ReturnTest.java:36) at
+sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at
+sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
+at
+sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
+at
+com.intellij.rt.execution.junit2.JUnitStarter.main(JUnitStarter.java:32)
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multiple-business-interface-hazzards.md
----------------------------------------------------------------------
diff --git a/docs/multiple-business-interface-hazzards.md b/docs/multiple-business-interface-hazzards.md
deleted file mode 100644
index c6558d7..0000000
--- a/docs/multiple-business-interface-hazzards.md
+++ /dev/null
@@ -1,202 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Multiple Business Interface Hazzards
-~~~~~~
-<a name="MultipleBusinessInterfaceHazzards-UndeclaredThrowableException"></a>
-# UndeclaredThrowableException
-
-When two java interfaces are implemented by a proxy and those two
-interfaces declare the *same method* but with *different throws clauses*
-some very nasty side effects happen, namely you loose the ability to throw
-any checked exceptions that are not in the throws clause of both methods.
-
-
- import junit.framework.TestCase;
-
- import java.lang.reflect.InvocationHandler;
- import java.lang.reflect.Method;
- import java.lang.reflect.UndeclaredThrowableException;
-
- /**
- * @version $Rev$ $Date$
- */
- public class ExceptionTest extends TestCase {
-
- public void test() throws Exception {
- ClassLoader classLoader = this.getClass().getClassLoader();
- Class[]
- interfaces = new Class[]{One.class, Two.class};
-
- InvocationHandler h = new TestInvocationHandler();
-
- Object proxy =
-java.lang.reflect.Proxy.newProxyInstance(classLoader, interfaces, h);
-
- One one = (One) proxy;
-
- try {
- one.run(new CommonException());
- } catch (CommonException e) {
- // this will work
- } catch(UndeclaredThrowableException u) {
- Throwable t = u.getCause();
- fail("Undeclared: "+t);
- } catch(Throwable t){
- fail("Caught: "+t);
- }
-
- try {
- one.run(new OneException());
- } catch (OneException e) {
- } catch(UndeclaredThrowableException u) {
- Throwable t = u.getCause();
- fail("Undeclared: "+t); // This will always be the code that
-executes
- } catch(Throwable t){
- fail("Caught: "+t);
- }
-
- Two two = (Two) proxy;
- try {
- two.run(new CommonException());
- } catch (TwoException e) {
- } catch(UndeclaredThrowableException u) {
- Throwable t = u.getCause();
- fail("Undeclared: "+t); // This will always be the code that
-executes
- } catch(Throwable t){
- fail("Caught: "+t);
- }
-
- }
-
- public static class CommonException extends Exception {
- public CommonException() {
- }
- }
-
- public static interface One {
- void run(Object o) throws OneException, CommonException;
- }
-
- public static class OneException extends Exception {
- public OneException() {
- }
- }
-
- public static interface Two {
- void run(Object o) throws TwoException, CommonException;
- }
-
- public static class TwoException extends Exception {
- public TwoException() {
- }
- }
-
- private static class TestInvocationHandler implements InvocationHandler
-{
- public Object invoke(Object proxy, Method method, Object[]
- args) throws Throwable {
- throw (Throwable)args[0]
-;
- }
- }
- }
-
-
-
-<a name="MultipleBusinessInterfaceHazzards-IllegalArgumentException"></a>
-# IllegalArgumentException
-
-This one is less of a runtime problem as doing this will cause things to
-fail up front. When two java interfaces are implemented by a proxy and
-those two interfaces declare the *same method* but with *different return
-types* the VM proxy code will refuse to create a proxy at all. Take this
-code example:
-
-
-
- import junit.framework.TestCase;
-
- import java.lang.reflect.InvocationHandler;
- import java.lang.reflect.Method;
-
- /**
- * @version $Rev$ $Date$
- */
- public class ReturnTest extends TestCase {
-
- public void test() throws Exception {
- ClassLoader classLoader = this.getClass().getClassLoader();
- Class[]
- interfaces = new Class[]{ReturnTest.One.class, ReturnTest.Two.class};
-
- InvocationHandler h = new ReturnTest.TestInvocationHandler();
-
- Object proxy =
-java.lang.reflect.Proxy.newProxyInstance(classLoader, interfaces, h);
-
- One one = (One) proxy;
- try {
- Object object = one.run(new ThingOne());
- } catch (Throwable t) {
- fail("Caught: " + t);
- }
-
- Two two = (Two) proxy;
- try {
- Object object = two.run(new ThingTwo());
- } catch (Throwable t) {
- fail("Caught: " + t);
- }
-
- }
-
- public static interface One {
- ThingOne run(Object o);
- }
-
- public static class ThingOne {
- }
-
- public static interface Two {
- ThingTwo run(Object o);
- }
-
- public static class ThingTwo {
- }
-
- private static class TestInvocationHandler implements InvocationHandler
-{
- public Object invoke(Object proxy, Method method, Object[]
- args) throws Throwable {
- return args[0]
-;
- }
- }
- }
-
-
-Running this code will result in the following exception:
-
-
- java.lang.IllegalArgumentException: methods with same signature
-run(java.lang.Object) but incompatible return types: [class ReturnTest$ThingOne, class ReturnTest$ThingTwo]
- at
-sun.misc.ProxyGenerator.checkReturnTypes(ProxyGenerator.java:669)
- at
-sun.misc.ProxyGenerator.generateClassFile(ProxyGenerator.java:420)
- at
-sun.misc.ProxyGenerator.generateProxyClass(ProxyGenerator.java:306)
- at java.lang.reflect.Proxy.getProxyClass(Proxy.java:501)
- at java.lang.reflect.Proxy.newProxyInstance(Proxy.java:581)
- at ReturnTest.test(ReturnTest.java:36)
- at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
- at
-sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
- at
-sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
- at
-com.intellij.rt.execution.junit2.JUnitStarter.main(JUnitStarter.java:32)
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multipoint-considerations.adoc
----------------------------------------------------------------------
diff --git a/docs/multipoint-considerations.adoc b/docs/multipoint-considerations.adoc
new file mode 100644
index 0000000..24d3644
--- /dev/null
+++ b/docs/multipoint-considerations.adoc
@@ -0,0 +1,32 @@
+:index-group: Discovery
+and Failover
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: Multipoint Considerations
+
+
+== Network size
+
+The general disadvantage of this topology is the number of connections
+required. The number of connections for the network of servers is equal
+to `(n * n - n) / 2`, where n is the number of servers. For example,
+with 5 servers you need 10 connections, with 10 servers you need 45
+connections, and with 50 servers you need 1225 connections. This is of
+course the number of connections across the entire network, each
+individual server only needs `n - 1` connections.
+
+The handling of these sockets is all asynchronous Java NIO code which
+allows the server to handle many connections (all of them) with one
+thread. From a pure threading perspective, the option is extremely
+efficient with just one thread to listen and broadcast to many peers.
+
+== Double connect
+
+It is possible in this process that two servers learn of each other at
+the same time and each attempts to connect to the other simultaneously,
+resulting in two connections between the same two servers. When this
+happens both servers will detect the extra connection and one of the
+connections will be dropped and one will be kept. In practice this race
+condition rarely happens and can be avoided almost entirely by fanning
+out server startup by as little as 100 milliseconds.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multipoint-considerations.md
----------------------------------------------------------------------
diff --git a/docs/multipoint-considerations.md b/docs/multipoint-considerations.md
deleted file mode 100644
index 63ebf11..0000000
--- a/docs/multipoint-considerations.md
+++ /dev/null
@@ -1,30 +0,0 @@
-index-group=Discovery and Failover
-type=page
-status=published
-title=Multipoint Considerations
-~~~~~~
-
-# Network size
-
-The general disadvantage of this topology is the number of connections
-required. The number of connections for the network of servers is equal to
-`(n * n - n) / 2`, where n is the number of servers. For example, with 5
-servers you need 10 connections, with 10 servers you need 45 connections,
-and with 50 servers you need 1225 connections. This is of course the
-number of connections across the entire network, each individual server
-only needs `n - 1` connections.
-
-The handling of these sockets is all asynchronous Java NIO code which
-allows the server to handle many connections (all of them) with one thread.
- From a pure threading perspective, the option is extremely efficient with
-just one thread to listen and broadcast to many peers.
-
-# Double connect
-
-It is possible in this process that two servers learn of each other at the
-same time and each attempts to connect to the other simultaneously,
-resulting in two connections between the same two servers. When this
-happens both servers will detect the extra connection and one of the
-connections will be dropped and one will be kept. In practice this race
-condition rarely happens and can be avoided almost entirely by fanning out
-server startup by as little as 100 milliseconds.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multipoint-discovery.adoc
----------------------------------------------------------------------
diff --git a/docs/multipoint-discovery.adoc b/docs/multipoint-discovery.adoc
new file mode 100644
index 0000000..a8a4daa
--- /dev/null
+++ b/docs/multipoint-discovery.adoc
@@ -0,0 +1,85 @@
+:index-group: Discovery
+and Failover
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: Multipoint (TCP) Discovery
+
+
+As TCP has no real broadcast functionality to speak of, communication of
+who is in the network is achieved by each server having a physical
+connection to each other server in the network.
+
+To join the network, the server must be configured to know the address
+of at least one server in the network and connect to it. When it does
+both servers will exchange the full list of all the other servers each
+knows about. Each server will then connect to any new servers they've
+just learned about and repeat the processes with those new servers. The
+end result is that everyone has a direct connection to everyone 100% of
+the time, hence the made-up term "multipoint" to describe this situation
+of each server having multiple point-to-point connections which create a
+fully connected graph.
+
+On the client side things are similar. It needs to know the address of
+at least one server in the network and be able to connect to it. When it
+does it will get the full (and dynamically maintained) list of every
+server in the network. The client doesn't connect to each of those
+servers immediately, but rather consults the list in the event of a
+failover, using it to decide who to connect to next.
+
+The entire process is essentially the art of using a statically
+maintained list to bootstrap getting the more valuable dynamically
+maintained list.
+
+== Server Configuration
+
+In the server this list can be specified via the
+`conf/multipoint.properties` file like so:
+
+....
+server = org.apache.openejb.server.discovery.MultipointDiscoveryAgent
+bind = 127.0.0.1
+port = 4212
+disabled = false
+initialServers = 192.168.1.20:4212, 192.168.1.30:4212, 192.168.1.40:4212
+....
+
+The above configuration shows the server has an `port` `4212` open for
+connections by other servers for multipoint communication. The
+`initialServers` list should be a comma separated list of other similar
+servers on the network. Only one of the servers listed is required to be
+running when this server starts up -- it is not required to list all
+servers in the network.
+
+== Client Configuration
+
+Configuration in the client is similar, but note that EJB clients do not
+participate directly in multipoint communication and do *not* connect to
+the multipoint port. The server list is simply a list of the regular
+`ejbd://` urls that a client normally uses to connect to a server.
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put(Context.PROVIDER_URL, "failover:ejbd://192.168.1.20:4201,ejbd://192.168.1.30:4201");
+InitialContext remoteContext = new InitialContext(p);
+....
+
+Failover can work entirely driven by the server, the client does not
+need to be configured to participate. A client can connect as usual to
+the server.
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put(Context.PROVIDER_URL, "ejbd://192.168.1.20:4201");
+InitialContext remoteContext = new InitialContext(p);
+....
+
+If the server at `192.168.1.20:4201` supports failover, so will the
+client.
+
+In this scenario the list of servers used for failover is supplied
+entirely by the server at `192.168.1.20:4201`. The server could have
+aquired the list via multicast or multipoint (or both), but this detail
+is not visible to the client.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multipoint-discovery.md
----------------------------------------------------------------------
diff --git a/docs/multipoint-discovery.md b/docs/multipoint-discovery.md
deleted file mode 100644
index bb93b13..0000000
--- a/docs/multipoint-discovery.md
+++ /dev/null
@@ -1,75 +0,0 @@
-index-group=Discovery and Failover
-type=page
-status=published
-title=Multipoint (TCP) Discovery
-~~~~~~
-
-As TCP has no real broadcast functionality to speak of, communication of
-who is in the network is achieved by each server having a physical
-connection to each other server in the network.
-
-To join the network, the server must be configured to know the address of
-at least one server in the network and connect to it. When it does both
-servers will exchange the full list of all the other servers each knows
-about. Each server will then connect to any new servers they've just
-learned about and repeat the processes with those new servers. The end
-result is that everyone has a direct connection to everyone 100% of the
-time, hence the made-up term "multipoint" to describe this situation of
-each server having multiple point-to-point connections which create a fully
-connected graph.
-
-On the client side things are similar. It needs to know the address of at
-least one server in the network and be able to connect to it. When it does
-it will get the full (and dynamically maintained) list of every server in
-the network. The client doesn't connect to each of those servers
-immediately, but rather consults the list in the event of a failover, using
-it to decide who to connect to next.
-
-The entire process is essentially the art of using a statically maintained
-list to bootstrap getting the more valuable dynamically maintained list.
-
-# Server Configuration
-
-In the server this list can be specified via the
-`conf/multipoint.properties` file like so:
-
- server = org.apache.openejb.server.discovery.MultipointDiscoveryAgent
- bind = 127.0.0.1
- port = 4212
- disabled = false
- initialServers = 192.168.1.20:4212, 192.168.1.30:4212, 192.168.1.40:4212
-
-
-The above configuration shows the server has an `port` `4212` open for
-connections by other servers for multipoint communication. The
-`initialServers` list should be a comma separated list of other similar
-servers on the network. Only one of the servers listed is required to be
-running when this server starts up -- it is not required to list all
-servers in the network.
-
-# Client Configuration
-
-Configuration in the client is similar, but note that EJB clients do not
-participate directly in multipoint communication and do **not** connect to
-the multipoint port. The server list is simply a list of the regular
-`ejbd://` urls that a client normally uses to connect to a server.
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put(Context.PROVIDER_URL, "failover:ejbd://192.168.1.20:4201,ejbd://192.168.1.30:4201");
- InitialContext remoteContext = new InitialContext(p);
-
-Failover can work entirely driven by the server, the client does not need
-to be configured to participate. A client can connect as usual to the server.
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put(Context.PROVIDER_URL, "ejbd://192.168.1.20:4201");
- InitialContext remoteContext = new InitialContext(p);
-
-If the server at `192.168.1.20:4201` supports failover, so will the client.
-
-In this scenario the list of servers used for failover is supplied entirely
-by the server at `192.168.1.20:4201`. The server could have aquired the list
-via multicast or multipoint (or both), but this detail is not visible to the
-client.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multipoint-recommendations.adoc
----------------------------------------------------------------------
diff --git a/docs/multipoint-recommendations.adoc b/docs/multipoint-recommendations.adoc
new file mode 100644
index 0000000..9764479
--- /dev/null
+++ b/docs/multipoint-recommendations.adoc
@@ -0,0 +1,153 @@
+:index-group: Discovery
+and Failover
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: Multipoint Recommendations
+
+
+As mentioned the `initialServers` is only used for bootstrapping the
+multipoint network. Once running, all servers will dynamically establish
+direct connections with each other and there is no single point of
+failure.
+
+However to ensure that the bootstrapping process can occur successfully,
+the `initialServers` property of the `conf/multipoint.properties` file
+must be set carefully and with a specific server start order in mind.
+Each server consults its `initialServers` list exactly once in the
+bootstrapping phase at startup, after that time connections are made
+dynamically.
+
+This means that at least one of the servers listed in `initialServers`
+must already be running when the server starts or the server might never
+become introduced and connected to all the other servers in the network.
+
+== Failed scenario background
+
+As an example of a failed scenario, imagine there are three servers;
+`server1`, `server2`, `server3`. They are setup only to point to the
+server in front of them making a chain:
+
+* server1; `initialServers = server2`
+* server2; `initialServers = server3`
+* server3; `initialServers = *<blank>*`
+
+Which is essentially `server1` -> `server2` -> `server3`. This scenario
+could work, but they servers would have to be started in exactly the
+opposite order:
+
+[arabic]
+. `server3` starts
+. `server2` starts
+[arabic]
+.. _static:_ connect to `server3`
+. `server1` starts
+[arabic]
+.. _static:_ connect to `server2`
+.. _dynamic:_ connect to `server3`
+
+At this point all servers would be fully connected. But the above setup
+is flawed and could easily fail. The first flaw is `server3` lists
+nothing in its `initialServers` list, so if it were restarted it would
+leave the multipoint network and not know how to get back in.
+
+The second flaw is if you started them in any other order, you would
+also not get a fully connected multipoint network. Say the servers were
+started in "front" order:
+
+[arabic]
+. `server1` starts
+[arabic]
+.. _static:_ connect to `server2` - failed, `server2` not started.
+. `server2` starts
+[arabic]
+.. _static:_ connect to `server3` - failed, `server3` not started.
+. `server3` starts
+[arabic]
+.. no connection attempts, initialServers list is empty.
+
+After startup completes, all servers will be completely isolated and
+failover will not work. The described setup is weaker than it needs to
+be. Listing just one server means the listed server is a potential point
+of weakness. As a matter of trivia, it is interesting to point out that
+you could bring a fourth server online temporarily that lists all three
+servers. Once it makes the introductions and all servers learn of each
+other, you could shut it down again.
+
+The above setup is easily fixable via better configuration. If `server3`
+listed both `server1` and `server2` in its initialServers list, rather
+than listing nothing at all, then all servers would fully discover each
+other regardless of startup order; assuming all three servers did
+eventually start.
+
+== Bootstrapping Three Servers or Less
+
+In a three sever scenario, we recommend simply having all three servers
+list all three servers.
+
+* server1/conf/multipoint.properties
+** `initialServers = server1, server2, server3`
+* server2/conf/multipoint.properties
+** `initialServers = server1, server2, server3`
+* server3/conf/multipoint.properties
+** `initialServers = server1, server2, server3`
+
+There's no harm to a server listing itself. It gives you one clean list
+to maintain and it will work even if you decide not to start one of the
+three servers.
+
+== Bootstrapping Four Servers or More
+
+In a scenario of four or more, we recommend picking at least to servers
+and focus on always keeping at least one of them running. Lets refer to
+them as "root" servers for simplicity sake.
+
+* server1/conf/multipoint.properties
+** `initialServers = server2`
+* server2/conf/multipoint.properties
+** `initialServers = server1`
+
+Root `server1` would list root `server2` so they would always be linked
+to each other regardless of start order or if one of them went down.
+`Server1` could be shutdown and reconnect on startup to the full
+multipoint network through `server2`, and vice versa.
+
+All other servers would simply list the root servers (`server1`,
+`server2`) in their initialServers list.
+
+* server3/conf/multipoint.properties
+** `initialServers = server1, server2`
+* server4/conf/multipoint.properties
+** `initialServers = server1, server2`
+* serverN/conf/multipoint.properties
+** `initialServers = server1, server2`
+
+As long as at least one root server (`server1` or `server2`) was
+running, you can bring other servers on and offline at will and always
+have a fully connected graph.
+
+Of course all servers once running and connected will have a full list
+of all other servers in the network, so if at any time the "root"
+servers weren't around to make initial introductions to new servers it
+would be no trouble. It's possible to reconfigure new servers to point
+at any other server in the network as all servers will have the full
+list. So these "root" servers are no real point of failure in function,
+but only of convenience.
+
+== Setting initialServers overrides
+
+Always remember that any property in a
+`conf/<server-service>.properties` file can be overridden on the command
+line or via system properties. So it is possible easily set the
+`initialServers` list in startup scripts.
+
+A bash example might look something like:
+
+....
+!/bin/bash
+
+OPENEJB_HOME=/opt/openejb-3.1.3
+INITIAL_LIST=$(cat /some/shared/directory/our_initial_servers.txt)
+
+$OPENEJB_HOME/bin/openejb start -Dmultipoint.initialServers=$INITIAL_LIST
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multipoint-recommendations.md
----------------------------------------------------------------------
diff --git a/docs/multipoint-recommendations.md b/docs/multipoint-recommendations.md
deleted file mode 100644
index dfcb573..0000000
--- a/docs/multipoint-recommendations.md
+++ /dev/null
@@ -1,141 +0,0 @@
-index-group=Discovery and Failover
-type=page
-status=published
-title=Multipoint Recommendations
-~~~~~~
-
-As mentioned the `initialServers` is only used for bootstrapping
-the multipoint network. Once running, all servers will dynamically
-establish direct connections with each other and there is no single point
-of failure.
-
-However to ensure that the bootstrapping process can occur successfully,
-the `initialServers` property of the `conf/multipoint.properties` file
-must be set carefully and with a specific server start order in mind. Each
-server consults its `initialServers` list exactly once in the
-bootstrapping phase at startup, after that time connections are made
-dynamically.
-
-This means that at least one of the servers listed in `initialServers`
-must already be running when the server starts or the server might never
-become introduced and connected to all the other servers in the network.
-
-# Failed scenario <small>background</small>
-
-As an example of a failed scenario, imagine there are three servers;
-`server1`, `server2`, `server3`. They are setup only to point to the server in
-front of them making a chain:
-
-* server1; `initialServers = server2`
-* server2; `initialServers = server3`
-* server3; `initialServers = *<blank>*`
-
-Which is essentially `server1` -> `server2` -> `server3`. This scenario could
-work, but they servers would have to be started in exactly the opposite
-order:
-
-1. `server3` starts
-1. `server2` starts
- 1. *static:* connect to `server3`
-1. `server1` starts
- 1. *static:* connect to `server2`
- 1. *dynamic:* connect to `server3`
-
-At this point all servers would be fully connected. But the above setup is
-flawed and could easily fail. The first flaw is `server3` lists nothing in
-its `initialServers` list, so if it were restarted it would leave the
-multipoint network and not know how to get back in.
-
-The second flaw is if you started them in any other order, you would also
-not get a fully connected multipoint network. Say the servers were started
-in "front" order:
-
-1. `server1` starts
- 1. *static:* connect to `server2` - failed, `server2` not started.
-1. `server2` starts
- 1. *static:* connect to `server3` - failed, `server3` not started.
-1. `server3` starts
- 1. no connection attempts, initialServers list is empty.
-
-After startup completes, all servers will be completely isolated and
-failover will not work. The described setup is weaker than it needs to be.
-Listing just one server means the listed server is a potential point of
-weakness. As a matter of trivia, it is interesting to point out that you
-could bring a fourth server online temporarily that lists all three
-servers. Once it makes the introductions and all servers learn of each
-other, you could shut it down again.
-
-The above setup is easily fixable via better configuration. If `server3`
-listed both `server1` and `server2` in its initialServers list, rather than
-listing nothing at all, then all servers would fully discover each other
-regardless of startup order; assuming all three servers did eventually
-start.
-
-# Bootstrapping Three Servers or Less
-
-In a three sever scenario, we recommend simply having all three servers
-list all three servers.
-
-* server1/conf/multipoint.properties
- * `initialServers = server1, server2, server3`
-* server2/conf/multipoint.properties
- * `initialServers = server1, server2, server3`
-* server3/conf/multipoint.properties
- * `initialServers = server1, server2, server3`
-
-There's no harm to a server listing itself. It gives you one clean list to
-maintain and it will work even if you decide not to start one of the three
-servers.
-
-# Bootstrapping Four Servers or More
-
-In a scenario of four or more, we recommend picking at least to servers and
-focus on always keeping at least one of them running. Lets refer to them
-as "root" servers for simplicity sake.
-
-* server1/conf/multipoint.properties
- * `initialServers = server2`
-* server2/conf/multipoint.properties
- * `initialServers = server1`
-
-Root `server1` would list root `server2` so they would always be linked to each
-other regardless of start order or if one of them went down. `Server1` could
-be shutdown and reconnect on startup to the full multipoint network through
-`server2`, and vice versa.
-
-All other servers would simply list the root servers (`server1`, `server2`) in
-their initialServers list.
-
-* server3/conf/multipoint.properties
- * `initialServers = server1, server2`
-* server4/conf/multipoint.properties
- * `initialServers = server1, server2`
-* serverN/conf/multipoint.properties
- * `initialServers = server1, server2`
-
-As long as at least one root server (`server1` or `server2`) was running, you
-can bring other servers on and offline at will and always have a fully
-connected graph.
-
-Of course all servers once running and connected will have a full list of
-all other servers in the network, so if at any time the "root" servers
-weren't around to make initial introductions to new servers it would be no
-trouble. It's possible to reconfigure new servers to point at any other
-server in the network as all servers will have the full list. So these
-"root" servers are no real point of failure in function, but only of
-convenience.
-
-# Setting initialServers <small>overrides</small>
-
-Always remember that any property in a `conf/<server-service>.properties`
-file can be overridden on the command line or via system properties. So it
-is possible easily set the `initialServers` list in startup scripts.
-
-A bash example might look something like:
-
- !/bin/bash
-
- OPENEJB_HOME=/opt/openejb-3.1.3
- INITIAL_LIST=$(cat /some/shared/directory/our_initial_servers.txt)
-
- $OPENEJB_HOME/bin/openejb start -Dmultipoint.initialServers=$INITIAL_LIST
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multipulse-discovery.adoc
----------------------------------------------------------------------
diff --git a/docs/multipulse-discovery.adoc b/docs/multipulse-discovery.adoc
new file mode 100644
index 0000000..63d6518
--- /dev/null
+++ b/docs/multipulse-discovery.adoc
@@ -0,0 +1,109 @@
+:index-group: Discovery
+and Failover
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: MultiPulse (UDP) Discovery
+
+
+MultiPulse is an alternative multicast lookup that does not use a
+regular heartbeat. Instead, servers listen for a multicast request
+packet (a pulse) to which a response is then sent. Multicast network
+traffic is effectively reduced to an absolute minimum.
+
+MultiPulse is only useful in network scenarios where both client and
+server can be configured to send multicast UDP packets.
+
+== Server Configuration
+
+After you boot the server for the first time the default configuration
+will create the file `conf/conf.d/multipulse.properties` containing:
+
+....
+server = org.apache.openejb.server.discovery.MulticastPulseAgent
+bind = 239.255.2.3
+port = 6142
+disabled = true
+group = default
+....
+
+You just need to enable the agent by setting `disabled = false`. It is
+advisable to disable multicast in the `multicast.properties file`, or at
+least to use a different bind address or port should you wish to use
+both.
+
+All of the above settings except `server` can be modified as required.
+The `port` and `bind` must be valid for general multicast/udp network
+communication.
+
+The `group` setting can be changed to further group/cluster servers that
+may use the same multicast channel. As shown below the client also has
+an optional `group` setting which can be used to select an appropriate
+server cluster from the multicast channel (See MultiPulse Client).
+
+The next step is to ensure that the advertised services are configured
+for discovery. Edit the `ejbd.properties` file (and any other enabled
+services such as http, etc.) and ensure that the `discovery` option is
+set to a value that remote clients will be able to resolve.
+
+....
+server = org.apache.openejb.server.ejbd.EjbServer
+bind = 0.0.0.0
+port = 4201
+disabled = false
+threads = 20
+discovery = ejb:ejbd://{bind}:{port}
+....
+
+NOTE: If either `0.0.0.0` (IPv4) or `[::]` (IPv6) wildcard bind
+addresses are used then the server will actually broadcast all of it's
+known public hosts to clients. Clients will then cycle though and
+attempt to connect to the provided hosts until successful.
+
+If `localhost` is used then only clients on the same physical machine
+will actually 'see' the server response.
+
+== MultiPulse Client
+
+The multipulse functionality is not just for servers to find each other
+in a cluster, it can also be used for EJB clients to discover a server.
+A special `multipulse://` URL can be used in the `InitialContext`
+properties to signify that multipulse should be used to seed the
+connection process. Such as:
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put(Context.PROVIDER_URL, "multipulse://239.255.2.3:6142?group=default&timeout=250");
+InitialContext remoteContext = new InitialContext(p);
+....
+
+The URL has optional query parameters such as `schemes` and `group` and
+`timeout` which allow you to zero in on a particular type of service of
+a particular cluster group as well as set how long you are willing to
+wait in the discovery process till finally giving up. The first matching
+service that it sees "flowing" around on the UDP stream is the one it
+picks and sticks to for that and subsequent requests, ensuring UDP is
+only used when there are no other servers to talk to.
+
+Note that EJB clients do not need to use multipulse to find a server. If
+the client knows the URL of a server in the cluster, it may use it and
+connect directly to that server, at which point that server will share
+the full list of its peers.
+
+== Multicast Servers with TCP Clients
+
+Note that clients do not need to use multipulse to communicate with
+servers. Servers can use multicast to discover each other, but clients
+are still free to connect to servers in the network using the server's
+TCP address.
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put(Context.PROVIDER_URL, "ejbd://192.168.1.30:4201");
+InitialContext remoteContext = new InitialContext(p);
+....
+
+When the client connects, the server will send the URLs of all the
+servers in the group and failover will take place normally.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/multipulse-discovery.md
----------------------------------------------------------------------
diff --git a/docs/multipulse-discovery.md b/docs/multipulse-discovery.md
deleted file mode 100644
index 087803d..0000000
--- a/docs/multipulse-discovery.md
+++ /dev/null
@@ -1,94 +0,0 @@
-index-group=Discovery and Failover
-type=page
-status=published
-title=MultiPulse (UDP) Discovery
-~~~~~~
-
-MultiPulse is an alternative multicast lookup that does not use a regular heartbeat.
-Instead, servers listen for a multicast request packet (a pulse) to which a response
-is then sent. Multicast network traffic is effectively reduced to an absolute minimum.
-
-MultiPulse is only useful in network scenarios where both client and server can be
-configured to send multicast UDP packets.
-
-# Server Configuration
-
-After you boot the server for the first time the default configuration will create the
-file `conf/conf.d/multipulse.properties` containing:
-
- server = org.apache.openejb.server.discovery.MulticastPulseAgent
- bind = 239.255.2.3
- port = 6142
- disabled = true
- group = default
-
-You just need to enable the agent by setting `disabled = false`. It is advisable to
-disable multicast in the `multicast.properties file`, or at least to use a different
-bind address or port should you wish to use both.
-
-All of the above settings except `server` can be modified as required.
-The `port` and `bind` must be valid for general multicast/udp network communication.
-
-The `group` setting can be changed to further group/cluster servers that may use
-the same multicast channel. As shown below the client also has an optional `group`
-setting which can be used to select an appropriate server cluster from the multicast
-channel (See MultiPulse Client).
-
-The next step is to ensure that the advertised services are configured for discovery.
-Edit the `ejbd.properties` file (and any other enabled services such as http, etc.) and
-ensure that the `discovery` option is set to a value that remote clients will be able
-to resolve.
-
- server = org.apache.openejb.server.ejbd.EjbServer
- bind = 0.0.0.0
- port = 4201
- disabled = false
- threads = 20
- discovery = ejb:ejbd://{bind}:{port}
-
-NOTE: If either `0.0.0.0` (IPv4) or `[::]` (IPv6) wildcard bind addresses are used then the
-server will actually broadcast all of it's known public hosts to clients. Clients will then
-cycle though and attempt to connect to the provided hosts until successful.
-
-If `localhost` is used then only clients on the same physical machine will actually 'see' the
-server response.
-
-# MultiPulse Client
-
-The multipulse functionality is not just for servers to find each other in a
-cluster, it can also be used for EJB clients to discover a server. A
-special `multipulse://` URL can be used in the `InitialContext` properties to
-signify that multipulse should be used to seed the connection process. Such
-as:
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put(Context.PROVIDER_URL, "multipulse://239.255.2.3:6142?group=default&timeout=250");
- InitialContext remoteContext = new InitialContext(p);
-
-The URL has optional query parameters such as `schemes` and `group` and
-`timeout` which allow you to zero in on a particular type of service of a
-particular cluster group as well as set how long you are willing to wait in
-the discovery process till finally giving up. The first matching service
-that it sees "flowing" around on the UDP stream is the one it picks and
-sticks to for that and subsequent requests, ensuring UDP is only used when
-there are no other servers to talk to.
-
-Note that EJB clients do not need to use multipulse to find a server. If
-the client knows the URL of a server in the cluster, it may use it and
-connect directly to that server, at which point that server will share the
-full list of its peers.
-
-# Multicast Servers with TCP Clients
-
-Note that clients do not need to use multipulse to communicate with servers.
-Servers can use multicast to discover each other, but clients are still
-free to connect to servers in the network using the server's TCP address.
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put(Context.PROVIDER_URL, "ejbd://192.168.1.30:4201");
- InitialContext remoteContext = new InitialContext(p);
-
-When the client connects, the server will send the URLs of all the servers
-in the group and failover will take place normally.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/new-in-openejb-3.0.adoc
----------------------------------------------------------------------
diff --git a/docs/new-in-openejb-3.0.adoc b/docs/new-in-openejb-3.0.adoc
new file mode 100644
index 0000000..f5d871f
--- /dev/null
+++ b/docs/new-in-openejb-3.0.adoc
@@ -0,0 +1,154 @@
+:jbake-title: New in OpenEJB 3.0
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# EJB 3.0
+
+OpenEJB 3.0 supports the EJB 3.0 specification as well as the prior EJB
+2.1, EJB 2.0, and EJB 1.1. New features in EJB 3.0 include:
+
+* Annotations instead of xml
+* No home interfaces
+* Business Interfaces
+* Dependency Injection
+* Intercpetors
+* Java Persistence API
+* Service Locator (ala SessionContext.lookup)
+* POJO-style beans
+
+EJB 2.x features since OpenEJB 1.0 also include: - MessageDriven Beans -
+Container-Managed Persistence (CMP) 2.0 - Timers
+
+The two aspects of EJB that OpenEJB does not yet support are: - Web
+Services (JAX-WS, JAX-RPC) - CORBA
+
+JAX-WS and CORBA support will be added in future releases. Support for
+the JAX-RPC API is not a planned feature.
+
+# Extensions to EJB 3.0
+
+== CMP via JPA
+
+Our CMP implementation is a thin layer over the new Java Persistence API
+(JPA). This means when you deploy an old style CMP 1.1 or CMP 2.1 bean
+it is internally converted and ran as a JPA bean. This makes it possible
+to use both CMP and JPA in the same application without any coherence
+issues that can come from using two competing persistence technologies
+against the same data. Everything is ultimately JPA in the end.
+
+== Extended Dependency Injection
+
+Dependency Injection in EJB 3.0 via @Resource is largely limited to
+objects provided by the container, such as DataSources, JMS Topics and
+Queues. It is possible for you to supply your own configuration
+information for injection, but standard rules allow for only data of
+type String, Character, Boolean, Integer, Short, Long, Double, Float and
+Byte. If you needed a URL, for example, you'd have to have it injected
+as a String then convert it yourself to a URL. This is just plain silly
+as the conversion of Strings to other basic data types has existed in
+JavaBeans long before Enterprise JavaBeans existed.
+
+OpenEJB 3.0 supports injection of any data type for which you can supply
+a JavaBeans PropertyEditor. We include several built-in PropertyEditors
+already such as Date, InetAddress, Class, File, URL, URI, Map, List and
+more.
+
+....
+import java.net.URI;
+import java.io.File;
+import java.util.Date;
+
+@Stateful
+public class MyBean {
+ @Resource URI blog;
+ @Resource Date birthday;
+ @Resource File homeDirectory;
+}
+....
+
+== The META-INF/env-entries.properties
+
+Along the lines of injection, one of the last remaining things in EJB 3
+that people need an ejb-jar.xml file for is to supply the value of
+env-entries. Env Entries are the source of data for all user supplied
+data injected into your bean; the afore mentioned String, Boolean,
+Integer, etc. This is a very big burden as each env-entry is going to
+cost you 5 lines of xml and the complication of having to figure out how
+to add you bean declaration in xml as an override of an existing bean
+and not accidentally as a new bean. All this can be very painful when
+all you want is to supply the value of a few @Resource String fields in
+you bean class.
+
+To fix this, OpenEJB supports the idea of a
+META-INF/env-entries.properties file where we will look for the value of
+things that need injection that are not container controlled resources
+(i.e. datasources and things of that nature). You can configure you ejbs
+via a properties file and skip the need for an ejb-jar.xml and it's 5
+lines per property madness.
+
+....
+blog = http://acme.org/myblog
+birthday = locale=en_US style=MEDIUM Mar 1, 1954
+homeDirectory = /home/esmith/
+....
+
+== Support for GlassFish descriptors
+
+Unit testing EJBs with OpenEJB is a major feature and draw for people,
+even for people who may still use other app servers for final deployment
+such as Geronimo or GlassFish. The descriptor format for Geronimo is
+natively understood by OpenEJB as OpenEJB is the EJB Container provider
+for Geronimo. However, OpenEJB also supports the GlassFish descriptors
+so people using GlassFish as their final server can still use OpenEJB
+for testing EJBs via plain JUnit tests in their build and only have one
+set of vendor descriptors to maintain.
+
+== JavaEE 5 EAR and Application Client support
+
+JavaEE 5 EARs and Application Clients can be deployed in addition to ejb
+jars. EAR support is limited to ejbs, application clients, and
+libraries; WAR files and RAR files will be ignored. Per the JavaEE 5
+spec, the META-INF/application.xml and META-INF/application-client.xml
+files are optional.
+
+== Application Validation for EJB 3.0
+
+Incorrect usage of various new aspects of EJB 3.0 are checked for and
+reported during the deployment process preventing strange errors and
+failures.
+
+As usual validation failures (non-compliant issues with your
+application) are printed out in complier-style "all-at-once" output
+allowing you to see and fix all your issues in one go. For example, if
+you have 10 @PersistenceContext annotations that reference an invalid
+persistence unit, you get all 10 errors on the _first_ deploy rather
+than one failure on the first deploy with 9 more failed deployments to
+go.
+
+Validation output comes in three levels. The most verbose level will
+tell you in detail what you did wrong, what the options are, and what to
+do next... even including valid code and annotation usage tailored to
+your app that you can copy and paste into your application. Very ideal
+for beginners and people using OpenEJB in a classroom setting.
+
+== Most configurable JNDI names ever
+
+# General Improvements
+
+== Online Deployment ## Security Service ## Connection Pooling ##
+Configuration Overriding ## Flexible JNDI Name Formatting ## Cleaner
+Embedding ## Tomcat 6 Support ## Business locals remotable
+
+If you want to make business local interfaces remotable, you can set
+this property:
+
+....
+ openejb.remotable.businessLocals=true
+....
+
+Then you can lookup your business local interfaces from remote clients.
+
+You'd still have to ensure that the you pass back and forth is
+serializable.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/new-in-openejb-3.0.md
----------------------------------------------------------------------
diff --git a/docs/new-in-openejb-3.0.md b/docs/new-in-openejb-3.0.md
deleted file mode 100644
index 3c568ab..0000000
--- a/docs/new-in-openejb-3.0.md
+++ /dev/null
@@ -1,179 +0,0 @@
-title= New in OpenEJB 3.0
-type=page
-status=published
-~~~~~~
-
-<a name="NewinOpenEJB3.0-EJB3.0"></a>
-# EJB 3.0
-
-OpenEJB 3.0 supports the EJB 3.0 specification as well as the prior EJB
-2.1, EJB 2.0, and EJB 1.1. New features in EJB 3.0 include:
-
- - Annotations instead of xml
- - No home interfaces
- - Business Interfaces
- - Dependency Injection
- - Intercpetors
- - Java Persistence API
- - Service Locator (ala SessionContext.lookup)
- - POJO-style beans
-
-EJB 2.x features since OpenEJB 1.0 also include:
- - MessageDriven Beans
- - Container-Managed Persistence (CMP) 2.0
- - Timers
-
-The two aspects of EJB that OpenEJB does not yet support are:
- - Web Services (JAX-WS, JAX-RPC)
- - CORBA
-
-JAX-WS and CORBA support will be added in future releases. Support for the
-JAX-RPC API is not a planned feature.
-
-<a name="NewinOpenEJB3.0-ExtensionstoEJB3.0"></a>
-# Extensions to EJB 3.0
-
-<a name="NewinOpenEJB3.0-CMPviaJPA"></a>
-## CMP via JPA
-
-Our CMP implementation is a thin layer over the new Java Persistence API
-(JPA). This means when you deploy an old style CMP 1.1 or CMP 2.1 bean it
-is internally converted and ran as a JPA bean. This makes it possible to
-use both CMP and JPA in the same application without any coherence issues
-that can come from using two competing persistence technologies against the
-same data. Everything is ultimately JPA in the end.
-
-<a name="NewinOpenEJB3.0-ExtendedDependencyInjection"></a>
-## Extended Dependency Injection
-
-Dependency Injection in EJB 3.0 via @Resource is largely limited to objects
-provided by the container, such as DataSources, JMS Topics and Queues. It
-is possible for you to supply your own configuration information for
-injection, but standard rules allow for only data of type String,
-Character, Boolean, Integer, Short, Long, Double, Float and Byte. If you
-needed a URL, for example, you'd have to have it injected as a String then
-convert it yourself to a URL. This is just plain silly as the conversion
-of Strings to other basic data types has existed in JavaBeans long before
-Enterprise JavaBeans existed.
-
-OpenEJB 3.0 supports injection of any data type for which you can supply a
-JavaBeans PropertyEditor. We include several built-in PropertyEditors
-already such as Date, InetAddress, Class, File, URL, URI, Map, List and
-more.
-
-
- import java.net.URI;
- import java.io.File;
- import java.util.Date;
-
- @Stateful
- public class MyBean {
- @Resource URI blog;
- @Resource Date birthday;
- @Resource File homeDirectory;
- }
-
-
-<a name="NewinOpenEJB3.0-TheMETA-INF/env-entries.properties"></a>
-## The META-INF/env-entries.properties
-
-Along the lines of injection, one of the last remaining things in EJB 3
-that people need an ejb-jar.xml file for is to supply the value of
-env-entries. Env Entries are the source of data for all user supplied data
-injected into your bean; the afore mentioned String, Boolean, Integer, etc.
- This is a very big burden as each env-entry is going to cost you 5 lines
-of xml and the complication of having to figure out how to add you bean
-declaration in xml as an override of an existing bean and not accidentally
-as a new bean. All this can be very painful when all you want is to supply
-the value of a few @Resource String fields in you bean class.
-
-To fix this, OpenEJB supports the idea of a META-INF/env-entries.properties
-file where we will look for the value of things that need injection that
-are not container controlled resources (i.e. datasources and things of that
-nature). You can configure you ejbs via a properties file and skip the
-need for an ejb-jar.xml and it's 5 lines per property madness.
-
-
- blog = http://acme.org/myblog
- birthday = locale=en_US style=MEDIUM Mar 1, 1954
- homeDirectory = /home/esmith/
-
-
-<a name="NewinOpenEJB3.0-SupportforGlassFishdescriptors"></a>
-## Support for GlassFish descriptors
-
-Unit testing EJBs with OpenEJB is a major feature and draw for people, even
-for people who may still use other app servers for final deployment such as
-Geronimo or GlassFish. The descriptor format for Geronimo is natively
-understood by OpenEJB as OpenEJB is the EJB Container provider for
-Geronimo. However, OpenEJB also supports the GlassFish descriptors so
-people using GlassFish as their final server can still use OpenEJB for
-testing EJBs via plain JUnit tests in their build and only have one set of
-vendor descriptors to maintain.
-
-<a name="NewinOpenEJB3.0-JavaEE5EARandApplicationClientsupport"></a>
-## JavaEE 5 EAR and Application Client support
-
-JavaEE 5 EARs and Application Clients can be deployed in addition to ejb
-jars. EAR support is limited to ejbs, application clients, and libraries;
-WAR files and RAR files will be ignored. Per the JavaEE 5 spec, the
-META-INF/application.xml and META-INF/application-client.xml files are
-optional.
-
-<a name="NewinOpenEJB3.0-ApplicationValidationforEJB3.0"></a>
-## Application Validation for EJB 3.0
-
-Incorrect usage of various new aspects of EJB 3.0 are checked for and
-reported during the deployment process preventing strange errors and
-failures.
-
-As usual validation failures (non-compliant issues with your application)
-are printed out in complier-style "all-at-once" output allowing you to see
-and fix all your issues in one go. For example, if you have 10
-@PersistenceContext annotations that reference an invalid persistence unit,
-you get all 10 errors on the *first* deploy rather than one failure on the
-first deploy with 9 more failed deployments to go.
-
-Validation output comes in three levels. The most verbose level will tell
-you in detail what you did wrong, what the options are, and what to do
-next... even including valid code and annotation usage tailored to your app
-that you can copy and paste into your application. Very ideal for
-beginners and people using OpenEJB in a classroom setting.
-
-<a name="NewinOpenEJB3.0-MostconfigurableJNDInamesever"></a>
-## Most configurable JNDI names ever
-
-<a name="NewinOpenEJB3.0-GeneralImprovements"></a>
-# General Improvements
-
-<a name="NewinOpenEJB3.0-OnlineDeployment"></a>
-## Online Deployment
-<a name="NewinOpenEJB3.0-SecurityService"></a>
-## Security Service
-<a name="NewinOpenEJB3.0-ConnectionPooling"></a>
-## Connection Pooling
-<a name="NewinOpenEJB3.0-ConfigurationOverriding"></a>
-## Configuration Overriding
-<a name="NewinOpenEJB3.0-FlexibleJNDINameFormatting"></a>
-## Flexible JNDI Name Formatting
-<a name="NewinOpenEJB3.0-CleanerEmbedding"></a>
-## Cleaner Embedding
-<a name="NewinOpenEJB3.0-Tomcat6Support"></a>
-## Tomcat 6 Support
-<a name="NewinOpenEJB3.0-Businesslocalsremotable"></a>
-## Business locals remotable
-
-If you want to make business local interfaces remotable, you can set this
-property:
-
- openejb.remotable.businessLocals=true
-
-Then you can lookup your business local interfaces from remote clients.
-
-You'd still have to ensure that the you pass back and forth is
-serializable.
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb-3.adoc
----------------------------------------------------------------------
diff --git a/docs/openejb-3.adoc b/docs/openejb-3.adoc
new file mode 100644
index 0000000..260bbb4
--- /dev/null
+++ b/docs/openejb-3.adoc
@@ -0,0 +1,69 @@
+# OpenEJB 3
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# Past, Present, and Future
+
+The goal of OpenEJB 3 is to merge our past, present, and future into one
+codebase. OpenEJB 3 will take the excellent features in OpenEJB 1.0
+(tomcat integration, testability, embeddibility, ease of use, etc), move
+towards an IoC architecture based on Gbean.org and Spring, bring in the
+OpenEJB 2 code, and implement the EJB 3.0 specification.
+
+# The Plan
+
+We will start on OpenEJB 3 by taking the 1.0 code (pretty much the same
+as 0.9.2), merging in the 2.0 code, and ensuring that the entire time
+the code we write is code you can use! We will never drop a feature,
+even temporarily. We will start from code that users are now using and
+always keep, maintain, and improve those features as we add new
+features. Releasing early and often.
+
+== Past
+
+OpenEJB 1.0 (from 0.9.2 lineage) has some great features and many people
+that depend on them. Tomcat integration, Collapsed EARs, Container
+Driven Testing, easy embedding, and other features make OpenEJB a unique
+EJB implementation. We're going to take this code, kill all the static
+old-school techniques, modernize it with and IoC architecture based on
+the gbean.org kernel. The gbean kernel is an IoC kernel compatible with
+both Spring and Geronimo.
+
+== Present
+
+OpenEJB 2.0 is an awesome fast implementation of EJB 2.1 that runs in
+Apache Geronimo. As the gbean.org kernel is both Spring and Geronimo
+compatible, it provides a great way for us to take the
+Geronimo-compatible EJB containers and deployers in OpenEJB 2 and start
+hammering them out and releasing them to long-time OpenEJB users. It
+will also allow people using OpenEJB to start experimenting with
+Spring's sophisticated IoC features.
+
+== Future
+
+EJB 3.0 is a new direction for EJB and we're going to do it with style.
+A focus on simplicity is where OpenEJB shines. Combining the EJB 3.0
+Simplified specification with our existing lightweight features, like
+Container Driven Testing, is just the beginning. We plan to go way
+beyond the planned additions and into areas the J2EE spec groups won't
+go such as deployment descriptors with attributes, simpler packaging,
+more flexible classloader setup, more powerful IoC support, simpler web
+services support and more.
+
+# Release on Day One
+
+Keep it working, keep it progressing, keep releasing. The 3.0 version
+number won't be the finishing line, but the starting line. Our work will
+start out as 3.0 on day one and keep incrementing the version number as
+we get further along our feature list. The EJB 3.0 spec is not completed
+and the OpenEJB 3.0 code line will be equally dynamic and best suited
+for adventurous developers who enjoy reading release notes and
+participating on user lists. There will be an incredible focus on
+keeping things stable enough to use the entire time as we work towards
+feature completion.
+
+The effect of all this is that you get a fixed-up, far more extensible,
+version of the code you are already using delivered to you right away.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb-3.md
----------------------------------------------------------------------
diff --git a/docs/openejb-3.md b/docs/openejb-3.md
deleted file mode 100644
index f6c94cc..0000000
--- a/docs/openejb-3.md
+++ /dev/null
@@ -1,72 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=OpenEJB 3
-~~~~~~
-
-<a name="OpenEJB3-Past,Present,andFuture"></a>
-# Past, Present, and Future
-
-The goal of OpenEJB 3 is to merge our past, present, and future into one
-codebase. OpenEJB 3 will take the excellent features in OpenEJB 1.0
-(tomcat integration, testability, embeddibility, ease of use, etc), move
-towards an IoC architecture based on Gbean.org and Spring, bring in the
-OpenEJB 2 code, and implement the EJB 3.0 specification.
-
-<a name="OpenEJB3-ThePlan"></a>
-# The Plan
-
-We will start on OpenEJB 3 by taking the 1.0 code (pretty much the same as
-0.9.2), merging in the 2.0 code, and ensuring that the entire time the code
-we write is code you can use! We will never drop a feature, even
-temporarily. We will start from code that users are now using and always
-keep, maintain, and improve those features as we add new features.
-Releasing early and often.
-
-<a name="OpenEJB3-Past"></a>
-## Past
-
-OpenEJB 1.0 (from 0.9.2 lineage) has some great features and many people
-that depend on them. Tomcat integration, Collapsed EARs, Container Driven
-Testing, easy embedding, and other features make OpenEJB a unique EJB
-implementation. We're going to take this code, kill all the static
-old-school techniques, modernize it with and IoC architecture based on the
-gbean.org kernel. The gbean kernel is an IoC kernel compatible with both
-Spring and Geronimo.
-
-<a name="OpenEJB3-Present"></a>
-## Present
-
-OpenEJB 2.0 is an awesome fast implementation of EJB 2.1 that runs in
-Apache Geronimo. As the gbean.org kernel is both Spring and Geronimo
-compatible, it provides a great way for us to take the Geronimo-compatible
-EJB containers and deployers in OpenEJB 2 and start hammering them out and
-releasing them to long-time OpenEJB users. It will also allow people using
-OpenEJB to start experimenting with Spring's sophisticated IoC features.
-
-<a name="OpenEJB3-Future"></a>
-## Future
-
-EJB 3.0 is a new direction for EJB and we're going to do it with style. A
-focus on simplicity is where OpenEJB shines. Combining the EJB 3.0
-Simplified specification with our existing lightweight features, like
-Container Driven Testing, is just the beginning. We plan to go way beyond
-the planned additions and into areas the J2EE spec groups won't go such as
-deployment descriptors with attributes, simpler packaging, more flexible
-classloader setup, more powerful IoC support, simpler web services support
-and more.
-
-<a name="OpenEJB3-ReleaseonDayOne"></a>
-# Release on Day One
-
-Keep it working, keep it progressing, keep releasing. The 3.0 version
-number won't be the finishing line, but the starting line. Our work will
-start out as 3.0 on day one and keep incrementing the version number as we
-get further along our feature list. The EJB 3.0 spec is not completed and
-the OpenEJB 3.0 code line will be equally dynamic and best suited for
-adventurous developers who enjoy reading release notes and participating on
-user lists. There will be an incredible focus on keeping things stable
-enough to use the entire time as we work towards feature completion.
-
-The effect of all this is that you get a fixed-up, far more extensible,
-version of the code you are already using delivered to you right away.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb-binaries.adoc
----------------------------------------------------------------------
diff --git a/docs/openejb-binaries.adoc b/docs/openejb-binaries.adoc
new file mode 100644
index 0000000..ca1e5dd
--- /dev/null
+++ b/docs/openejb-binaries.adoc
@@ -0,0 +1,32 @@
+# OpenEJB Binaries
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+Add this to your _$HOME/.m2/settings.xml_ to enable publishing to
+the Apache Nexus repo. This works for snapshots or staging final
+binaries.
+
+....
+<settings>
+ <servers>
+ <server>
+ <id>apache.snapshots.https</id>
+ <username>yourapacheid</username>
+ <password>yourapachepass</password>
+ </server>
+ <server>
+ <id>apache.releases.https</id>
+ <username>yourapacheid</username>
+ <password>yourapachepass</password>
+ </server>
+ </servers>
+</settings>
+....
+
+Then publish via:
+
+....
+$ mvn clean deploy
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb-binaries.md
----------------------------------------------------------------------
diff --git a/docs/openejb-binaries.md b/docs/openejb-binaries.md
deleted file mode 100644
index d27ce26..0000000
--- a/docs/openejb-binaries.md
+++ /dev/null
@@ -1,27 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=OpenEJB Binaries
-~~~~~~
-Add this to your *$HOME/.m2/settings.xml* to enable publishing to the
-Apache Nexus repo. This works for snapshots or staging final binaries.
-
- <settings>
- <servers>
- <server>
- <id>apache.snapshots.https</id>
- <username>yourapacheid</username>
- <password>yourapachepass</password>
- </server>
- <server>
- <id>apache.releases.https</id>
- <username>yourapacheid</username>
- <password>yourapachepass</password>
- </server>
- </servers>
- </settings>
-
-
-Then publish via:
-
- $ mvn clean deploy
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb-eclipse-plugin.adoc
----------------------------------------------------------------------
diff --git a/docs/openejb-eclipse-plugin.adoc b/docs/openejb-eclipse-plugin.adoc
new file mode 100644
index 0000000..670e936
--- /dev/null
+++ b/docs/openejb-eclipse-plugin.adoc
@@ -0,0 +1,22 @@
+# OpenEJB Eclipse Plugin
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# OpenEJB Eclipse Plugin
+
+=== Overview
+
+The OpenEJB plugin for Eclipse provides the ability to run an OpenEJB
+standalone server and deploy projects directly from within the IDE,
+using functionality provided by the Eclipse Web Tools Project (WTP).
+Additionally, the plugin also provides the capability to read a
+ejb-jar.xml (and optionally a openejb-jar.xml) file and automatically
+add the corresponding EJB 3 annotations to your code automatically.
+
+link:installation.html[Installation]
+link:building-from-source.html[Building from source]
+link:generating-ejb-3-annotations.html[Generating EJB 3 annotations]
+link:running-a-standalone-openejb-server.html[Running a standalone
+OpenEJB server]
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb-eclipse-plugin.md
----------------------------------------------------------------------
diff --git a/docs/openejb-eclipse-plugin.md b/docs/openejb-eclipse-plugin.md
deleted file mode 100644
index e68fb3a..0000000
--- a/docs/openejb-eclipse-plugin.md
+++ /dev/null
@@ -1,22 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=OpenEJB Eclipse Plugin
-~~~~~~
-<a name="OpenEJBEclipsePlugin-OpenEJBEclipsePlugin"></a>
-# OpenEJB Eclipse Plugin
-
-<a name="OpenEJBEclipsePlugin-Overview"></a>
-### Overview
-
-The OpenEJB plugin for Eclipse provides the ability to run an OpenEJB
-standalone server and deploy projects directly from within the IDE, using
-functionality provided by the Eclipse Web Tools Project (WTP).
-Additionally, the plugin also provides the capability to read a ejb-jar.xml
-(and optionally a openejb-jar.xml) file and automatically add the
-corresponding EJB 3 annotations to your code automatically.
-
-[Installation](installation.html)
-[Building from source](building-from-source.html)
-[Generating EJB 3 annotations](generating-ejb-3-annotations.html)
-[Running a standalone OpenEJB server](running-a-standalone-openejb-server.html)
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb-jsr-107-integration.adoc
----------------------------------------------------------------------
diff --git a/docs/openejb-jsr-107-integration.adoc b/docs/openejb-jsr-107-integration.adoc
new file mode 100644
index 0000000..e7b3172
--- /dev/null
+++ b/docs/openejb-jsr-107-integration.adoc
@@ -0,0 +1,24 @@
+# OpenEJB JSR-107 Integration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# OpenEJB JSR-107 (JCACHE) Integration
+
+This page is for the collaboration for those involved with the
+integration of JSR-107 into OpenEJB.
+
+=== Overview
+
+The idea here is to add a caching layer to OpenEJB. The overall
+objective is to improve performance in OpenEJB where applicable through
+caching EJBs.
+
+=== Status
+
+Dain and myself (Jeremy) have deciphered the JSR-107 spec and how I am
+working on the first crude integration of JCACHE into OpenEJB. Anyone
+interested in helping or providing any feedback/suggestions, please
+contact me via the developer mailing list.
[41/44] tomee git commit: This closes apache/tomee#251
Posted by jl...@apache.org.
This closes apache/tomee#251
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/74a26ae2
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/74a26ae2
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/74a26ae2
Branch: refs/heads/master
Commit: 74a26ae29d0e99180a3b7d0c30354866afe752e6
Parents: 4c7a363 05b3c83
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:52:01 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:52:01 2018 +0100
----------------------------------------------------------------------
docs/messagedrivencontainer-config.adoc | 85 +++
docs/messagedrivencontainer-config.md | 67 --
docs/multicast-discovery.adoc | 90 +++
docs/multicast-discovery.md | 83 ---
docs/multiple-business-interface-hazzards.adoc | 200 ++++++
docs/multiple-business-interface-hazzards.md | 202 ------
docs/multipoint-considerations.adoc | 31 +
docs/multipoint-considerations.md | 30 -
docs/multipoint-discovery.adoc | 84 +++
docs/multipoint-discovery.md | 75 --
docs/multipoint-recommendations.adoc | 152 ++++
docs/multipoint-recommendations.md | 141 ----
docs/multipulse-discovery.adoc | 108 +++
docs/multipulse-discovery.md | 94 ---
docs/new-in-openejb-3.0.adoc | 153 ++++
docs/new-in-openejb-3.0.md | 179 -----
docs/openejb-3.adoc | 69 ++
docs/openejb-3.md | 72 --
docs/openejb-binaries.adoc | 32 +
docs/openejb-binaries.md | 27 -
docs/openejb-eclipse-plugin.adoc | 22 +
docs/openejb-eclipse-plugin.md | 22 -
docs/openejb-jsr-107-integration.adoc | 24 +
docs/openejb-jsr-107-integration.md | 25 -
docs/openejb.xml.adoc | 96 +++
docs/openejb.xml.md | 96 ---
docs/openjpa.adoc | 125 ++++
docs/openjpa.md | 113 ---
docs/orb-config.adoc | 40 ++
docs/orb-config.md | 26 -
docs/persistence-context.adoc | 59 ++
docs/persistence-context.md | 57 --
docs/persistence-unit-ref.adoc | 91 +++
docs/persistence-unit-ref.md | 91 ---
docs/properties-listing.adoc | 729 ++++++++++++++++++++
docs/properties-listing.md | 94 ---
docs/properties-tool.adoc | 218 ++++++
docs/properties-tool.md | 216 ------
docs/property-overriding.adoc | 64 ++
docs/property-overriding.md | 65 --
docs/provisioning.adoc | 96 +++
docs/provisioning.md | 78 ---
docs/proxyfactory-config.adoc | 42 ++
docs/proxyfactory-config.md | 26 -
44 files changed, 2610 insertions(+), 1879 deletions(-)
----------------------------------------------------------------------
[15/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 7
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/debug-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/debug-mojo.md b/docs/maven/debug-mojo.md
deleted file mode 100644
index a12473f..0000000
--- a/docs/maven/debug-mojo.md
+++ /dev/null
@@ -1,1395 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:debug<a name="tomee:debug"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:debug</p>
-
-<p><b>Description</b>:</p>
-
-<div>As run but with debug activated.</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apacheRepos">apacheRepos</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>snapshots</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.apache-repos</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#appDir">appDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>apps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apps">apps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#args">args</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.args</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#bin">bin</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/bin</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.bin</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#catalinaBase">catalinaBase</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.catalina-base</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#checkStarted">checkStarted</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.check-started</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#classpaths">classpaths</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#config">config</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/conf</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.conf</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#context">context</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>rename the current artifact<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#debug">debug</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debug</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#debugPort">debugPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>5005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debugPort</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#deployOpenEjbApplication">deployOpenEjbApplication</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#docBases">docBases</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, which docBase to use for this war.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#ejbRemote">ejbRemote</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ejb-remote</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#externalRepositories">externalRepositories</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, add some external repositories to
-classloader.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#forceReloadable">forceReloadable</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>force webapp to be reloadable<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.force-reloadable</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#javaagents">javaagents</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#keepServerXmlAsthis">keepServerXmlAsthis</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.keep-server-xml</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#lib">lib</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/lib</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.lib</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#libDir">libDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>lib</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#libs">libs</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#mainDir">mainDir</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#quickSession">quickSession</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use a real random instead of secure random. saves few ms at
-startup.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.quick-session</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#reloadOnUpdate">reloadOnUpdate</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.reload-on-update</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#removeDefaultWebapps">removeDefaultWebapps</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-default-webapps</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#removeTomeeWebapp">removeTomeeWebapp</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-tomee-webapps</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#simpleLog">simpleLog</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.simple-log</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#skipCurrentProject">skipCurrentProject</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipCurrentProject</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#skipWarResources">skipWarResources</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipWarResources</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#synchronization">synchronization</a></b></td>
-
-<td><tt>Synchronization</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#synchronizations">synchronizations</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#systemVariables">systemVariables</a></b></td>
-
-<td><tt>Map</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#target">target</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeAjpPort">tomeeAjpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8009</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ajp</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeAlreadyInstalled">tomeeAlreadyInstalled</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exiting</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeArtifactId">tomeeArtifactId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.artifactId</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeClassifier">tomeeClassifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>webprofile</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeGroupId">tomeeGroupId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.groupId</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHttpsPort">tomeeHttpsPort</a></b></td>
-
-<td><tt>Integer</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.https</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeShutdownCommand">tomeeShutdownCommand</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>SHUTDOWN</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown-command</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeShutdownPort">tomeeShutdownPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeVersion">tomeeVersion</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>-1</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.version</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#useConsole">useConsole</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.use-console</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#useOpenEJB">useOpenEJB</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use openejb-standalone automatically instead of TomEE<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.openejb</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#warFile">warFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappClasses">webappClasses</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappClasses</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappDefaultConfig">webappDefaultConfig</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>forcing nice default for war development (WEB-INF/classes and web
-resources)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappDefaultConfig</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappDir">webappDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>webapps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappResources">webappResources</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/webapp</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappResources</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webapps">webapps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="apacheRepos">apacheRepos</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.apache-repos</tt></li>
-
-<li><b>Default</b>: <tt>snapshots</tt></li>
- </ul><hr />
-<p><b><a name="appDir">appDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>apps</tt></li>
- </ul><hr />
-<p><b><a name="apps">apps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="args">args</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.args</tt></li>
- </ul><hr />
-<p><b><a name="bin">bin</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.bin</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/bin</tt></li>
- </ul><hr />
-<p><b><a name="catalinaBase">catalinaBase</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.catalina-base</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="checkStarted">checkStarted</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.check-started</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="classpaths">classpaths</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="config">config</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.conf</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/conf</tt></li>
- </ul><hr />
-<p><b><a name="context">context</a>:</b></p>
-
-<div>rename the current artifact</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="debug">debug</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debug</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="debugPort">debugPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debugPort</tt></li>
-
-<li><b>Default</b>: <tt>5005</tt></li>
- </ul><hr />
-<p><b><a name="deployOpenEjbApplication">deployOpenEjbApplication</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="docBases">docBases</a>:</b></p>
-
-<div>for TomEE and wars only, which docBase to use for this war.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="ejbRemote">ejbRemote</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ejb-remote</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="externalRepositories">externalRepositories</a>:</b></p>
-
-<div>for TomEE and wars only, add some external repositories to
-classloader.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="forceReloadable">forceReloadable</a>:</b></p>
-
-<div>force webapp to be reloadable</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.force-reloadable</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="javaagents">javaagents</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="keepServerXmlAsthis">keepServerXmlAsthis</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.keep-server-xml</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="lib">lib</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.lib</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/lib</tt></li>
- </ul><hr />
-<p><b><a name="libDir">libDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>lib</tt></li>
- </ul><hr />
-<p><b><a name="libs">libs</a>:</b></p>
-
-<div>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="mainDir">mainDir</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main</tt></li>
- </ul><hr />
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="quickSession">quickSession</a>:</b></p>
-
-<div>use a real random instead of secure random. saves few ms at
-startup.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.quick-session</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="reloadOnUpdate">reloadOnUpdate</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.reload-on-update</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="removeDefaultWebapps">removeDefaultWebapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-default-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="removeTomeeWebapp">removeTomeeWebapp</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-tomee-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="simpleLog">simpleLog</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.simple-log</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipCurrentProject">skipCurrentProject</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipCurrentProject</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipWarResources">skipWarResources</a>:</b></p>
-
-<div>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipWarResources</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="synchronization">synchronization</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>org.apache.openejb.maven.plugin.Synchronization</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="synchronizations">synchronizations</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="systemVariables">systemVariables</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="target">target</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAjpPort">tomeeAjpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ajp</tt></li>
-
-<li><b>Default</b>: <tt>8009</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAlreadyInstalled">tomeeAlreadyInstalled</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.exiting</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="tomeeArtifactId">tomeeArtifactId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.artifactId</tt></li>
-
-<li><b>Default</b>: <tt>apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="tomeeClassifier">tomeeClassifier</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li>
-
-<li><b>Default</b>: <tt>webprofile</tt></li>
- </ul><hr />
-<p><b><a name="tomeeGroupId">tomeeGroupId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.groupId</tt></li>
-
-<li><b>Default</b>: <tt>org.apache.openejb</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpsPort">tomeeHttpsPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.Integer</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.https</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownCommand">tomeeShutdownCommand</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown-command</tt></li>
-
-<li><b>Default</b>: <tt>SHUTDOWN</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownPort">tomeeShutdownPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown</tt></li>
-
-<li><b>Default</b>: <tt>8005</tt></li>
- </ul><hr />
-<p><b><a name="tomeeVersion">tomeeVersion</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.version</tt></li>
-
-<li><b>Default</b>: <tt>-1</tt></li>
- </ul><hr />
-<p><b><a name="useConsole">useConsole</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.use-console</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="useOpenEJB">useOpenEJB</a>:</b></p>
-
-<div>use openejb-standalone automatically instead of TomEE</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.openejb</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul><hr />
-<p><b><a name="warFile">warFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt></li>
- </ul><hr />
-<p><b><a name="webappClasses">webappClasses</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappClasses</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li>
- </ul><hr />
-<p><b><a name="webappDefaultConfig">webappDefaultConfig</a>:</b></p>
-
-<div>forcing nice default for war development (WEB-INF/classes and web
-resources)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappDefaultConfig</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="webappDir">webappDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>webapps</tt></li>
- </ul><hr />
-<p><b><a name="webappResources">webappResources</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappResources</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li>
- </ul><hr />
-<p><b><a name="webapps">webapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/deploy-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/deploy-mojo.adoc b/docs/maven/deploy-mojo.adoc
new file mode 100644
index 0000000..a4834fa
--- /dev/null
+++ b/docs/maven/deploy-mojo.adoc
@@ -0,0 +1,196 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:deploy
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:deploy
+
+Description:
+
+Simply deploy an application in a running TomEE
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Required Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+path
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.archive.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+systemVariables
+
+Map
+
+-
+
+(no description)
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+useBinaries
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.binary.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+Parameter Details
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+path:
+
+(no description)
+
+Type: java.lang.String
+
+Required: Yes
+
+User Property: tomee-plugin.archive
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+systemVariables:
+
+(no description)
+
+Type: java.util.Map
+
+Required: No
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+useBinaries:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.binary
+
+Default: false
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/deploy-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/deploy-mojo.md b/docs/maven/deploy-mojo.md
deleted file mode 100644
index b1dc402..0000000
--- a/docs/maven/deploy-mojo.md
+++ /dev/null
@@ -1,255 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:deploy<a name="tomee:deploy"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:deploy</p>
-
-<p><b>Description</b>:</p>
-
-<div>Simply deploy an application in a running TomEE</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Required Parameters<a name="Required_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#path">path</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.archive</tt>.</td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#systemVariables">systemVariables</a></b></td>
-
-<td><tt>Map</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#useBinaries">useBinaries</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.binary</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="path">path</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>Yes</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.archive</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="systemVariables">systemVariables</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="useBinaries">useBinaries</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.binary</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/exec-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/exec-mojo.adoc b/docs/maven/exec-mojo.adoc
new file mode 100644
index 0000000..d9b76c0
--- /dev/null
+++ b/docs/maven/exec-mojo.adoc
@@ -0,0 +1,1277 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:exec
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:exec
+
+Description:
+
+(no description)
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime+system.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+apacheRepos
+
+String
+
+-
+
+(no description)Default value is: snapshots.User property is:
+tomee-plugin.apache-repos.
+
+appDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: apps.
+
+apps
+
+List
+
+-
+
+(no description)
+
+args
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.args.
+
+attach
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.attach.
+
+bin
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/bin.User property is:
+tomee-plugin.bin.
+
+catalinaBase
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.build.directory}/apache-tomee.User property is:
+tomee-plugin.catalina-base.
+
+checkStarted
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.check-started.
+
+classifier
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.classifier.
+
+classpaths
+
+List
+
+-
+
+(no description)
+
+config
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/conf.User property is:
+tomee-plugin.conf.
+
+context
+
+String
+
+-
+
+rename the current artifact
+
+debug
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.debug.
+
+debugPort
+
+int
+
+-
+
+(no description)Default value is: 5005.User property is:
+tomee-plugin.debugPort.
+
+deployOpenEjbApplication
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.deploy-openejb-internal-application.
+
+distributionName
+
+String
+
+-
+
+(no description)Default value is: tomee.zip.User property is:
+tomee-plugin.distribution-name.
+
+docBases
+
+List
+
+-
+
+for TomEE and wars only, which docBase to use for this war.
+
+ejbRemote
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.ejb-remote.
+
+execFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}-exec.jar.User
+property is: tomee-plugin.exec-file.
+
+externalRepositories
+
+List
+
+-
+
+for TomEE and wars only, add some external repositories to classloader.
+
+forceReloadable
+
+boolean
+
+-
+
+force webapp to be reloadableDefault value is: false.User property is:
+tomee-plugin.force-reloadable.
+
+javaagents
+
+List
+
+-
+
+(no description)
+
+keepServerXmlAsthis
+
+boolean
+
+-
+
+(Removed since 7.0.0)Default value is: false.User property is:
+tomee-plugin.keep-server-xml.
+
+lib
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/lib.User property is:
+tomee-plugin.lib.
+
+libDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: lib.
+
+libs
+
+List
+
+-
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+mainDir
+
+File
+
+-
+
+(no description)Default value is: $\{project.basedir}/src/main.
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+quickSession
+
+boolean
+
+-
+
+use a real random instead of secure random. saves few ms at
+startup.Default value is: true.User property is:
+tomee-plugin.quick-session.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+removeDefaultWebapps
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-default-webapps.
+
+removeTomeeWebapp
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-tomee-webapps.
+
+runnerClass
+
+String
+
+-
+
+(no description)Default value is:
+org.apache.openejb.maven.plugin.runner.ExecRunner.User property is:
+tomee-plugin.runner-class.
+
+runtimeWorkingDir
+
+String
+
+-
+
+(no description)Default value is: .distribution.User property is:
+tomee-plugin.runtime-working-dir.
+
+script
+
+String
+
+-
+
+(no description)Default value is: bin/catalina[.sh|.bat].User property
+is: tomee-plugin.script.
+
+simpleLog
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.simple-log.
+
+skipCurrentProject
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.skipCurrentProject.
+
+skipWarResources
+
+boolean
+
+-
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.Default value is: false.User property is:
+tomee-plugin.skipWarResources.
+
+systemVariables
+
+Map
+
+-
+
+(no description)
+
+target
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.directory}.
+
+tomeeAjpPort
+
+int
+
+-
+
+(no description)Default value is: 8009.User property is:
+tomee-plugin.ajp.
+
+tomeeAlreadyInstalled
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.exiting.
+
+tomeeArtifactId
+
+String
+
+-
+
+(no description)Default value is: apache-tomee.User property is:
+tomee-plugin.artifactId.
+
+tomeeClassifier
+
+String
+
+-
+
+(no description)Default value is: webprofile.User property is:
+tomee-plugin.classifier.
+
+tomeeGroupId
+
+String
+
+-
+
+(no description)Default value is: org.apache.openejb.User property is:
+tomee-plugin.groupId.
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+tomeeHttpsPort
+
+Integer
+
+-
+
+(no description)User property is: tomee-plugin.https.
+
+tomeeShutdownCommand
+
+String
+
+-
+
+(no description)Default value is: SHUTDOWN.User property is:
+tomee-plugin.shutdown-command.
+
+tomeeShutdownPort
+
+int
+
+-
+
+(no description)Default value is: 8005.User property is:
+tomee-plugin.shutdown.
+
+tomeeVersion
+
+String
+
+-
+
+(no description)Default value is: -1.User property is:
+tomee-plugin.version.
+
+useConsole
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.use-console.
+
+useOpenEJB
+
+boolean
+
+-
+
+use openejb-standalone automatically instead of TomEEDefault value is:
+false.User property is: tomee-plugin.openejb.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+warFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}.
+
+webappClasses
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.outputDirectory}.User
+property is: tomee-plugin.webappClasses.
+
+webappDefaultConfig
+
+boolean
+
+-
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)Default value is: false.User property is:
+tomee-plugin.webappDefaultConfig.
+
+webappDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: webapps.
+
+webappResources
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/webapp.User property is:
+tomee-plugin.webappResources.
+
+webapps
+
+List
+
+-
+
+(no description)
+
+zip
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.zip.
+
+zipFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.zip.User
+property is: tomee-plugin.zip-file.
+
+Parameter Details
+
+apacheRepos:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.apache-repos
+
+Default: snapshots
+
+appDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: apps
+
+apps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+args:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.args
+
+attach:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.attach
+
+Default: true
+
+bin:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.bin
+
+Default: $\{project.basedir}/src/main/tomee/bin
+
+catalinaBase:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.catalina-base
+
+Default: $\{project.build.directory}/apache-tomee
+
+checkStarted:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.check-started
+
+Default: false
+
+classifier:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.classifier
+
+classpaths:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+config:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.conf
+
+Default: $\{project.basedir}/src/main/tomee/conf
+
+context:
+
+rename the current artifact
+
+Type: java.lang.String
+
+Required: No
+
+debug:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.debug
+
+Default: false
+
+debugPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.debugPort
+
+Default: 5005
+
+deployOpenEjbApplication:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.deploy-openejb-internal-application
+
+Default: false
+
+distributionName:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.distribution-name
+
+Default: tomee.zip
+
+docBases:
+
+for TomEE and wars only, which docBase to use for this war.
+
+Type: java.util.List
+
+Required: No
+
+ejbRemote:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.ejb-remote
+
+Default: true
+
+execFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.exec-file
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}-exec.jar
+
+externalRepositories:
+
+for TomEE and wars only, add some external repositories to classloader.
+
+Type: java.util.List
+
+Required: No
+
+forceReloadable:
+
+force webapp to be reloadable
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.force-reloadable
+
+Default: false
+
+javaagents:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+keepServerXmlAsthis:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.keep-server-xml
+
+Default: false
+
+lib:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.lib
+
+Default: $\{project.basedir}/src/main/tomee/lib
+
+libDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: lib
+
+libs:
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+Type: java.util.List
+
+Required: No
+
+mainDir:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.basedir}/src/main
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+quickSession:
+
+use a real random instead of secure random. saves few ms at startup.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.quick-session
+
+Default: true
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+removeDefaultWebapps:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-default-webapps
+
+Default: true
+
+removeTomeeWebapp:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-tomee-webapps
+
+Default: true
+
+runnerClass:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.runner-class
+
+Default: org.apache.openejb.maven.plugin.runner.ExecRunner
+
+runtimeWorkingDir:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.runtime-working-dir
+
+Default: .distribution
+
+script:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.script
+
+Default: bin/catalina[.sh|.bat]
+
+simpleLog:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.simple-log
+
+Default: false
+
+skipCurrentProject:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipCurrentProject
+
+Default: false
+
+skipWarResources:
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipWarResources
+
+Default: false
+
+systemVariables:
+
+(no description)
+
+Type: java.util.Map
+
+Required: No
+
+target:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.build.directory}
+
+tomeeAjpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.ajp
+
+Default: 8009
+
+tomeeAlreadyInstalled:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.exiting
+
+Default: false
+
+tomeeArtifactId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.artifactId
+
+Default: apache-tomee
+
+tomeeClassifier:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.classifier
+
+Default: webprofile
+
+tomeeGroupId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.groupId
+
+Default: org.apache.openejb
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+tomeeHttpsPort:
+
+(no description)
+
+Type: java.lang.Integer
+
+Required: No
+
+User Property: tomee-plugin.https
+
+tomeeShutdownCommand:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.shutdown-command
+
+Default: SHUTDOWN
+
+tomeeShutdownPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.shutdown
+
+Default: 8005
+
+tomeeVersion:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.version
+
+Default: -1
+
+useConsole:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.use-console
+
+Default: true
+
+useOpenEJB:
+
+use openejb-standalone automatically instead of TomEE
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.openejb
+
+Default: false
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
+
+warFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}
+
+webappClasses:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappClasses
+
+Default: $\{project.build.outputDirectory}
+
+webappDefaultConfig:
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.webappDefaultConfig
+
+Default: false
+
+webappDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: webapps
+
+webappResources:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappResources
+
+Default: $\{project.basedir}/src/main/webapp
+
+webapps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+zip:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.zip
+
+Default: true
+
+zipFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.zip-file
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.zip
[28/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 4
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 4
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/4ac0e338
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/4ac0e338
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/4ac0e338
Branch: refs/heads/master
Commit: 4ac0e338dfd14755f12feb4adbdef121a20eb1c4
Parents: b45a3d0
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 23:06:53 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 23:06:53 2018 -0800
----------------------------------------------------------------------
docs/deploy-tool.adoc | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/4ac0e338/docs/deploy-tool.adoc
----------------------------------------------------------------------
diff --git a/docs/deploy-tool.adoc b/docs/deploy-tool.adoc
index f269dfe..49eba0f 100644
--- a/docs/deploy-tool.adoc
+++ b/docs/deploy-tool.adoc
@@ -1,9 +1,8 @@
-:index-group: OpenEJB
-Standalone Server
+# Deploy Tool
+:index-group: OpenEJB Standalone Server
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: Deploy Tool
# NAME
[16/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 7
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/configtest-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/configtest-mojo.md b/docs/maven/configtest-mojo.md
deleted file mode 100644
index d4586c0..0000000
--- a/docs/maven/configtest-mojo.md
+++ /dev/null
@@ -1,1328 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:configtest<a name="tomee:configtest"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:configtest</p>
-
-<p><b>Description</b>:</p>
-
-<div>Run configtest Tomcat command.</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apacheRepos">apacheRepos</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>snapshots</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.apache-repos</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#appDir">appDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>apps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apps">apps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#args">args</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.args</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#bin">bin</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/bin</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.bin</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#catalinaBase">catalinaBase</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.catalina-base</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#checkStarted">checkStarted</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.check-started</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#classpaths">classpaths</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#config">config</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/conf</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.conf</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#context">context</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>rename the current artifact<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#debug">debug</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debug</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#debugPort">debugPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>5005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debugPort</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#deployOpenEjbApplication">deployOpenEjbApplication</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#docBases">docBases</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, which docBase to use for this war.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#ejbRemote">ejbRemote</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ejb-remote</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#externalRepositories">externalRepositories</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, add some external repositories to
-classloader.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#forceReloadable">forceReloadable</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>force webapp to be reloadable<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.force-reloadable</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#javaagents">javaagents</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#keepServerXmlAsthis">keepServerXmlAsthis</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(Removed since 7.0.0)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.keep-server-xml</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#lib">lib</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/lib</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.lib</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#libDir">libDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>lib</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#libs">libs</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#mainDir">mainDir</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#quickSession">quickSession</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use a real random instead of secure random. saves few ms at
-startup.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.quick-session</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#removeDefaultWebapps">removeDefaultWebapps</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-default-webapps</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#removeTomeeWebapp">removeTomeeWebapp</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-tomee-webapps</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#simpleLog">simpleLog</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.simple-log</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#skipCurrentProject">skipCurrentProject</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipCurrentProject</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#skipWarResources">skipWarResources</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipWarResources</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#systemVariables">systemVariables</a></b></td>
-
-<td><tt>Map</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#target">target</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeAjpPort">tomeeAjpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8009</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ajp</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeAlreadyInstalled">tomeeAlreadyInstalled</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exiting</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeArtifactId">tomeeArtifactId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.artifactId</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeClassifier">tomeeClassifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>webprofile</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeGroupId">tomeeGroupId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.groupId</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHttpsPort">tomeeHttpsPort</a></b></td>
-
-<td><tt>Integer</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.https</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeShutdownCommand">tomeeShutdownCommand</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>SHUTDOWN</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown-command</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeShutdownPort">tomeeShutdownPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeVersion">tomeeVersion</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>-1</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.version</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#useConsole">useConsole</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.use-console</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#useOpenEJB">useOpenEJB</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use openejb-standalone automatically instead of TomEE<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.openejb</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#warFile">warFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappClasses">webappClasses</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappClasses</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappDefaultConfig">webappDefaultConfig</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>forcing nice default for war development (WEB-INF/classes and web
-resources)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappDefaultConfig</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappDir">webappDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>webapps</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappResources">webappResources</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/webapp</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappResources</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webapps">webapps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="apacheRepos">apacheRepos</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.apache-repos</tt></li>
-
-<li><b>Default</b>: <tt>snapshots</tt></li>
- </ul><hr />
-<p><b><a name="appDir">appDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>apps</tt></li>
- </ul><hr />
-<p><b><a name="apps">apps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="args">args</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.args</tt></li>
- </ul><hr />
-<p><b><a name="bin">bin</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.bin</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/bin</tt></li>
- </ul><hr />
-<p><b><a name="catalinaBase">catalinaBase</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.catalina-base</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="checkStarted">checkStarted</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.check-started</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="classpaths">classpaths</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="config">config</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.conf</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/conf</tt></li>
- </ul><hr />
-<p><b><a name="context">context</a>:</b></p>
-
-<div>rename the current artifact</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="debug">debug</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debug</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="debugPort">debugPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debugPort</tt></li>
-
-<li><b>Default</b>: <tt>5005</tt></li>
- </ul><hr />
-<p><b><a name="deployOpenEjbApplication">deployOpenEjbApplication</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="docBases">docBases</a>:</b></p>
-
-<div>for TomEE and wars only, which docBase to use for this war.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="ejbRemote">ejbRemote</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ejb-remote</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="externalRepositories">externalRepositories</a>:</b></p>
-
-<div>for TomEE and wars only, add some external repositories to
-classloader.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="forceReloadable">forceReloadable</a>:</b></p>
-
-<div>force webapp to be reloadable</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.force-reloadable</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="javaagents">javaagents</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="keepServerXmlAsthis">keepServerXmlAsthis</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.keep-server-xml</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="lib">lib</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.lib</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/lib</tt></li>
- </ul><hr />
-<p><b><a name="libDir">libDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>lib</tt></li>
- </ul><hr />
-<p><b><a name="libs">libs</a>:</b></p>
-
-<div>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="mainDir">mainDir</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main</tt></li>
- </ul><hr />
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="quickSession">quickSession</a>:</b></p>
-
-<div>use a real random instead of secure random. saves few ms at
-startup.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.quick-session</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="removeDefaultWebapps">removeDefaultWebapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-default-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="removeTomeeWebapp">removeTomeeWebapp</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-tomee-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="simpleLog">simpleLog</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.simple-log</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipCurrentProject">skipCurrentProject</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipCurrentProject</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipWarResources">skipWarResources</a>:</b></p>
-
-<div>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipWarResources</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="systemVariables">systemVariables</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="target">target</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAjpPort">tomeeAjpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ajp</tt></li>
-
-<li><b>Default</b>: <tt>8009</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAlreadyInstalled">tomeeAlreadyInstalled</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.exiting</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="tomeeArtifactId">tomeeArtifactId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.artifactId</tt></li>
-
-<li><b>Default</b>: <tt>apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="tomeeClassifier">tomeeClassifier</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li>
-
-<li><b>Default</b>: <tt>webprofile</tt></li>
- </ul><hr />
-<p><b><a name="tomeeGroupId">tomeeGroupId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.groupId</tt></li>
-
-<li><b>Default</b>: <tt>org.apache.openejb</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpsPort">tomeeHttpsPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.Integer</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.https</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownCommand">tomeeShutdownCommand</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown-command</tt></li>
-
-<li><b>Default</b>: <tt>SHUTDOWN</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownPort">tomeeShutdownPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown</tt></li>
-
-<li><b>Default</b>: <tt>8005</tt></li>
- </ul><hr />
-<p><b><a name="tomeeVersion">tomeeVersion</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.version</tt></li>
-
-<li><b>Default</b>: <tt>-1</tt></li>
- </ul><hr />
-<p><b><a name="useConsole">useConsole</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.use-console</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="useOpenEJB">useOpenEJB</a>:</b></p>
-
-<div>use openejb-standalone automatically instead of TomEE</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.openejb</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul><hr />
-<p><b><a name="warFile">warFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt></li>
- </ul><hr />
-<p><b><a name="webappClasses">webappClasses</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappClasses</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li>
- </ul><hr />
-<p><b><a name="webappDefaultConfig">webappDefaultConfig</a>:</b></p>
-
-<div>forcing nice default for war development (WEB-INF/classes and web
-resources)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappDefaultConfig</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="webappDir">webappDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>webapps</tt></li>
- </ul><hr />
-<p><b><a name="webappResources">webappResources</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappResources</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li>
- </ul><hr />
-<p><b><a name="webapps">webapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/debug-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/debug-mojo.adoc b/docs/maven/debug-mojo.adoc
new file mode 100644
index 0000000..73fcf0a
--- /dev/null
+++ b/docs/maven/debug-mojo.adoc
@@ -0,0 +1,1139 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:debug
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:debug
+
+Description:
+
+As run but with debug activated.
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime+system.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+apacheRepos
+
+String
+
+-
+
+(no description)Default value is: snapshots.User property is:
+tomee-plugin.apache-repos.
+
+appDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: apps.
+
+apps
+
+List
+
+-
+
+(no description)
+
+args
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.args.
+
+bin
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/bin.User property is:
+tomee-plugin.bin.
+
+catalinaBase
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.build.directory}/apache-tomee.User property is:
+tomee-plugin.catalina-base.
+
+checkStarted
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.check-started.
+
+classpaths
+
+List
+
+-
+
+(no description)
+
+config
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/conf.User property is:
+tomee-plugin.conf.
+
+context
+
+String
+
+-
+
+rename the current artifact
+
+debug
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.debug.
+
+debugPort
+
+int
+
+-
+
+(no description)Default value is: 5005.User property is:
+tomee-plugin.debugPort.
+
+deployOpenEjbApplication
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.deploy-openejb-internal-application.
+
+docBases
+
+List
+
+-
+
+for TomEE and wars only, which docBase to use for this war.
+
+ejbRemote
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.ejb-remote.
+
+externalRepositories
+
+List
+
+-
+
+for TomEE and wars only, add some external repositories to classloader.
+
+forceReloadable
+
+boolean
+
+-
+
+force webapp to be reloadableDefault value is: false.User property is:
+tomee-plugin.force-reloadable.
+
+javaagents
+
+List
+
+-
+
+(no description)
+
+keepServerXmlAsthis
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.keep-server-xml.
+
+lib
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/lib.User property is:
+tomee-plugin.lib.
+
+libDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: lib.
+
+libs
+
+List
+
+-
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+mainDir
+
+File
+
+-
+
+(no description)Default value is: $\{project.basedir}/src/main.
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+quickSession
+
+boolean
+
+-
+
+use a real random instead of secure random. saves few ms at
+startup.Default value is: true.User property is:
+tomee-plugin.quick-session.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+reloadOnUpdate
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.reload-on-update.
+
+removeDefaultWebapps
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-default-webapps.
+
+removeTomeeWebapp
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-tomee-webapps.
+
+simpleLog
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.simple-log.
+
+skipCurrentProject
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.skipCurrentProject.
+
+skipWarResources
+
+boolean
+
+-
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.Default value is: false.User property is:
+tomee-plugin.skipWarResources.
+
+synchronization
+
+Synchronization
+
+-
+
+(no description)
+
+synchronizations
+
+List
+
+-
+
+(no description)
+
+systemVariables
+
+Map
+
+-
+
+(no description)
+
+target
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.directory}.
+
+tomeeAjpPort
+
+int
+
+-
+
+(no description)Default value is: 8009.User property is:
+tomee-plugin.ajp.
+
+tomeeAlreadyInstalled
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.exiting.
+
+tomeeArtifactId
+
+String
+
+-
+
+(no description)Default value is: apache-tomee.User property is:
+tomee-plugin.artifactId.
+
+tomeeClassifier
+
+String
+
+-
+
+(no description)Default value is: webprofile.User property is:
+tomee-plugin.classifier.
+
+tomeeGroupId
+
+String
+
+-
+
+(no description)Default value is: org.apache.openejb.User property is:
+tomee-plugin.groupId.
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+tomeeHttpsPort
+
+Integer
+
+-
+
+(no description)User property is: tomee-plugin.https.
+
+tomeeShutdownCommand
+
+String
+
+-
+
+(no description)Default value is: SHUTDOWN.User property is:
+tomee-plugin.shutdown-command.
+
+tomeeShutdownPort
+
+int
+
+-
+
+(no description)Default value is: 8005.User property is:
+tomee-plugin.shutdown.
+
+tomeeVersion
+
+String
+
+-
+
+(no description)Default value is: -1.User property is:
+tomee-plugin.version.
+
+useConsole
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.use-console.
+
+useOpenEJB
+
+boolean
+
+-
+
+use openejb-standalone automatically instead of TomEEDefault value is:
+false.User property is: tomee-plugin.openejb.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+warFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}.
+
+webappClasses
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.outputDirectory}.User
+property is: tomee-plugin.webappClasses.
+
+webappDefaultConfig
+
+boolean
+
+-
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)Default value is: false.User property is:
+tomee-plugin.webappDefaultConfig.
+
+webappDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: webapps.
+
+webappResources
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/webapp.User property is:
+tomee-plugin.webappResources.
+
+webapps
+
+List
+
+-
+
+(no description)
+
+Parameter Details
+
+apacheRepos:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.apache-repos
+
+Default: snapshots
+
+appDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: apps
+
+apps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+args:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.args
+
+bin:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.bin
+
+Default: $\{project.basedir}/src/main/tomee/bin
+
+catalinaBase:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.catalina-base
+
+Default: $\{project.build.directory}/apache-tomee
+
+checkStarted:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.check-started
+
+Default: false
+
+classpaths:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+config:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.conf
+
+Default: $\{project.basedir}/src/main/tomee/conf
+
+context:
+
+rename the current artifact
+
+Type: java.lang.String
+
+Required: No
+
+debug:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.debug
+
+Default: false
+
+debugPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.debugPort
+
+Default: 5005
+
+deployOpenEjbApplication:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.deploy-openejb-internal-application
+
+Default: false
+
+docBases:
+
+for TomEE and wars only, which docBase to use for this war.
+
+Type: java.util.List
+
+Required: No
+
+ejbRemote:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.ejb-remote
+
+Default: true
+
+externalRepositories:
+
+for TomEE and wars only, add some external repositories to classloader.
+
+Type: java.util.List
+
+Required: No
+
+forceReloadable:
+
+force webapp to be reloadable
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.force-reloadable
+
+Default: false
+
+javaagents:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+keepServerXmlAsthis:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.keep-server-xml
+
+Default: false
+
+lib:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.lib
+
+Default: $\{project.basedir}/src/main/tomee/lib
+
+libDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: lib
+
+libs:
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+Type: java.util.List
+
+Required: No
+
+mainDir:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.basedir}/src/main
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+quickSession:
+
+use a real random instead of secure random. saves few ms at startup.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.quick-session
+
+Default: true
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+reloadOnUpdate:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.reload-on-update
+
+Default: false
+
+removeDefaultWebapps:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-default-webapps
+
+Default: true
+
+removeTomeeWebapp:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-tomee-webapps
+
+Default: true
+
+simpleLog:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.simple-log
+
+Default: false
+
+skipCurrentProject:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipCurrentProject
+
+Default: false
+
+skipWarResources:
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipWarResources
+
+Default: false
+
+synchronization:
+
+(no description)
+
+Type: org.apache.openejb.maven.plugin.Synchronization
+
+Required: No
+
+synchronizations:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+systemVariables:
+
+(no description)
+
+Type: java.util.Map
+
+Required: No
+
+target:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.build.directory}
+
+tomeeAjpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.ajp
+
+Default: 8009
+
+tomeeAlreadyInstalled:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.exiting
+
+Default: false
+
+tomeeArtifactId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.artifactId
+
+Default: apache-tomee
+
+tomeeClassifier:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.classifier
+
+Default: webprofile
+
+tomeeGroupId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.groupId
+
+Default: org.apache.openejb
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+tomeeHttpsPort:
+
+(no description)
+
+Type: java.lang.Integer
+
+Required: No
+
+User Property: tomee-plugin.https
+
+tomeeShutdownCommand:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.shutdown-command
+
+Default: SHUTDOWN
+
+tomeeShutdownPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.shutdown
+
+Default: 8005
+
+tomeeVersion:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.version
+
+Default: -1
+
+useConsole:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.use-console
+
+Default: true
+
+useOpenEJB:
+
+use openejb-standalone automatically instead of TomEE
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.openejb
+
+Default: false
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
+
+warFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}
+
+webappClasses:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappClasses
+
+Default: $\{project.build.outputDirectory}
+
+webappDefaultConfig:
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.webappDefaultConfig
+
+Default: false
+
+webappDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: webapps
+
+webappResources:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappResources
+
+Default: $\{project.basedir}/src/main/webapp
+
+webapps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
[27/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 1
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 1
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/bf438173
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/bf438173
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/bf438173
Branch: refs/heads/master
Commit: bf438173f6dcf9edc7e325777ae792e75df40e78
Parents: 3e87b47
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 23:06:50 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 23:06:50 2018 -0800
----------------------------------------------------------------------
docs/admin/cluster/index.adoc | 2 +-
docs/advanced/client/jndi.adoc | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/bf438173/docs/admin/cluster/index.adoc
----------------------------------------------------------------------
diff --git a/docs/admin/cluster/index.adoc b/docs/admin/cluster/index.adoc
index a7cc4a7..7cf31aa 100644
--- a/docs/admin/cluster/index.adoc
+++ b/docs/admin/cluster/index.adoc
@@ -1,7 +1,7 @@
+# Clustering and High Availability (HA)
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: Clustering and High Availability (HA)
=== Session clustering
http://git-wip-us.apache.org/repos/asf/tomee/blob/bf438173/docs/advanced/client/jndi.adoc
----------------------------------------------------------------------
diff --git a/docs/advanced/client/jndi.adoc b/docs/advanced/client/jndi.adoc
index 3097e69..0d1b975 100644
--- a/docs/advanced/client/jndi.adoc
+++ b/docs/advanced/client/jndi.adoc
@@ -1,4 +1,4 @@
-:jbake-title: Java Naming and Directory Interface (JNDI)
+# Java Naming and Directory Interface (JNDI)
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
[40/44] tomee git commit: This closes apache/tomee#250
Posted by jl...@apache.org.
This closes apache/tomee#250
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/4c7a363f
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/4c7a363f
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/4c7a363f
Branch: refs/heads/master
Commit: 4c7a363f5c0c9d7717956b72ea68a7051ca1a674
Parents: 2f8b7a6 52a090b
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:51:55 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:51:55 2018 +0100
----------------------------------------------------------------------
docs/local-client-injection.adoc | 86 ++
docs/local-client-injection.md | 87 --
docs/local-server.adoc | 56 +
docs/local-server.md | 61 --
docs/lookup-of-other-ejbs-example.adoc | 146 +++
docs/lookup-of-other-ejbs-example.md | 149 ---
docs/managedcontainer-config.adoc | 42 +
docs/managedcontainer-config.md | 26 -
docs/manual-installation.adoc | 145 +++
docs/manual-installation.md | 224 ----
docs/maven.adoc | 61 ++
docs/maven.md | 42 -
docs/maven/build-mojo.adoc | 1169 ++++++++++++++++++++
docs/maven/build-mojo.md | 1426 ------------------------
docs/maven/configtest-mojo.adoc | 1086 +++++++++++++++++++
docs/maven/configtest-mojo.md | 1328 -----------------------
docs/maven/debug-mojo.adoc | 1139 ++++++++++++++++++++
docs/maven/debug-mojo.md | 1395 ------------------------
docs/maven/deploy-mojo.adoc | 196 ++++
docs/maven/deploy-mojo.md | 255 -----
docs/maven/exec-mojo.adoc | 1277 ++++++++++++++++++++++
docs/maven/exec-mojo.md | 1551 ---------------------------
docs/maven/help-mojo.adoc | 115 ++
docs/maven/help-mojo.md | 149 ---
docs/maven/index.adoc | 175 +++
docs/maven/index.md | 148 ---
docs/maven/list-mojo.adoc | 132 +++
docs/maven/list-mojo.md | 169 ---
docs/maven/run-mojo.adoc | 1139 ++++++++++++++++++++
docs/maven/run-mojo.md | 1395 ------------------------
docs/maven/start-mojo.adoc | 1139 ++++++++++++++++++++
docs/maven/start-mojo.md | 1395 ------------------------
docs/maven/stop-mojo.adoc | 1086 +++++++++++++++++++
docs/maven/stop-mojo.md | 1328 -----------------------
docs/maven/undeploy-mojo.adoc | 159 +++
docs/maven/undeploy-mojo.md | 209 ----
36 files changed, 9348 insertions(+), 11337 deletions(-)
----------------------------------------------------------------------
[17/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 7
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/build-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/build-mojo.md b/docs/maven/build-mojo.md
deleted file mode 100644
index 7b7e1e5..0000000
--- a/docs/maven/build-mojo.md
+++ /dev/null
@@ -1,1426 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:build<a name="tomee:build"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:build</p>
-
-<p><b>Description</b>:</p>
-
-<div>Create but not run a TomEE.</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apacheRepos">apacheRepos</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>snapshots</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.apache-repos</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#appDir">appDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>apps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apps">apps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#args">args</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.args</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#attach">attach</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.attach</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#bin">bin</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/bin</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.bin</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#catalinaBase">catalinaBase</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.catalina-base</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#checkStarted">checkStarted</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.check-started</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#classifier">classifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#classpaths">classpaths</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#config">config</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/conf</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.conf</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#context">context</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>rename the current artifact<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#debug">debug</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debug</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#debugPort">debugPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>5005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debugPort</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#deployOpenEjbApplication">deployOpenEjbApplication</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#docBases">docBases</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, which docBase to use for this war.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#ejbRemote">ejbRemote</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ejb-remote</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#externalRepositories">externalRepositories</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, add some external repositories to
-classloader.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#forceReloadable">forceReloadable</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>force webapp to be reloadable<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.force-reloadable</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#javaagents">javaagents</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#keepServerXmlAsthis">keepServerXmlAsthis</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(Removed since 7.0.0)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.keep-server-xml</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#lib">lib</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/lib</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.lib</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#libDir">libDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>lib</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#libs">libs</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#mainDir">mainDir</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#quickSession">quickSession</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use a real random instead of secure random. saves few ms at
-startup.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.quick-session</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#removeDefaultWebapps">removeDefaultWebapps</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-default-webapps</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#removeTomeeWebapp">removeTomeeWebapp</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-tomee-webapps</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#simpleLog">simpleLog</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.simple-log</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#skipCurrentProject">skipCurrentProject</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipCurrentProject</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#skipWarResources">skipWarResources</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipWarResources</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#systemVariables">systemVariables</a></b></td>
-
-<td><tt>Map</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#target">target</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeAjpPort">tomeeAjpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8009</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ajp</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeAlreadyInstalled">tomeeAlreadyInstalled</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exiting</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeArtifactId">tomeeArtifactId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.artifactId</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeClassifier">tomeeClassifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>webprofile</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeGroupId">tomeeGroupId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.groupId</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHttpsPort">tomeeHttpsPort</a></b></td>
-
-<td><tt>Integer</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.https</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeShutdownCommand">tomeeShutdownCommand</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>SHUTDOWN</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown-command</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeShutdownPort">tomeeShutdownPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeVersion">tomeeVersion</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>-1</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.version</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#useConsole">useConsole</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.use-console</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#useOpenEJB">useOpenEJB</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use openejb-standalone automatically instead of TomEE<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.openejb</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#warFile">warFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappClasses">webappClasses</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappClasses</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappDefaultConfig">webappDefaultConfig</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>forcing nice default for war development (WEB-INF/classes and web
-resources)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappDefaultConfig</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappDir">webappDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>webapps</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappResources">webappResources</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/webapp</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappResources</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webapps">webapps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#zip">zip</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.zip</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#zipFile">zipFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.zip</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.zip-file</tt>.</td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="apacheRepos">apacheRepos</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.apache-repos</tt></li>
-
-<li><b>Default</b>: <tt>snapshots</tt></li>
- </ul><hr />
-<p><b><a name="appDir">appDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>apps</tt></li>
- </ul><hr />
-<p><b><a name="apps">apps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="args">args</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.args</tt></li>
- </ul><hr />
-<p><b><a name="attach">attach</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.attach</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="bin">bin</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.bin</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/bin</tt></li>
- </ul><hr />
-<p><b><a name="catalinaBase">catalinaBase</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.catalina-base</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="checkStarted">checkStarted</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.check-started</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="classifier">classifier</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li>
- </ul><hr />
-<p><b><a name="classpaths">classpaths</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="config">config</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.conf</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/conf</tt></li>
- </ul><hr />
-<p><b><a name="context">context</a>:</b></p>
-
-<div>rename the current artifact</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="debug">debug</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debug</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="debugPort">debugPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debugPort</tt></li>
-
-<li><b>Default</b>: <tt>5005</tt></li>
- </ul><hr />
-<p><b><a name="deployOpenEjbApplication">deployOpenEjbApplication</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="docBases">docBases</a>:</b></p>
-
-<div>for TomEE and wars only, which docBase to use for this war.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="ejbRemote">ejbRemote</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ejb-remote</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="externalRepositories">externalRepositories</a>:</b></p>
-
-<div>for TomEE and wars only, add some external repositories to
-classloader.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="forceReloadable">forceReloadable</a>:</b></p>
-
-<div>force webapp to be reloadable</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.force-reloadable</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="javaagents">javaagents</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="keepServerXmlAsthis">keepServerXmlAsthis</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.keep-server-xml</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="lib">lib</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.lib</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/lib</tt></li>
- </ul><hr />
-<p><b><a name="libDir">libDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>lib</tt></li>
- </ul><hr />
-<p><b><a name="libs">libs</a>:</b></p>
-
-<div>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="mainDir">mainDir</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main</tt></li>
- </ul><hr />
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="quickSession">quickSession</a>:</b></p>
-
-<div>use a real random instead of secure random. saves few ms at
-startup.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.quick-session</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="removeDefaultWebapps">removeDefaultWebapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-default-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="removeTomeeWebapp">removeTomeeWebapp</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-tomee-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="simpleLog">simpleLog</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.simple-log</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipCurrentProject">skipCurrentProject</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipCurrentProject</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipWarResources">skipWarResources</a>:</b></p>
-
-<div>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipWarResources</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="systemVariables">systemVariables</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="target">target</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAjpPort">tomeeAjpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ajp</tt></li>
-
-<li><b>Default</b>: <tt>8009</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAlreadyInstalled">tomeeAlreadyInstalled</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.exiting</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="tomeeArtifactId">tomeeArtifactId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.artifactId</tt></li>
-
-<li><b>Default</b>: <tt>apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="tomeeClassifier">tomeeClassifier</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li>
-
-<li><b>Default</b>: <tt>webprofile</tt></li>
- </ul><hr />
-<p><b><a name="tomeeGroupId">tomeeGroupId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.groupId</tt></li>
-
-<li><b>Default</b>: <tt>org.apache.openejb</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpsPort">tomeeHttpsPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.Integer</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.https</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownCommand">tomeeShutdownCommand</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown-command</tt></li>
-
-<li><b>Default</b>: <tt>SHUTDOWN</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownPort">tomeeShutdownPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown</tt></li>
-
-<li><b>Default</b>: <tt>8005</tt></li>
- </ul><hr />
-<p><b><a name="tomeeVersion">tomeeVersion</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.version</tt></li>
-
-<li><b>Default</b>: <tt>-1</tt></li>
- </ul><hr />
-<p><b><a name="useConsole">useConsole</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.use-console</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="useOpenEJB">useOpenEJB</a>:</b></p>
-
-<div>use openejb-standalone automatically instead of TomEE</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.openejb</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul><hr />
-<p><b><a name="warFile">warFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt></li>
- </ul><hr />
-<p><b><a name="webappClasses">webappClasses</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappClasses</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li>
- </ul><hr />
-<p><b><a name="webappDefaultConfig">webappDefaultConfig</a>:</b></p>
-
-<div>forcing nice default for war development (WEB-INF/classes and web
-resources)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappDefaultConfig</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="webappDir">webappDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>webapps</tt></li>
- </ul><hr />
-<p><b><a name="webappResources">webappResources</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappResources</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li>
- </ul><hr />
-<p><b><a name="webapps">webapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="zip">zip</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.zip</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="zipFile">zipFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.zip-file</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.zip</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/configtest-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/configtest-mojo.adoc b/docs/maven/configtest-mojo.adoc
new file mode 100644
index 0000000..c28c94b
--- /dev/null
+++ b/docs/maven/configtest-mojo.adoc
@@ -0,0 +1,1086 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:configtest
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:configtest
+
+Description:
+
+Run configtest Tomcat command.
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime+system.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+apacheRepos
+
+String
+
+-
+
+(no description)Default value is: snapshots.User property is:
+tomee-plugin.apache-repos.
+
+appDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: apps.
+
+apps
+
+List
+
+-
+
+(no description)
+
+args
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.args.
+
+bin
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/bin.User property is:
+tomee-plugin.bin.
+
+catalinaBase
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.build.directory}/apache-tomee.User property is:
+tomee-plugin.catalina-base.
+
+checkStarted
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.check-started.
+
+classpaths
+
+List
+
+-
+
+(no description)
+
+config
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/conf.User property is:
+tomee-plugin.conf.
+
+context
+
+String
+
+-
+
+rename the current artifact
+
+debug
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.debug.
+
+debugPort
+
+int
+
+-
+
+(no description)Default value is: 5005.User property is:
+tomee-plugin.debugPort.
+
+deployOpenEjbApplication
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.deploy-openejb-internal-application.
+
+docBases
+
+List
+
+-
+
+for TomEE and wars only, which docBase to use for this war.
+
+ejbRemote
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.ejb-remote.
+
+externalRepositories
+
+List
+
+-
+
+for TomEE and wars only, add some external repositories to classloader.
+
+forceReloadable
+
+boolean
+
+-
+
+force webapp to be reloadableDefault value is: false.User property is:
+tomee-plugin.force-reloadable.
+
+javaagents
+
+List
+
+-
+
+(no description)
+
+keepServerXmlAsthis
+
+boolean
+
+-
+
+(Removed since 7.0.0)Default value is: false.User property is:
+tomee-plugin.keep-server-xml.
+
+lib
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/lib.User property is:
+tomee-plugin.lib.
+
+libDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: lib.
+
+libs
+
+List
+
+-
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+mainDir
+
+File
+
+-
+
+(no description)Default value is: $\{project.basedir}/src/main.
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+quickSession
+
+boolean
+
+-
+
+use a real random instead of secure random. saves few ms at
+startup.Default value is: true.User property is:
+tomee-plugin.quick-session.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+removeDefaultWebapps
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-default-webapps.
+
+removeTomeeWebapp
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-tomee-webapps.
+
+simpleLog
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.simple-log.
+
+skipCurrentProject
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.skipCurrentProject.
+
+skipWarResources
+
+boolean
+
+-
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.Default value is: false.User property is:
+tomee-plugin.skipWarResources.
+
+systemVariables
+
+Map
+
+-
+
+(no description)
+
+target
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.directory}.
+
+tomeeAjpPort
+
+int
+
+-
+
+(no description)Default value is: 8009.User property is:
+tomee-plugin.ajp.
+
+tomeeAlreadyInstalled
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.exiting.
+
+tomeeArtifactId
+
+String
+
+-
+
+(no description)Default value is: apache-tomee.User property is:
+tomee-plugin.artifactId.
+
+tomeeClassifier
+
+String
+
+-
+
+(no description)Default value is: webprofile.User property is:
+tomee-plugin.classifier.
+
+tomeeGroupId
+
+String
+
+-
+
+(no description)Default value is: org.apache.openejb.User property is:
+tomee-plugin.groupId.
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+tomeeHttpsPort
+
+Integer
+
+-
+
+(no description)User property is: tomee-plugin.https.
+
+tomeeShutdownCommand
+
+String
+
+-
+
+(no description)Default value is: SHUTDOWN.User property is:
+tomee-plugin.shutdown-command.
+
+tomeeShutdownPort
+
+int
+
+-
+
+(no description)Default value is: 8005.User property is:
+tomee-plugin.shutdown.
+
+tomeeVersion
+
+String
+
+-
+
+(no description)Default value is: -1.User property is:
+tomee-plugin.version.
+
+useConsole
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.use-console.
+
+useOpenEJB
+
+boolean
+
+-
+
+use openejb-standalone automatically instead of TomEEDefault value is:
+false.User property is: tomee-plugin.openejb.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+warFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}.
+
+webappClasses
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.outputDirectory}.User
+property is: tomee-plugin.webappClasses.
+
+webappDefaultConfig
+
+boolean
+
+-
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)Default value is: false.User property is:
+tomee-plugin.webappDefaultConfig.
+
+webappDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: webapps.
+
+webappResources
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/webapp.User property is:
+tomee-plugin.webappResources.
+
+webapps
+
+List
+
+-
+
+(no description)
+
+Parameter Details
+
+apacheRepos:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.apache-repos
+
+Default: snapshots
+
+appDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: apps
+
+apps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+args:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.args
+
+bin:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.bin
+
+Default: $\{project.basedir}/src/main/tomee/bin
+
+catalinaBase:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.catalina-base
+
+Default: $\{project.build.directory}/apache-tomee
+
+checkStarted:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.check-started
+
+Default: false
+
+classpaths:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+config:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.conf
+
+Default: $\{project.basedir}/src/main/tomee/conf
+
+context:
+
+rename the current artifact
+
+Type: java.lang.String
+
+Required: No
+
+debug:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.debug
+
+Default: false
+
+debugPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.debugPort
+
+Default: 5005
+
+deployOpenEjbApplication:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.deploy-openejb-internal-application
+
+Default: false
+
+docBases:
+
+for TomEE and wars only, which docBase to use for this war.
+
+Type: java.util.List
+
+Required: No
+
+ejbRemote:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.ejb-remote
+
+Default: true
+
+externalRepositories:
+
+for TomEE and wars only, add some external repositories to classloader.
+
+Type: java.util.List
+
+Required: No
+
+forceReloadable:
+
+force webapp to be reloadable
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.force-reloadable
+
+Default: false
+
+javaagents:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+keepServerXmlAsthis:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.keep-server-xml
+
+Default: false
+
+lib:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.lib
+
+Default: $\{project.basedir}/src/main/tomee/lib
+
+libDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: lib
+
+libs:
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+Type: java.util.List
+
+Required: No
+
+mainDir:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.basedir}/src/main
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+quickSession:
+
+use a real random instead of secure random. saves few ms at startup.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.quick-session
+
+Default: true
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+removeDefaultWebapps:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-default-webapps
+
+Default: true
+
+removeTomeeWebapp:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-tomee-webapps
+
+Default: true
+
+simpleLog:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.simple-log
+
+Default: false
+
+skipCurrentProject:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipCurrentProject
+
+Default: false
+
+skipWarResources:
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipWarResources
+
+Default: false
+
+systemVariables:
+
+(no description)
+
+Type: java.util.Map
+
+Required: No
+
+target:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.build.directory}
+
+tomeeAjpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.ajp
+
+Default: 8009
+
+tomeeAlreadyInstalled:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.exiting
+
+Default: false
+
+tomeeArtifactId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.artifactId
+
+Default: apache-tomee
+
+tomeeClassifier:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.classifier
+
+Default: webprofile
+
+tomeeGroupId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.groupId
+
+Default: org.apache.openejb
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+tomeeHttpsPort:
+
+(no description)
+
+Type: java.lang.Integer
+
+Required: No
+
+User Property: tomee-plugin.https
+
+tomeeShutdownCommand:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.shutdown-command
+
+Default: SHUTDOWN
+
+tomeeShutdownPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.shutdown
+
+Default: 8005
+
+tomeeVersion:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.version
+
+Default: -1
+
+useConsole:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.use-console
+
+Default: true
+
+useOpenEJB:
+
+use openejb-standalone automatically instead of TomEE
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.openejb
+
+Default: false
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
+
+warFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}
+
+webappClasses:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappClasses
+
+Default: $\{project.build.outputDirectory}
+
+webappDefaultConfig:
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.webappDefaultConfig
+
+Default: false
+
+webappDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: webapps
+
+webappResources:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappResources
+
+Default: $\{project.basedir}/src/main/webapp
+
+webapps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
[36/44] tomee git commit: This closes apache/tomee#246
Posted by jl...@apache.org.
This closes apache/tomee#246
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/a175e04d
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/a175e04d
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/a175e04d
Branch: refs/heads/master
Commit: a175e04da55612de6d30d7a3bd994751f22f1816
Parents: c044eaa 6972efb
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:51:31 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:51:31 2018 +0100
----------------------------------------------------------------------
docs/configuration.adoc | 147 ++++++
docs/configuration.md | 144 ------
docs/configuring-containers-in-tests.adoc | 29 ++
docs/configuring-containers-in-tests.md | 27 --
docs/configuring-datasources-in-tests.adoc | 65 +++
docs/configuring-datasources-in-tests.md | 60 ---
docs/configuring-datasources.adoc | 190 ++++++++
docs/configuring-datasources.md | 170 -------
docs/configuring-durations.adoc | 69 +++
docs/configuring-durations.md | 67 ---
docs/configuring-javamail.adoc | 42 ++
docs/configuring-javamail.md | 41 --
docs/configuring-logging-in-tests.adoc | 119 +++++
docs/configuring-logging-in-tests.md | 118 -----
docs/configuring-persistenceunits-in-tests.adoc | 157 ++++++
docs/configuring-persistenceunits-in-tests.md | 144 ------
docs/constructor-injection.adoc | 100 ++++
docs/constructor-injection.md | 98 ----
docs/containers-and-resources.adoc | 473 ++++++++++++++++++
docs/containers-and-resources.md | 483 -------------------
docs/contrib/debug/debug-intellij.adoc | 182 +++++++
docs/contrib/debug/debug-intellij.md | 133 -----
docs/custom-injection.adoc | 203 ++++++++
docs/custom-injection.md | 193 --------
24 files changed, 1776 insertions(+), 1678 deletions(-)
----------------------------------------------------------------------
[38/44] tomee git commit: This closes apache/tomee#248
Posted by jl...@apache.org.
This closes apache/tomee#248
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/18ed6f35
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/18ed6f35
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/18ed6f35
Branch: refs/heads/master
Commit: 18ed6f35653a5a72e04a8c23db44f9a9285dc27a
Parents: f36b208 54346fb
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:51:41 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:51:41 2018 +0100
----------------------------------------------------------------------
docs/eclipse-plugin.adoc | 41 ++++
docs/eclipse-plugin.md | 42 ----
docs/ejb-failover.adoc | 93 +++++++
docs/ejb-failover.md | 89 -------
docs/ejb-local-ref.adoc | 54 +++++
docs/ejb-local-ref.md | 52 ----
docs/ejb-over-ssl.adoc | 132 ++++++++++
docs/ejb-over-ssl.md | 100 --------
docs/ejb-ref.adoc | 53 ++++
docs/ejb-ref.md | 50 ----
docs/ejb-refs.adoc | 190 +++++++++++++++
docs/ejb-refs.md | 178 --------------
docs/ejb-request-logging.adoc | 155 ++++++++++++
docs/ejb-request-logging.md | 98 --------
docs/ejbd-transport.adoc | 205 ++++++++++++++++
docs/ejbd-transport.md | 136 -----------
docs/embedded-and-remotable.adoc | 175 +++++++++++++
docs/embedded-and-remotable.md | 181 --------------
docs/embedded-configuration.adoc | 135 +++++++++++
docs/embedded-configuration.md | 135 -----------
docs/embedding.adoc | 34 +++
docs/embedding.md | 30 ---
docs/failover-logging.adoc | 53 ++++
docs/failover-logging.md | 42 ----
docs/faq.adoc | 105 ++++++++
docs/faq.md | 99 --------
docs/features.adoc | 6 +
docs/features.md | 6 -
docs/from-glassfish-to-tomee.adoc | 11 +
docs/from-glassfish-to-tomee.md | 7 -
...esting-with-openejb,-jetty-and-selenium.adoc | 243 +++++++++++++++++++
...-testing-with-openejb,-jetty-and-selenium.md | 240 ------------------
32 files changed, 1685 insertions(+), 1485 deletions(-)
----------------------------------------------------------------------
[08/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 5
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 5
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/6bbcdc10
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/6bbcdc10
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/6bbcdc10
Branch: refs/heads/master
Commit: 6bbcdc10d2b8fd9cdf56208b4b42e6813c85f66d
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:21 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:07:21 2018 -0800
----------------------------------------------------------------------
docs/eclipse-plugin.adoc | 41 ++++
docs/eclipse-plugin.md | 42 ----
docs/ejb-failover.adoc | 94 +++++++
docs/ejb-failover.md | 89 -------
docs/ejb-local-ref.adoc | 54 +++++
docs/ejb-local-ref.md | 52 ----
docs/ejb-over-ssl.adoc | 132 ++++++++++
docs/ejb-over-ssl.md | 100 --------
docs/ejb-ref.adoc | 53 ++++
docs/ejb-ref.md | 50 ----
docs/ejb-refs.adoc | 190 +++++++++++++++
docs/ejb-refs.md | 178 --------------
docs/ejb-request-logging.adoc | 155 ++++++++++++
docs/ejb-request-logging.md | 98 --------
docs/ejbd-transport.adoc | 205 ++++++++++++++++
docs/ejbd-transport.md | 136 -----------
docs/embedded-and-remotable.adoc | 175 +++++++++++++
docs/embedded-and-remotable.md | 181 --------------
docs/embedded-configuration.adoc | 135 +++++++++++
docs/embedded-configuration.md | 135 -----------
docs/embedding.adoc | 34 +++
docs/embedding.md | 30 ---
docs/failover-logging.adoc | 54 +++++
docs/failover-logging.md | 42 ----
docs/faq.adoc | 105 ++++++++
docs/faq.md | 99 --------
docs/features.adoc | 6 +
docs/features.md | 6 -
docs/from-glassfish-to-tomee.adoc | 11 +
docs/from-glassfish-to-tomee.md | 7 -
...esting-with-openejb,-jetty-and-selenium.adoc | 243 +++++++++++++++++++
...-testing-with-openejb,-jetty-and-selenium.md | 240 ------------------
32 files changed, 1687 insertions(+), 1485 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/eclipse-plugin.adoc
----------------------------------------------------------------------
diff --git a/docs/eclipse-plugin.adoc b/docs/eclipse-plugin.adoc
new file mode 100644
index 0000000..5bf8e39
--- /dev/null
+++ b/docs/eclipse-plugin.adoc
@@ -0,0 +1,41 @@
+# Eclipse Plugin
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# What is it?
+
+The _OpenEJB Eclipse Plugin_ will be a suite of tools made available via
+Eclipse to make EJB development with OpenEJB easier. The initial
+offering will probably provide basic functionality by taking advantage
+of http://www.eclipse.org/webtools[WebTools] to allow for OpenEJB to be
+an available container/runtime within Eclipse. This means full debugging
+and Eclipse project integration. From there, the sky is the limit so
+feel free to suggest features on the [OpenEJB Dev list|Mailing
+Lists#MailingLists-DeveloperMailingList] .
+
+# How to get involved?
+
+Just the same as getting involved with any part of OpenEJB -- send a
+mail to the
+link:mailing-lists#mailinglists-developermailinglist.html[OpenEJB Dev
+list] and say "Hi!" We're a very relaxed group so no need to be perfect
+or overly prepared. Just dive right in, we're always happy to have more.
+
+# Where do I get it?
+
+The initiative is just launching, but you can grab what we have right
+here and start hacking.
+
+http://svn.apache.org/repos/asf/tomee/openejb-eclipse-plugin/trunk/
+
+# What do I need to help?
+
+http://www.eclipse.org[Eclipse] http://www.eclipse.org/webtools[Eclipse
+Web Tools]
+
+# Resources
+
+http://eclipsezilla.eclipsecon.org/show_bug.cgi?id=3581[EclipseCon
+Presentation for Extending WTP]
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/eclipse-plugin.md
----------------------------------------------------------------------
diff --git a/docs/eclipse-plugin.md b/docs/eclipse-plugin.md
deleted file mode 100644
index dd85c45..0000000
--- a/docs/eclipse-plugin.md
+++ /dev/null
@@ -1,42 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Eclipse Plugin
-~~~~~~
-<a name="EclipsePlugin-Whatisit?"></a>
-# What is it?
-
-The *OpenEJB Eclipse Plugin* will be a suite of tools made available via
-Eclipse to make EJB development with OpenEJB easier. The initial offering
-will probably provide basic functionality by taking advantage of [WebTools](http://www.eclipse.org/webtools)
- to allow for OpenEJB to be an available container/runtime within Eclipse.
-This means full debugging and Eclipse project integration. From there, the
-sky is the limit so feel free to suggest features on the [OpenEJB Dev list|Mailing Lists#MailingLists-DeveloperMailingList]
-.
-
-<a name="EclipsePlugin-Howtogetinvolved?"></a>
-# How to get involved?
-
-Just the same as getting involved with any part of OpenEJB -- send a mail
-to the [OpenEJB Dev list](mailing-lists#mailinglists-developermailinglist.html)
- and say "Hi!" We're a very relaxed group so no need to be perfect or
-overly prepared. Just dive right in, we're always happy to have more.
-
-<a name="EclipsePlugin-WheredoIgetit?"></a>
-# Where do I get it?
-
-The initiative is just launching, but you can grab what we have right here
-and start hacking.
-
- http://svn.apache.org/repos/asf/tomee/openejb-eclipse-plugin/trunk/
-
-<a name="EclipsePlugin-WhatdoIneedtohelp?"></a>
-# What do I need to help?
-
- [Eclipse](http://www.eclipse.org)
- [Eclipse Web Tools](http://www.eclipse.org/webtools)
-
-<a name="EclipsePlugin-Resources"></a>
-# Resources
-
- [EclipseCon Presentation for Extending WTP](http://eclipsezilla.eclipsecon.org/show_bug.cgi?id=3581)
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-failover.adoc
----------------------------------------------------------------------
diff --git a/docs/ejb-failover.adoc b/docs/ejb-failover.adoc
new file mode 100644
index 0000000..04f0ee3
--- /dev/null
+++ b/docs/ejb-failover.adoc
@@ -0,0 +1,94 @@
+:index-group: Discovery
+and Failover
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: EJB Client/Server Failover
+
+
+OpenEJB supports stateless failover. Specifically, the ability for an
+EJB client to failover from one server to the next if a request cannot
+be completed. No application state information is communicated between
+the servers, so this functionality should be used only with applications
+that are inherently stateless. A common term for this sort of setup is a
+server farm.
+
+The basic design assumption is that all servers in the same group have
+the same applications deployed and are capable of doing the same job.
+Servers can be brought online and offline while clients are running. As
+members join/leave this information is sent to the client as part of
+normal EJB request/response communication so active clients always have
+the most current information on servers that can process their request
+should communication with a particular server fail.
+
+== Client Behavior
+
+On each request to the server, the client will send the version number
+associated with the list of servers in the cluster it is aware of.
+Initially this version will be zero and the list will be empty. Only
+when the server sees the client has an old list will the server send the
+updated list. This is an important distinction as the list is not
+transmitted back and forth on every request, only on change. If the
+membership of the cluster is stable there is essentially no clustering
+overhead to the protocol -- 8 byte overhead to each request and 1 byte
+on each response -- so you will _not_ see an exponential slowdown in
+response times the more members are added to the cluster. This new list
+takes affect for all proxies that share the same connection.
+
+When a server shuts down, more connections are refused, existing
+connections not in mid-request are closed, any remaining connections are
+closed immediately after completion of the request in progress and
+clients can failover gracefully to the next server in the list. If a
+server crashes requests are retried on the next server in the list (or
+depending on the `ConnectionStrategy`). This failover pattern is
+followed until there are no more servers in the list at which point the
+client attempts a final multicast search (if it was created with a
+`PROVIDER_URL` starting with `multicast://`) before abandoning the
+request and throwing an exception to the caller.
+
+By default, the failover is ordered but random selection is supported.
+The multicast discovery aspect of the client adds a nice randomness to
+the selection of the first server.
+
+== Discovery
+
+Each discoverable service has a URI which is broadcast as a heartbeat to
+other servers in the cluster. This URI advertises the service's type,
+its cluster group, and its location in the format of
+'group:jbake-date: 2018-12-05
+:jbake-type:location'. Say for example
+"cluster1:ejb:ejbd://thehost:4201". The URI is sent out repeatedly in a
+pulse and its presence on the network indicates its availability and its
+absence indicates the service is no longer available.
+
+The sending of this pulse (the heartbeat) can be done via UDP or TCP:
+multicast and "multipoint" respectively. More on that in the following
+section. The rate at which the heartbeat is pulsed to the network can be
+specified via the 'heart_rate' property. The default is 500
+milliseconds. This rate is also used when listening for services on the
+network. If a service goes missing for the duration of 'heart_rate'
+multiplied by 'max_missed_heartbeats', then the service is considered
+dead.
+
+The 'group' property, cluster1 in the example, is used to dissect the
+servers on the network into smaller logical clusters. A given server
+will broadcast all it's services with the group prefixed in the URI, as
+well it will ignore any services it sees broadcast if they do not share
+the same group name.
+
+#Details
+
+Multicast
+
+* link:multicast-discovery.html[Multicast UDP Discovery]
+* link:multipulse-discovery.html[Multipulse UDP Discovery]
+
+Multipoint
+
+* link:multipoint-discovery.html[Multipoint TCP Discovery]
+* link:multipoint-considerations.html[Considerations]
+* link:multipoint-recommendations.html[Recommendations]
+
+Logging
+
+* link:failover-logging.html[Failover Logging Events]
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-failover.md
----------------------------------------------------------------------
diff --git a/docs/ejb-failover.md b/docs/ejb-failover.md
deleted file mode 100644
index 8e2029e..0000000
--- a/docs/ejb-failover.md
+++ /dev/null
@@ -1,89 +0,0 @@
-index-group=Discovery and Failover
-type=page
-status=published
-title=EJB Client/Server Failover
-~~~~~~
-
-OpenEJB supports stateless failover. Specifically, the ability for an EJB
-client to failover from one server to the next if a request cannot be
-completed. No application state information is communicated between the
-servers, so this functionality should be used only with applications that
-are inherently stateless. A common term for this sort of setup is a server
-farm.
-
-The basic design assumption is that all servers in the same group have the
-same applications deployed and are capable of doing the same job. Servers
-can be brought online and offline while clients are running. As members
-join/leave this information is sent to the client as part of normal EJB
-request/response communication so active clients always have the most
-current information on servers that can process their request should
-communication with a particular server fail.
-
-# Client Behavior
-
-On each request to the server, the client will send the version number
-associated with the list of servers in the cluster it is aware of.
-Initially this version will be zero and the list will be empty. Only when
-the server sees the client has an old list will the server send the updated
-list. This is an important distinction as the list is not transmitted back
-and forth on every request, only on change. If the membership of the
-cluster is stable there is essentially no clustering overhead to the
-protocol -- 8 byte overhead to each request and 1 byte on each response --
-so you will *not* see an exponential slowdown in response times the more
-members are added to the cluster. This new list takes affect for all
-proxies that share the same connection.
-
-When a server shuts down, more connections are refused, existing
-connections not in mid-request are closed, any remaining connections are
-closed immediately after completion of the request in progress and clients
-can failover gracefully to the next server in the list. If a server
-crashes requests are retried on the next server in the list (or depending
-on the `ConnectionStrategy`). This failover pattern is followed until there
-are no more servers in the list at which point the client attempts a final
-multicast search (if it was created with a `PROVIDER_URL` starting with
-`multicast://`) before abandoning the request and throwing an exception to
-the caller.
-
-By default, the failover is ordered but random selection is supported. The
-multicast discovery aspect of the client adds a nice randomness to the
-selection of the first server.
-
-# Discovery
-
-Each discoverable service has a URI which is broadcast as a heartbeat to
-other servers in the cluster. This URI advertises the service's type, its
-cluster group, and its location in the format of 'group:type:location'.
-Say for example "cluster1:ejb:ejbd://thehost:4201". The URI is sent out
-repeatedly in a pulse and its presence on the network indicates its
-availability and its absence indicates the service is no longer available.
-
-The sending of this pulse (the heartbeat) can be done via UDP or TCP:
-multicast and "multipoint" respectively. More on that in the following
-section. The rate at which the heartbeat is pulsed to the network can be
-specified via the 'heart_rate' property. The default is 500 milliseconds.
-This rate is also used when listening for services on the network. If a
-service goes missing for the duration of 'heart_rate' multiplied by
-'max_missed_heartbeats', then the service is considered dead.
-
-The 'group' property, cluster1 in the example, is used to dissect the
-servers on the network into smaller logical clusters. A given server will
-broadcast all it's services with the group prefixed in the URI, as well it
-will ignore any services it sees broadcast if they do not share the same
-group name.
-
-#Details
-
-Multicast
-
- - [Multicast UDP Discovery](multicast-discovery.html)
- - [Multipulse UDP Discovery](multipulse-discovery.html)
-
-Multipoint
-
- - [Multipoint TCP Discovery](multipoint-discovery.html)
- - [Considerations](multipoint-considerations.html)
- - [Recommendations](multipoint-recommendations.html)
-
-Logging
-
- - [Failover Logging Events](failover-logging.html)
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-local-ref.adoc
----------------------------------------------------------------------
diff --git a/docs/ejb-local-ref.adoc b/docs/ejb-local-ref.adoc
new file mode 100644
index 0000000..a7787c6
--- /dev/null
+++ b/docs/ejb-local-ref.adoc
@@ -0,0 +1,54 @@
+# ejb-local-ref
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Via annotation
+
+Usable by EJB, Interceptor, Servlet, Filter, or Listener
+
+....
+package org.superbiz.refs;
+
+import javax.ejb.EJB;
+import javax.ejb.Stateless;
+import javax.naming.InitialContext;
+
+@Stateless
+@EJB(name = "myFooEjb", beanInterface = FooLocal.class)
+public class MyEjbLocalRefBean implements MyBeanInterface {
+
+ @EJB
+ private BarLocal myBarEjb;
+
+ public void someBusinessMethod() throws Exception {
+ if (myBarEjb == null) throw new NullPointerException("myBarEjb not injected");
+
+ // Both can be looked up from JNDI as well
+ InitialContext context = new InitialContext();
+ FooLocal fooLocal = (FooLocal) context.lookup("java:comp/env/myFooEjb");
+ BarLocal barLocal = (BarLocal) context.lookup("java:comp/env/org.superbiz.refs.MyEjbLocalRefBean/myBarEjb");
+ }
+}
+....
+
+# Via xml
+
+The above @EJB annotation usage is 100% equivalent to the following xml.
+
+....
+<ejb-local-ref>
+ <ejb-ref-name>myFooEjb</ejb-ref-name>
+ <local>org.superbiz.refs.FooLocal</local>
+</ejb-local-ref>
+
+<ejb-local-ref>
+ <ejb-ref-name>org.superbiz.refs.MyEjbLocalRefBean/myBarEjb</ejb-ref-name>
+ <local>org.superbiz.refs.BarLocal</local>
+ <injection-target>
+ <injection-target-class>org.superbiz.refs.MyEjbLocalRefBean</injection-target-class>
+ <injection-target-name>myBarEjb</injection-target-name>
+ </injection-target>
+</ejb-local-ref>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-local-ref.md
----------------------------------------------------------------------
diff --git a/docs/ejb-local-ref.md b/docs/ejb-local-ref.md
deleted file mode 100644
index 1b716b6..0000000
--- a/docs/ejb-local-ref.md
+++ /dev/null
@@ -1,52 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=ejb-local-ref
-~~~~~~
-<a name="ejb-local-ref-Viaannotation"></a>
-# Via annotation
-
-Usable by EJB, Interceptor, Servlet, Filter, or Listener
-
- package org.superbiz.refs;
-
- import javax.ejb.EJB;
- import javax.ejb.Stateless;
- import javax.naming.InitialContext;
-
- @Stateless
- @EJB(name = "myFooEjb", beanInterface = FooLocal.class)
- public class MyEjbLocalRefBean implements MyBeanInterface {
-
- @EJB
- private BarLocal myBarEjb;
-
- public void someBusinessMethod() throws Exception {
- if (myBarEjb == null) throw new NullPointerException("myBarEjb not injected");
-
- // Both can be looked up from JNDI as well
- InitialContext context = new InitialContext();
- FooLocal fooLocal = (FooLocal) context.lookup("java:comp/env/myFooEjb");
- BarLocal barLocal = (BarLocal) context.lookup("java:comp/env/org.superbiz.refs.MyEjbLocalRefBean/myBarEjb");
- }
- }
-
-
-<a name="ejb-local-ref-Viaxml"></a>
-# Via xml
-
-The above @EJB annotation usage is 100% equivalent to the following xml.
-
- <ejb-local-ref>
- <ejb-ref-name>myFooEjb</ejb-ref-name>
- <local>org.superbiz.refs.FooLocal</local>
- </ejb-local-ref>
-
- <ejb-local-ref>
- <ejb-ref-name>org.superbiz.refs.MyEjbLocalRefBean/myBarEjb</ejb-ref-name>
- <local>org.superbiz.refs.BarLocal</local>
- <injection-target>
- <injection-target-class>org.superbiz.refs.MyEjbLocalRefBean</injection-target-class>
- <injection-target-name>myBarEjb</injection-target-name>
- </injection-target>
- </ejb-local-ref>
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-over-ssl.adoc
----------------------------------------------------------------------
diff --git a/docs/ejb-over-ssl.adoc b/docs/ejb-over-ssl.adoc
new file mode 100644
index 0000000..6b799a6
--- /dev/null
+++ b/docs/ejb-over-ssl.adoc
@@ -0,0 +1,132 @@
+# EJB over SSL
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+It is possible to setup client/server requests over SSL. EJB requests
+from a remote client can happen two different ways:
+
+* *https* for when an EJB is running in TomEE
+* *ejbds* for when an EJB is running in OpenEJB Standalone
+
+Note, TomEE can be setup to support *ejbds*.
+
+== https
+
+First, you'll need to setup Tomcat (TomEE) with SSL as described here:
+
+http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html
+
+Once that is done and the `tomee` webapp can be accessed with `https`,
+an EJB client can invoke over `https` using the following
+`InitialContext` setup:
+
+....
+Properties p = new Properties();
+p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put("java.naming.provider.url", "https://127.0.0.1:8443/tomee/ejb");
+// user and pass optional
+p.put("java.naming.security.principal", "myuser");
+p.put("java.naming.security.credentials", "mypass");
+
+InitialContext ctx = new InitialContext(p);
+
+MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
+....
+
+If you setup Tomcat (TomEE) to use the APR (Apache Portable Runitme)
+implementation of SSL on the server side, and you have connection issues
+like connection reset, you'll have to set 'https.protocols' system
+property. 'https.protocols' property must be set according to the
+SSLProtocol parameter of the HTTPS connector configuration :
+
+http://tomcat.apache.org/tomcat-7.0-doc/config/http.html
+
+You can also have a look a this :
+
+http://docs.oracle.com/javase/1.4.2/docs/guide/plugin/developer_guide/faq/troubleshooting.html
+
+== ejbds
+
+The SSL version of the `ejbd` protocol is called `ejbds` and is enabled
+and setup in OpenEJB Standalone by default.
+
+Its configuration `conf/ejbds.properties` looks like this:
+
+....
+server = org.apache.openejb.server.ejbd.EjbServer
+bind = 127.0.0.1
+port = 4203
+disabled = false
+threads = 200
+backlog = 200
+secure = true
+discovery = ejb:ejbds://{bind}:{port}
+....
+
+To access this service from a remote client, the `InitialContext` would
+be setup like the following:
+
+....
+Properties p = new Properties();
+p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put("java.naming.provider.url", "ejbd://localhost:4201");
+// user and pass optional
+p.put("java.naming.security.principal", "myuser");
+p.put("java.naming.security.credentials", "mypass");
+
+InitialContext ctx = new InitialContext(p);
+
+MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
+....
+
+=== Changing the Cipher Suite
+
+https://issues.apache.org/jira/browse/OPENEJB-1856[This is a pending
+feature] By default, the ejbds protocol connects with
+SSL_DH_anon_WITH_RC4_128_MD5. That means your connection is encrypted
+and the integrity of the transmission is verified. However, this only
+protects your from eavesdroppers, it offers absolutely zero protection
+from Man in the Middle attacks. This sort of attack could be pulled off
+without your knowledge and the attacker has the ability to intercept,
+monitor, and even modify your messages. If the attacker could control a
+router on your connection path, this attack could be trivially pulled
+off with nothing more but the OpenEJB server and client.
+
+To secure your connections against this sort of attack, your client can
+cryptographically prove it's talking to the correct server before
+sending any data. To do this, simply select one or more secure cipher
+suites that your J2SE provider supports from
+http://docs.oracle.com/cd/E19728-01/820-2550/cipher_suites.html[this
+listing].
+
+You must now instruct the client and server to use that suite.
+
+On the server:
+
+....
+server = org.apache.openejb.server.ejbd.EjbServer
+bind = 127.0.0.1
+port = 4203
+disabled = false
+threads = 200
+backlog = 200
+secure = true
+enabledCipherSuites = TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA
+discovery = ejb:ejbds://{bind}:{port}
+....
+
+On the client, you must supply a property:
+
+....
+-Dopenejb.client.enabledCipherSuites=TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA
+....
+
+The final piece is to make sure your server has available a private
+certificate that the the client can trust. This can be certificate from
+an authority or a self signed certificate. The javax.net.ssl.trustStore
+and javax.net.ssl.keyStore JVM properties
+http://fusesource.com/docs/broker/5.3/security/SSL-SysProps.html[are
+used to set this up.]
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-over-ssl.md
----------------------------------------------------------------------
diff --git a/docs/ejb-over-ssl.md b/docs/ejb-over-ssl.md
deleted file mode 100644
index f221331..0000000
--- a/docs/ejb-over-ssl.md
+++ /dev/null
@@ -1,100 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=EJB over SSL
-~~~~~~
-
-It is possible to setup client/server requests over SSL. EJB requests from a remote client can happen two different ways:
-
- - **https** for when an EJB is running in TomEE
- - **ejbds** for when an EJB is running in OpenEJB Standalone
-
-Note, TomEE can be setup to support **ejbds**.
-
-# https
-
-First, you'll need to setup Tomcat (TomEE) with SSL as described here:
-
- [http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html](http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html)
-
-Once that is done and the `tomee` webapp can be accessed with `https`, an EJB client can invoke over `https` using the following
-`InitialContext` setup:
-
-
- Properties p = new Properties();
- p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put("java.naming.provider.url", "https://127.0.0.1:8443/tomee/ejb");
- // user and pass optional
- p.put("java.naming.security.principal", "myuser");
- p.put("java.naming.security.credentials", "mypass");
-
- InitialContext ctx = new InitialContext(p);
-
- MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
-
-If you setup Tomcat (TomEE) to use the APR (Apache Portable Runitme) implementation of SSL on the server side, and you have connection issues like connection reset, you'll have to set 'https.protocols' system property.
-'https.protocols' property must be set according to the SSLProtocol parameter of the HTTPS connector configuration :
-
-[http://tomcat.apache.org/tomcat-7.0-doc/config/http.html][1]
-
-You can also have a look a this :
-
-[http://docs.oracle.com/javase/1.4.2/docs/guide/plugin/developer_guide/faq/troubleshooting.html][2]
-
-# ejbds
-
-The SSL version of the `ejbd` protocol is called `ejbds` and is enabled and setup in OpenEJB Standalone by default.
-
-Its configuration `conf/ejbds.properties` looks like this:
-
- server = org.apache.openejb.server.ejbd.EjbServer
- bind = 127.0.0.1
- port = 4203
- disabled = false
- threads = 200
- backlog = 200
- secure = true
- discovery = ejb:ejbds://{bind}:{port}
-
-To access this service from a remote client, the `InitialContext` would be setup like the following:
-
- Properties p = new Properties();
- p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put("java.naming.provider.url", "ejbd://localhost:4201");
- // user and pass optional
- p.put("java.naming.security.principal", "myuser");
- p.put("java.naming.security.credentials", "mypass");
-
- InitialContext ctx = new InitialContext(p);
-
- MyBean myBean = (MyBean) ctx.lookup("MyBeanRemote");
-
-## Changing the Cipher Suite
-[This is a pending feature](https://issues.apache.org/jira/browse/OPENEJB-1856)
-By default, the ejbds protocol connects with SSL_DH_anon_WITH_RC4_128_MD5. That means your connection is encrypted and the integrity of the transmission is verified. However, this only protects your from eavesdroppers, it offers absolutely zero protection from Man in the Middle attacks. This sort of attack could be pulled off without your knowledge and the attacker has the ability to intercept, monitor, and even modify your messages. If the attacker could control a router on your connection path, this attack could be trivially pulled off with nothing more but the OpenEJB server and client.
-
-To secure your connections against this sort of attack, your client can cryptographically prove it's talking to the correct server before sending any data. To do this, simply select one or more secure cipher suites that your J2SE provider supports from [this listing](http://docs.oracle.com/cd/E19728-01/820-2550/cipher_suites.html).
-
-You must now instruct the client and server to use that suite.
-
-On the server:
-
- server = org.apache.openejb.server.ejbd.EjbServer
- bind = 127.0.0.1
- port = 4203
- disabled = false
- threads = 200
- backlog = 200
- secure = true
- enabledCipherSuites = TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA
- discovery = ejb:ejbds://{bind}:{port}
-
-On the client, you must supply a property:
-
- -Dopenejb.client.enabledCipherSuites=TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA
-
-The final piece is to make sure your server has available a private certificate that the the client can trust. This can be certificate from an authority or a self signed certificate. The javax.net.ssl.trustStore and javax.net.ssl.keyStore JVM properties [are used to set this up.](http://fusesource.com/docs/broker/5.3/security/SSL-SysProps.html)
-
-
- [1]: http://tomcat.apache.org/tomcat-7.0-doc/config/http.html
- [2]: http://docs.oracle.com/javase/1.4.2/docs/guide/plugin/developer_guide/faq/troubleshooting.html
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-ref.adoc
----------------------------------------------------------------------
diff --git a/docs/ejb-ref.adoc b/docs/ejb-ref.adoc
new file mode 100644
index 0000000..1c3a6a8
--- /dev/null
+++ b/docs/ejb-ref.adoc
@@ -0,0 +1,53 @@
+# ejb-ref
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+#
+Via annotation
+
+....
+package org.superbiz.refs;
+
+import javax.ejb.EJB;
+import javax.ejb.Stateless;
+import javax.naming.InitialContext;
+
+@Stateless
+@EJB(name = "myFooEjb", beanInterface = FooRemote.class)
+public class MyEjbRemoteRefBean implements MyBeanInterface {
+
+ @EJB
+ private BarRemote myBarEjb;
+
+ public void someBusinessMethod() throws Exception {
+ if (myBarEjb == null) throw new NullPointerException("myBarEjb not injected");
+
+ // Both can be looked up from JNDI as well
+ InitialContext context = new InitialContext();
+ FooRemote fooRemote = (FooRemote) context.lookup("java:comp/env/myFooEjb");
+ BarRemote barRemote = (BarRemote) context.lookup("java:comp/env/org.superbiz.refs.MyEjbRemoteRefBean/myBarEjb");
+ }
+}
+....
+
+# Via xml
+
+The above @EJB annotation usage is 100% equivalent to the following xml.
+
+....
+<ejb-ref>
+ <ejb-ref-name>myFooEjb</ejb-ref-name>
+ <remote>org.superbiz.refs.FooRemote</remote>
+</ejb-ref>
+<ejb-ref>
+
+<ejb-ref-name>org.superbiz.refs.MyEjbRemoteRefBean/myBarEjb</ejb-ref-name>
+ <remote>org.superbiz.refs.BarRemote</remote>
+ <injection-target>
+ <injection-target-class>org.superbiz.refs.MyEjbRemoteRefBean</injection-target-class>
+ <injection-target-name>myBarEjb</injection-target-name>
+ </injection-target>
+</ejb-ref>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-ref.md
----------------------------------------------------------------------
diff --git a/docs/ejb-ref.md b/docs/ejb-ref.md
deleted file mode 100644
index 8e66acf..0000000
--- a/docs/ejb-ref.md
+++ /dev/null
@@ -1,50 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=ejb-ref
-~~~~~~
-<a name="ejb-ref-Viaannotation"></a>
-# Via annotation
-
- package org.superbiz.refs;
-
- import javax.ejb.EJB;
- import javax.ejb.Stateless;
- import javax.naming.InitialContext;
-
- @Stateless
- @EJB(name = "myFooEjb", beanInterface = FooRemote.class)
- public class MyEjbRemoteRefBean implements MyBeanInterface {
-
- @EJB
- private BarRemote myBarEjb;
-
- public void someBusinessMethod() throws Exception {
- if (myBarEjb == null) throw new NullPointerException("myBarEjb not injected");
-
- // Both can be looked up from JNDI as well
- InitialContext context = new InitialContext();
- FooRemote fooRemote = (FooRemote) context.lookup("java:comp/env/myFooEjb");
- BarRemote barRemote = (BarRemote) context.lookup("java:comp/env/org.superbiz.refs.MyEjbRemoteRefBean/myBarEjb");
- }
- }
-
-
-<a name="ejb-ref-Viaxml"></a>
-# Via xml
-
-The above @EJB annotation usage is 100% equivalent to the following xml.
-
- <ejb-ref>
- <ejb-ref-name>myFooEjb</ejb-ref-name>
- <remote>org.superbiz.refs.FooRemote</remote>
- </ejb-ref>
- <ejb-ref>
-
- <ejb-ref-name>org.superbiz.refs.MyEjbRemoteRefBean/myBarEjb</ejb-ref-name>
- <remote>org.superbiz.refs.BarRemote</remote>
- <injection-target>
- <injection-target-class>org.superbiz.refs.MyEjbRemoteRefBean</injection-target-class>
- <injection-target-name>myBarEjb</injection-target-name>
- </injection-target>
- </ejb-ref>
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-refs.adoc
----------------------------------------------------------------------
diff --git a/docs/ejb-refs.adoc b/docs/ejb-refs.adoc
new file mode 100644
index 0000000..f108da5
--- /dev/null
+++ b/docs/ejb-refs.adoc
@@ -0,0 +1,190 @@
+# EJB Refs
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+TomEE complains it doesn't know the container type, so I added
+type="javax.naming.InitialContext" and it worked (mostly). ##
+Referencing a bean in another jar (with annotations)
+
+When using annotations to reference a bean from another ejb in your ear
+you have to supplement the @EJB reference with a small chunk of xml in
+the ejb-jar.xml of the referring bean.
+
+So in ejb app A colorsApp.jar you have this bean:
+
+....
+package com.foo.colors;
+
+import javax.ejb.Stateless;
+
+@Stateless
+public class OrangeBean implements OrangeRemote {
+}
+....
+
+Then in ejb app B shapesApp.jar you have this bean with a reference to
+OrangeRemote:
+
+....
+package com.foo.shapes;
+
+import javax.ejb.Stateless;
+import com.foo.colors.OrangeRemote;
+
+@Stateless
+public class SquareBean implements SquareRemote {
+ @EJB OrangeRemote orangeRemote;
+}
+....
+
+To hook this reference up you need to override this ref and add more
+info in the ejb-jar.xml of shapesApp.jar as follows:
+
+....
+<ejb-jar>
+ <enterprise-beans>
+
+ <session>
+ <ejb-name>SquareBean</ejb-name>
+ <ejb-ref>
+ <ejb-ref-name>com.foo.shapes.SquareBean/orangeRemote</ejb-ref-name>
+ <ejb-link>colorsApp.jar#OrangeBean</ejb-link>
+ </ejb-ref>
+ </session>
+
+ </enterprise-beans>
+</ejb-jar>
+....
+
+== Referencing a bean in another jar (xml only, no annotations)
+
+The same basic approach applies and dependency injection is still
+possible, however more information must be described in the xml.
+
+In ejb app A colorsApp.jar you have this bean:
+
+....
+package com.foo.colors;
+
+import javax.ejb.Stateless;
+
+@Stateless
+public class OrangeBean implements OrangeRemote {
+}
+....
+
+Then in ejb app B shapesApp.jar -- note there is no @EJB annotation:
+
+....
+package com.foo.shapes;
+
+import javax.ejb.Stateless;
+import com.foo.colors.OrangeRemote;
+
+@Stateless
+public class SquareBean implements SquareRemote {
+ OrangeRemote orangeRemote;
+}
+....
+
+Here's how you would hook this reference up, injection and all, with
+just xml. The following would be added to the ejb-jar.xml of
+shapesApp.jar:
+
+....
+<ejb-jar>
+ <enterprise-beans>
+
+ <session>
+ <ejb-name>SquareBean</ejb-name>
+ <ejb-ref>
+ <ejb-ref-name>com.foo.shapes.SquareBean/orangeRemote</ejb-ref-name>
+ <ejb-ref-type>Session</ejb-ref-type>
+ <remote>com.foo.colors.OrangeRemote</remote>
+ <ejb-link>colorsApp.jar#OrangeBean</ejb-link>
+ <injection-target>
+ <injection-target-class>com.foo.shapes.SquareBean</injection-target-class>
+ <injection-target-name>orangeRemote</injection-target-name>
+ </injection-target>
+ </ejb-ref>
+ </session>
+
+ </enterprise-beans>
+</ejb-jar>
+....
+
+Note that the value of could actually be anything and the above example
+would still work as there is no annotation that needs to match the and
+no one will likely be looking up the EJB as it's injected.
+
+== Referencing a bean in another server
+
+As of OpenEJB 4.0.0-beta-3, server to server references work.
+
+First we need to configure and name the InitialContext that will be used
+to satisfy the lookup to the other server.
+
+In this example we are calling our InitialContext `shoe` for fun.
+
+....
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<openejb>
+
+ <JndiProvider id="shoe" type="javax.naming.InitialContext">
+ java.naming.provider.url = ejbd://localhost:4201
+ java.naming.factory.initial = org.apache.openejb.client.RemoteInitialContextFactory
+ </JndiProvider>
+
+</openejb>
+....
+
+Declaring the `@EJB` reference is then done using a `mappedName` that
+references the named `InitialContext`
+
+....
+public class BlueBean implements BlueRemote {
+
+ @EJB(mappedName = "jndi:ext://shoe/OrangeBeanRemote")
+ private OrangeRemote orangeRemote;
+
+ public void hasOrangeRemote() {
+ Assert.assertNotNull("orangeRemote is null", orangeRemote);
+ assertEquals("olleh", orangeRemote.echo("hello"));
+ }
+}
+....
+
+Specifically, the `mappedName` syntax is as follows:
+
+* jndi:ext://`<contextId>`/`<jndiName>`
+
+=== Referencing a bean in "many" servers
+
+Note the above also works with the various forms of failover that TomEE
+supports.
+
+If say, there are two servers that have the `OrangeBeanRemote` bean, you
+could expand the `<JndiProvider>` delcaration like so:
+
+....
+ <JndiProvider id="shoe" type="javax.naming.InitialContext">
+ java.naming.provider.url = failover:ejbd://192.168.1.20:4201,ejbd://192.168.1.30:4201
+ java.naming.factory.initial = org.apache.openejb.client.RemoteInitialContextFactory
+ </JndiProvider>
+....
+
+In the event that the `ejbd://192.168.1.20:4201` server cannot be
+contacted, the second server will be tried.
+
+This sort of arangement can also happen dynamicall against a list of
+servers that continuously grows and shrinks. The server list is
+maintained behind the scenes using server discovery logic that can
+function on either UDP or TCP. See these docs for more details on
+Failover and Discovery:
+
+* link:multicast-discovery.html[Multicast Discovery (UDP)]
+* link:multipulse-discovery.html[Multipulse Discovery (TCP)]
+* link:multipoint-discovery.html[Multipoint Discovery (TCP)]
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-refs.md
----------------------------------------------------------------------
diff --git a/docs/ejb-refs.md b/docs/ejb-refs.md
deleted file mode 100644
index 2e03567..0000000
--- a/docs/ejb-refs.md
+++ /dev/null
@@ -1,178 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=EJB Refs
-~~~~~~
-
-TomEE complains it doesn't know the container type, so I added type="javax.naming.InitialContext" and it worked (mostly).
-<a name="EJBRefs-Referencingabeaninanotherjar(withannotations)"></a>
-## Referencing a bean in another jar (with annotations)
-
-When using annotations to reference a bean from another ejb in your ear you
-have to supplement the @EJB reference with a small chunk of xml in the
-ejb-jar.xml of the referring bean.
-
-So in ejb app A colorsApp.jar you have this bean:
-
-
- package com.foo.colors;
-
- import javax.ejb.Stateless;
-
- @Stateless
- public class OrangeBean implements OrangeRemote {
- }
-
-
-Then in ejb app B shapesApp.jar you have this bean with a reference to
-OrangeRemote:
-
-
- package com.foo.shapes;
-
- import javax.ejb.Stateless;
- import com.foo.colors.OrangeRemote;
-
- @Stateless
- public class SquareBean implements SquareRemote {
- @EJB OrangeRemote orangeRemote;
- }
-
-
-To hook this reference up you need to override this ref and add more info
-in the ejb-jar.xml of shapesApp.jar as follows:
-
-
- <ejb-jar>
- <enterprise-beans>
-
- <session>
- <ejb-name>SquareBean</ejb-name>
- <ejb-ref>
- <ejb-ref-name>com.foo.shapes.SquareBean/orangeRemote</ejb-ref-name>
- <ejb-link>colorsApp.jar#OrangeBean</ejb-link>
- </ejb-ref>
- </session>
-
- </enterprise-beans>
- </ejb-jar>
-
-
-<a name="EJBRefs-Referencingabeaninanotherjar(xmlonly,noannotations)"></a>
-## Referencing a bean in another jar (xml only, no annotations)
-
-The same basic approach applies and dependency injection is still possible,
-however more information must be described in the xml.
-
-
-In ejb app A colorsApp.jar you have this bean:
-
-
- package com.foo.colors;
-
- import javax.ejb.Stateless;
-
- @Stateless
- public class OrangeBean implements OrangeRemote {
- }
-
-
-Then in ejb app B shapesApp.jar -- note there is no @EJB annotation:
-
-
- package com.foo.shapes;
-
- import javax.ejb.Stateless;
- import com.foo.colors.OrangeRemote;
-
- @Stateless
- public class SquareBean implements SquareRemote {
- OrangeRemote orangeRemote;
- }
-
-
-Here's how you would hook this reference up, injection and all, with just
-xml. The following would be added to the ejb-jar.xml of shapesApp.jar:
-
-
- <ejb-jar>
- <enterprise-beans>
-
- <session>
- <ejb-name>SquareBean</ejb-name>
- <ejb-ref>
- <ejb-ref-name>com.foo.shapes.SquareBean/orangeRemote</ejb-ref-name>
- <ejb-ref-type>Session</ejb-ref-type>
- <remote>com.foo.colors.OrangeRemote</remote>
- <ejb-link>colorsApp.jar#OrangeBean</ejb-link>
- <injection-target>
- <injection-target-class>com.foo.shapes.SquareBean</injection-target-class>
- <injection-target-name>orangeRemote</injection-target-name>
- </injection-target>
- </ejb-ref>
- </session>
-
- </enterprise-beans>
- </ejb-jar>
-
-
-Note that the value of <ejb-ref-name> could actually be anything and the
-above example would still work as there is no annotation that needs to
-match the <ejb-ref-name> and no one will likely be looking up the EJB as
-it's injected.
-
-# Referencing a bean in another server
-
-As of OpenEJB 4.0.0-beta-3, server to server references work.
-
-First we need to configure and name the InitialContext that will be used to satisfy the lookup to the other server.
-
-In this example we are calling our InitialContext `shoe` for fun.
-
- <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
- <openejb>
-
- <JndiProvider id="shoe" type="javax.naming.InitialContext">
- java.naming.provider.url = ejbd://localhost:4201
- java.naming.factory.initial = org.apache.openejb.client.RemoteInitialContextFactory
- </JndiProvider>
-
- </openejb>
-
-Declaring the `@EJB` reference is then done using a `mappedName` that references the named `InitialContext`
-
- public class BlueBean implements BlueRemote {
-
- @EJB(mappedName = "jndi:ext://shoe/OrangeBeanRemote")
- private OrangeRemote orangeRemote;
-
- public void hasOrangeRemote() {
- Assert.assertNotNull("orangeRemote is null", orangeRemote);
- assertEquals("olleh", orangeRemote.echo("hello"));
- }
- }
-
-Specifically, the `mappedName` syntax is as follows:
-
- - jndi:ext://`<contextId>`/`<jndiName>`
-
-
-## Referencing a bean in "many" servers
-
-Note the above also works with the various forms of failover that TomEE supports.
-
-If say, there are two servers that have the `OrangeBeanRemote` bean, you could expand the `<JndiProvider>` delcaration like so:
-
- <JndiProvider id="shoe" type="javax.naming.InitialContext">
- java.naming.provider.url = failover:ejbd://192.168.1.20:4201,ejbd://192.168.1.30:4201
- java.naming.factory.initial = org.apache.openejb.client.RemoteInitialContextFactory
- </JndiProvider>
-
-In the event that the `ejbd://192.168.1.20:4201` server cannot be contacted, the second server will be tried.
-
-This sort of arangement can also happen dynamicall against a list of servers that continuously grows and shrinks. The server list is maintained behind
-the scenes using server discovery logic that can function on either UDP or TCP. See these docs for more details on Failover and Discovery:
-
- - [Multicast Discovery (UDP)](multicast-discovery.html)
- - [Multipulse Discovery (TCP)](multipulse-discovery.html)
- - [Multipoint Discovery (TCP)](multipoint-discovery.html)
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-request-logging.adoc
----------------------------------------------------------------------
diff --git a/docs/ejb-request-logging.adoc b/docs/ejb-request-logging.adoc
new file mode 100644
index 0000000..48a48bf
--- /dev/null
+++ b/docs/ejb-request-logging.adoc
@@ -0,0 +1,155 @@
+# EJB Request Logging
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+NOTE: Licensed to the Apache Software Foundation (ASF)
+under one or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information regarding
+copyright ownership. The ASF licenses this file to you 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.
+
+Both client-side and server-side request logging is supported and
+includes various invocation times aimed at helping to identify where
+time is going in a request.
+
+== Client-side
+
+On the client requests/responses are logged on java.util.logging
+`FINEST` level in category `OpenEJB.client`. The code is similar to the
+following:
+
+....
+final long time = System.nanoTime() - start;
+final String message = String.format("Invocation %sns - %s - Request(%s) - Response(%s)", time, conn.getURI(), req, res);
+logger.log(Level.FINEST, message);
+....
+
+Note that the check to see if FINEST is enabled is cached for
+performance reasons, so it must be set at VM startup.
+
+== Server-side
+
+On the server requests/responses are logged in java.util.logging `FINE`
+in category`"OpenEJB.server.remote.ejb`. The code for that is similar to
+this:
+
+....
+logger.fine("EJB REQUEST: " + req + " -- RESPONSE: " + res);
+....
+
+== Request times
+
+Three times are tracked per request and logged in the above statements
+as part of the formatting of the EJB Response. They're best understood
+in reverse:
+
+* *Container time* -- this is the raw time of invoking the bean
+including its interceptors and any transaction begin/commit time. This
+time is effectively "business logic".
+* *Server time* -- this timer starts the (nano)second the request is
+seen by the server and the (nano)second the response is actually
+written. The serverTime minus the containerTime will effectively show
+you how long serialization and deserialization is taking pre request.
+* *Client time* -- entire begin to end including attempting to contact
+the server and fully reading the response. The clientTime minus the
+serverTime will show network latency for the most part.
+
+The container time and server time are written in the EJB response and
+visible to the client. The client will log all three times, the server
+will log the first two. All log statements are on a single line.
+
+== Bean-time and JMX Statistics
+
+The above information applies purely to remote EJB calls made over a
+network. Calls on `@Remote` or `@Local` interfaces between two
+components in the same server are not logged.
+
+However, *all* EJB invocations to business methods _or_ callbacks like
+`@PostConstruct` are tracked for statistical analysis. By default a
+floating window of 2000 samples are kept. The time tracked is purely
+*bean time* which includes interceptors, decorators and the bean itself,
+but does not include other container services like transactions or
+security.
+
+This information is available in JMX. A sample JMX ObjectName for a
+`CounterBean` will look like this:
+
+....
+openejb.management:J2EEServer=openejb,J2EEApplication=null,EJBModule=StatsModule,StatelessSessionBean=CounterBean,j2eeType=Invocations,name=CounterBean
+....
+
+All beans have the following MBean attributes, listed here in shorthand:
+
+* javax.management.MBeanAttributeInfo[description=,
+name=InvocationCount, type=long, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=, name=InvocationTime,
+type=long, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=MonitoredMethods, type=long, read-only, descriptor=\{}]
+* javax.management.MBeanOperationInfo[description=,
+name=FilterAttributes, returnType=void,
+signature=[javax.management.MBeanParameterInfo[description="",
+name=excludeRegex, type=java.lang.String, descriptor=\{}],
+javax.management.MBeanParameterInfo[description="", name=includeRegex,
+type=java.lang.String, descriptor=\{}]], impact=unknown, descriptor=\{}]
+
+Then for every method there will be these attributes and operations:
+
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Count, type=long, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().GeometricMean, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Kurtosis, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Max, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Mean, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Min, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Percentile01, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Percentile10, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Percentile25, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Percentile50, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Percentile75, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Percentile90, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Percentile99, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().SampleSize, type=int, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Skewness, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().StandardDeviation, type=double, read-only,
+descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Sum, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Sumsq, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanAttributeInfo[description=,
+name=someMethod().Variance, type=double, read-only, descriptor=\{}]
+* javax.management.MBeanOperationInfo[description=,
+name=someMethod().setSampleSize, returnType=void,
+signature=[javax.management.MBeanParameterInfo[description=, name=p1,
+type=int, descriptor=\{}]], impact=unknown, descriptor=\{}]
+* javax.management.MBeanOperationInfo[description=,
+name=someMethod().sortedValues, returnType=[D, signature=[],
+impact=unknown, descriptor=\{}]
+* javax.management.MBeanOperationInfo[description=,
+name=someMethod().values, returnType=[D, signature=[], impact=unknown,
+descriptor=\{}]
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejb-request-logging.md
----------------------------------------------------------------------
diff --git a/docs/ejb-request-logging.md b/docs/ejb-request-logging.md
deleted file mode 100644
index 068fdbf..0000000
--- a/docs/ejb-request-logging.md
+++ /dev/null
@@ -1,98 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=EJB Request Logging
-~~~~~~
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-Both client-side and server-side request logging is supported and includes various invocation times aimed at helping to identify where time
-is going in a request.
-
-## Client-side
-
-On the client requests/responses are logged on java.util.logging `FINEST` level in category `OpenEJB.client`. The code is similar to the following:
-
- final long time = System.nanoTime() - start;
- final String message = String.format("Invocation %sns - %s - Request(%s) - Response(%s)", time, conn.getURI(), req, res);
- logger.log(Level.FINEST, message);
-
-Note that the check to see if FINEST is enabled is cached for performance reasons, so it must be set at VM startup.
-
-## Server-side
-
-On the server requests/responses are logged in java.util.logging `FINE` in category`"OpenEJB.server.remote.ejb`. The code for that
-is similar to this:
-
- logger.fine("EJB REQUEST: " + req + " -- RESPONSE: " + res);
-
-## Request times
-
-Three times are tracked per request and logged in the above statements as part of the formatting of the EJB Response. They're best understood in reverse:
-
- - **Container time** -- this is the raw time of invoking the bean including its
-interceptors and any transaction begin/commit time. This time is effectively "business logic".
- - **Server time** -- this timer starts the (nano)second the request is seen by the server and
- the (nano)second the response is actually written. The serverTime minus the containerTime will
-effectively show you how long serialization and deserialization is taking pre request.
- - **Client time** -- entire begin to end including attempting to contact the server and fully reading the response. The clientTime minus the serverTime will show network latency for the most part.
-
-The container time and server time are written in the EJB response and visible to the client. The client will log all three times, the server will log the first two. All log statements are on a single line.
-
-## Bean-time and JMX Statistics
-
-The above information applies purely to remote EJB calls made over a network. Calls on `@Remote` or `@Local` interfaces between two components in the same server are not logged.
-
-However, **all** EJB invocations to business methods *or* callbacks like `@PostConstruct` are tracked for statistical analysis.
-By default a floating window of 2000 samples are kept. The time tracked is purely **bean time** which includes
-interceptors, decorators and the bean itself, but does not include other container services like transactions or security.
-
-This information is available in JMX. A sample JMX ObjectName for a `CounterBean` will look like this:
-
- openejb.management:J2EEServer=openejb,J2EEApplication=null,EJBModule=StatsModule,StatelessSessionBean=CounterBean,j2eeType=Invocations,name=CounterBean
-
-All beans have the following MBean attributes, listed here in shorthand:
-
- * javax.management.MBeanAttributeInfo[description=, name=InvocationCount, type=long, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=InvocationTime, type=long, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=MonitoredMethods, type=long, read-only, descriptor={}]
- * javax.management.MBeanOperationInfo[description=, name=FilterAttributes, returnType=void, signature=[javax.management.MBeanParameterInfo[description="", name=excludeRegex, type=java.lang.String, descriptor={}], javax.management.MBeanParameterInfo[description="", name=includeRegex, type=java.lang.String, descriptor={}]], impact=unknown, descriptor={}]
-
-Then for every method there will be these attributes and operations:
-
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Count, type=long, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().GeometricMean, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Kurtosis, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Max, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Mean, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Min, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Percentile01, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Percentile10, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Percentile25, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Percentile50, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Percentile75, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Percentile90, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Percentile99, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().SampleSize, type=int, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Skewness, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().StandardDeviation, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Sum, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Sumsq, type=double, read-only, descriptor={}]
- * javax.management.MBeanAttributeInfo[description=, name=someMethod().Variance, type=double, read-only, descriptor={}]
- * javax.management.MBeanOperationInfo[description=, name=someMethod().setSampleSize, returnType=void, signature=[javax.management.MBeanParameterInfo[description=, name=p1, type=int, descriptor={}]], impact=unknown, descriptor={}]
- * javax.management.MBeanOperationInfo[description=, name=someMethod().sortedValues, returnType=[D, signature=[], impact=unknown, descriptor={}]
- * javax.management.MBeanOperationInfo[description=, name=someMethod().values, returnType=[D, signature=[], impact=unknown, descriptor={}]
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejbd-transport.adoc
----------------------------------------------------------------------
diff --git a/docs/ejbd-transport.adoc b/docs/ejbd-transport.adoc
new file mode 100644
index 0000000..5d07978
--- /dev/null
+++ b/docs/ejbd-transport.adoc
@@ -0,0 +1,205 @@
+# Ejbd Transport
+:index-group: EJB
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+The Ejbd Transport allows to remotely access EJBs that have a remote
+interface. Nevertheless it is not based on IIOP.
+
+Ejbd Transport is different using TomEE or OpenEJB.
+
+In OpenEJB it uses openejb http layer and ejbd is configured through
+ejbd service (same for ejbds). So to activate/deactivate them use
+conf/ejbd(s).properties files. You can set property disabled to true if
+you don't want them to be started.
+
+In TomEE the transport is the Tomcat one. It uses a servlet brought by
+TomEE webapp. Here is the servlet as defined in TomEE webapp:
+
+....
+<servlet>
+ <servlet-name>ServerServlet</servlet-name>
+ <servlet-class>org.apache.openejb.server.httpd.ServerServlet</servlet-class>
+</servlet>
+
+<servlet-mapping>
+ <servlet-name>ServerServlet</servlet-name>
+ <url-pattern>/ejb/*</url-pattern>
+</servlet-mapping>
+....
+
+You can easily remove it if you don't use remote EJBs. Another way is to
+deactivate the servlet using the "activated" init parameter of the
+servlet.
+
+Finally you can move this servlet in your own webapp if you want to use
+a provider url containing your webapp context. Simply copy paste the
+servlet definition in your web.xml and set the url mapping to what you
+want (let say /foo/*). Then use the provider url
+http://<host>:<port>/<webapp context name>/foo
+
+== Remote communication and serialization
+
+Remotely calling EJBs, independent of using Ejbd or other RMI/IIOP based
+protocols, involves serialization and deserialization of objects.
+Deserializing unknown content coming from an untrusted source imposes a
+security risk as the stream could be manipulated. A much publicized
+http://www.kb.cert.org/vuls/id/576313[vulnerability] was found in the
+commons-collections library which allowed to remotely execute arbitrary
+code simply by deserializing instances of the class
+`InvokerTransformer`.
+
+To prevent this risk TomEE and the OpenEJB client since 1.7.4 before
+deserializing every object checks its class against a configurable
+blacklist and a whitelist. The default black list is defined as `*`,
+meaning that requests cannot be deserialized at all and the Ejbd
+transport in fact cannot be used.
+
+The blacklist and whitelist is configured via the system properties:
+
+* `tomee.serialization.class.whitelist`
+* `tomee.serialization.class.blacklist`
+
+You will also find these properties in
+link:properties-listing.html[System Properties Listing]
+
+These rules apply for the whitelist:
+
+* The whitelist has a lower priority than the blacklist. That means a
+class that is part of the blacklist cannot be whitelisted and will
+always be refused.
+* If a whitelist is not defined, either by not defining the property at
+all or defining it with an empty value, every class is on the whitelist.
+In this case only the blacklist applies.
+* If a whitelist is defined it must be a comma separated list of
+prefixes of fully qualified class names. Then deserialization of an
+object fails if its class is not part of this whitelist. A class is on
+the whitelist if its fully qualified classname is prefixed by one of the
+values in the whitelist.
+
+These rules apply for the blacklist:
+
+* If the blacklist should be deactivated it must be configured to the
+value `-`. This will open your system to the serialization vulnerability
+if you don't configure a whitelist!
+* If the blacklist is not configured its default value is
+`org.codehaus.groovy.runtime.,org.apache.commons.collections.functors.,org.apache.xalan,java.lang.Process`
+so that for example the class
+`org.apache.commons.collections.functors.InvokerTransformer` cannot be
+deserialized.
+* If the blacklist is configured with an empty value the blacklist is
+effectively `*`, therefore preventing any Ejbd communication.
+* If you want to blacklist certain classes the property must be
+configured to a comma separated list of prefixes of fully qualified
+class names. A class is on the blacklist if its fully qualified
+classname is prefixed by one of the values in the blacklist.
+
+The default for `tomee.serialization.class.whitelist` is empty, the
+default for `tomee.serialization.class.blacklist` is `*` since TomEE
+1.7.4.
+
+If an EJB request fails because a class is not whitelisted you will find
+this log entry:
+
+....
+WARN - "null OEJP/4.7" FAIL "Security error - foo.Bar is not whitelisted as deserializable, prevented before loading it." - Debug for StackTrace
+....
+
+If you trust this class and want to support serialization in remote
+communication you have to configure these properties appropriately both
+on server side as well as on client side.
+
+If you only want to support serialization of the classes `foo.Bar` and
+`foo.Baz` you can configure the properties like this:
+
+....
+tomee.serialization.class.whitelist = foo.Bar,foo.Baz
+tomee.serialization.class.blacklist = -
+....
+
+If you trust all classes in the package `foo` define the properties like
+this:
+
+....
+tomee.serialization.class.whitelist = foo.
+tomee.serialization.class.blacklist = -
+....
+
+(Don't forget the trailing `.` after foo, as it will also whitelist all
+classes in the package `foo2` otherwise.)
+
+If you trust all classes in the package `foo` except the class `foo.Bar`
+you have to configure the properties like this:
+
+....
+tomee.serialization.class.whitelist = foo.
+tomee.serialization.class.blacklist = foo.Bar
+....
+
+=== Revert to behavior of TomEE 1.7.3
+
+TomEE 1.7.3 already contained a fixed blacklist that was not
+configurable and contained the packages org.codehaus.groovy.runtime,
+org.apache.commons.collections.functors and org.apache.xalan including
+subpackages and the class java.lang.Process. If you know that your
+applications runs on TomEE 1.7.3 but does not on TomEE 1.7.4 showing the
+aforementioned log message, you can define the configuration so that the
+serialization will work in the same way as it did with TomEE 1.7.3:
+
+....
+tomee.serialization.class.whitelist =
+tomee.serialization.class.blacklist = org.codehaus.groovy.runtime.,org.apache.commons.collections.functors.,org.apache.xalan,java.lang.Process
+....
+
+Please note that with this configuration your server may be vulnerable
+to Java serialization attacks not yet identified by the Zero Day
+initiative. Also note that the following versions of the affected
+libraries have been patched and approved by the Zero Day initiative and
+_may_ be safe to deserialize.
+
+* Groovy 2.4.4
+* Commons Collections 3.2.2
+* Xalan 2.7.2
+
+As Ejbd transport is tunneled over HTTP please make sure that the
+`ServerServlet` is not publicly accessible. When the applications
+running on TomEE do not package the `ServerServlet` themselves ensure
+that the URL http://<host>:<port>/tomee/ejb is not accessible from
+untrusted sources.
+
+If your applications package declare it in their own web.xml make sure
+that the respective URL is not accessible from untrusted sources.
+
+=== Revert to behavior of TomEE 1.7.2
+
+TomEE 1.7.2 did not have any kind of blacklist when deserializing
+objects over Ejbd. If you want to revert to this behavior you can simply
+deactivate the blacklist with this configuration:
+
+....
+tomee.serialization.class.whitelist =
+tomee.serialization.class.blacklist = -
+....
+
+Note that this configuration makes your system highly vulnerable to
+serialization attacks! Consider your system as unsafe!
+
+=== Remote communication and Arquillian tests
+
+The mechanism described above principally also works when running
+Arquillian tests. As the Ejbd transport is already used for deploying
+applications all Arquillian tests would fail with the default settings.
+
+Therefore the TomEE Arquillian adapter automatically starts the
+container so that all classes except for a set of well-know dangerous
+classes are whitelisted.
+
+As Ejbd is by default disabled since TomEE 7.0.0, the TomEE Arquillian
+adapter automatically activates it when starting a remote container.
+
+=== Remote communication and the TomEE Maven Plugin
+
+The same mentioned above on Arquillian and TomEE is also valid when
+using the TomEE Maven Plugin.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/ejbd-transport.md
----------------------------------------------------------------------
diff --git a/docs/ejbd-transport.md b/docs/ejbd-transport.md
deleted file mode 100644
index 784c6f5..0000000
--- a/docs/ejbd-transport.md
+++ /dev/null
@@ -1,136 +0,0 @@
-index-group=EJB
-type=page
-status=published
-title=Ejbd Transport
-~~~~~~
-
-The Ejbd Transport allows to remotely access EJBs that have a remote interface.
-Nevertheless it is not based on IIOP.
-
-Ejbd Transport is different using TomEE or OpenEJB.
-
-In OpenEJB it uses openejb http layer and ejbd is configured through ejbd service (same for ejbds).
-So to activate/deactivate them use conf/ejbd(s).properties files. You can set property disabled to true
-if you don't want them to be started.
-
-In TomEE the transport is the Tomcat one. It uses a servlet brought by TomEE webapp.
-Here is the servlet as defined in TomEE webapp:
-
- <servlet>
- <servlet-name>ServerServlet</servlet-name>
- <servlet-class>org.apache.openejb.server.httpd.ServerServlet</servlet-class>
- </servlet>
-
- <servlet-mapping>
- <servlet-name>ServerServlet</servlet-name>
- <url-pattern>/ejb/*</url-pattern>
- </servlet-mapping>
-
-
-You can easily remove it if you don't use remote EJBs. Another way is to deactivate the servlet
-using the "activated" init parameter of the servlet.
-
-Finally you can move this servlet in your own webapp if you want to use a provider url
-containing your webapp context. Simply copy paste the servlet definition in your web.xml
-and set the url mapping to what you want (let say /foo/*). Then use the provider url
-http://<host>:<port>/<webapp context name>/foo
-
-### Remote communication and serialization
-
-Remotely calling EJBs, independent of using Ejbd or other RMI/IIOP based protocols, involves serialization and deserialization of objects.
-Deserializing unknown content coming from an untrusted source imposes a security risk as the stream could be manipulated.
-A much publicized [vulnerability](http://www.kb.cert.org/vuls/id/576313) was found in the commons-collections library which allowed to remotely execute arbitrary code simply by deserializing instances of the class `InvokerTransformer`.
-
-To prevent this risk TomEE and the OpenEJB client since 1.7.4 before deserializing every object checks its class against a configurable blacklist and a whitelist.
-The default black list is defined as `*`, meaning that requests cannot be deserialized at all and the Ejbd transport in fact cannot be used.
-
-The blacklist and whitelist is configured via the system properties:
-
-- `tomee.serialization.class.whitelist`
-- `tomee.serialization.class.blacklist`
-
-You will also find these properties in [System Properties Listing](properties-listing.html)
-
-These rules apply for the whitelist:
-
-- The whitelist has a lower priority than the blacklist. That means a class that is part of the blacklist cannot be whitelisted and will always be refused.
-- If a whitelist is not defined, either by not defining the property at all or defining it with an empty value, every class is on the whitelist. In this case only the blacklist applies.
-- If a whitelist is defined it must be a comma separated list of prefixes of fully qualified class names. Then deserialization of an object fails if its class is not part of this whitelist. A class is on the whitelist if its fully qualified classname is prefixed by one of the values in the whitelist.
-
-These rules apply for the blacklist:
-
-- If the blacklist should be deactivated it must be configured to the value `-`. This will open your system to the serialization vulnerability if you don't configure a whitelist!
-- If the blacklist is not configured its default value is `org.codehaus.groovy.runtime.,org.apache.commons.collections.functors.,org.apache.xalan,java.lang.Process` so that for example the class `org.apache.commons.collections.functors.InvokerTransformer` cannot be deserialized.
-- If the blacklist is configured with an empty value the blacklist is effectively `*`, therefore preventing any Ejbd communication.
-- If you want to blacklist certain classes the property must be configured to a comma separated list of prefixes of fully qualified class names. A class is on the blacklist if its fully qualified classname is prefixed by one of the values in the blacklist.
-
-The default for `tomee.serialization.class.whitelist` is empty, the default for `tomee.serialization.class.blacklist` is `*` since TomEE 1.7.4.
-
-If an EJB request fails because a class is not whitelisted you will find this log entry:
-
- WARN - "null OEJP/4.7" FAIL "Security error - foo.Bar is not whitelisted as deserializable, prevented before loading it." - Debug for StackTrace
-
-If you trust this class and want to support serialization in remote communication you have to configure these properties appropriately both on server side as well as on client side.
-
-If you only want to support serialization of the classes `foo.Bar` and `foo.Baz` you can configure the properties like this:
-
- tomee.serialization.class.whitelist = foo.Bar,foo.Baz
- tomee.serialization.class.blacklist = -
-
-If you trust all classes in the package `foo` define the properties like this:
-
- tomee.serialization.class.whitelist = foo.
- tomee.serialization.class.blacklist = -
-
-(Don't forget the trailing `.` after foo, as it will also whitelist all classes in the package `foo2` otherwise.)
-
-If you trust all classes in the package `foo` except the class `foo.Bar` you have to configure the properties like this:
-
- tomee.serialization.class.whitelist = foo.
- tomee.serialization.class.blacklist = foo.Bar
-
-
-
-#### Revert to behavior of TomEE 1.7.3
-
-TomEE 1.7.3 already contained a fixed blacklist that was not configurable and contained the packages org.codehaus.groovy.runtime, org.apache.commons.collections.functors and org.apache.xalan including subpackages and the class java.lang.Process.
-If you know that your applications runs on TomEE 1.7.3 but does not on TomEE 1.7.4 showing the aforementioned log message, you can define the configuration so that the serialization will work in the same way as it did with TomEE 1.7.3:
-
- tomee.serialization.class.whitelist =
- tomee.serialization.class.blacklist = org.codehaus.groovy.runtime.,org.apache.commons.collections.functors.,org.apache.xalan,java.lang.Process
-
-Please note that with this configuration your server may be vulnerable to Java serialization attacks not yet identified by the Zero Day initiative.
-Also note that the following versions of the affected libraries have been patched and approved by the Zero Day initiative and *may* be safe to deserialize.
-
-- Groovy 2.4.4
-- Commons Collections 3.2.2
-- Xalan 2.7.2
-
-As Ejbd transport is tunneled over HTTP please make sure that the `ServerServlet` is not publicly accessible.
-When the applications running on TomEE do not package the `ServerServlet` themselves ensure that the URL http://<host>:<port>/tomee/ejb is not accessible from untrusted sources.
-
-If your applications package declare it in their own web.xml make sure that the respective URL is not accessible from untrusted sources.
-
-#### Revert to behavior of TomEE 1.7.2
-
-TomEE 1.7.2 did not have any kind of blacklist when deserializing objects over Ejbd.
-If you want to revert to this behavior you can simply deactivate the blacklist with this configuration:
-
- tomee.serialization.class.whitelist =
- tomee.serialization.class.blacklist = -
-
-Note that this configuration makes your system highly vulnerable to serialization attacks!
-Consider your system as unsafe!
-
-#### Remote communication and Arquillian tests
-
-The mechanism described above principally also works when running Arquillian tests.
-As the Ejbd transport is already used for deploying applications all Arquillian tests would fail with the default settings.
-
-Therefore the TomEE Arquillian adapter automatically starts the container so that all classes except for a set of well-know dangerous classes are whitelisted.
-
-As Ejbd is by default disabled since TomEE 7.0.0, the TomEE Arquillian adapter automatically activates it when starting a remote container.
-
-#### Remote communication and the TomEE Maven Plugin
-
-The same mentioned above on Arquillian and TomEE is also valid when using the TomEE Maven Plugin.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6bbcdc10/docs/embedded-and-remotable.adoc
----------------------------------------------------------------------
diff --git a/docs/embedded-and-remotable.adoc b/docs/embedded-and-remotable.adoc
new file mode 100644
index 0000000..ee6cc5e
--- /dev/null
+++ b/docs/embedded-and-remotable.adoc
@@ -0,0 +1,175 @@
+# Embedded and Remotable
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Overview
+
+This example shows how to use OpenEJB3's remoting capabilities in an
+embedded scenario. By remoting we mean that you wish to allow _clients
+in other vms_ access your ejbs. _Note, you do not need to go to this
+extreme to unit test ejbs with remote interfaces._
+
+The basic recipe is the same for a standard embedded scenario but with
+these added ingreditents:
+
+* _openejb.embedded.remotable_ property
+* _openejb-ejbd_ jar
+
+While creating the InitialContext, pass in the
+openejb.embedded.remotable property with the value of "true". When this
+is seen by the LocalInitialContextFactory, it will boot up the Server
+ServiceManager in the VM which will in turn look for ServerServices in
+the classpath.
+
+Provided you have the openejb-ejbd jar in your classpath along with it's
+dependencies (openejb-server, openejb-client, openejb-core), then those
+services will be brought online and remote clients will be able to
+connect into your vm and invoke beans.
+
+If you want to add more ServerServices such as the http version of the
+ejbd protocol you'd simply add the openejb-httpejbd jar to your
+classpath. A number of ServerServices are available currently:
+
+* openejb-ejbd
+* openejb-http
+* openejb-telnet
+* openejb-derbynet
+* openejb-hsql
+* openejb-activemq
+
+_The source for this example is in the "telephone-stateful" directory
+located in the openejb:download.html[openejb-examples.zip] available on
+the http://tomee.apache.org/downloads.html[download page]._
+
+\{note} If your goal is simply to unit test beans with remote
+interfaces, this is _not_ the right example for you. The
+LocalInitialContextFactory completely supports remote interfaces and all
+spec required pass-by-value (serialization) semantics without the need
+for network sockets. This example shows the use of OpenEJB in an
+embedded environment where connection _outside_ the vm is
+required.\{note}
+
+# The Code
+
+For this example we have a simple Stateful bean called TelephoneBean as
+defined below. As a simple way of demonstrating the state we have to
+methods: speak and listen. You call _speak_ and pass in some text, then
+you call _listen_ to get your answer.
+
+== bean
+
+\{snippet:id=code|url=openejb3/examples/telephone-stateful/src/main/java/org/superbiz/telephone/TelephoneBean.java|lang=java}
+
+== business interface
+
+\{snippet:id=code|url=openejb3/examples/telephone-stateful/src/main/java/org/superbiz/telephone/Telephone.java|lang=java}
+
+:jbake-title: EJB3 Notes} The bean class uses the annotation _@Remote_ but
+does not specify a list of interfaces as is normally required. Per EJB3
+rules, if the bean implements exactly _one business interface_ it may
+use @Remote with no other values and that business interface is then
+implied to be a remote business interface. The same rule applies to
+identical usage of @Local.
+
+The critical thing to know is that if you add another interface the
+rules change and require that you specify both interfaces in the @Remote
+annotation as in @Remote(\{Telephone.class, SecondInterface.class}).
+\{tip}
+
+# Embedding
+
+We're going to embed OpenEJB3 into a plain JUnit TestCase as a simple
+means of demonstrating the remote capabilities. We'll do the embedding
+in our test setUp method, then will make two test methods: - one for
+invoking the bean's remote interface via the
+_LocalInitialContextFactory_ which goes straight against the embedded
+container system - one for invoking the bean's remote interface via the
+_RemoteInitialContextFactory_ which connects to a Socket and
+communicates to the embedded container system over the ejbd protocol.
+
+== setUp
+
+\{snippet:id=setup|url=openejb3/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java|lang=java}
+
+== LocalInitialContextFactory: making in-vm calls to a remote business
+
+interface
+
+\{snippet:id=localcontext|url=openejb3/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java|lang=java}
+
+== RemoteInitialContextFactory: making networked calls to a remote
+
+business interface
+
+This is the part you would want to do in apps that are running a
+different VM than the one in which the ejb container is embedded. These
+"client" VMs need only have the the _openejb-client jar_ in their
+classpath and connect to OpenEJB via the RemoteInitialContextFactory
+like any other remote EJB client.
+
+\{snippet:id=remotecontext|url=openejb3/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java|lang=java}
+
+# Maven setup
+
+\{snippet:id=desc|url=openejb3/examples/telephone-stateful/pom.xml}
+
+\{snippet:id=openejbdep|url=openejb3/examples/telephone-stateful/pom.xml|lang=xml}
+
+# Running
+
+Running the example is fairly simple. In the "telephone-stateful"
+directory of the openejb:download.html[examples zip] , just run:
+
+$ mvn clean install
+
+Which should create output like the following.
+
+....
+-------------------------------------------------------
+ T E S T S
+-------------------------------------------------------
+Running org.superbiz.telephone.TelephoneTest
+Apache OpenEJB 3.0 build: 20080408-04:13
+http://tomee.apache.org/
+INFO - openejb.home =
+....
+
+/Users/dblevins/work/openejb-3.0/examples/telephone-stateful INFO -
+openejb.base =
+/Users/dblevins/work/openejb-3.0/examples/telephone-stateful INFO -
+Configuring Service(id=Default Security Service, type=SecurityService,
+provider-id=Default Security Service) INFO - Configuring
+Service(id=Default Transaction Manager, type=TransactionManager,
+provider-id=Default Transaction Manager) INFO - Configuring
+Service(id=Default JDK 1.3 ProxyFactory, type=ProxyFactory,
+provider-id=Default JDK 1.3 ProxyFactory) INFO - Found EjbModule in
+classpath:
+/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes
+INFO - Configuring app:
+/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes
+INFO - Configuring Service(id=Default Stateful Container,
+type=Container, provider-id=Default Stateful Container) INFO -
+Auto-creating a container for bean TelephoneBean:
+Container(type=STATEFUL, id=Default Stateful Container) INFO - Loaded
+Module:
+/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes
+INFO - Assembling app:
+/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes
+INFO - Jndi(name=TelephoneBeanRemote) -->
+Ejb(deployment-id=TelephoneBean) INFO - Created
+Ejb(deployment-id=TelephoneBean, ejb-name=TelephoneBean,
+container=Default Stateful Container) INFO - Deployed
+Application(path=/Users/dblevins/work/openejb-3.0/examples/telephone-stateful/target/classes)
+** Starting Services ** NAME IP PORT +
+ejbd 127.0.0.1 4201 +
+admin thread 127.0.0.1 4200 +
+------- Ready! Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time
+elapsed: 0.89 sec
+
+....
+Results :
+
+Tests run: 2, Failures: 0, Errors: 0, Skipped: 0
+....
[09/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 5
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jms-resources-and-mdb-container.adoc
----------------------------------------------------------------------
diff --git a/docs/jms-resources-and-mdb-container.adoc b/docs/jms-resources-and-mdb-container.adoc
new file mode 100644
index 0000000..9cf0e89
--- /dev/null
+++ b/docs/jms-resources-and-mdb-container.adoc
@@ -0,0 +1,356 @@
+# JMS Resources and MDB Container
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+== External ActiveMQ Broker
+
+....
+<tomee>
+ <Resource id="MyJmsResourceAdapter" type="ActiveMQResourceAdapter">
+ # Do not start the embedded ActiveMQ broker
+ BrokerXmlConfig =
+ ServerUrl = tcp://someHostName:61616
+ </Resource>
+
+ <Resource id="MyJmsConnectionFactory" type="javax.jms.ConnectionFactory">
+ ResourceAdapter = MyJmsResourceAdapter
+ </Resource>
+
+ <Container id="MyJmsMdbContainer" ctype="MESSAGE">
+ ResourceAdapter = MyJmsResourceAdapter
+ </Container>
+
+ <Resource id="FooQueue" type="javax.jms.Queue"/>
+ <Resource id="BarTopic" type="javax.jms.Topic"/>
+</tomee>
+....
+
+The `ServerUrl` would be changed to point to the host and port of the
+ActiveMQ process. The various URL formats that ActiveMQ supports also
+work, such as 'failover:'.
+
+== Internal ActiveMQ Broker
+
+....
+<tomee>
+ <Resource id="MyJmsResourceAdapter" type="ActiveMQResourceAdapter">
+ BrokerXmlConfig = broker:(tcp://someHostName:61616)
+ ServerUrl = tcp://someHostName:61616
+ </Resource>
+
+ <Resource id="MyJmsConnectionFactory" type="javax.jms.ConnectionFactory">
+ ResourceAdapter = MyJmsResourceAdapter
+ </Resource>
+
+ <Container id="MyJmsMdbContainer" ctype="MESSAGE">
+ ResourceAdapter = MyJmsResourceAdapter
+ </Container>
+
+ <Resource id="FooQueue" type="javax.jms.Queue"/>
+ <Resource id="BarTopic" type="javax.jms.Topic"/>
+</tomee>
+....
+
+The `BrokerXmlConfig` tells ActiveMQ to start on the tcp host/port
+`someHostName` and `61616`
+
+=== Internal ActiveMQ Broker with JDBC Persistence
+
+Adding the `DataSource` property to your `ActiveMQResourceAdapter`
+config will automatically setup JDBC Persistence using the
+`org.apache.activemq.store.jdbc.JDBCPersistenceAdapter`
+
+....
+<tomee>
+ <Resource id="MyJmsResourceAdapter" type="ActiveMQResourceAdapter">
+ BrokerXmlConfig = broker:(tcp://someHostName:61616)
+ ServerUrl = tcp://someHostName:61616
+ DataSource = MyDataSource
+ </Resource>
+
+ <Resource id="MyDataSource" type="javax.sql.DataSource">
+ JdbcDriver = org.hsqldb.jdbcDriver.
+ JdbcUrl = jdbc:hsqldb:file:data/hsqldb/hsqldb.
+ UserName = sa
+ Password = foo
+ </Resource>
+</tomee>
+....
+
+=== Internal ActiveMQ Broker with activemq.xml
+
+The activemq.xml file format requires a number of Spring dependencies,
+and is therefore not included in the distribution by default. This is
+purley due to the fact that this ActiveMQ file format is parsed using
+Spring libraries and this is beyond our control. However, the advantage
+is opening up the door to the huge number of configuration options
+available found here: http://activemq.apache.org/xml-configuration.html.
+
+This support can be enabled by adding the right libraries and creating
+an link:activemq.xml[`[tomee]/conf/activemq.xml`] file (Click the link
+for a basic example).
+
+Add the following jars to the `tomee/lib/` directory:
+
+* http://repo1.maven.org/maven2/org/springframework/spring-beans/3.2.9.RELEASE/spring-beans-3.2.9.RELEASE.jar[spring-beans-3.2.9.RELEASE.jar]
+* http://repo1.maven.org/maven2/org/springframework/spring-context/3.2.9.RELEASE/spring-context-3.2.9.RELEASE.jar[spring-context-3.2.9.RELEASE.jar]
+* http://repo1.maven.org/maven2/org/springframework/spring-core/3.2.9.RELEASE/spring-core-3.2.9.RELEASE.jar[spring-core-3.2.9.RELEASE.jar]
+* http://repo1.maven.org/maven2/org/springframework/spring-web/3.2.9.RELEASE/spring-web-3.2.9.RELEASE.jar[spring-web-3.2.9.RELEASE.jar]
+* http://repo1.maven.org/maven2/org/apache/xbean/xbean-spring/3.2.9.RELEASE/xbean-spring-3.9.jar[xbean-spring-3.9.jar]
+
+Later versions should work, but have not been tested.
+
+Create an link:activemq.xml[activemq.xml file] a in
+`[tomee]/conf/activemq.xml`.
+
+Then use the `xbean:file:` url prefix in the `BrokerXmlConfig` as shown
+belog.
+
+....
+<tomee>
+ <Resource id="MyJmsResourceAdapter" type="ActiveMQResourceAdapter">
+ BrokerXmlConfig = xbean:file:conf/activemq.xml
+ ServerUrl = tcp://someHostName:61616
+ </Resource>
+
+ <Resource id="MyJmsConnectionFactory" type="javax.jms.ConnectionFactory">
+ ResourceAdapter = MyJmsResourceAdapter
+ </Resource>
+
+ <Container id="MyJmsMdbContainer" ctype="MESSAGE">
+ ResourceAdapter = MyJmsResourceAdapter
+ </Container>
+
+ <Resource id="FooQueue" type="javax.jms.Queue"/>
+ <Resource id="BarTopic" type="javax.jms.Topic"/>
+</tomee>
+....
+
+Finally, restart the server.
+
+== Configuration via System properties
+
+The same can be done via properties in an embedded configuration, via
+the `conf/system.properties` file or on the command line via `-D` flags.
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY, LocalInitialContextFactory.class.getName());
+
+p.put("MyJmsResourceAdapter", "new://Resource?type=ActiveMQResourceAdapter");
+p.put("MyJmsResourceAdapter.ServerUrl", "tcp://someHostName:61616");
+p.put("MyJmsResourceAdapter.BrokerXmlConfig", "");
+
+p.put("MyJmsConnectionFactory", "new://Resource?type=javax.jms.ConnectionFactory");
+p.put("MyJmsConnectionFactory.ResourceAdapter", "MyJmsResourceAdapter");
+
+p.put("MyJmsMdbContainer", "new://Container?type=MESSAGE");
+p.put("MyJmsMdbContainer.ResourceAdapter", "MyJmsResourceAdapter");
+
+p.put("FooQueue", "new://Resource?type=javax.jms.Queue");
+p.put("BarTopic", "new://Resource?type=javax.jms.Topic");
+
+InitialContext context = new InitialContext(p);
+....
+
+== Global lookup of JMS Resources
+
+From anywhere in the same VM as the EJB Container you could lookup the
+above resources like so:
+
+....
+javax.jms.ConnectionFactory cf = (ConnectionFactory)
+ context.lookup("openejb:Resource/MyJmsConnectionFactory");
+
+javax.jms.Queue queue = (Queue) context.lookup("openejb:Resource/FooQueue");
+javax.jms.Topic topic = (Topic) context.lookup("openejb:Resource/BarTopic");
+....
+
+== MDB ActivationConfig
+
+Here, the value for `destination` is the physical name of the desired
+destination. The value for `destinationType` is the class name that
+defines the type of destination. It should be `javax.jms.Queue` or
+`javax.jms.Topic`.
+
+The Activation Spec properties that can be configured are:
+
+Property Name
+
+Required
+
+Default Value
+
+Description
+
+acknowledgeMode
+
+no
+
+Auto-acknowledge
+
+The JMS Acknowledgement mode to use. Valid values are: Auto-acknowledge
+or Dups-ok-acknowledge
+
+clientId
+
+no
+
+set in resource adapter
+
+The JMS Client ID to use (only really required for durable topics)
+
+destinationType
+
+yes
+
+null
+
+The type of destination; a queue or topic
+
+destination
+
+yes
+
+null
+
+The destination name (queue or topic name)
+
+enableBatch
+
+no
+
+false
+
+Used to enable transaction batching for increased performance
+
+maxMessagesPerBatch
+
+no
+
+10
+
+The number of messages per transaction batch
+
+maxMessagesPerSessions
+
+no
+
+10
+
+This is actually the prefetch size for the subscription. (Yes, badly
+named).
+
+maxSessions
+
+no
+
+10
+
+The maximum number of concurrent sessions to use
+
+messageSelector
+
+no
+
+null
+
+Message Selector to use on the subscription to perform content based
+routing filtering the messages
+
+noLocal
+
+no
+
+false
+
+Only required for topic subscriptions; indicates if locally published
+messages should be included in the subscription or not
+
+password
+
+no
+
+set in resource adapter
+
+The password for the JMS connection
+
+subscriptionDurability
+
+no
+
+NonDurable
+
+Whether or not a durable (topic) subscription is required. Valid values
+are: Durable or NonDurable
+
+subscriptionName
+
+no
+
+null
+
+The name of the durable subscriber. Only used for durable topics and
+combined with the clientID to uniquely identify the durable topic
+subscription
+
+userName
+
+no
+
+set in resource adapter
+
+The user for the JMS connection
+
+useRAManagedTransaction
+
+no
+
+false
+
+Typically, a resource adapter delivers messages to an endpoint which is
+managed by a container. Normally, this container likes to be the one
+that wants to control the transaction that the inbound message is being
+delivered on. But sometimes, you want to deliver to a simpler container
+system that will not be controlling the inbound transaction. In these
+cases, if you set useRAManagedTransaction to true, the resource adapter
+will commit the transaction if no exception was generated from the
+MessageListener and rollback if an exception is thrown.
+
+initialRedeliveryDelay
+
+no
+
+1000
+
+The delay before redeliveries start. Also configurable on the
+ResourceAdapter
+
+maximumRedeliveries
+
+no
+
+5
+
+The maximum number of redeliveries or -1 for no maximum. Also
+configurable on the ResourceAdapter
+
+redeliveryBackOffMultiplier
+
+no
+
+5
+
+The multiplier to use if exponential back off is enabled. Also
+configurable on the ResourceAdapter
+
+redeliveryUseExponentialBackOff
+
+no
+
+false
+
+To enable exponential backoff. Also configurable on the ResourceAdapter
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jms-resources-and-mdb-container.md
----------------------------------------------------------------------
diff --git a/docs/jms-resources-and-mdb-container.md b/docs/jms-resources-and-mdb-container.md
deleted file mode 100644
index bcb365d..0000000
--- a/docs/jms-resources-and-mdb-container.md
+++ /dev/null
@@ -1,283 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=JMS Resources and MDB Container
-~~~~~~
-
-# External ActiveMQ Broker
-
- <tomee>
- <Resource id="MyJmsResourceAdapter" type="ActiveMQResourceAdapter">
- # Do not start the embedded ActiveMQ broker
- BrokerXmlConfig =
- ServerUrl = tcp://someHostName:61616
- </Resource>
-
- <Resource id="MyJmsConnectionFactory" type="javax.jms.ConnectionFactory">
- ResourceAdapter = MyJmsResourceAdapter
- </Resource>
-
- <Container id="MyJmsMdbContainer" ctype="MESSAGE">
- ResourceAdapter = MyJmsResourceAdapter
- </Container>
-
- <Resource id="FooQueue" type="javax.jms.Queue"/>
- <Resource id="BarTopic" type="javax.jms.Topic"/>
- </tomee>
-
-
-The `ServerUrl` would be changed to point to the host and port of the
-ActiveMQ process. The various URL formats that ActiveMQ supports also
-work, such as 'failover:'.
-
-# Internal ActiveMQ Broker
-
- <tomee>
- <Resource id="MyJmsResourceAdapter" type="ActiveMQResourceAdapter">
- BrokerXmlConfig = broker:(tcp://someHostName:61616)
- ServerUrl = tcp://someHostName:61616
- </Resource>
-
- <Resource id="MyJmsConnectionFactory" type="javax.jms.ConnectionFactory">
- ResourceAdapter = MyJmsResourceAdapter
- </Resource>
-
- <Container id="MyJmsMdbContainer" ctype="MESSAGE">
- ResourceAdapter = MyJmsResourceAdapter
- </Container>
-
- <Resource id="FooQueue" type="javax.jms.Queue"/>
- <Resource id="BarTopic" type="javax.jms.Topic"/>
- </tomee>
-
-The `BrokerXmlConfig` tells ActiveMQ to start on the tcp host/port `someHostName` and `61616`
-
-## Internal ActiveMQ Broker with JDBC Persistence
-
-Adding the `DataSource` property to your `ActiveMQResourceAdapter` config will automatically setup JDBC Persistence using the
-`org.apache.activemq.store.jdbc.JDBCPersistenceAdapter`
-
- <tomee>
- <Resource id="MyJmsResourceAdapter" type="ActiveMQResourceAdapter">
- BrokerXmlConfig = broker:(tcp://someHostName:61616)
- ServerUrl = tcp://someHostName:61616
- DataSource = MyDataSource
- </Resource>
-
- <Resource id="MyDataSource" type="javax.sql.DataSource">
- JdbcDriver = org.hsqldb.jdbcDriver.
- JdbcUrl = jdbc:hsqldb:file:data/hsqldb/hsqldb.
- UserName = sa
- Password = foo
- </Resource>
- </tomee>
-
-
-
-## Internal ActiveMQ Broker with activemq.xml
-
-The [activemq.xml](activemq.xml) file format requires a number of Spring dependencies, and is therefore not included in the distribution by default. This is purley due to the fact that this ActiveMQ file format is parsed using Spring libraries and this is beyond our control. However, the advantage is opening up the door to the huge number of configuration options available found here: [http://activemq.apache.org/xml-configuration.html](http://activemq.apache.org/xml-configuration.html).
-
-This support can be enabled by adding the right libraries and creating an [`[tomee]/conf/activemq.xml`](activemq.xml) file (Click the link for a basic example).
-
-Add the following jars to the `tomee/lib/` directory:
-
-- [spring-beans-3.2.9.RELEASE.jar](http://repo1.maven.org/maven2/org/springframework/spring-beans/3.2.9.RELEASE/spring-beans-3.2.9.RELEASE.jar)
-- [spring-context-3.2.9.RELEASE.jar](http://repo1.maven.org/maven2/org/springframework/spring-context/3.2.9.RELEASE/spring-context-3.2.9.RELEASE.jar)
-- [spring-core-3.2.9.RELEASE.jar](http://repo1.maven.org/maven2/org/springframework/spring-core/3.2.9.RELEASE/spring-core-3.2.9.RELEASE.jar)
-- [spring-web-3.2.9.RELEASE.jar](http://repo1.maven.org/maven2/org/springframework/spring-web/3.2.9.RELEASE/spring-web-3.2.9.RELEASE.jar)
-- [xbean-spring-3.9.jar](http://repo1.maven.org/maven2/org/apache/xbean/xbean-spring/3.2.9.RELEASE/xbean-spring-3.9.jar)
-
-Later versions should work, but have not been tested.
-
-Create an [activemq.xml file](activemq.xml) a in `[tomee]/conf/activemq.xml`.
-
-Then use the `xbean:file:` url prefix in the `BrokerXmlConfig` as shown belog.
-
-
- <tomee>
- <Resource id="MyJmsResourceAdapter" type="ActiveMQResourceAdapter">
- BrokerXmlConfig = xbean:file:conf/activemq.xml
- ServerUrl = tcp://someHostName:61616
- </Resource>
-
- <Resource id="MyJmsConnectionFactory" type="javax.jms.ConnectionFactory">
- ResourceAdapter = MyJmsResourceAdapter
- </Resource>
-
- <Container id="MyJmsMdbContainer" ctype="MESSAGE">
- ResourceAdapter = MyJmsResourceAdapter
- </Container>
-
- <Resource id="FooQueue" type="javax.jms.Queue"/>
- <Resource id="BarTopic" type="javax.jms.Topic"/>
- </tomee>
-
-Finally, restart the server.
-
-
-# Configuration via System properties
-
-The same can be done via properties in an embedded configuration, via the
-`conf/system.properties` file or on the command line via `-D` flags.
-
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, LocalInitialContextFactory.class.getName());
-
- p.put("MyJmsResourceAdapter", "new://Resource?type=ActiveMQResourceAdapter");
- p.put("MyJmsResourceAdapter.ServerUrl", "tcp://someHostName:61616");
- p.put("MyJmsResourceAdapter.BrokerXmlConfig", "");
-
- p.put("MyJmsConnectionFactory", "new://Resource?type=javax.jms.ConnectionFactory");
- p.put("MyJmsConnectionFactory.ResourceAdapter", "MyJmsResourceAdapter");
-
- p.put("MyJmsMdbContainer", "new://Container?type=MESSAGE");
- p.put("MyJmsMdbContainer.ResourceAdapter", "MyJmsResourceAdapter");
-
- p.put("FooQueue", "new://Resource?type=javax.jms.Queue");
- p.put("BarTopic", "new://Resource?type=javax.jms.Topic");
-
- InitialContext context = new InitialContext(p);
-
-# Global lookup of JMS Resources
-
-From anywhere in the same VM as the EJB Container you could lookup the
-above resources like so:
-
- javax.jms.ConnectionFactory cf = (ConnectionFactory)
- context.lookup("openejb:Resource/MyJmsConnectionFactory");
-
- javax.jms.Queue queue = (Queue) context.lookup("openejb:Resource/FooQueue");
- javax.jms.Topic topic = (Topic) context.lookup("openejb:Resource/BarTopic");
-
-# MDB ActivationConfig
-
-
-Here, the value for `destination` is the physical name of the desired destination. The value for
-`destinationType` is the class name that defines the type of destination. It should be `javax.jms.Queue` or `javax.jms.Topic`.
-
-The Activation Spec properties that can be configured are:
-
-<TABLE><TBODY>
-<TR>
-<TH> Property Name </TH>
-<TH> Required </TH>
-<TH> Default Value </TH>
-<TH> Description </TH>
-</TR>
-<TR>
-<TD> acknowledgeMode </TD>
-<TD> no </TD>
-<TD> Auto-acknowledge </TD>
-<TD> The JMS Acknowledgement mode to use. Valid values are: Auto-acknowledge or Dups-ok-acknowledge </TD>
-</TR>
-<TR>
-<TD> clientId </TD>
-<TD> no </TD>
-<TD> set in resource adapter </TD>
-<TD> The JMS Client ID to use (only really required for durable topics) </TD>
-</TR>
-<TR>
-<TD> destinationType </TD>
-<TD> yes </TD>
-<TD> null </TD>
-<TD> The type of destination; a queue or topic </TD>
-</TR>
-<TR>
-<TD> destination </TD>
-<TD> yes </TD>
-<TD> null </TD>
-<TD> The destination name (queue or topic name) </TD>
-</TR>
-<TR>
-<TD> enableBatch </TD>
-<TD> no </TD>
-<TD> false </TD>
-<TD> Used to enable transaction batching for increased performance </TD>
-</TR>
-<TR>
-<TD> maxMessagesPerBatch </TD>
-<TD> no </TD>
-<TD> 10 </TD>
-<TD> The number of messages per transaction batch </TD>
-</TR>
-<TR>
-<TD> maxMessagesPerSessions </TD>
-<TD> no </TD>
-<TD> 10 </TD>
-<TD> This is actually the prefetch size for the subscription. (Yes, badly named). </TD>
-</TR>
-<TR>
-<TD> maxSessions </TD>
-<TD> no </TD>
-<TD> 10 </TD>
-<TD> The maximum number of concurrent sessions to use </TD>
-</TR>
-<TR>
-<TD> messageSelector </TD>
-<TD> no </TD>
-<TD> null </TD>
-<TD>Message Selector</A> to use on the subscription to perform content based routing filtering the messages </TD>
-</TR>
-<TR>
-<TD> noLocal </TD>
-<TD> no </TD>
-<TD> false </TD>
-<TD> Only required for topic subscriptions; indicates if locally published messages should be included in the subscription or not </TD>
-</TR>
-<TR>
-<TD> password </TD>
-<TD> no </TD>
-<TD> set in resource adapter </TD>
-<TD> The password for the JMS connection </TD>
-</TR>
-<TR>
-<TD> subscriptionDurability </TD>
-<TD> no </TD>
-<TD> NonDurable </TD>
-<TD> Whether or not a durable (topic) subscription is required. Valid values are: Durable or NonDurable </TD>
-</TR>
-<TR>
-<TD> subscriptionName </TD>
-<TD> no </TD>
-<TD> null </TD>
-<TD> The name of the durable subscriber. Only used for durable topics and combined with the clientID to uniquely identify the durable topic subscription </TD>
-</TR>
-<TR>
-<TD> userName </TD>
-<TD> no </TD>
-<TD> set in resource adapter </TD>
-<TD> The user for the JMS connection </TD>
-</TR>
-<TR>
-<TD> useRAManagedTransaction </TD>
-<TD> no </TD>
-<TD> false </TD>
-<TD> Typically, a resource adapter delivers messages to an endpoint which is managed by a container. Normally, this container likes to be the one that wants to control the transaction that the inbound message is being delivered on. But sometimes, you want to deliver to a simpler container system that will not be controlling the inbound transaction. In these cases, if you set useRAManagedTransaction to true, the resource adapter will commit the transaction if no exception was generated from the MessageListener and rollback if an exception is thrown. </TD>
-</TR>
-<TR>
-<TD> initialRedeliveryDelay </TD>
-<TD> no </TD>
-<TD> 1000 </TD>
-<TD> The delay before redeliveries start. Also configurable on the ResourceAdapter </TD>
-</TR>
-<TR>
-<TD> maximumRedeliveries </TD>
-<TD> no </TD>
-<TD> 5 </TD>
-<TD> The maximum number of redeliveries or -1 for no maximum. Also configurable on the ResourceAdapter </TD>
-</TR>
-<TR>
-<TD> redeliveryBackOffMultiplier </TD>
-<TD> no </TD>
-<TD> 5 </TD>
-<TD> The multiplier to use if exponential back off is enabled. Also configurable on the ResourceAdapter </TD>
-</TR>
-<TR>
-<TD> redeliveryUseExponentialBackOff </TD>
-<TD> no </TD>
-<TD> false </TD>
-<TD> To enable exponential backoff. Also configurable on the ResourceAdapter </TD>
-</TR>
-</TBODY></TABLE>
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jmsconnectionfactory-config.adoc
----------------------------------------------------------------------
diff --git a/docs/jmsconnectionfactory-config.adoc b/docs/jmsconnectionfactory-config.adoc
new file mode 100644
index 0000000..c0327e5
--- /dev/null
+++ b/docs/jmsconnectionfactory-config.adoc
@@ -0,0 +1,102 @@
+# JmsConnectionFactory Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A JmsConnectionFactory can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Resource id="myJmsConnectionFactory" type="javax.jms.ConnectionFactory">
+ connectionMaxIdleTime = 15 Minutes
+ connectionMaxWaitTime = 5 seconds
+ poolMaxSize = 10
+ poolMinSize = 0
+ resourceAdapter = Default JMS Resource Adapter
+ transactionSupport = xa
+</Resource>
+....
+
+Alternatively, a JmsConnectionFactory can be declared via properties in
+the `<tomee-home>/conf/system.properties` file or via Java
+VirtualMachine `-D` properties. The properties can also be used when
+embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or
+`InitialContext`
+
+....
+myJmsConnectionFactory = new://Resource?type=javax.jms.ConnectionFactory
+myJmsConnectionFactory.connectionMaxIdleTime = 15 Minutes
+myJmsConnectionFactory.connectionMaxWaitTime = 5 seconds
+myJmsConnectionFactory.poolMaxSize = 10
+myJmsConnectionFactory.poolMinSize = 0
+myJmsConnectionFactory.resourceAdapter = Default JMS Resource Adapter
+myJmsConnectionFactory.transactionSupport = xa
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared JmsConnectionFactory
+a warning will be logged. If a JmsConnectionFactory is needed by the
+application and one is not declared, TomEE will create one dynamically
+using default settings. Multiple JmsConnectionFactory declarations are
+allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+connectionMaxIdleTime
+
+time
+
+15 Minutes
+
+Maximum amount of time a connection can be idle before being reclaimed
+
+connectionMaxWaitTime
+
+time
+
+5 seconds
+
+Maximum amount of time to wait for a connection
+
+poolMaxSize
+
+int
+
+10
+
+Maximum number of physical connection to the ActiveMQ broker
+
+poolMinSize
+
+int
+
+0
+
+Minimum number of physical connection to the ActiveMQ broker
+
+resourceAdapter
+
+String
+
+Default JMS Resource Adapter
+
+transactionSupport
+
+String
+
+xa
+
+Specifies if the connection is enrolled in global transaction allowed
+values: xa, local or none
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jmsconnectionfactory-config.md
----------------------------------------------------------------------
diff --git a/docs/jmsconnectionfactory-config.md b/docs/jmsconnectionfactory-config.md
deleted file mode 100644
index 4a43833..0000000
--- a/docs/jmsconnectionfactory-config.md
+++ /dev/null
@@ -1,87 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=JmsConnectionFactory Configuration
-~~~~~~
-
-
-A JmsConnectionFactory can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Resource id="myJmsConnectionFactory" type="javax.jms.ConnectionFactory">
- connectionMaxIdleTime = 15 Minutes
- connectionMaxWaitTime = 5 seconds
- poolMaxSize = 10
- poolMinSize = 0
- resourceAdapter = Default JMS Resource Adapter
- transactionSupport = xa
- </Resource>
-
-Alternatively, a JmsConnectionFactory can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myJmsConnectionFactory = new://Resource?type=javax.jms.ConnectionFactory
- myJmsConnectionFactory.connectionMaxIdleTime = 15 Minutes
- myJmsConnectionFactory.connectionMaxWaitTime = 5 seconds
- myJmsConnectionFactory.poolMaxSize = 10
- myJmsConnectionFactory.poolMinSize = 0
- myJmsConnectionFactory.resourceAdapter = Default JMS Resource Adapter
- myJmsConnectionFactory.transactionSupport = xa
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared JmsConnectionFactory a warning will be logged. If a JmsConnectionFactory is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple JmsConnectionFactory declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td>connectionMaxIdleTime</td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>15 Minutes</td>
- <td>
-Maximum amount of time a connection can be idle before being reclaimed
-</td>
-</tr>
-<tr>
- <td>connectionMaxWaitTime</td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>5 seconds</td>
- <td>
-Maximum amount of time to wait for a connection
-</td>
-</tr>
-<tr>
- <td>poolMaxSize</td>
- <td>int</td>
- <td>10</td>
- <td>
-Maximum number of physical connection to the ActiveMQ broker
-</td>
-</tr>
-<tr>
- <td>poolMinSize</td>
- <td>int</td>
- <td>0</td>
- <td>
-Minimum number of physical connection to the ActiveMQ broker
-</td>
-</tr>
-<tr>
- <td>resourceAdapter</td>
- <td>String</td>
- <td>Default JMS Resource Adapter</td>
- <td>
-
-</td>
-</tr>
-<tr>
- <td>transactionSupport</td>
- <td>String</td>
- <td>xa</td>
- <td>
-Specifies if the connection is enrolled in global transaction
-allowed values: xa, local or none
-</td>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jndi-names.adoc
----------------------------------------------------------------------
diff --git a/docs/jndi-names.adoc b/docs/jndi-names.adoc
new file mode 100644
index 0000000..916c3de
--- /dev/null
+++ b/docs/jndi-names.adoc
@@ -0,0 +1,390 @@
+# JNDI Names
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# What's My Bean's JNDI Name? There are two things to keep in mind
+before you start reading:
+
+1 OpenEJB provides a default JNDI name to your EJB. +
+2 You can customize the JNDI name.
+
+== Default JNDI name The default JNDI name is in the following format:
+
+....
+{deploymentId}{interfaceType.annotationName}
+....
+
+Lets try and understand the above format. Both _deploymentId_ and
+_interfaceType.annotationName_ are pre-defined variables. There are
+other pre-defined variables available which you could use to customize
+the JNDI name format.
+
+# JNDI Name Formatting
+
+The _openejb.jndiname.format_ property allows you to supply a template
+for the global JNDI names of all your EJBs. With it, you have complete
+control over the structure of the JNDI layout can institute a design
+pattern just right for your client apps. See the
+link:service-locator.html[Service Locator] doc for clever ways to use
+the JNDI name formatting functionality in client code.
+
+variable
+
+description
+
+moduleId
+
+Typically the name of the ejb-jar file or the id value if specified
+
+ejbType
+
+STATEFUL, STATELESS, BMP_ENTITY, CMP_ENTITY, or MESSAGE_DRIVEN
+
+ejbClass
+
+for a class named org.acme.superfun.WidgetBean results in
+org.acme.superfun.WidgetBean
+
+ejbClass.simpleName
+
+for a class named org.acme.superfun.WidgetBean results in WidgetBean
+
+ejbClass.packageName
+
+for a class named org.acme.superfun.WidgetBean results in
+org.acme.superfun
+
+ejbName
+
+The ejb-name as specified in xml or via the 'name' attribute in an
+@Stateful, @Stateless, or @MessageDriven annotation
+
+deploymentId
+
+The unique system id for the ejb. Typically the ejbName unless specified
+in the openejb-jar.xml or via changing the openejb.deploymentId.format
+
+interfaceType
+
+see interfaceType.annotationName
+
+interfaceType.annotationName
+
+Following the EJB 3 annotations @RemoteHome, @LocalHome, @Remote and
+@Local RemoteHome (EJB 2 EJBHome) LocalHome (EJB 2 EJBLocalHome) Remote
+(EJB 3 Business Remote) Local (EJB 3 Business Local) Endpoint (EJB
+webservice endpoint)
+
+interfaceType.annotationNameLC
+
+This is the same as interfaceType.annotationName, but all in lower case.
+
+interfaceType.xmlName
+
+Following the ejb-jar.xml descriptor elements , , , , and : home (EJB 2
+EJBHome) local-home (EJB 2 EJBLocalHome) business-remote (EJB 3 Business
+Remote) business-local (EJB 3 Business Local) service-endpoint (EJB
+webservice endpoint)
+
+interfaceType.xmlNameCc
+
+Camel-case version of interfaceType.xmlName: Home (EJB 2 EJBHome)
+LocalHome (EJB 2 EJBLocalHome) BusinessRemote (EJB 3 Business Remote)
+BusinessLocal (EJB 3 Business Local) ServiceEndpoint (EJB webservice
+endpoint)
+
+interfaceType.openejbLegacyName
+
+Following the OpenEJB 1.0 hard-coded format: (empty string) (EJB 2
+EJBHome) Local (EJB 2 EJBLocalHome) BusinessRemote (EJB 3 Business
+Remote) BusinessLocal (EJB 3 Business Local) ServiceEndpoint (EJB
+webservice endpoint)
+
+interfaceClass
+
+(business) for a class named org.acme.superfun.WidgetRemote results in
+org.acme.superfun.WidgetRemote (home) for a class named
+org.acme.superfun.WidgetHome results in org.acme.superfun.WidgetHome
+
+interfaceClass.simpleName
+
+(business) for a class named org.acme.superfun.WidgetRemote results in
+WidgetRemote (home) for a class named org.acme.superfun.WidgetHome
+results in WidgetHome
+
+interfaceClass.packageName
+
+for a class named org.acme.superfun.WidgetRemote results in
+org.acme.superfun
+
+# Setting the JNDI name
+
+It's possible to set the desired jndi name format for the whole server
+level, an ejb-jar, an ejb, an ejb's "local" interface
+(local/remote/local-home/home), and for an individual interface the ejb
+implements. More specific jndi name formats act as an override to any
+more general formats. The most specific format dictates the jndi name
+that will be used for any given interface of an ejb. It's possible to
+specify a general format for your server, override it at an ejb level
+and override that further for a specific interface of that ejb.
+
+== Via System property
+
+The jndi name format can be set on a server level via a _system
+property_, for example:
+
+....
+$ ./bin/openejb start
+-Dopenejb.jndiname.format=\{ejbName}/\{interfaceClass}"
+....
+
+As usual, other ways of specifying system properties are via the
+conf/system.properties file in a standalone server, or via the
+InitialContext properties when embedded.
+
+== Via properties in the openejb-jar.xml
+
+It's possible to set the openejb.jndiname.format for an ejb-jar jar in a
+META-INF/openejb-jar.xml file as follows:
+
+....
+<openejb-jar>
+ <properties>
+ openejb.deploymentId.format = {ejbName}
+ openejb.jndiname.format = {deploymentId}{interfaceType.annotationName}
+ </properties>
+</openejb-jar>
+....
+
+== Via the tag for a specific ejb
+
+The following sets the name specifically for the interface
+org.superbiz.Foo.
+
+....
+<openejb-jar>
+ <ejb-deployment ejb-name="FooBean">
+ <jndi name="foo" interface="org.superbiz.Foo"/>
+ </ejb-deployment>
+</openejb-jar>
+....
+
+Or more generally...
+
+....
+<openejb-jar>
+ <ejb-deployment ejb-name="FooBean">
+ <jndi name="foo" interface="Remote"/>
+ </ejb-deployment>
+</openejb-jar>
+....
+
+Or more generally still...
+
+....
+<openejb-jar>
+ <ejb-deployment ejb-name="FooBean">
+ <jndi name="foo"/>
+ </ejb-deployment>
+</openejb-jar>
+....
+
+The 'name' attribute can still use templates if it likes, such as:
+
+....
+<openejb-jar>
+ <ejb-deployment ejb-name="FooBean">
+ <jndi name="ejb/{interfaceClass.simpleName}" interface="org.superbiz.Foo"/>
+ </ejb-deployment>
+</openejb-jar>
+....
+
+=== Multiple tags
+
+Multiple tags are allowed making it possible for you to be as specific
+as you need about the jndi name of each interface or each logical group
+of iterfaces (Local, Remote, LocalHome, RemoteHome).
+
+Given an ejb, FooBean, with the following interfaces: - business-local:
+org.superbiz.LocalOne - business-local: org.superbiz.LocalTwo -
+business-remote: org.superbiz.RemoteOne - business-remote:
+org.superbiz.RemoteTwo - home: org.superbiz.FooHome - local-home:
+org.superbiz.FooLocalHome
+
+The following four examples would yield the same jndi names. The
+intention with these examples is to show the various ways you can
+isolate specific interfaces or types of interfaces to gain more specific
+control on how they are named.
+
+....
+<openejb-jar>
+ <ejb-deployment ejb-name="FooBean">
+ <jndi name="LocalOne" interface="org.superbiz.LocalOne"/>
+ <jndi name="LocalTwo" interface="org.superbiz.LocalTwo"/>
+ <jndi name="RemoteOne" interface="org.superbiz.RemoteOne"/>
+ <jndi name="RemoteTwo" interface="org.superbiz.RemoteTwo"/>
+ <jndi name="FooHome" interface="org.superbiz.FooHome"/>
+ <jndi name="FooLocalHome" interface="org.superbiz.FooLocalHome"/>
+ </ejb-deployment>
+</openejb-jar>
+....
+
+Or
+
+....
+<openejb-jar>
+ <ejb-deployment ejb-name="FooBean">
+ <!-- applies to LocalOne and LocalTwo -->
+ <jndi name="{interfaceClass.simpleName}" interface="Local"/>
+
+ <!-- applies to RemoteOne and RemoteTwo -->
+ <jndi name="{interfaceClass.simpleName}" interface="Remote"/>
+
+ <!-- applies to FooHome -->
+ <jndi name="{interfaceClass.simpleName}" interface="RemoteHome"/>
+
+ <!-- applies to FooLocalHome -->
+ <jndi name="{interfaceClass.simpleName}" interface="LocalHome"/>
+ </ejb-deployment>
+</openejb-jar>
+....
+
+Or
+
+....
+<openejb-jar>
+ <ejb-deployment ejb-name="FooBean">
+ <!-- applies to RemoteOne, RemoteTwo, FooHome, and FooLocalHome -->
+ <jndi name="{interfaceClass.simpleName}"/>
+
+ <!-- these two would count as an override on the above format -->
+ <jndi name="LocalOne" interface="org.superbiz.LocalOne"/>
+ <jndi name="LocalTwo" interface="org.superbiz.LocalTwo"/>
+ </ejb-deployment>
+</openejb-jar>
+....
+
+or
+
+....
+<openejb-jar>
+ <ejb-deployment ejb-name="FooBean">
+ <!-- applies to LocalOne, LocalTwo, RemoteOne, RemoteTwo, FooHome, and FooLocalHome -->
+ <jndi name="{interfaceClass.simpleName}"/>
+ </ejb-deployment>
+</openejb-jar>
+....
+
+# Changing the Default Setting
+
+_You are responsible for ensuring the names don't conflict._
+
+=== Conservative settings
+
+A very conservative setting such as
+
+"\{deploymentId}/\{interfaceClass}"
+
+would guarantee that each and every single interface is bound to JNDI.
+If your bean had a legacy EJBObject interface, three business remote
+interfaces, and two business local interfaces, this pattern would result
+in +
+_six_ proxies bound into JNDI. +
+
+Bordeline optimistic: +
+
+The above two settings would work if you the interface wasn't shared by
+other beans.
+
+=== Pragmatic settings
+
+A more middle ground setting such as
+"\{deploymentId}/\{interfaceType.annotationName}" would guarantee that
+at least one proxy of each interface type is bound to JNDI. If your bean
+had a legacy EJBObject interface, three business remote interfaces, and
+two business local interfaces, this pattern would result in _three_
+proxies bound into JNDI: one proxy dedicated to your EJBObject
+interface; one proxy implementing all three business remote interfaces;
+one proxy implementing the two business local interfaces.
+
+Similarly pragmatic settings would be +
+
+=== Optimistic settings
+
+A very optimistic setting such as "\{deploymentId}" would guarantee only
+one proxy for the bean will be bound to JNDI. This would be fine if you
+knew you only had one type of interface in your beans. For example, only
+business remote interfaces, or only business local interfaces, or only
+an EJBObject interface, or only an EJBLocalObject interface.
+
+If a bean in the app did have more than one interface type, one business
+local and one business remote for example, by default OpenEJB will
+reject the app when it detects that it cannot bind the second interface.
+This strict behavior can be disabled by setting the
+_openejb.jndiname.failoncollision_ system property to _false_. When this
+property is set to false, we will simply log an error that the second
+proxy cannot be bound to JNDI, tell you which ejb is using that name,
+and continue loading your app.
+
+Similarly optimistic settings would be: +
+
+=== Advanced Details on EJB 3.0 Business Proxies (the simple part)
+
+If you implement your business interfaces, your life is simple as your
+proxies will also implement your business interfaces of the same type.
+Meaning any proxy OpenEJB creates for a business local interface will
+also implement your other business local interfaces. Similarly, any
+proxy OpenEJB creates for a business remote interface will also
+implement your other business remote interfaces.
+
+=== Advanced Details on EJB 3.0 Business Proxies (the complicated part)
+
+_Who should read?_ +
+Read this section of either of these two apply to you: +
+- You do not implement your business interfaces in your bean class +
+- One or more of your business remote interfaces extend from
+javax.rmi.Remote
+
+If neither of these two items describe your apps, then there is no need
+to read further. Go have fun.
+
+=== Not implementing business interfaces
+
+If you do not implement your business interfaces it may not be possible
+for us to implement all your business interfaces in a single interface.
+Conflicts in the throws clauses and the return values can occur as
+detailed link:multiple-business-interface-hazzards.html[here] . When
+creating a proxy for an interface we will detect and remove any other
+business interfaces that would conflict with the main interface.
+
+=== Business interfaces extending javax.rmi.Remote
+
+Per spec rules many runtime exceptions (container or connection related)
+are thrown from javax.rmi.Remote proxies as java.rmi.RemoteException
+which is not a runtime exception and must be throwable via the proxy as
+a checked exception. The issue is that conflicting throws clauses are
+actually removed for two interfaces sharing the same method signature.
+For example two methods such as these: +
+- InterfaceA: void doIt() throws Foo; +
+- InterfaceB: void doIt() throws RemoteException;
+
+can be implemented by trimming out the conflicting throws clauses as
+follows: +
+- Implementation: void doIt()\{}
+
+This is fine for a bean class as it does not need to throw the RMI
+required javax.rmi.RemoteException. However if we create a proxy from
+these two interfaces it will also wind up with a 'doIt()\{}' method that
+cannot throw javax.rmi.RemoteException. This is very bad as the
+container does need to throw RemoteException to any business interfaces
+extending java.rmi.Remote for any container related issues or connection
+issues. If the container attempts to throw a RemoteException from the
+proxies 'doIt()\{}' method, it will result in an
+UndeclaredThrowableException thrown by the VM.
+
+The only way to guarantee the proxy has the 'doIt() throws
+RemoteException \{}' method of InterfaceB is to cut out InterfaceA when
+we create the proxy dedicated to InterfaceB.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jndi-names.md
----------------------------------------------------------------------
diff --git a/docs/jndi-names.md b/docs/jndi-names.md
deleted file mode 100644
index 6e73234..0000000
--- a/docs/jndi-names.md
+++ /dev/null
@@ -1,372 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=JNDI Names
-~~~~~~
-
-<a name="JNDINames-What'sMyBean'sJNDIName?"></a>
-# What's My Bean's JNDI Name?
-There are two things to keep in mind before you start reading:
-
-1 OpenEJB provides a default JNDI name to your EJB.
-2 You can customize the JNDI name.
-
-<a name="JNDINames-DefaultJNDIname"></a>
-## Default JNDI name
-The default JNDI name is in the following format:
-
- {deploymentId}{interfaceType.annotationName}
-
-Lets try and understand the above format. Both *deploymentId* and
-*interfaceType.annotationName* are pre-defined variables. There are other
-pre-defined variables available which you could use to customize the JNDI
-name format.
-
-<a name="JNDINames-JNDINameFormatting"></a>
-# JNDI Name Formatting
-
-The *openejb.jndiname.format* property allows you to supply a template for
-the global JNDI names of all your EJBs. With it, you have complete control
-over the structure of the JNDI layout can institute a design pattern just
-right for your client apps. See the [Service Locator](service-locator.html)
- doc for clever ways to use the JNDI name formatting functionality in
-client code.
-<table class="mdtable">
-<tr><td>variable</td><td> description</td></tr>
-<tr><td>moduleId</td><td> Typically the name of the ejb-jar file<br> or the <ejb-jar id=""> id value if specified</td></tr>
-<tr><td>ejbType</td><td> STATEFUL, STATELESS, BMP_ENTITY, CMP_ENTITY, or MESSAGE_DRIVEN</td></tr>
-<tr><td>ejbClass</td><td> for a class named org.acme.superfun.WidgetBean results in org.acme.superfun.WidgetBean</td></tr>
-<tr><td>ejbClass.simpleName</td><td> for a class named org.acme.superfun.WidgetBean results in WidgetBean</td></tr>
-<tr><td>ejbClass.packageName</td><td> for a class named org.acme.superfun.WidgetBean results in org.acme.superfun</td></tr>
-<tr><td>ejbName</td><td> The ejb-name as specified in xml or via the 'name' attribute in an @Stateful, @Stateless, or @MessageDriven annotation</td></tr>
-<tr><td>deploymentId</td><td> The unique system id for the ejb. Typically the ejbName unless specified in the openejb-jar.xml or via changing the openejb.deploymentId.format</td></tr>
-<tr><td>interfaceType</td><td> see interfaceType.annotationName</td></tr>
-<tr><td>interfaceType.annotationName</td><td> Following the EJB 3 annotations @RemoteHome, @LocalHome, @Remote and @Local
-RemoteHome (EJB 2 EJBHome)
-LocalHome (EJB 2 EJBLocalHome)
-Remote (EJB 3 Business Remote)
-Local (EJB 3 Business Local)
-Endpoint (EJB webservice endpoint)</td></tr>
-<tr><td>interfaceType.annotationNameLC</td><td> This is the same as interfaceType.annotationName, but all in lower case.</td></tr>
-<tr><td>interfaceType.xmlName</td><td> Following the ejb-jar.xml descriptor elements <home>, <local-home>, <business-remote>, <business-local>, and <service-endpoint>:
-home (EJB 2 EJBHome)
-local-home (EJB 2 EJBLocalHome)
-business-remote (EJB 3 Business Remote)
-business-local (EJB 3 Business Local)
-service-endpoint (EJB webservice endpoint)</td></tr>
-<tr><td>interfaceType.xmlNameCc</td><td> Camel-case version of interfaceType.xmlName:
-Home (EJB 2 EJBHome)
-LocalHome (EJB 2 EJBLocalHome)
-BusinessRemote (EJB 3 Business Remote)
-BusinessLocal (EJB 3 Business Local)
-ServiceEndpoint (EJB webservice endpoint)</td></tr>
-<tr><td>interfaceType.openejbLegacyName</td><td>Following the OpenEJB 1.0 hard-coded format:
-(empty string) (EJB 2 EJBHome)
-Local (EJB 2 EJBLocalHome)
-BusinessRemote (EJB 3 Business Remote)
-BusinessLocal (EJB 3 Business Local)
-ServiceEndpoint (EJB webservice endpoint)</td></tr>
-<tr><td>interfaceClass</td><td>
-(business) for a class named org.acme.superfun.WidgetRemote results in org.acme.superfun.WidgetRemote<br>
-(home) for a class named org.acme.superfun.WidgetHome results in org.acme.superfun.WidgetHome</td></tr>
-<tr><td>interfaceClass.simpleName</td><td>
-(business) for a class named org.acme.superfun.WidgetRemote results in WidgetRemote
-(home) for a class named org.acme.superfun.WidgetHome results in WidgetHome</td></tr>
-<tr><td>interfaceClass.packageName</td><td> for a class named org.acme.superfun.WidgetRemote results in org.acme.superfun</td></tr>
-</table>
-<a name="JNDINames-SettingtheJNDIname"></a>
-# Setting the JNDI name
-
-It's possible to set the desired jndi name format for the whole server
-level, an ejb-jar, an ejb, an ejb's "local" interface
-(local/remote/local-home/home), and for an individual interface the ejb
-implements. More specific jndi name formats act as an override to any more
-general formats. The most specific format dictates the jndi name that will
-be used for any given interface of an ejb. It's possible to specify a
-general format for your server, override it at an ejb level and override
-that further for a specific interface of that ejb.
-
-<a name="JNDINames-ViaSystemproperty"></a>
-## Via System property
-
-The jndi name format can be set on a server level via a _system property_,
-for example:
-
-
- $ ./bin/openejb start
- -Dopenejb.jndiname.format=\{ejbName}/\{interfaceClass}"
-
-
-As usual, other ways of specifying system properties are via the
-conf/system.properties file in a standalone server, or via the
-InitialContext properties when embedded.
-
-<a name="JNDINames-Viapropertiesintheopenejb-jar.xml"></a>
-## Via properties in the openejb-jar.xml
-
-It's possible to set the openejb.jndiname.format for an ejb-jar jar in a
-META-INF/openejb-jar.xml file as follows:
-
-
- <openejb-jar>
- <properties>
- openejb.deploymentId.format = {ejbName}
- openejb.jndiname.format = {deploymentId}{interfaceType.annotationName}
- </properties>
- </openejb-jar>
-
-
-<a name="JNDINames-Viathe<jndi>tagforaspecificejb"></a>
-## Via the <jndi> tag for a specific ejb
-
-The following sets the name specifically for the interface
-org.superbiz.Foo.
-
-
- <openejb-jar>
- <ejb-deployment ejb-name="FooBean">
- <jndi name="foo" interface="org.superbiz.Foo"/>
- </ejb-deployment>
- </openejb-jar>
-
-
-Or more generally...
-
-
- <openejb-jar>
- <ejb-deployment ejb-name="FooBean">
- <jndi name="foo" interface="Remote"/>
- </ejb-deployment>
- </openejb-jar>
-
-
-Or more generally still...
-
-
- <openejb-jar>
- <ejb-deployment ejb-name="FooBean">
- <jndi name="foo"/>
- </ejb-deployment>
- </openejb-jar>
-
-
-The 'name' attribute can still use templates if it likes, such as:
-
-
- <openejb-jar>
- <ejb-deployment ejb-name="FooBean">
- <jndi name="ejb/{interfaceClass.simpleName}" interface="org.superbiz.Foo"/>
- </ejb-deployment>
- </openejb-jar>
-
-
-<a name="JNDINames-Multiple<jndi>tags"></a>
-### Multiple <jndi> tags
-
-Multiple <jndi> tags are allowed making it possible for you to be as
-specific as you need about the jndi name of each interface or each logical
-group of iterfaces (Local, Remote, LocalHome, RemoteHome).
-
-Given an ejb, FooBean, with the following interfaces:
- - business-local: org.superbiz.LocalOne
- - business-local: org.superbiz.LocalTwo
- - business-remote: org.superbiz.RemoteOne
- - business-remote: org.superbiz.RemoteTwo
- - home: org.superbiz.FooHome
- - local-home: org.superbiz.FooLocalHome
-
-The following four examples would yield the same jndi names. The intention
-with these examples is to show the various ways you can isolate specific
-interfaces or types of interfaces to gain more specific control on how they
-are named.
-
- <openejb-jar>
- <ejb-deployment ejb-name="FooBean">
- <jndi name="LocalOne" interface="org.superbiz.LocalOne"/>
- <jndi name="LocalTwo" interface="org.superbiz.LocalTwo"/>
- <jndi name="RemoteOne" interface="org.superbiz.RemoteOne"/>
- <jndi name="RemoteTwo" interface="org.superbiz.RemoteTwo"/>
- <jndi name="FooHome" interface="org.superbiz.FooHome"/>
- <jndi name="FooLocalHome" interface="org.superbiz.FooLocalHome"/>
- </ejb-deployment>
- </openejb-jar>
-
-Or
-
- <openejb-jar>
- <ejb-deployment ejb-name="FooBean">
- <!-- applies to LocalOne and LocalTwo -->
- <jndi name="{interfaceClass.simpleName}" interface="Local"/>
-
- <!-- applies to RemoteOne and RemoteTwo -->
- <jndi name="{interfaceClass.simpleName}" interface="Remote"/>
-
- <!-- applies to FooHome -->
- <jndi name="{interfaceClass.simpleName}" interface="RemoteHome"/>
-
- <!-- applies to FooLocalHome -->
- <jndi name="{interfaceClass.simpleName}" interface="LocalHome"/>
- </ejb-deployment>
- </openejb-jar>
-
-Or
-
- <openejb-jar>
- <ejb-deployment ejb-name="FooBean">
- <!-- applies to RemoteOne, RemoteTwo, FooHome, and FooLocalHome -->
- <jndi name="{interfaceClass.simpleName}"/>
-
- <!-- these two would count as an override on the above format -->
- <jndi name="LocalOne" interface="org.superbiz.LocalOne"/>
- <jndi name="LocalTwo" interface="org.superbiz.LocalTwo"/>
- </ejb-deployment>
- </openejb-jar>
-
-or
-
- <openejb-jar>
- <ejb-deployment ejb-name="FooBean">
- <!-- applies to LocalOne, LocalTwo, RemoteOne, RemoteTwo, FooHome, and FooLocalHome -->
- <jndi name="{interfaceClass.simpleName}"/>
- </ejb-deployment>
- </openejb-jar>
-
-
-<a name="JNDINames-ChangingtheDefaultSetting"></a>
-# Changing the Default Setting
-
-*You are responsible for ensuring the names don't conflict.*
-
-<a name="JNDINames-Conservativesettings"></a>
-### Conservative settings
-
-A very conservative setting such as
-
- "{deploymentId}/{interfaceClass}"
-
-would guarantee that each and every single interface is bound to JNDI. If
-your bean had a legacy EJBObject interface, three business remote
-interfaces, and two business local interfaces, this pattern would result in
-*six* proxies bound into JNDI.
-<pre>
- - {deploymentId}/{interfaceClass.simpleName}
- - {moduleId}/{ejbName}/{interfaceClass}
- - {ejbName}/{interfaceClass}
- - {moduleId}/{ejbClass}/{interfaceClass}
- - {ejbClass}/{interfaceClass}
- - {ejbClass}/{interfaceClass.simpleName}
- - {ejbClass.simpleName}/{interfaceClass.simpleName}
- - {interfaceClass}/{ejbName}
-</pre>
-Bordeline optimistic:
-<pre>
- - {moduleId}/{interfaceClass}
- - {interfaceClass}
-</pre>
-The above two settings would work if you the interface wasn't shared by
-other beans.
-
-<a name="JNDINames-Pragmaticsettings"></a>
-### Pragmatic settings
-
-A more middle ground setting such as
-"{deploymentId}/{interfaceType.annotationName}" would guarantee that at
-least one proxy of each interface type is bound to JNDI. If your bean had
-a legacy EJBObject interface, three business remote interfaces, and two
-business local interfaces, this pattern would result in *three* proxies
-bound into JNDI: one proxy dedicated to your EJBObject interface; one proxy
-implementing all three business remote interfaces; one proxy implementing
-the two business local interfaces.
-
-Similarly pragmatic settings would be
-<pre>
- - {moduleId}/{ejbClass}/{interfaceType.annotationName}
- - {ejbClass}/{interfaceType.xmlName}
- - {ejbClass.simpleName}/{interfaceType.xmlNameCc}
- - {interfaceType}/{ejbName}
- - {interfaceType}/{ejbClass}
-</pre>
-<a name="JNDINames-Optimisticsettings"></a>
-### Optimistic settings
-
-A very optimistic setting such as "{deploymentId}" would guarantee only
-one proxy for the bean will be bound to JNDI. This would be fine if you
-knew you only had one type of interface in your beans. For example, only
-business remote interfaces, or only business local interfaces, or only an
-EJBObject interface, or only an EJBLocalObject interface.
-
-If a bean in the app did have more than one interface type, one business
-local and one business remote for example, by default OpenEJB will reject
-the app when it detects that it cannot bind the second interface. This
-strict behavior can be disabled by setting the
-*openejb.jndiname.failoncollision* system property to _false_. When this
-property is set to false, we will simply log an error that the second proxy
-cannot be bound to JNDI, tell you which ejb is using that name, and
-continue loading your app.
-
-Similarly optimistic settings would be:
-<pre>
- - {ejbName}
- - {ejbClass}
- - {ejbClass.simpleName}
- - {moduleId}/{ejbClass.simpleName}
- - {moduleId}/{ejbName}
-</pre>
-<a name="JNDINames-AdvancedDetailsonEJB3.0BusinessProxies(thesimplepart)"></a>
-### Advanced Details on EJB 3.0 Business Proxies (the simple part)
-
-If you implement your business interfaces, your life is simple as your
-proxies will also implement your business interfaces of the same type.
-Meaning any proxy OpenEJB creates for a business local interface will also
-implement your other business local interfaces. Similarly, any proxy
-OpenEJB creates for a business remote interface will also implement your
-other business remote interfaces.
-
-<a name="JNDINames-AdvancedDetailsonEJB3.0BusinessProxies(thecomplicatedpart)"></a>
-### Advanced Details on EJB 3.0 Business Proxies (the complicated part)
-
-*Who should read?*
-Read this section of either of these two apply to you:
- - You do not implement your business interfaces in your bean class
- - One or more of your business remote interfaces extend from javax.rmi.Remote
-
-If neither of these two items describe your apps, then there is no need to
-read further. Go have fun.
-
-<a name="JNDINames-Notimplementingbusinessinterfaces"></a>
-### Not implementing business interfaces
-
-If you do not implement your business interfaces it may not be possible for
-us to implement all your business interfaces in a single interface.
-Conflicts in the throws clauses and the return values can occur as detailed [here](multiple-business-interface-hazzards.html)
-. When creating a proxy for an interface we will detect and remove any
-other business interfaces that would conflict with the main interface.
-
-<a name="JNDINames-Businessinterfacesextendingjavax.rmi.Remote"></a>
-### Business interfaces extending javax.rmi.Remote
-
-Per spec rules many runtime exceptions (container or connection related)
-are thrown from javax.rmi.Remote proxies as java.rmi.RemoteException which
-is not a runtime exception and must be throwable via the proxy as a checked
-exception. The issue is that conflicting throws clauses are actually
-removed for two interfaces sharing the same method signature. For example
-two methods such as these:
- - InterfaceA: void doIt() throws Foo;
- - InterfaceB: void doIt() throws RemoteException;
-
-can be implemented by trimming out the conflicting throws clauses as
-follows:
- - Implementation: void doIt(){}
-
-This is fine for a bean class as it does not need to throw the RMI required
-javax.rmi.RemoteException. However if we create a proxy from these two
-interfaces it will also wind up with a 'doIt(){}' method that cannot throw
-javax.rmi.RemoteException. This is very bad as the container does need to
-throw RemoteException to any business interfaces extending java.rmi.Remote
-for any container related issues or connection issues. If the container
-attempts to throw a RemoteException from the proxies 'doIt(){}' method, it
-will result in an UndeclaredThrowableException thrown by the VM.
-
-The only way to guarantee the proxy has the 'doIt() throws RemoteException
-{}' method of InterfaceB is to cut out InterfaceA when we create the proxy
-dedicated to InterfaceB.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jpa-concepts.adoc
----------------------------------------------------------------------
diff --git a/docs/jpa-concepts.adoc b/docs/jpa-concepts.adoc
new file mode 100644
index 0000000..0c74735
--- /dev/null
+++ b/docs/jpa-concepts.adoc
@@ -0,0 +1,223 @@
+# JPA Concepts
+:index-group: JPA
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# JPA 101
+
+If there's one thing you have to understand to successfully use JPA
+(Java Persistence API) it's the concept of a _Cache_. Almost everything
+boils down to the Cache at one point or another. Unfortunately the Cache
+is an internal thing and not exposed via the JPA API classes, so it not
+easy to touch or feel from a coding perspective.
+
+Here's a quick cheat sheet of the JPA world:
+
+* A *Cache* is a *copy of data*, copy meaning pulled from but living
+outside the database.
+* *Flushing* a Cache is the act of putting modified data back into the
+database.
+* A *PersistenceContext* is essentially a Cache. It also tends to have
+it's own non-shared database connection.
+* An *EntityManager* represents a PersistenceContext (and therefore a
+Cache)
+* An *EntityManagerFactory* creates an EntityManager (and therefore a
+PersistenceContext/Cache)
+
+Comparing `RESOURCE_LOCAL` and `JTA` persistence contexts
+
+With <persistence-unit transaction-type="*RESOURCE_LOCAL*"> *you* are
+responsible for EntityManager (PersistenceContext/Cache) creating and
+tracking...
+
+* You *must* use the *EntityManagerFactory* to get an EntityManager
+* The resulting *EntityManager* instance *is* a PersistenceContext/Cache
+* An *EntityManagerFactory* can be injected via the *@PersistenceUnit*
+annotation only (not @PersistenceContext)
+* You are *not* allowed to use @PersistenceContext to refer to a unit of
+type RESOURCE_LOCAL
+* You *must* use the *EntityTransaction* API to begin/commit around
+*every* call to your EntityManger
+* Calling entityManagerFactory.createEntityManager() twice results in
+*two* separate EntityManager instances and therefor *two* separate
+PersistenceContexts/Caches.
+* It is *almost never* a good idea to have more than one *instance* of
+an EntityManager in use (don't create a second one unless you've
+destroyed the first)
+
+With <persistence-unit transaction-type="*JTA*"> the *container* will do
+EntityManager (PersistenceContext/Cache) creating and tracking...
+
+* You *cannot* use the *EntityManagerFactory* to get an EntityManager
+* You can only get an *EntityManager* supplied by the *container*
+* An *EntityManager* can be injected via the *@PersistenceContext*
+annotation only (not @PersistenceUnit)
+* You are *not* allowed to use @PersistenceUnit to refer to a unit of
+type JTA
+* The *EntityManager* given by the container is a *reference* to the
+PersistenceContext/Cache associated with a JTA Transaction.
+* If no JTA transaction is in progress, the EntityManager *cannot be
+used* because there is no PersistenceContext/Cache.
+* Everyone with an EntityManager reference to the *same unit* in the
+*same transaction* will automatically have a reference to the *same
+PersistenceContext/Cache*
+* The PersistenceContext/Cache is *flushed* and cleared at JTA *commit*
+time
+
+# Cache == PersistenceContext
+
+The concept of a database cache is an extremely important concept to be
+aware of. Without a copy of the data in memory (i.e. a cache) when you
+call account.getBalance() the persistence provider would have to go read
+the value from the database. Calling account.getBalance() several times
+would cause several trips to the database. This would obviously be a big
+waste of resources. The other side of having a cache is that when you
+call account.setBalance(5000) it also doesn't hit the database
+(usually). When the cache is "flushed" the data in it is sent to the
+database via as many SQL updates, inserts and deletes as are required.
+That is the basics of java persistence of any kind all wrapped in a
+nutshell. If you can understand that, you're good to go in nearly any
+persistence technology java has to offer.
+
+Complications can arise when there is more than one
+PersistenceContext/Cache relating the same data in the same transaction.
+In any given transaction you want exactly one PersistenceContext/Cache
+for a given set of data. Using a JTA unit with an EntityManager created
+by the container will always guarantee that this is the case. With a
+RESOURCE_LOCAL unit and an EntityManagerFactory you should create and
+use exactly one EntityManager instance in your transaction to ensure
+there is only one active PersistenceContext/Cache for the given set of
+data active against the current transaction.
+
+# Caches and Detaching
+
+Detaching is the concept of a persistent object *leaving* the
+PersistenceContext/Cache. Leaving means that any updates made to the
+object are *not* reflected in the PersistenceContext/Cache. An object
+will become Detached if it somehow *lives longer* or is *used outside*
+the scope of the PersistenceContext/Cache.
+
+For a JTA unit, the PersistenceContext/Cache will live as long as the
+transaction does. When a transaction completes (commits or rollsback)
+all objects that were in the PersistenceContext/Cache are Detached. You
+can still use them, but they are no longer associated with a
+PersistenceContext/Cache and modifications on them will *not* be
+reflected in a PersistenceContext/Cache and therefore not the database
+either.
+
+Serializing objects that are currently in a PersistenceContext/Cache
+will also cause them to Detach.
+
+In some cases objects or collections of objects that become Detached may
+not have all the data you need. This can be because of lazy loading.
+With lazy loading, data isn't pulled from the database and into the
+PersistenceContext/Cache until it is requested in code. In many cases
+the Collections of persistent objects returned from an
+javax.persistence.Query.getResultList() call are completely empty until
+you iterate over them. A side effect of this is that if the Collection
+becomes Detached before it's been fully read it will be permanently
+empty and of no use and calling methods on the Detached Collection can
+cause strange errors and exceptions to be thrown. If you wish to Detach
+a Collection of persistent objects it is always a good idea to iterate
+over the Collection at least once.
+
+You *cannot* call EntityManager.persist() or EntityManager.remove() on a
+Detached object.
+
+Calling EntityManager.merge() will re-attach a Detached object.
+
+# Valid RESOURCE_LOCAL Unit usage
+
+Servlets and EJBs can use RESOURCE_LOCAL persistence units through the
+EntityManagerFactory as follows:
+
+....
+<?xml version="1.0" encoding="UTF-8" ?>
+<persistence xmlns="http://java.sun.com/xml/ns/persistence" version="1.0">
+
+ <!-- Tutorial "unit" -->
+ <persistence-unit name="Tutorial" transaction-type="RESOURCE_LOCAL">
+ <non-jta-data-source>myNonJtaDataSource</non-jta-data-source>
+ <class>org.superbiz.jpa.Account</class>
+ </persistence-unit>
+
+</persistence>
+....
+
+And referenced as follows
+
+....
+import javax.persistence.EntityManagerFactory;
+import javax.persistence.EntityManager;
+import javax.persistence.EntityTransaction;
+import javax.persistence.PersistenceUnit;
+
+public class MyEjbOrServlet ... {
+
+ @PersistenceUnit(unitName="Tutorial")
+ private EntityManagerFactory factory;
+
+ // Proper exception handling left out for simplicity
+ public void ejbMethodOrServletServiceMethod() throws Exception {
+ EntityManager entityManager = factory.createEntityManager();
+
+ EntityTransaction entityTransaction = entityManager.getTransaction();
+
+ entityTransaction.begin();
+
+ Account account = entityManager.find(Account.class, 12345);
+
+ account.setBalance(5000);
+
+ entityTransaction.commit();
+ }
+
+ ...
+}
+....
+
+== Valid JTA Unit usage
+
+EJBs can use JTA persistence units through the EntityManager as follows:
+
+....
+<?xml version="1.0" encoding="UTF-8" ?>
+<persistence xmlns="http://java.sun.com/xml/ns/persistence" version="1.0">
+
+ <!-- Tutorial "unit" -->
+ <persistence-unit name="Tutorial" transaction-type="JTA">
+ <jta-data-source>myJtaDataSource</jta-data-source>
+ <non-jta-data-source>myNonJtaDataSource</non-jta-data-source>
+ <class>org.superbiz.jpa.Account</class>
+ </persistence-unit>
+
+</persistence>
+....
+
+And referenced as follows
+
+....
+import javax.ejb.Stateless;
+import javax.ejb.TransactionAttribute;
+import javax.ejb.TransactionAttributeType;
+import javax.persistence.EntityManager;
+import javax.persistence.PersistenceContext;
+
+@Stateless
+public class MyEjb implements MyEjbInterface {
+
+ @PersistenceContext(unitName = "Tutorial")
+ private EntityManager entityManager;
+
+ // Proper exception handling left out for simplicity
+ @TransactionAttribute(TransactionAttributeType.REQUIRED)
+ public void ejbMethod() throws Exception {
+
+ Account account = entityManager.find(Account.class, 12345);
+
+ account.setBalance(5000);
+
+ }
+}
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jpa-concepts.md
----------------------------------------------------------------------
diff --git a/docs/jpa-concepts.md b/docs/jpa-concepts.md
deleted file mode 100644
index 1d7788e..0000000
--- a/docs/jpa-concepts.md
+++ /dev/null
@@ -1,220 +0,0 @@
-index-group=JPA
-type=page
-status=published
-title=JPA Concepts
-~~~~~~
-<a name="JPAConcepts-JPA101"></a>
-# JPA 101
-
-If there's one thing you have to understand to successfully use JPA (Java
-Persistence API) it's the concept of a *Cache*. Almost everything boils
-down to the Cache at one point or another. Unfortunately the Cache is an
-internal thing and not exposed via the JPA API classes, so it not easy to
-touch or feel from a coding perspective.
-
-Here's a quick cheat sheet of the JPA world:
-
- - A **Cache** is a **copy of data**, copy meaning pulled from but living
-outside the database.
- - **Flushing** a Cache is the act of putting modified data back into the
-database.
- - A **PersistenceContext** is essentially a Cache. It also tends to have
-it's own non-shared database connection.
- - An **EntityManager** represents a PersistenceContext (and therefore a
-Cache)
- - An **EntityManagerFactory** creates an EntityManager (and therefore a
-PersistenceContext/Cache)
-
-Comparing `RESOURCE_LOCAL` and `JTA` persistence contexts
-
-With <persistence-unit transaction-type="**RESOURCE_LOCAL**"> **you** are
-responsible for EntityManager (PersistenceContext/Cache) creating and
-tracking...
-
-- You **must** use the **EntityManagerFactory** to get an EntityManager
-- The resulting **EntityManager** instance **is** a
-PersistenceContext/Cache
-- An **EntityManagerFactory** can be injected via the **@PersistenceUnit**
-annotation only (not @PersistenceContext)
-- You are **not** allowed to use @PersistenceContext to refer to a unit
-of type RESOURCE_LOCAL
-- You **must** use the **EntityTransaction** API to begin/commit around
-**every** call to your EntityManger
-- Calling entityManagerFactory.createEntityManager() twice results in
-**two** separate EntityManager instances and therefor **two** separate
-PersistenceContexts/Caches.
-- It is **almost never** a good idea to have more than one **instance** of
-an EntityManager in use (don't create a second one unless you've destroyed
-the first)
-
-With <persistence-unit transaction-type="**JTA**"> the **container**
-will do EntityManager (PersistenceContext/Cache) creating and tracking...
-
-- You **cannot** use the **EntityManagerFactory** to get an EntityManager
-- You can only get an **EntityManager** supplied by the **container**
-- An **EntityManager** can be injected via the **@PersistenceContext**
-annotation only (not @PersistenceUnit)
-- You are **not** allowed to use @PersistenceUnit to refer to a unit of
-type JTA
-- The **EntityManager** given by the container is a **reference** to the
-PersistenceContext/Cache associated with a JTA Transaction.
-- If no JTA transaction is in progress, the EntityManager **cannot be
-used** because there is no PersistenceContext/Cache.
-- Everyone with an EntityManager reference to the **same unit** in the
-**same transaction** will automatically have a reference to the **same
-PersistenceContext/Cache**
-- The PersistenceContext/Cache is **flushed** and cleared at JTA
-**commit** time
-
-<a name="JPAConcepts-Cache==PersistenceContext"></a>
-# Cache == PersistenceContext
-
-The concept of a database cache is an extremely important concept to be
-aware of. Without a copy of the data in memory (i.e. a cache) when you
-call account.getBalance() the persistence provider would have to go read
-the value from the database. Calling account.getBalance() several times
-would cause several trips to the database. This would obviously be a big
-waste of resources. The other side of having a cache is that when you call
-account.setBalance(5000) it also doesn't hit the database (usually). When
-the cache is "flushed" the data in it is sent to the database via as many
-SQL updates, inserts and deletes as are required. That is the basics of
-java persistence of any kind all wrapped in a nutshell. If you can
-understand that, you're good to go in nearly any persistence technology
-java has to offer.
-
-Complications can arise when there is more than one
-PersistenceContext/Cache relating the same data in the same transaction.
-In any given transaction you want exactly one PersistenceContext/Cache for
-a given set of data. Using a JTA unit with an EntityManager
-created by the container will always guarantee that this is the case. With
-a RESOURCE_LOCAL unit and an EntityManagerFactory you should create and use
-exactly one EntityManager instance in your transaction to ensure there is
-only one active PersistenceContext/Cache for the given set of data active
-against the current transaction.
-
-<a name="JPAConcepts-CachesandDetaching"></a>
-# Caches and Detaching
-
-Detaching is the concept of a persistent object **leaving** the
-PersistenceContext/Cache. Leaving means that any updates made to the
-object are **not** reflected in the PersistenceContext/Cache. An object will
-become Detached if it somehow **lives longer** or is **used outside** the scope
-of the PersistenceContext/Cache.
-
-For a JTA unit, the PersistenceContext/Cache will live as long as
-the transaction does. When a transaction completes (commits or rollsback)
-all objects that were in the PersistenceContext/Cache are Detached. You
-can still use them, but they are no longer associated with a
-PersistenceContext/Cache and modifications on them will **not** be reflected
-in a PersistenceContext/Cache and therefore not the database either.
-
-Serializing objects that are currently in a PersistenceContext/Cache will
-also cause them to Detach.
-
-In some cases objects or collections of objects that become Detached may
-not have all the data you need. This can be because of lazy loading. With
-lazy loading, data isn't pulled from the database and into the
-PersistenceContext/Cache until it is requested in code. In many cases the
-Collections of persistent objects returned from an
-javax.persistence.Query.getResultList() call are completely empty until you
-iterate over them. A side effect of this is that if the Collection becomes
-Detached before it's been fully read it will be permanently empty and of no
-use and calling methods on the Detached Collection can cause strange errors
-and exceptions to be thrown. If you wish to Detach a Collection of
-persistent objects it is always a good idea to iterate over the Collection
-at least once.
-
-You **cannot** call EntityManager.persist() or EntityManager.remove() on a
-Detached object.
-
-Calling EntityManager.merge() will re-attach a Detached object.
-
-<a name="JPAConcepts-ValidRESOURCE_LOCALUnitusage"></a>
-# Valid RESOURCE_LOCAL Unit usage
-
-Servlets and EJBs can use RESOURCE_LOCAL persistence units through the
-EntityManagerFactory as follows:
-
- <?xml version="1.0" encoding="UTF-8" ?>
- <persistence xmlns="http://java.sun.com/xml/ns/persistence" version="1.0">
-
- <!-- Tutorial "unit" -->
- <persistence-unit name="Tutorial" transaction-type="RESOURCE_LOCAL">
- <non-jta-data-source>myNonJtaDataSource</non-jta-data-source>
- <class>org.superbiz.jpa.Account</class>
- </persistence-unit>
-
- </persistence>
-
-And referenced as follows
-
- import javax.persistence.EntityManagerFactory;
- import javax.persistence.EntityManager;
- import javax.persistence.EntityTransaction;
- import javax.persistence.PersistenceUnit;
-
- public class MyEjbOrServlet ... {
-
- @PersistenceUnit(unitName="Tutorial")
- private EntityManagerFactory factory;
-
- // Proper exception handling left out for simplicity
- public void ejbMethodOrServletServiceMethod() throws Exception {
- EntityManager entityManager = factory.createEntityManager();
-
- EntityTransaction entityTransaction = entityManager.getTransaction();
-
- entityTransaction.begin();
-
- Account account = entityManager.find(Account.class, 12345);
-
- account.setBalance(5000);
-
- entityTransaction.commit();
- }
-
- ...
- }
-
-
-# Valid JTA Unit usage
-
-EJBs can use JTA persistence units through the EntityManager as
-follows:
-
- <?xml version="1.0" encoding="UTF-8" ?>
- <persistence xmlns="http://java.sun.com/xml/ns/persistence" version="1.0">
-
- <!-- Tutorial "unit" -->
- <persistence-unit name="Tutorial" transaction-type="JTA">
- <jta-data-source>myJtaDataSource</jta-data-source>
- <non-jta-data-source>myNonJtaDataSource</non-jta-data-source>
- <class>org.superbiz.jpa.Account</class>
- </persistence-unit>
-
- </persistence>
-
-And referenced as follows
-
- import javax.ejb.Stateless;
- import javax.ejb.TransactionAttribute;
- import javax.ejb.TransactionAttributeType;
- import javax.persistence.EntityManager;
- import javax.persistence.PersistenceContext;
-
- @Stateless
- public class MyEjb implements MyEjbInterface {
-
- @PersistenceContext(unitName = "Tutorial")
- private EntityManager entityManager;
-
- // Proper exception handling left out for simplicity
- @TransactionAttribute(TransactionAttributeType.REQUIRED)
- public void ejbMethod() throws Exception {
-
- Account account = entityManager.find(Account.class, 12345);
-
- account.setBalance(5000);
-
- }
- }
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jpa-usage.adoc
----------------------------------------------------------------------
diff --git a/docs/jpa-usage.adoc b/docs/jpa-usage.adoc
new file mode 100644
index 0000000..21e0210
--- /dev/null
+++ b/docs/jpa-usage.adoc
@@ -0,0 +1,48 @@
+# JPA Usage
+:index-group: JPA
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Things to watch out for
+
+== Critical: Always set jta-data-source and non-jta-data-source
+
+Always set the value of jta-data-source and non-jta-data-source in your
+persistence.xml file. Regardless if targeting your EntityManager usage
+for transaction-type="RESOURCE_LOCAL" or transaction-type="TRANSACTION",
+it's very difficult to guarantee one or the other will be the only one
+needed. Often times the JPA Provider itself will require both internally
+to do various optimizations or other special features.
+
+* The _jta-data-source_ should always have it's OpenEJB-specific
+'_JtaManaged_' property set to '_true_' (this is the default)
+* The _non-jta-data-source_ should always have it's OpenEJB-specific
+'_JtaManaged_' property set to '_false_'.
+
+See link:containers-and-resources.html[Containers and Resources] for how
+to configure 'JtaManaged' and a full list of properties for DataSources.
+
+== Be detach aware
+
+A warning for any new JPA user is by default all objects will detach at
+the end of a transaction. People typically discover this when the go to
+remove or update an object they fetched previously and get an exception
+like "You cannot perform operation delete on detached object".
+
+All ejb methods start a transaction unless a) you
+link:transaction-annotations.html[configure them otherwise] , or b) the
+caller already has a transaction in progress when it calls the bean. If
+you're in a test case or a servlet, it's most likely B that is biting
+you. You're asking an ejb for some persistent objects, it uses the
+EntityManager in the scope of the transaction started around it's method
+and returns some persistent objects, by the time you get them the
+transaction has completed and now the objects are detached.
+
+=== Solutions 1. Call EntityManager.merge(..) inside the bean code to
+reattach your object. 1. Use PersistenceContextType.EXTENDED as in
+'@PersistenceContext(unitName = "movie-unit", type =
+PersistenceContextType.EXTENDED)' for EntityManager refs instead of the
+default of PersistenceContextType.TRANSACTION. 1. If testing, use a
+technique to execute transactions in your test code. That's described
+here in link:unit-testing-transactions.html[Unit testing transactions]
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/jpa-usage.md
----------------------------------------------------------------------
diff --git a/docs/jpa-usage.md b/docs/jpa-usage.md
deleted file mode 100644
index 6b8f8a8..0000000
--- a/docs/jpa-usage.md
+++ /dev/null
@@ -1,52 +0,0 @@
-index-group=JPA
-type=page
-status=published
-title=JPA Usage
-~~~~~~
-<a name="JPAUsage-Thingstowatchoutfor"></a>
-# Things to watch out for
-
-<a name="JPAUsage-Critical:Alwayssetjta-data-sourceandnon-jta-data-source"></a>
-## Critical: Always set jta-data-source and non-jta-data-source
-
-Always set the value of jta-data-source and non-jta-data-source in your
-persistence.xml file. Regardless if targeting your EntityManager usage for
-transaction-type="RESOURCE_LOCAL" or transaction-type="TRANSACTION", it's
-very difficult to guarantee one or the other will be the only one needed.
-Often times the JPA Provider itself will require both internally to do
-various optimizations or other special features.
-
-* The *jta-data-source* should always have it's OpenEJB-specific
-'*JtaManaged*' property set to '*true*' (this is the default)
-* The *non-jta-data-source* should always have it's OpenEJB-specific
-'*JtaManaged*' property set to '*false*'.
-
-See [Containers and Resources](containers-and-resources.html)
- for how to configure 'JtaManaged' and a full list of <Resource> properties
-for DataSources.
-
-<a name="JPAUsage-Bedetachaware"></a>
-## Be detach aware
-
-A warning for any new JPA user is by default all objects will detach at the
-end of a transaction. People typically discover this when the go to remove
-or update an object they fetched previously and get an exception like "You
-cannot perform operation delete on detached object".
-
-All ejb methods start a transaction unless a) you [configure them otherwise](transaction-annotations.html)
-, or b) the caller already has a transaction in progress when it calls the
-bean. If you're in a test case or a servlet, it's most likely B that is
-biting you. You're asking an ejb for some persistent objects, it uses the
-EntityManager in the scope of the transaction started around it's method
-and returns some persistent objects, by the time you get them the
-transaction has completed and now the objects are detached.
-
-<a name="JPAUsage-Solutions"></a>
-### Solutions
-1. Call EntityManager.merge(..) inside the bean code to reattach your
-object.
-1. Use PersistenceContextType.EXTENDED as in '@PersistenceContext(unitName
-= "movie-unit", type = PersistenceContextType.EXTENDED)' for EntityManager
-refs instead of the default of PersistenceContextType.TRANSACTION.
-1. If testing, use a technique to execute transactions in your test code.
-That's described here in [Unit testing transactions](unit-testing-transactions.html)
[12/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 7
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/start-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/start-mojo.md b/docs/maven/start-mojo.md
deleted file mode 100644
index 85c2013..0000000
--- a/docs/maven/start-mojo.md
+++ /dev/null
@@ -1,1395 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:start<a name="tomee:start"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:start</p>
-
-<p><b>Description</b>:</p>
-
-<div>Start and forget TomEE.</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apacheRepos">apacheRepos</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>snapshots</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.apache-repos</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#appDir">appDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>apps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apps">apps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#args">args</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.args</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#bin">bin</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/bin</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.bin</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#catalinaBase">catalinaBase</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.catalina-base</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#checkStarted">checkStarted</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.check-started</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#classpaths">classpaths</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#config">config</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/conf</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.conf</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#context">context</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>rename the current artifact<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#debug">debug</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debug</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#debugPort">debugPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>5005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debugPort</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#deployOpenEjbApplication">deployOpenEjbApplication</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#docBases">docBases</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, which docBase to use for this war.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#ejbRemote">ejbRemote</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ejb-remote</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#externalRepositories">externalRepositories</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, add some external repositories to
-classloader.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#forceReloadable">forceReloadable</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>force webapp to be reloadable<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.force-reloadable</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#javaagents">javaagents</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#keepServerXmlAsthis">keepServerXmlAsthis</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(Removed since 7.0.0)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.keep-server-xml</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#lib">lib</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/lib</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.lib</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#libDir">libDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>lib</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#libs">libs</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#mainDir">mainDir</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#quickSession">quickSession</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use a real random instead of secure random. saves few ms at
-startup.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.quick-session</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#reloadOnUpdate">reloadOnUpdate</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.reload-on-update</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#removeDefaultWebapps">removeDefaultWebapps</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-default-webapps</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#removeTomeeWebapp">removeTomeeWebapp</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-tomee-webapps</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#simpleLog">simpleLog</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.simple-log</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#skipCurrentProject">skipCurrentProject</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipCurrentProject</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#skipWarResources">skipWarResources</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipWarResources</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#synchronization">synchronization</a></b></td>
-
-<td><tt>Synchronization</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#synchronizations">synchronizations</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#systemVariables">systemVariables</a></b></td>
-
-<td><tt>Map</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#target">target</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeAjpPort">tomeeAjpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8009</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ajp</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeAlreadyInstalled">tomeeAlreadyInstalled</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exiting</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeArtifactId">tomeeArtifactId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.artifactId</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeClassifier">tomeeClassifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>webprofile</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeGroupId">tomeeGroupId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.groupId</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHttpsPort">tomeeHttpsPort</a></b></td>
-
-<td><tt>Integer</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.https</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeShutdownCommand">tomeeShutdownCommand</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>SHUTDOWN</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown-command</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeShutdownPort">tomeeShutdownPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeVersion">tomeeVersion</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>-1</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.version</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#useConsole">useConsole</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.use-console</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#useOpenEJB">useOpenEJB</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use openejb-standalone automatically instead of TomEE<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.openejb</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#warFile">warFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappClasses">webappClasses</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappClasses</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappDefaultConfig">webappDefaultConfig</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>forcing nice default for war development (WEB-INF/classes and web
-resources)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappDefaultConfig</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappDir">webappDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>webapps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappResources">webappResources</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/webapp</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappResources</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webapps">webapps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="apacheRepos">apacheRepos</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.apache-repos</tt></li>
-
-<li><b>Default</b>: <tt>snapshots</tt></li>
- </ul><hr />
-<p><b><a name="appDir">appDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>apps</tt></li>
- </ul><hr />
-<p><b><a name="apps">apps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="args">args</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.args</tt></li>
- </ul><hr />
-<p><b><a name="bin">bin</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.bin</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/bin</tt></li>
- </ul><hr />
-<p><b><a name="catalinaBase">catalinaBase</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.catalina-base</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="checkStarted">checkStarted</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.check-started</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="classpaths">classpaths</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="config">config</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.conf</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/conf</tt></li>
- </ul><hr />
-<p><b><a name="context">context</a>:</b></p>
-
-<div>rename the current artifact</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="debug">debug</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debug</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="debugPort">debugPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debugPort</tt></li>
-
-<li><b>Default</b>: <tt>5005</tt></li>
- </ul><hr />
-<p><b><a name="deployOpenEjbApplication">deployOpenEjbApplication</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="docBases">docBases</a>:</b></p>
-
-<div>for TomEE and wars only, which docBase to use for this war.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="ejbRemote">ejbRemote</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ejb-remote</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="externalRepositories">externalRepositories</a>:</b></p>
-
-<div>for TomEE and wars only, add some external repositories to
-classloader.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="forceReloadable">forceReloadable</a>:</b></p>
-
-<div>force webapp to be reloadable</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.force-reloadable</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="javaagents">javaagents</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="keepServerXmlAsthis">keepServerXmlAsthis</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.keep-server-xml</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="lib">lib</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.lib</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/lib</tt></li>
- </ul><hr />
-<p><b><a name="libDir">libDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>lib</tt></li>
- </ul><hr />
-<p><b><a name="libs">libs</a>:</b></p>
-
-<div>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="mainDir">mainDir</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main</tt></li>
- </ul><hr />
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="quickSession">quickSession</a>:</b></p>
-
-<div>use a real random instead of secure random. saves few ms at
-startup.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.quick-session</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="reloadOnUpdate">reloadOnUpdate</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.reload-on-update</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="removeDefaultWebapps">removeDefaultWebapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-default-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="removeTomeeWebapp">removeTomeeWebapp</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-tomee-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="simpleLog">simpleLog</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.simple-log</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipCurrentProject">skipCurrentProject</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipCurrentProject</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipWarResources">skipWarResources</a>:</b></p>
-
-<div>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipWarResources</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="synchronization">synchronization</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>org.apache.openejb.maven.plugin.Synchronization</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="synchronizations">synchronizations</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="systemVariables">systemVariables</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="target">target</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAjpPort">tomeeAjpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ajp</tt></li>
-
-<li><b>Default</b>: <tt>8009</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAlreadyInstalled">tomeeAlreadyInstalled</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.exiting</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="tomeeArtifactId">tomeeArtifactId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.artifactId</tt></li>
-
-<li><b>Default</b>: <tt>apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="tomeeClassifier">tomeeClassifier</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li>
-
-<li><b>Default</b>: <tt>webprofile</tt></li>
- </ul><hr />
-<p><b><a name="tomeeGroupId">tomeeGroupId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.groupId</tt></li>
-
-<li><b>Default</b>: <tt>org.apache.openejb</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpsPort">tomeeHttpsPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.Integer</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.https</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownCommand">tomeeShutdownCommand</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown-command</tt></li>
-
-<li><b>Default</b>: <tt>SHUTDOWN</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownPort">tomeeShutdownPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown</tt></li>
-
-<li><b>Default</b>: <tt>8005</tt></li>
- </ul><hr />
-<p><b><a name="tomeeVersion">tomeeVersion</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.version</tt></li>
-
-<li><b>Default</b>: <tt>-1</tt></li>
- </ul><hr />
-<p><b><a name="useConsole">useConsole</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.use-console</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="useOpenEJB">useOpenEJB</a>:</b></p>
-
-<div>use openejb-standalone automatically instead of TomEE</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.openejb</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul><hr />
-<p><b><a name="warFile">warFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt></li>
- </ul><hr />
-<p><b><a name="webappClasses">webappClasses</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappClasses</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li>
- </ul><hr />
-<p><b><a name="webappDefaultConfig">webappDefaultConfig</a>:</b></p>
-
-<div>forcing nice default for war development (WEB-INF/classes and web
-resources)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappDefaultConfig</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="webappDir">webappDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>webapps</tt></li>
- </ul><hr />
-<p><b><a name="webappResources">webappResources</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappResources</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li>
- </ul><hr />
-<p><b><a name="webapps">webapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/stop-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/stop-mojo.adoc b/docs/maven/stop-mojo.adoc
new file mode 100644
index 0000000..d3477b1
--- /dev/null
+++ b/docs/maven/stop-mojo.adoc
@@ -0,0 +1,1086 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:stop
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:stop
+
+Description:
+
+Stop a TomEE started with start command.
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime+system.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+apacheRepos
+
+String
+
+-
+
+(no description)Default value is: snapshots.User property is:
+tomee-plugin.apache-repos.
+
+appDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: apps.
+
+apps
+
+List
+
+-
+
+(no description)
+
+args
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.args.
+
+bin
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/bin.User property is:
+tomee-plugin.bin.
+
+catalinaBase
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.build.directory}/apache-tomee.User property is:
+tomee-plugin.catalina-base.
+
+checkStarted
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.check-started.
+
+classpaths
+
+List
+
+-
+
+(no description)
+
+config
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/conf.User property is:
+tomee-plugin.conf.
+
+context
+
+String
+
+-
+
+rename the current artifact
+
+debug
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.debug.
+
+debugPort
+
+int
+
+-
+
+(no description)Default value is: 5005.User property is:
+tomee-plugin.debugPort.
+
+deployOpenEjbApplication
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.deploy-openejb-internal-application.
+
+docBases
+
+List
+
+-
+
+for TomEE and wars only, which docBase to use for this war.
+
+ejbRemote
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.ejb-remote.
+
+externalRepositories
+
+List
+
+-
+
+for TomEE and wars only, add some external repositories to classloader.
+
+forceReloadable
+
+boolean
+
+-
+
+force webapp to be reloadableDefault value is: false.User property is:
+tomee-plugin.force-reloadable.
+
+javaagents
+
+List
+
+-
+
+(no description)
+
+keepServerXmlAsthis
+
+boolean
+
+-
+
+(Removed since 7.0.0)Default value is: false.User property is:
+tomee-plugin.keep-server-xml.
+
+lib
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/lib.User property is:
+tomee-plugin.lib.
+
+libDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: lib.
+
+libs
+
+List
+
+-
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+mainDir
+
+File
+
+-
+
+(no description)Default value is: $\{project.basedir}/src/main.
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+quickSession
+
+boolean
+
+-
+
+use a real random instead of secure random. saves few ms at
+startup.Default value is: true.User property is:
+tomee-plugin.quick-session.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+removeDefaultWebapps
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-default-webapps.
+
+removeTomeeWebapp
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-tomee-webapps.
+
+simpleLog
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.simple-log.
+
+skipCurrentProject
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.skipCurrentProject.
+
+skipWarResources
+
+boolean
+
+-
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.Default value is: false.User property is:
+tomee-plugin.skipWarResources.
+
+systemVariables
+
+Map
+
+-
+
+(no description)
+
+target
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.directory}.
+
+tomeeAjpPort
+
+int
+
+-
+
+(no description)Default value is: 8009.User property is:
+tomee-plugin.ajp.
+
+tomeeAlreadyInstalled
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.exiting.
+
+tomeeArtifactId
+
+String
+
+-
+
+(no description)Default value is: apache-tomee.User property is:
+tomee-plugin.artifactId.
+
+tomeeClassifier
+
+String
+
+-
+
+(no description)Default value is: webprofile.User property is:
+tomee-plugin.classifier.
+
+tomeeGroupId
+
+String
+
+-
+
+(no description)Default value is: org.apache.openejb.User property is:
+tomee-plugin.groupId.
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+tomeeHttpsPort
+
+Integer
+
+-
+
+(no description)User property is: tomee-plugin.https.
+
+tomeeShutdownCommand
+
+String
+
+-
+
+(no description)Default value is: SHUTDOWN.User property is:
+tomee-plugin.shutdown-command.
+
+tomeeShutdownPort
+
+int
+
+-
+
+(no description)Default value is: 8005.User property is:
+tomee-plugin.shutdown.
+
+tomeeVersion
+
+String
+
+-
+
+(no description)Default value is: -1.User property is:
+tomee-plugin.version.
+
+useConsole
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.use-console.
+
+useOpenEJB
+
+boolean
+
+-
+
+use openejb-standalone automatically instead of TomEEDefault value is:
+false.User property is: tomee-plugin.openejb.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+warFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}.
+
+webappClasses
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.outputDirectory}.User
+property is: tomee-plugin.webappClasses.
+
+webappDefaultConfig
+
+boolean
+
+-
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)Default value is: false.User property is:
+tomee-plugin.webappDefaultConfig.
+
+webappDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: webapps.
+
+webappResources
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/webapp.User property is:
+tomee-plugin.webappResources.
+
+webapps
+
+List
+
+-
+
+(no description)
+
+Parameter Details
+
+apacheRepos:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.apache-repos
+
+Default: snapshots
+
+appDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: apps
+
+apps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+args:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.args
+
+bin:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.bin
+
+Default: $\{project.basedir}/src/main/tomee/bin
+
+catalinaBase:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.catalina-base
+
+Default: $\{project.build.directory}/apache-tomee
+
+checkStarted:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.check-started
+
+Default: false
+
+classpaths:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+config:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.conf
+
+Default: $\{project.basedir}/src/main/tomee/conf
+
+context:
+
+rename the current artifact
+
+Type: java.lang.String
+
+Required: No
+
+debug:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.debug
+
+Default: false
+
+debugPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.debugPort
+
+Default: 5005
+
+deployOpenEjbApplication:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.deploy-openejb-internal-application
+
+Default: false
+
+docBases:
+
+for TomEE and wars only, which docBase to use for this war.
+
+Type: java.util.List
+
+Required: No
+
+ejbRemote:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.ejb-remote
+
+Default: true
+
+externalRepositories:
+
+for TomEE and wars only, add some external repositories to classloader.
+
+Type: java.util.List
+
+Required: No
+
+forceReloadable:
+
+force webapp to be reloadable
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.force-reloadable
+
+Default: false
+
+javaagents:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+keepServerXmlAsthis:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.keep-server-xml
+
+Default: false
+
+lib:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.lib
+
+Default: $\{project.basedir}/src/main/tomee/lib
+
+libDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: lib
+
+libs:
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+Type: java.util.List
+
+Required: No
+
+mainDir:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.basedir}/src/main
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+quickSession:
+
+use a real random instead of secure random. saves few ms at startup.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.quick-session
+
+Default: true
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+removeDefaultWebapps:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-default-webapps
+
+Default: true
+
+removeTomeeWebapp:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-tomee-webapps
+
+Default: true
+
+simpleLog:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.simple-log
+
+Default: false
+
+skipCurrentProject:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipCurrentProject
+
+Default: false
+
+skipWarResources:
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipWarResources
+
+Default: false
+
+systemVariables:
+
+(no description)
+
+Type: java.util.Map
+
+Required: No
+
+target:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.build.directory}
+
+tomeeAjpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.ajp
+
+Default: 8009
+
+tomeeAlreadyInstalled:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.exiting
+
+Default: false
+
+tomeeArtifactId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.artifactId
+
+Default: apache-tomee
+
+tomeeClassifier:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.classifier
+
+Default: webprofile
+
+tomeeGroupId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.groupId
+
+Default: org.apache.openejb
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+tomeeHttpsPort:
+
+(no description)
+
+Type: java.lang.Integer
+
+Required: No
+
+User Property: tomee-plugin.https
+
+tomeeShutdownCommand:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.shutdown-command
+
+Default: SHUTDOWN
+
+tomeeShutdownPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.shutdown
+
+Default: 8005
+
+tomeeVersion:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.version
+
+Default: -1
+
+useConsole:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.use-console
+
+Default: true
+
+useOpenEJB:
+
+use openejb-standalone automatically instead of TomEE
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.openejb
+
+Default: false
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
+
+warFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}
+
+webappClasses:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappClasses
+
+Default: $\{project.build.outputDirectory}
+
+webappDefaultConfig:
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.webappDefaultConfig
+
+Default: false
+
+webappDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: webapps
+
+webappResources:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappResources
+
+Default: $\{project.basedir}/src/main/webapp
+
+webapps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
[05/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 4
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deployment-id.md
----------------------------------------------------------------------
diff --git a/docs/deployment-id.md b/docs/deployment-id.md
deleted file mode 100644
index 533a16d..0000000
--- a/docs/deployment-id.md
+++ /dev/null
@@ -1,231 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Deployment ID
-~~~~~~
-
-<a name="DeploymentID-WhatisaDeploymentID?"></a>
-# What is a Deployment ID?
-
-Every bean deployed in OpenEJB has a unique deployment-id that identifies
-it within the scope of the entire container system. The server and
-container system refer beans at run-time using the bean's deployment id.
-
-<a name="DeploymentID-Likeejb-name"></a>
-## Like ejb-name
-
-This deployment id is much like the <ejb-name> element of the ejb-jar.xml ,
-with one very important difference. The <ejb-name> is only required to be
-unique within the scope of the ejb-jar.xml in the bean's jar. The
-deployment id is required to be unique across all beans and jars in
-OpenEJB. This is a subtle, but important, distinction.
-
-Remember that the EJB specification was designed so that enterprise beans
-could be create, packaged, and sold by vendors (EJB Providers).
-Furthermore, users should be able to buy a packaged set of beans (a jar
-with an ejb-jar.xml in it) and deploy it into an EJB Container without
-modification.
-
-<a name="DeploymentID-Theejb-nameisnotunique"></a>
-## The ejb-name is not unique
-
-Let's consider this, what happens if two vendors each sell a package (jar)
-that contains a bean with the <ejb-name> PurchaseOrder? Both are completely
-different in terms functionality and are different beans in every other
-respect. The EJB spec says, this is fine, ejb-names only have to unique
-within the jar and that jar's ejb-jar.xml file. It's ridiculous to expect
-EJB Providers to call each other up and ask, "Are you already using the
-name 'PurchaseOrder' in your jar?" Remember that the EJB specification was
-designed so that enterprise beans could be create, packaged, and sold by
-vendors (EJB Providers). Furthermore, users should be able to buy a
-packaged set of beans (a jar with an ejb-jar.xml in it) and deploy it into
-an EJB Container without modification. This is all fine and dandy, but it
-still leaves it up to the EJB Container/Server providers to settle the
-difference.
-
-<a name="DeploymentID-Thedeployment-idisunique"></a>
-## The deployment-id is unique
-
-OpenEJB solves this with the OpenEJB-specific deployment id. By requiring
-that each bean deployed into OpenEJB has a unique name, we can guarantee
-that we are always referring to the right bean at all times. Furthermore, it
-allows you to deploy different versions of the same package several times
-in the same container system, each time giving the beans new deployment
-ids.
-
-<a name="DeploymentID-Usingejb-nameasdeployment-idanyway"></a>
-## Using ejb-name as deployment-id anyway
-
-If you're lazy -- as any truly great programmer should be -- and don't want
-to type a deployment id for each bean every time you deploy a jar, you can
-use the -D option of the Deploy Tool. This will throw caution to the wind,
-and automatically assign the bean's ejb-name as the value of the bean's
-OpenEJB deployment id. This leaves up to you to guarantee that bean's
-ejb-name will be unique across all beans and jars in the container system.
-In other words, be very careful with the -D option!
-
-<a name="DeploymentID-Howisitused?"></a>
-# How is it used?
-
-<a name="DeploymentID-Inthecontainersystem"></a>
-## In the container system
-
-In the container system, the deployment id is used to index the bean in a
-system-wide registry. This registry is refereed to on every call made in the
-container system. Being able to safely hash and cache bean information by
-id is a must. This stresses the importance of unique ids for every bean
-deployed in OpenEJB.
-
-<a name="DeploymentID-IntheLocalServer"></a>
-## In the Local Server
-
-The Local (IntraVM) Server is an integral part of the container system and
-the two are, in many ways, inseparable. The Local Server takes care of all
-bean to bean and client to bean invocations made inside the virtual
-machine. For this reason, it often refered to as the IntraVM Server.
-
-For bean to bean communications, the Local Server must create a JNDI
-namespace (JNDI ENC) for each bean as defined by the bean's <env-entry>,
-<ejb-ref>, and <resource-ref> elements of the bean's ejb-jar.xml file.
-Every bean literally gets its very own JNDI namespace. When a bean makes a
-JNDI call, the Local Server intercepts this call and uses the deployment id
-of the calling bean to retrieve that bean's private JNDI namespace from the
-container system's index. The Local Server then carries out the lookup on
-that bean's namespace.
-
-All non-bean clients share one big global namespace. Since non-bean clients
-are not deployed and do not have a deployment descriptor like an
-ejb-jar.xml, the Local Server is unable to taylor a namespace for each
-non-bean client as it can for bean clients. The Local server cannot
-identify non-bean clients as they have no deployment id. All JNDI calls
-made by clients that the Local Server cannot identify go to the public,
-global namespace. The public, global JNDI namespace contains all beans and
-resources in the container system. name.
-
-Each bean is added to the public, global namespace using it's deployment id
-as its JNDI lookup. For example, if a bean had a deployment-id of
-"/my/bean/foo", a non-bean client could lookup that bean as follows.
-
- ...
- Object bean = initialContext.lookup("/my/bean/Foo");
- ...
-
-
-If a bean in the container system made the above JNDI call, the Local
-Server would see the bean's identity (deployment id) hidden in the Thread,
-go get the bean's private JNDI namespace and finish the lookup on that.
-Since all names in bean's JNDI namespace are required start with
-"java:comp/env", the lookup would fail and the bean would receive a
-javax.naming.NameNotFoundException.
-
-In short...
-
-For beans:
- - Each bean has it's own private, personalized JNDI namespace
- - The names in it are the same names it uses in its ejb-jar.xml
- - Beans can only access their private namespace, period
-
-For non-beans (everyone else):
- - Non-bean clients share the public, global JNDI namespace
- - The names in it are the deployment ids of all the beans
- - Non-bean clients can only access the one global namespace
-
-<a name="DeploymentID-IntheRemoteServer"></a>
-## In the Remote Server
-
-The Remote Server has a public, global namespace just as the Local Server
-does. The difference being that the Remote Server only serves clients
-outside the container system and outside the virtual machine. So, all
-clients from the perspective of the Remote Server are non-bean clients. As
-a result, the Remote Server only has the one public, global JNDI namespace.
-Just as in the Local Server, the names in this namespace consist of the
-deployment ids of the beans in the container system.
-
-Just as before, clients can lookup beans from the Remote Server using the
-bean's deployment id. For example, if a bean had a deployment-id of
-"/my/bean/foo", a client could lookup that bean as follows.
-
- ...
- Object bean = initialContext.lookup("/my/bean/Foo");
- ...
-
-
-<a name="DeploymentID-IntheCORBAAdapter"></a>
-## In the CORBA Adapter
-
-The CORBA Adapter is separate than the Remote Server. It adapts the OpenEJB
-Container System and the Local Server into OpenORB as an embedded library.
-It provides users of OpenORB the ability to lookup and execute beans (EJBs)
-via the RMI-IIOP protocol. All the EJBHome and EJBObject interfaces of
-beans in OpenEJB are implemented by OpenORB as CORBA stubs and ties.
-
-The beans are exported into OpenORB's naming service by deployment id. So,
-just as with the Local Server and Remote Server, clients can lookup beans
-using the bean's deployment id. OpenORB has a JNDI implementation of their
-naming service, so lookups can be done just as before.
-
- ...
- String[] args = ...
-
- // The ORB and Object
- org.omg.CORBA.ORB orb = null;
- org.omg.CORBA.Object bean = null.
-
- // The Naming Service and Object Name
- org.omg.CosNaming.NamingContext context = null;
- org.omg.CosNaming.NameComponent[] name = null;
-
- // Get the ORB
- orb = org.omg.CORBA.ORB.init( args, null );
-
- // Get the Naming Service
- org.omg.CORBA.Object ref = null;
- ref = orb.resolve_initial_references("NameService");
- context = org.omg.CosNaming.NamingContextHelper.narrow( ref );
-
- // Get the Name as a component
- // Note: the string is the bean's deployment id
- name = new org.omg.CosNaming.NameComponent[ 1 ];
- name[0] = new org.omg.CosNaming.NameComponent("/my/bean/foo","");
-
- // Finally, get the bean as a CORBA object
- // Equvalent to an InitialContext.lookup("/my/bean/foo");
- bean = context.resolve( name );
- ...
-
-
-<a name="DeploymentID-WhathappensifthereisaduplicatedeploymentID?"></a>
-# What happens if there is a duplicate deployment ID?
-
-The deployment ID uniquely identifies the bean in the OpenEJB container
-system. Therefore, no two beans can share the same deployment ID.
-
-If a bean attempts to use a deployment ID that is already in use by another
-bean, the second bean and all beans in it's jar will not be loaded. In
-addition, the system will log a warning like the following one asking you
-to redeploy the jar and choose an different deployment ID for the bean.
-
- WARN : Jar C:\openejb\beans\fooEjbs.jar cannot be loaded. The Deployment ID "/my/bean/foo" is already in use. Please redeploy this jar and assign a different deployment ID to the bean with the ejb-name "FooBean".
-
-For example, the acmeEjbs.jar contains a bean with the ejb-name
-"DaffyDuckBean". The disneyEjbs.jar contains contains a bean with the
-ejb-name "DonaldDuckBean".
-
-We deploy the acmeEjbs.jar and give the "DaffyDuckBean" the deployment ID
-of "/my/favorite/duck". Sometime afterwards, we deploy the disneyEjbs.jar
-and assign the "DonaldDuckBean" the deployment ID "/my/favorite/duck",
-having forgotten that we already gave that unique ID to the "DaffyDuckBean"
-in the acmeEjbs.jar.
-
-When the container system is started, the system will begin loading all the
-beans one jar at a time. It will first load the acmeEjbs.jar and index each
-bean by deployment ID. But, when the system reaches the disneyEjbs.jar, it
-will discover that it cannot index the "DonaldDuckBean" using the
-deployment ID "/my/favorite/duck" because that index is already taken.
-
-The system cannot load the "DonaldDuckBean" and must also ignore the rest
-of the beans in the disneyEjbs.jar as they may need the "DonaldDuckBean"
-bean to function properly. The disneyEjbs.jar is skipped and the following
-warning is logged.
-
- WARN : Jar C:\openejb\beans\disneyEjbs.jar cannot be loaded. The Deployment ID "/my/favorite/duck" is already in use. Please redeploy this jar and assign a different deployment ID to the bean with the ejb-name "DonaldDuckBean".
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deployments.adoc
----------------------------------------------------------------------
diff --git a/docs/deployments.adoc b/docs/deployments.adoc
new file mode 100644
index 0000000..dc31d32
--- /dev/null
+++ b/docs/deployments.adoc
@@ -0,0 +1,146 @@
+# Deployments
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# The 'Deployments' element in openejb.xml
+
+== A single jar
+
+To include a single jar by name, just declare a 'Deployments' element
+with a 'jar' attribute pointing to the jar file on the file system.
+
+....
+<openejb>
+...
+<Deployments jar="c:\my\app\superEjbs.jar" />
+<Deployments jar="c:\someplace\purchasing.jar" />
+<Deployments jar="timeTrack.jar" />
+</openejb>
+....
+
+The last element in the example uses a relative path to point to the ejb
+jar. This path will be resolved relative to the openejb.base property.
+So, for example, of the value of openejb.base was 'c:' then OpenEJB
+would look for the jar 'c:.jar'. See the [OPENEJB:Configuration] guide
+for more details.
+
+== A directory of jars
+
+To point to a directory that contains several jar files that OpenEJB
+should load, simply declare a 'Deployments' element with a 'dir'
+attribute pointing to the directory containing the jar files.
+
+....
+<openejb>
+...
+
+<Deployments dir="c:\my\app\beans\" />
+<Deployments dir="c:\crimestopper\lib" />
+<Deployments dir="ejbs" />
+<Deployments dir="beans" />
+</openejb>
+....
+
+The directories listed will be searched for jars containing
+'META-INF/ejb-jar.xml' files and will be added to the list of jars to
+load if they do. Better said, it's completely safe to point to a
+directory containing a mix of ejbs and regular jar files. OpenEJB will
+simply skip over jars that do contain the required
+'META-INF/ejb-jar.xml' file.
+
+The last Deployments element declares a 'beans' directory relative to
+openejb.base for holding ejb jars. This declaration is simply convention
+and not required.
+
+== An unpacked jar
+
+As of 1.0 beta1, OpenEJB supports unpacked ejb jars. Simply meaning that
+you don't need to pack your ejb's into a jar file in order to use them
+in OpenEJB. You still need to follow the ejb jar layout and include an
+"META-INF/ejb-jar.xml" in the directory that contains your ejbs.
+
+For example, if you have a directory structure like this:
+
+....
+> C:\myapp\
+> C:\myapp\acmeEjbs\
+> C:\myapp\acmeEjbs\META-INF\ejb-jar.xml
+> C:\myapp\acmeEjbs\org\acme\Foo.class
+> C:\myapp\acmeEjbs\org\acme\FooBean.class
+> C:\myapp\acmeEjbs\org\acme\FooHome.class
+> C:\myapp\acmeEjbs\org\acme\Bar.class
+> C:\myapp\acmeEjbs\org\acme\BarBean.class
+> C:\myapp\acmeEjbs\org\acme\BarHome.class
+....
+
+Then you would delcare a 'Deployments' element with the 'dir' attribute
+set to 'C:' as shown below.
+
+....
+<openejb>
+...
+
+<Deployments dir="c:\myapp\acmeEjbs" />
+</openejb>
+....
+
+Note that this syntax is the same as the directory syntax above. If
+OpenEJB finds a META-INF directory with an 'ejb-jar.xml' fine inside,
+then OpenEJB will treat the directory as an unpacked ejb jar. Otherwise
+OpenEJB will look for ejb jar files to load as detailed in the above
+section.
+
+== Log file
+
+When trying to figure out if your ejbs were loaded, the openejb.log file
+is an incredible asset.
+
+If your ejbs were loaded successfully you should see entries like the
+following (1.x and higher only):
+
+....
+INFO : Loaded EJBs from
+/usr/local/openejb-1.0-beta1/beans/openejb-itests-beans.jar
+INFO : Loaded EJBs from
+/usr/local/openejb-1.0-beta1/beans/openejb-webadmin-clienttools.jar
+....
+
+If your ejbs failed to load, you will see an entry similar to the
+following.
+
+....
+WARN : Jar not loaded. /usr/local/openejb-1.0-beta1/beans/helloworld.jar.
+Jar failed validation. Use the validation tool for more details
+....
+
+Additionally, all the successfully loaded ejbs are individually listed
+in the log file at startup. The Deployment ID listed is the JNDI name
+used to lookup the ejb from a client of the Local or Remote Servers. The
+beans listed below are from our test suite.
+
+....
+DEBUG: Deployments : 19
+DEBUG: Type Deployment ID
+DEBUG: CMP_ENTITY client/tests/entity/cmp/RMI-over-IIOP/EJBHome
+DEBUG: STATEFUL client/tests/stateful/EncBean
+DEBUG: STATELESS client/tests/stateless/BeanManagedBasicStatelessHome
+DEBUG: STATEFUL client/tests/stateful/BasicStatefulHome
+DEBUG: STATELESS client/tests/stateless/EncBean
+DEBUG: STATEFUL client/tests/stateful/BeanManagedTransactionTests/EJBHome
+DEBUG: BMP_ENTITY client/tests/entity/bmp/RMI-over-IIOP/EJBHome
+DEBUG: STATEFUL client/tests/stateful/RMI-over-IIOP/EJBHome
+DEBUG: STATELESS client/tests/stateless/BeanManagedTransactionTests/EJBHome
+DEBUG: BMP_ENTITY client/tests/entity/bmp/allowed_operations/EntityHome
+DEBUG: CMP_ENTITY client/tests/entity/cmp/EncBean
+DEBUG: STATEFUL client/tests/stateful/BeanManagedBasicStatefulHome
+DEBUG: BMP_ENTITY client/tests/entity/bmp/BasicBmpHome
+DEBUG: STATELESS client/tests/stateless/BasicStatelessHome
+DEBUG: CMP_ENTITY client/tests/entity/cmp/BasicCmpHome
+DEBUG: STATELESS client/tools/DatabaseHome
+DEBUG: CMP_ENTITY client/tests/entity/cmp/allowed_operations/EntityHome
+DEBUG: BMP_ENTITY client/tests/entity/bmp/EncBean
+DEBUG: STATELESS client/tests/stateless/RMI-over-IIOP/EJBHome
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deployments.md
----------------------------------------------------------------------
diff --git a/docs/deployments.md b/docs/deployments.md
deleted file mode 100644
index a6d9be1..0000000
--- a/docs/deployments.md
+++ /dev/null
@@ -1,135 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=Deployments
-~~~~~~
-
-<a name="Deployments-The'Deployments'elementinopenejb.xml"></a>
-# The 'Deployments' element in openejb.xml
-
-<a name="Deployments-Asinglejar"></a>
-## A single jar
-
-To include a single jar by name, just declare a 'Deployments' element with
-a 'jar' attribute pointing to the jar file on the file system.
-
- <openejb>
- ...
- <Deployments jar="c:\my\app\superEjbs.jar" />
- <Deployments jar="c:\someplace\purchasing.jar" />
- <Deployments jar="timeTrack.jar" />
- </openejb>
-
-
-The last element in the example uses a relative path to point to the ejb
-jar. This path will be resolved relative to the openejb.base property.
-So, for example, of the value of openejb.base was 'c:\timeapp\' then
-OpenEJB would look for the jar 'c:\timeapp\timeTrack.jar'. See the [OPENEJB:Configuration]
- guide for more details.
-
-## A directory of jars
-
-To point to a directory that contains several jar files that OpenEJB should
-load, simply declare a 'Deployments' element with a 'dir' attribute
-pointing to the directory containing the jar files.
-
- <openejb>
- ...
-
- <Deployments dir="c:\my\app\beans\" />
- <Deployments dir="c:\crimestopper\lib" />
- <Deployments dir="ejbs" />
- <Deployments dir="beans" />
- </openejb>
-
-
-The directories listed will be searched for jars containing
-'META-INF/ejb-jar.xml' files and will be added to the list of jars to load
-if they do. Better said, it's completely safe to point to a directory
-containing a mix of ejbs and regular jar files. OpenEJB will simply skip
-over jars that do contain the required 'META-INF/ejb-jar.xml' file.
-
-The last Deployments element declares a 'beans' directory relative to
-openejb.base for holding ejb jars. This declaration is simply convention
-and not required.
-
-<a name="Deployments-Anunpackedjar"></a>
-## An unpacked jar
-
-As of 1.0 beta1, OpenEJB supports unpacked ejb jars. Simply meaning that
-you don't need to pack your ejb's into a jar file in order to use them in
-OpenEJB. You still need to follow the ejb jar layout and include an
-"META-INF/ejb-jar.xml" in the directory that contains your ejbs.
-
-For example, if you have a directory structure like this:
-
- > C:\myapp\
- > C:\myapp\acmeEjbs\
- > C:\myapp\acmeEjbs\META-INF\ejb-jar.xml
- > C:\myapp\acmeEjbs\org\acme\Foo.class
- > C:\myapp\acmeEjbs\org\acme\FooBean.class
- > C:\myapp\acmeEjbs\org\acme\FooHome.class
- > C:\myapp\acmeEjbs\org\acme\Bar.class
- > C:\myapp\acmeEjbs\org\acme\BarBean.class
- > C:\myapp\acmeEjbs\org\acme\BarHome.class
-
-Then you would delcare a 'Deployments' element with the 'dir' attribute set
-to 'C:\myapp\acmeEjbs' as shown below.
-
- <openejb>
- ...
-
- <Deployments dir="c:\myapp\acmeEjbs" />
- </openejb>
-
-
-Note that this syntax is the same as the directory syntax above. If
-OpenEJB finds a META-INF directory with an 'ejb-jar.xml' fine inside, then
-OpenEJB will treat the directory as an unpacked ejb jar. Otherwise OpenEJB
-will look for ejb jar files to load as detailed in the above section.
-
-# Log file
-
-When trying to figure out if your ejbs were loaded, the openejb.log file is
-an incredible asset.
-
-If your ejbs were loaded successfully you should see entries like the
-following (1.x and higher only):
-
- INFO : Loaded EJBs from
- /usr/local/openejb-1.0-beta1/beans/openejb-itests-beans.jar
- INFO : Loaded EJBs from
- /usr/local/openejb-1.0-beta1/beans/openejb-webadmin-clienttools.jar
-
-If your ejbs failed to load, you will see an entry similar to the
-following.
-
- WARN : Jar not loaded. /usr/local/openejb-1.0-beta1/beans/helloworld.jar.
- Jar failed validation. Use the validation tool for more details
-
-Additionally, all the successfully loaded ejbs are individually listed in
-the log file at startup. The Deployment ID listed is the JNDI name used to
-lookup the ejb from a client of the Local or Remote Servers. The beans
-listed below are from our test suite.
-
- DEBUG: Deployments : 19
- DEBUG: Type Deployment ID
- DEBUG: CMP_ENTITY client/tests/entity/cmp/RMI-over-IIOP/EJBHome
- DEBUG: STATEFUL client/tests/stateful/EncBean
- DEBUG: STATELESS client/tests/stateless/BeanManagedBasicStatelessHome
- DEBUG: STATEFUL client/tests/stateful/BasicStatefulHome
- DEBUG: STATELESS client/tests/stateless/EncBean
- DEBUG: STATEFUL client/tests/stateful/BeanManagedTransactionTests/EJBHome
- DEBUG: BMP_ENTITY client/tests/entity/bmp/RMI-over-IIOP/EJBHome
- DEBUG: STATEFUL client/tests/stateful/RMI-over-IIOP/EJBHome
- DEBUG: STATELESS client/tests/stateless/BeanManagedTransactionTests/EJBHome
- DEBUG: BMP_ENTITY client/tests/entity/bmp/allowed_operations/EntityHome
- DEBUG: CMP_ENTITY client/tests/entity/cmp/EncBean
- DEBUG: STATEFUL client/tests/stateful/BeanManagedBasicStatefulHome
- DEBUG: BMP_ENTITY client/tests/entity/bmp/BasicBmpHome
- DEBUG: STATELESS client/tests/stateless/BasicStatelessHome
- DEBUG: CMP_ENTITY client/tests/entity/cmp/BasicCmpHome
- DEBUG: STATELESS client/tools/DatabaseHome
- DEBUG: CMP_ENTITY client/tests/entity/cmp/allowed_operations/EntityHome
- DEBUG: BMP_ENTITY client/tests/entity/bmp/EncBean
- DEBUG: STATELESS client/tests/stateless/RMI-over-IIOP/EJBHome
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/details-on-openejb-jar.adoc
----------------------------------------------------------------------
diff --git a/docs/details-on-openejb-jar.adoc b/docs/details-on-openejb-jar.adoc
new file mode 100644
index 0000000..36ceb86
--- /dev/null
+++ b/docs/details-on-openejb-jar.adoc
@@ -0,0 +1,152 @@
+# Details on openejb-jar
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# What is an openejb-jar.xml?
+
+This is the file created by the Deploy Tool that maps your bean's
+deployment descriptor (ejb-jar.xml) to actual containers and resources
+declared in your OpenEJB configuration (openejb.conf). In fact, the
+Deploy tool really does nothing more than create this file and put it in
+your jar, that's it.
+
+# When is the openejb-jar.xml used?
+
+At startup, any jar containing a openejb-jar.xml is loaded by the
+container system. The configuration tools will go looking in all the
+directories and jars you have declared in your openejb.conf with the
+element. For every jar file it finds, it will look inside for an
+openejb-jar.xml. If it finds one, it will attempt to load and deploy it
+into the container system.
+
+# Do I even need the deploy tool then?
+
+Nope. Typically you would only use the deploy tool to create your
+openejb-jar.xml, then just keep your openejb-jar.xml in your CVS (or
+other repository). If you learn how to maintain this openejb-jar.xml
+file, you'll never need the deploy tool again! You can do all your
+builds and deploys automatically.
+
+# Where do I put the openejb-jar.xml in my jar?
+
+The openejb-jar.xml file just goes in the META-INF directory of your jar
+next to the ejb-jar.xml file.
+
+# Is the file format easy?
+
+If you can understand the ejb-jar.xml, the openejb-jar.xml should be a
+breeze.
+
+This is the openejb-jar.xml that is created by the Deploy tool in the
+Hello World example. As you can see, the file format is extremely
+simple.
+
+....
+<?xml version="1.0"?>
+<openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1">
+ <ejb-deployment ejb-name="Hello"
+ deployment-id="Hello"
+ container-id="Default Stateless Container"/>
+</openejb-jar>
+....
+
+The _ejb-name_ attribute is the name you gave the bean in your
+ejb-jar.xml. The _deployment-id_ is the name you want to use to lookup
+the bean in your client's JNDI namespace. The _container-id_ is the name
+of the container in your openejb.conf file that you would like the bean
+to run in. There MUST be one _ejb-deployment_ element for each EJB in
+your jar.
+
+== What if my bean uses a JDBC datasource?
+
+Then you simply add a element to your element like this
+
+....
+<?xml version="1.0"?>
+<openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1">
+
+ <ejb-deployment ejb-name="Hello"
+ deployment-id="Hello"
+ container-id="Default Stateless Container" >
+
+ <resource-link res-ref-name="jdbc/basic/entityDatabase"
+ res-id="Default JDBC Database"/>
+
+ </ejb-deployment>
+
+</openejb-jar>
+....
+
+The _res-ref-name_ attribute refers to the element of the bean's
+declaration in the ejb-jar.xml. The _res-id_ attribute refers to the id
+of the declared in your openejb.conf that will handle the connections
+and provide access to the desired resource.
+
+# How many resource-link elements will I need?
+
+You will need one element for every element in your ejb-jar.xml. So if
+you had an ejb-jar.xml like the following
+
+....
+<?xml version="1.0"?>
+<ejb-jar>
+ <enterprise-beans>
+ <session>
+ <ejb-name>MyExampleBean</ejb-name>
+ <home>com.widget.ExampleHome</home>
+ <remote>com.widget.ExampleObject</remote>
+ <ejb-class>com.widget.ExampleBean</ejb-class>
+ <session-type>Stateless</session-type>
+ <transaction-type>Container</transaction-type>
+
+ <resource-ref>
+ <description>
+ This is a reference to a JDBC database.
+ </description>
+ <res-ref-name>jdbc/myFirstDatabase</res-ref-name>
+ <res-type>javax.sql.DataSource</res-type>
+ <res-auth>Container</res-auth>
+ </resource-ref>
+
+ <resource-ref>
+ <description>
+ This is another reference to a JDBC database.
+ </description>
+ <res-ref-name>jdbc/anotherDatabase</res-ref-name>
+ <res-type>javax.sql.DataSource</res-type>
+ <res-auth>Container</res-auth>
+ </resource-ref>
+
+ </session>
+ </enterprise-beans>
+</ejb-jar>
+....
+
+Then you would need two elements for that bean in your openejb-jar.xml
+file as such.
+
+....
+<?xml version="1.0"?>
+<openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1">
+
+ <ejb-deployment ejb-name="MyExampleBean"
+ deployment-id="MyExampleBean"
+ container-id="Default Stateless Container" >
+
+ <resource-link res-ref-name="jdbc/myFirstDatabase"
+ res-id="My Oracle JDBC Database"/>
+
+ <resource-link res-ref-name="jdbc/anotherDatabase"
+ res-id="My PostgreSQL JDBC Database"/>
+
+ </ejb-deployment>
+
+</openejb-jar>
+....
+
+This would require two declarations in your openejb.conf, one with the
+_id_ attribute set to _"My Oracle JDBC Database"_ , and another with
+it's _id_ attribute set to _"My PostgreSQL JDBC Database"_
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/details-on-openejb-jar.md
----------------------------------------------------------------------
diff --git a/docs/details-on-openejb-jar.md b/docs/details-on-openejb-jar.md
deleted file mode 100644
index 8ab2848..0000000
--- a/docs/details-on-openejb-jar.md
+++ /dev/null
@@ -1,156 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Details on openejb-jar
-~~~~~~
-
-<a name="Detailsonopenejb-jar-Whatisanopenejb-jar.xml?"></a>
-# What is an openejb-jar.xml?
-
-This is the file created by the Deploy Tool that maps your bean's
-deployment descriptor (ejb-jar.xml) to actual containers and resources
-declared in your OpenEJB configuration (openejb.conf). In fact, the Deploy
-tool really does nothing more than create this file and put it in your jar,
-that's it.
-
-<a name="Detailsonopenejb-jar-Whenistheopenejb-jar.xmlused?"></a>
-# When is the openejb-jar.xml used?
-
-At startup, any jar containing a openejb-jar.xml is loaded by the container
-system. The configuration tools will go looking in all the directories and
-jars you have declared in your openejb.conf with the <Deployment> element.
-For every jar file it finds, it will look inside for an openejb-jar.xml. If
-it finds one, it will attempt to load and deploy it into the container
-system.
-
-<a name="Detailsonopenejb-jar-DoIevenneedthedeploytoolthen?"></a>
-# Do I even need the deploy tool then?
-
-Nope. Typically you would only use the deploy tool to create your
-openejb-jar.xml, then just keep your openejb-jar.xml in your CVS (or other
-repository). If you learn how to maintain this openejb-jar.xml file, you'll
-never need the deploy tool again! You can do all your builds and deploys
-automatically.
-
-<a name="Detailsonopenejb-jar-WheredoIputtheopenejb-jar.xmlinmyjar?"></a>
-# Where do I put the openejb-jar.xml in my jar?
-
-The openejb-jar.xml file just goes in the META-INF directory of your jar
-next to the ejb-jar.xml file.
-
-<a name="Detailsonopenejb-jar-Isthefileformateasy?"></a>
-# Is the file format easy?
-
-If you can understand the ejb-jar.xml, the openejb-jar.xml should be a
-breeze.
-
-This is the openejb-jar.xml that is created by the Deploy tool in the Hello
-World example. As you can see, the file format is extremely simple.
-
- <?xml version="1.0"?>
- <openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1">
- <ejb-deployment ejb-name="Hello"
- deployment-id="Hello"
- container-id="Default Stateless Container"/>
- </openejb-jar>
-
-
-
-The *ejb-name* attribute is the name you gave the bean in your ejb-jar.xml.
-The *deployment-id* is the name you want to use to lookup the bean in your
-client's JNDI namespace. The *container-id* is the name of the container in
-your openejb.conf file that you would like the bean to run in. There MUST
-be one *ejb-deployment* element for each EJB in your jar.
-
-# What if my bean uses a JDBC datasource?
-
-Then you simply add a <resource-link> element to your <ejb-deployment>
-element like this
-
- <?xml version="1.0"?>
- <openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1">
-
- <ejb-deployment ejb-name="Hello"
- deployment-id="Hello"
- container-id="Default Stateless Container" >
-
- <resource-link res-ref-name="jdbc/basic/entityDatabase"
- res-id="Default JDBC Database"/>
-
- </ejb-deployment>
-
- </openejb-jar>
-
-
-
-The *res-ref-name* attribute refers to the <res-ref-name> element of the
-bean's <resource-ref> declaration in the ejb-jar.xml. The *res-id*
-attribute refers to the id of the <Connector> declared in your openejb.conf
-that will handle the connections and provide access to the desired
-resource.
-
-<a name="Detailsonopenejb-jar-Howmanyresource-linkelementswillIneed?"></a>
-# How many resource-link elements will I need?
-
-You will need one <resource-link> element for every <resource-ref> element
-in your ejb-jar.xml. So if you had an ejb-jar.xml like the following
-
- <?xml version="1.0"?>
- <ejb-jar>
- <enterprise-beans>
- <session>
- <ejb-name>MyExampleBean</ejb-name>
- <home>com.widget.ExampleHome</home>
- <remote>com.widget.ExampleObject</remote>
- <ejb-class>com.widget.ExampleBean</ejb-class>
- <session-type>Stateless</session-type>
- <transaction-type>Container</transaction-type>
-
- <resource-ref>
- <description>
- This is a reference to a JDBC database.
- </description>
- <res-ref-name>jdbc/myFirstDatabase</res-ref-name>
- <res-type>javax.sql.DataSource</res-type>
- <res-auth>Container</res-auth>
- </resource-ref>
-
- <resource-ref>
- <description>
- This is another reference to a JDBC database.
- </description>
- <res-ref-name>jdbc/anotherDatabase</res-ref-name>
- <res-type>javax.sql.DataSource</res-type>
- <res-auth>Container</res-auth>
- </resource-ref>
-
- </session>
- </enterprise-beans>
- </ejb-jar>
-
-
-Then you would need two <resource-link> elements for that bean in your
-openejb-jar.xml file as such.
-
- <?xml version="1.0"?>
- <openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1">
-
- <ejb-deployment ejb-name="MyExampleBean"
- deployment-id="MyExampleBean"
- container-id="Default Stateless Container" >
-
- <resource-link res-ref-name="jdbc/myFirstDatabase"
- res-id="My Oracle JDBC Database"/>
-
- <resource-link res-ref-name="jdbc/anotherDatabase"
- res-id="My PostgreSQL JDBC Database"/>
-
- </ejb-deployment>
-
- </openejb-jar>
-
-
-
-This would require two <Connector> declarations in your openejb.conf, one
-with the *id* attribute set to _"My Oracle JDBC Database"_ , and another
-with it's *id* attribute set to _"My PostgreSQL JDBC Database"_
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/documentation.adoc
----------------------------------------------------------------------
diff --git a/docs/documentation.adoc b/docs/documentation.adoc
new file mode 100644
index 0000000..c3baa94
--- /dev/null
+++ b/docs/documentation.adoc
@@ -0,0 +1,103 @@
+# Documentation
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+See also the link:examples-trunk/index.html[examples page] for
+downloadable, executable and code-focused view of Java EE and TomEE. You
+can also find us on IRC freenode.org #openejb and #tomee
+
+\{row
+
+\{span-one-third ###IDE link:tomee-and-intellij.html[Get started with
+Intellij], link:contrib/debug/debug-intellij.html[Debugging in
+Intellij] +
+link:tomee-and-eclipse.html[Get started with Eclipse (WTP)] +
+link:getting-started-with-eclipse-and-webby.html[Get started with
+Eclipse (m2e-Webby)] +
+link:tomee-and-netbeans.html[Get started with Netbeans]
+
+###General Informations link:comparison.html[Comparison: OpenEJB, TomEE,
+TomEE+] +
+link:tomee-directory-structure.html[TomEE Directory structure] +
+link:deploying-in-tomee.html[Deploying in TomEE] +
+link:tomee-webapp.html[The 'tomee' webapp] +
+link:refcard/refcard.html[TomEE Reference Card] +
+link:application-composer/index.html[ApplicationComposer] +
+} \{span-one-third ###Configuration link:system-properties.html[System
+Properties] +
+link:deployments.html[Deployments] +
+link:Configuring-in-tomee.html[Configuring Resources] +
+link:configuring-datasources.html[Configuring DataSources] +
+link:containers-and-resources.html[Containers and Resources] +
+link:jms-resources-and-mdb-container.html[JMS Resources and MDB
+Container] +
+link:configuring-javamail.html[Configuring JavaMail] +
+link:tomee-and-security.html[TomEE Security] +
+link:security.html[Security How To] +
+link:clients.html[EJB Clients] +
+link:ejb-over-ssl.html[EJB over SSL] +
+link:jndi-names.html[JNDI Names] +
+link:changing-jms-implementations.html[Changing JMS implementations] +
+link:tomee-and-hibernate.html[Changing JPA to Hibernate] +
+} \{span-one-third ###Testing Techniques
+link:application-discovery-via-the-classpath.html[Application discovery
+via the classpath] +
+link:embedded-configuration.html[Embedded Configuration] +
+link:configuring-datasources-in-tests.html[Configuring DataSources in
+Tests] +
+link:configuring-persistenceunits-in-tests.html[Configuring
+PersistenceUnits in Tests] +
+link:configuring-containers-in-tests.html[Configuring Containers in
+Tests] +
+link:configuring-logging-in-tests.html[Configuring Logging in Tests] +
+link:alternate-descriptors.html[Alternate Descriptors] +
+link:unit-testing-transactions.html[Unit Testing Transactions] +
+link:testcase-with-testbean-inner-class.html[TestCase with TestBean
+inner-class] +
+[TestCase Injection (@LocalClient)](local-client-injection.html) +
+} } \{row
+
+\{span-one-third ###Discovery and Failover
+link:ejb-failover.html[Overview] +
+link:multicast-discovery.html[Multicast Discovery (UDP)] +
+link:multipulse-discovery.html[Multipulse Discovery (UDP)] +
+link:multipoint-discovery.html[Multipoint Discovery (TCP)] +
+link:multipoint-considerations.html[Multipoint Considerations] +
+link:multipoint-recommendations.html[Multipoint Recommendations] +
+link:failover-logging.html[Logging Events] +
+} \{span-one-third
+
+###OpenEJB Standalone Server
+link:understanding-the-directory-layout.html[Understanding the Directory
+Layout] +
+link:startup.html[Startup] +
+link:deploy-tool.html[Deploy Tool] +
+link:properties-tool.html[Properties Tool] +
+} \{span-one-third ###Spring link:spring-and-openejb-3.0.html[Spring and
+OpenEJB 3.0] +
+link:spring.html[Spring and OpenEJB 3.1 and later] +
+link:spring-ejb-and-jpa.html[Spring, EJB and JPA example] +
+} } \{row
+
+\{span-one-third ###Arquillian
+link:arquillian-getting-started.html[Arquillian Primer - What you need
+to know] +
+link:arquillian-available-adapters.html[Using the TomEE Arquillian
+adapters] +
+} \{span-one-third ###TomEE Maven Plugin
+link:tomee-mp-getting-started.html[Getting started] +
+link:maven/index.html[tomee-maven-plugin reference documentation] +
+link:tomee-embedded-maven-plugin.html[tomee-embedded-maven-plugin
+reference documentation] +
+link:tomee-mp-getting-started.html[TomEE simple webapp archetype
+documentation] +
+} \{span-one-third ###Tips and Tricks
+link:installation-drop-in-war.html[Install TomEE using the drop-in
+WAR] +
+link:tip-concurrency.html[Global Concurrency Management] +
+link:tip-weblogic.html[WebLogic Lookup] +
+link:tip-jersey-client.html[Jersey Client] +
+} }
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/documentation.md
----------------------------------------------------------------------
diff --git a/docs/documentation.md b/docs/documentation.md
deleted file mode 100644
index 2310807..0000000
--- a/docs/documentation.md
+++ /dev/null
@@ -1,106 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Documentation
-~~~~~~
-
-See also the [examples page](examples-trunk/index.html) for downloadable, executable and code-focused view of Java EE and TomEE.
-You can also find us on IRC freenode.org #openejb and #tomee
-
-{row
-
-{span-one-third
-###IDE
-[Get started with Intellij](tomee-and-intellij.html), [Debugging in Intellij](contrib/debug/debug-intellij.html)
-[Get started with Eclipse (WTP)](tomee-and-eclipse.html)
-[Get started with Eclipse (m2e-Webby)](getting-started-with-eclipse-and-webby.html)
-[Get started with Netbeans](tomee-and-netbeans.html)
-
-###General Informations
-[Comparison: OpenEJB, TomEE, TomEE+](comparison.html)
-[TomEE Directory structure](tomee-directory-structure.html)
-[Deploying in TomEE](deploying-in-tomee.html)
-[The 'tomee' webapp](tomee-webapp.html)
-[TomEE Reference Card](refcard/refcard.html)
-[ApplicationComposer](application-composer/index.html)
-}
-{span-one-third
-###Configuration
-[System Properties](system-properties.html)
-[Deployments](deployments.html)
-[Configuring Resources](Configuring-in-tomee.html)
-[Configuring DataSources](configuring-datasources.html)
-[Containers and Resources](containers-and-resources.html)
-[JMS Resources and MDB Container](jms-resources-and-mdb-container.html)
-[Configuring JavaMail](configuring-javamail.html)
-[TomEE Security](tomee-and-security.html)
-[Security How To](security.html)
-[EJB Clients](clients.html)
-[EJB over SSL](ejb-over-ssl.html)
-[JNDI Names](jndi-names.html)
-[Changing JMS implementations](changing-jms-implementations.html)
-[Changing JPA to Hibernate](tomee-and-hibernate.html)
-}
-{span-one-third
-###Testing Techniques
-[Application discovery via the classpath](application-discovery-via-the-classpath.html)
-[Embedded Configuration](embedded-configuration.html)
-[Configuring DataSources in Tests](configuring-datasources-in-tests.html)
-[Configuring PersistenceUnits in Tests](configuring-persistenceunits-in-tests.html)
-[Configuring Containers in Tests](configuring-containers-in-tests.html)
-[Configuring Logging in Tests](configuring-logging-in-tests.html)
-[Alternate Descriptors](alternate-descriptors.html)
-[Unit Testing Transactions](unit-testing-transactions.html)
-[TestCase with TestBean inner-class](testcase-with-testbean-inner-class.html)
-[TestCase Injection (@LocalClient)](local-client-injection.html)
-}
-}
-{row
-
-{span-one-third
-###Discovery and Failover
-[Overview](ejb-failover.html)
-[Multicast Discovery (UDP)](multicast-discovery.html)
-[Multipulse Discovery (UDP)](multipulse-discovery.html)
-[Multipoint Discovery (TCP)](multipoint-discovery.html)
-[Multipoint Considerations](multipoint-considerations.html)
-[Multipoint Recommendations](multipoint-recommendations.html)
-[Logging Events](failover-logging.html)
-}
-{span-one-third
-
-###OpenEJB Standalone Server
-[Understanding the Directory Layout](understanding-the-directory-layout.html)
-[Startup](startup.html)
-[Deploy Tool](deploy-tool.html)
-[Properties Tool](properties-tool.html)
-}
-{span-one-third
-###Spring
-[Spring and OpenEJB 3.0](spring-and-openejb-3.0.html)
-[Spring and OpenEJB 3.1 and later](spring.html)
-[Spring, EJB and JPA example](spring-ejb-and-jpa.html)
-}
-}
-{row
-
-{span-one-third
-###Arquillian
-[Arquillian Primer - What you need to know](arquillian-getting-started.html)
-[Using the TomEE Arquillian adapters](arquillian-available-adapters.html)
-}
-{span-one-third
-###TomEE Maven Plugin
-[Getting started](tomee-mp-getting-started.html)
-[tomee-maven-plugin reference documentation](maven/index.html)
-[tomee-embedded-maven-plugin reference documentation](tomee-embedded-maven-plugin.html)
-[TomEE simple webapp archetype documentation](tomee-mp-getting-started.html)
-}
-{span-one-third
-###Tips and Tricks
-[Install TomEE using the drop-in WAR](installation-drop-in-war.html)
-[Global Concurrency Management](tip-concurrency.html)
-[WebLogic Lookup](tip-weblogic.html)
-[Jersey Client](tip-jersey-client.html)
-}
-}
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/documentation.old.adoc
----------------------------------------------------------------------
diff --git a/docs/documentation.old.adoc b/docs/documentation.old.adoc
new file mode 100644
index 0000000..c7fe243
--- /dev/null
+++ b/docs/documentation.old.adoc
@@ -0,0 +1,98 @@
+Title: Documentation
+
+See also the link:examples-trunk/index.html[examples page] for
+downloadable, executable and code-focused view of Java EE and TomEE. You
+can also find us on IRC freenode.org #openejb and #tomee
+
+\{row
+
+\{span-one-third ###IDE link:tomee-and-intellij.html[Get started with
+Intellij], link:contrib/debug/debug-intellij.html[Debugging in
+Intellij] +
+link:tomee-and-eclipse.html[Get started with Eclipse (WTP)] +
+link:getting-started-with-eclipse-and-webby.html[Get started with
+Eclipse (m2e-Webby)] +
+link:tomee-and-netbeans.html[Get started with Netbeans]
+
+###General Informations link:comparison.html[Comparison: OpenEJB, TomEE,
+TomEE+] +
+link:tomee-directory-structure.html[TomEE Directory structure] +
+link:deploying-in-tomee.html[Deploying in TomEE] +
+link:tomee-webapp.html[The 'tomee' webapp] +
+link:refcard/refcard.html[TomEE Reference Card] +
+link:application-composer/index.html[ApplicationComposer] +
+} \{span-one-third ###Configuration link:system-properties.html[System
+Properties] +
+link:deployments.html[Deployments] +
+link:Configuring-in-tomee.html[Configuring Resources] +
+link:configuring-datasources.html[Configuring DataSources] +
+link:containers-and-resources.html[Containers and Resources] +
+link:jms-resources-and-mdb-container.html[JMS Resources and MDB
+Container] +
+link:configuring-javamail.html[Configuring JavaMail] +
+link:tomee-and-security.html[TomEE Security] +
+link:security.html[Security How To] +
+link:clients.html[EJB Clients] +
+link:ejb-over-ssl.html[EJB over SSL] +
+link:jndi-names.html[JNDI Names] +
+link:changing-jms-implementations.html[Changing JMS implementations] +
+link:tomee-and-hibernate.html[Changing JPA to Hibernate] +
+} \{span-one-third ###Testing Techniques
+link:application-discovery-via-the-classpath.html[Application discovery
+via the classpath] +
+link:embedded-configuration.html[Embedded Configuration] +
+link:configuring-datasources-in-tests.html[Configuring DataSources in
+Tests] +
+link:configuring-persistenceunits-in-tests.html[Configuring
+PersistenceUnits in Tests] +
+link:configuring-containers-in-tests.html[Configuring Containers in
+Tests] +
+link:configuring-logging-in-tests.html[Configuring Logging in Tests] +
+link:alternate-descriptors.html[Alternate Descriptors] +
+link:unit-testing-transactions.html[Unit Testing Transactions] +
+link:testcase-with-testbean-inner-class.html[TestCase with TestBean
+inner-class] +
+[TestCase Injection (@LocalClient)](local-client-injection.html) +
+} } \{row
+
+\{span-one-third ###Discovery and Failover
+link:ejb-failover.html[Overview] +
+link:multicast-discovery.html[Multicast Discovery (UDP)] +
+link:multipulse-discovery.html[Multipulse Discovery (UDP)] +
+link:multipoint-discovery.html[Multipoint Discovery (TCP)] +
+link:multipoint-considerations.html[Multipoint Considerations] +
+link:multipoint-recommendations.html[Multipoint Recommendations] +
+link:failover-logging.html[Logging Events] +
+} \{span-one-third
+
+###OpenEJB Standalone Server
+link:understanding-the-directory-layout.html[Understanding the Directory
+Layout] +
+link:startup.html[Startup] +
+link:deploy-tool.html[Deploy Tool] +
+link:properties-tool.html[Properties Tool] +
+} \{span-one-third ###Spring link:spring-and-openejb-3.0.html[Spring and
+OpenEJB 3.0] +
+link:spring.html[Spring and OpenEJB 3.1 and later] +
+link:spring-ejb-and-jpa.html[Spring, EJB and JPA example] +
+} } \{row
+
+\{span-one-third ###Arquillian
+link:arquillian-getting-started.html[Arquillian Primer - What you need
+to know] +
+link:arquillian-available-adapters.html[Using the TomEE Arquillian
+adapters] +
+} \{span-one-third ###TomEE Maven Plugin
+link:tomee-mp-getting-started.html[Getting started] +
+link:maven/index.html[tomee-maven-plugin reference documentation] +
+link:tomee-embedded-maven-plugin.html[tomee-embedded-maven-plugin
+reference documentation] +
+link:tomee-mp-getting-started.html[TomEE simple webapp archetype
+documentation] +
+} \{span-one-third ###Tips and Tricks
+link:installation-drop-in-war.html[Install TomEE using the drop-in
+WAR] +
+link:tip-concurrency.html[Global Concurrency Management] +
+link:tip-weblogic.html[WebLogic Lookup] +
+link:tip-jersey-client.html[Jersey Client] +
+} }
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/documentation.old.md
----------------------------------------------------------------------
diff --git a/docs/documentation.old.md b/docs/documentation.old.md
deleted file mode 100644
index b0f4238..0000000
--- a/docs/documentation.old.md
+++ /dev/null
@@ -1,102 +0,0 @@
-Title: Documentation
-
-See also the [examples page](examples-trunk/index.html) for downloadable, executable and code-focused view of Java EE and TomEE.
-You can also find us on IRC freenode.org #openejb and #tomee
-
-{row
-
-{span-one-third
-###IDE
-[Get started with Intellij](tomee-and-intellij.html), [Debugging in Intellij](contrib/debug/debug-intellij.html)
-[Get started with Eclipse (WTP)](tomee-and-eclipse.html)
-[Get started with Eclipse (m2e-Webby)](getting-started-with-eclipse-and-webby.html)
-[Get started with Netbeans](tomee-and-netbeans.html)
-
-###General Informations
-[Comparison: OpenEJB, TomEE, TomEE+](comparison.html)
-[TomEE Directory structure](tomee-directory-structure.html)
-[Deploying in TomEE](deploying-in-tomee.html)
-[The 'tomee' webapp](tomee-webapp.html)
-[TomEE Reference Card](refcard/refcard.html)
-[ApplicationComposer](application-composer/index.html)
-}
-{span-one-third
-###Configuration
-[System Properties](system-properties.html)
-[Deployments](deployments.html)
-[Configuring Resources](Configuring-in-tomee.html)
-[Configuring DataSources](configuring-datasources.html)
-[Containers and Resources](containers-and-resources.html)
-[JMS Resources and MDB Container](jms-resources-and-mdb-container.html)
-[Configuring JavaMail](configuring-javamail.html)
-[TomEE Security](tomee-and-security.html)
-[Security How To](security.html)
-[EJB Clients](clients.html)
-[EJB over SSL](ejb-over-ssl.html)
-[JNDI Names](jndi-names.html)
-[Changing JMS implementations](changing-jms-implementations.html)
-[Changing JPA to Hibernate](tomee-and-hibernate.html)
-}
-{span-one-third
-###Testing Techniques
-[Application discovery via the classpath](application-discovery-via-the-classpath.html)
-[Embedded Configuration](embedded-configuration.html)
-[Configuring DataSources in Tests](configuring-datasources-in-tests.html)
-[Configuring PersistenceUnits in Tests](configuring-persistenceunits-in-tests.html)
-[Configuring Containers in Tests](configuring-containers-in-tests.html)
-[Configuring Logging in Tests](configuring-logging-in-tests.html)
-[Alternate Descriptors](alternate-descriptors.html)
-[Unit Testing Transactions](unit-testing-transactions.html)
-[TestCase with TestBean inner-class](testcase-with-testbean-inner-class.html)
-[TestCase Injection (@LocalClient)](local-client-injection.html)
-}
-}
-{row
-
-{span-one-third
-###Discovery and Failover
-[Overview](ejb-failover.html)
-[Multicast Discovery (UDP)](multicast-discovery.html)
-[Multipulse Discovery (UDP)](multipulse-discovery.html)
-[Multipoint Discovery (TCP)](multipoint-discovery.html)
-[Multipoint Considerations](multipoint-considerations.html)
-[Multipoint Recommendations](multipoint-recommendations.html)
-[Logging Events](failover-logging.html)
-}
-{span-one-third
-
-###OpenEJB Standalone Server
-[Understanding the Directory Layout](understanding-the-directory-layout.html)
-[Startup](startup.html)
-[Deploy Tool](deploy-tool.html)
-[Properties Tool](properties-tool.html)
-}
-{span-one-third
-###Spring
-[Spring and OpenEJB 3.0](spring-and-openejb-3.0.html)
-[Spring and OpenEJB 3.1 and later](spring.html)
-[Spring, EJB and JPA example](spring-ejb-and-jpa.html)
-}
-}
-{row
-
-{span-one-third
-###Arquillian
-[Arquillian Primer - What you need to know](arquillian-getting-started.html)
-[Using the TomEE Arquillian adapters](arquillian-available-adapters.html)
-}
-{span-one-third
-###TomEE Maven Plugin
-[Getting started](tomee-mp-getting-started.html)
-[tomee-maven-plugin reference documentation](maven/index.html)
-[tomee-embedded-maven-plugin reference documentation](tomee-embedded-maven-plugin.html)
-[TomEE simple webapp archetype documentation](tomee-mp-getting-started.html)
-}
-{span-one-third
-###Tips and Tricks
-[Install TomEE using the drop-in WAR](installation-drop-in-war.html)
-[Global Concurrency Management](tip-concurrency.html)
-[WebLogic Lookup](tip-weblogic.html)
-[Jersey Client](tip-jersey-client.html)
-}
-}
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/dynamic-datasource.adoc
----------------------------------------------------------------------
diff --git a/docs/dynamic-datasource.adoc b/docs/dynamic-datasource.adoc
new file mode 100644
index 0000000..95bf338
--- /dev/null
+++ b/docs/dynamic-datasource.adoc
@@ -0,0 +1,219 @@
+# Dynamic Datasource
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# OpenEJB dynamic datasource
+
+== Goal
+
+The openejb dynamic datasource api aims to allow to use multiple data
+sources as one.
+
+It can be useful for technical reasons (load balancing for example) or
+functionnal reasons (filtering, aggregation, enriching...).
+
+== The API
+
+The interface Router (_org.apache.openejb.resource.jdbc.Router_) have
+only one method to get the datasource to use:
+
+....
+Router.getDataSource()
+....
+
+The _org.apache.openejb.resource.jdbc.RoutedDataSource_ wraps a
+classical data source. It has to be used to declare your datasource.
+
+You can implement all the policy you want in your Router implementation.
+
+A class called _org.apache.openejb.resource.jdbc.AbstractRouter_ is
+available to ease router development.
+
+== Known limitation(s)
+
+You have to use the same kind of databases (same version, same
+configuration...).
+
+All database have to be created when you use the router. The way to do
+it automatically can depend of your JPA provider.
+
+=== OpenJPA
+
+OpenJPA initializes its database when the entitymanager is called for
+the first time so you need to initialize all your proxied datasource
+before using the other one. It can be done using an Init EJB doing a
+find() on each proxied datasource.
+
+=== Hibernate
+
+Hibernate initializes the database when it starts so if you declare a
+persistence unit by database all databases will be initialized at the
+start up.
+
+== Example
+
+=== The story (the unit test example)
+
+You want to use only one datasource in the code but you have a criteria
+to set to choose the real database to use between three.
+
+So in your code you want something like:
+
+....
+public class RoutedEJBBean {
+ @PersistenceContext(unitName = "router")
+ private EntityManager em;
+
+ // this router is not automatic, we
+ // need it to select the database to use
+ @Resource(name = "My Router")
+ private DeterminedRouter router;
+
+ public void persist(int id, String name, String clientDatasource) {
+ router.setDataSource(clientDatasource);
+ em.persist(new Person(id, name));
+ }
+}
+....
+
+== The router implementation
+
+The router will simply manage a map to store proxied datasources and a
+field to store the datasource used in the current thread (ThreadLocal).
+
+....
+public class DeterminedRouter implements Router {
+ private String dataSourceNames; // used to store configuration (openejb.xml)
+ private String defaultDataSourceName; // defautl data source name
+ private Map<String, DataSource> dataSources = null; // proxied data sources
+ private ThreadLocal<DataSource> currentDataSource = new ThreadLocal<DataSource>(); // the datasource to use or null
+
+ /**
+ * @param datasourceList datasource resource name, separator is a space
+ */
+ public void setDataSourceNames(String datasourceList) {
+ dataSourceNames = datasourceList;
+ }
+
+ /**
+ * lookup datasource in openejb resources
+ */
+ private void init() { // looking up datasources declared as proxied
+ dataSources = new ConcurrentHashMap<String, DataSource>();
+ for (String ds : dataSourceNames.split(" ")) {
+ ContainerSystem containerSystem = SystemInstance.get().getComponent(ContainerSystem.class);
+
+ Object o = null;
+ Context ctx = containerSystem.getJNDIContext();
+ try {
+ o = ctx.lookup("openejb:Resource/" + ds);
+ if (o instanceof DataSource) {
+ dataSources.put(ds, (DataSource) o);
+ }
+ } catch (NamingException ignore) {
+ }
+ }
+ }
+
+ /**
+ * @return the user selected data source if it is set
+ * or the default one
+ * @throws IllegalArgumentException if the data source is not found
+ */
+ public DataSource getDataSource() {
+ // lazy init of routed datasources
+ if (dataSources == null) {
+ init();
+ }
+
+ // if no datasource is selected use the default one
+ if (currentDataSource.get() == null) {
+ if (dataSources.containsKey(defaultDataSourceName)) {
+ return dataSources.get(defaultDataSourceName);
+
+ } else {
+ throw new IllegalArgumentException("you have to specify at least one datasource");
+ }
+ }
+
+ // the developper set the datasource to use
+ return currentDataSource.get();
+ }
+
+ /**
+ *
+ * @param datasourceName data source name
+ */
+ public void setDataSource(String datasourceName) {
+ if (dataSources == null) {
+ init();
+ }
+ if (!dataSources.containsKey(datasourceName)) {
+ throw new IllegalArgumentException("data source called " + datasourceName + " can't be found.");
+ }
+ DataSource ds = dataSources.get(datasourceName);
+ currentDataSource.set(ds);
+ }
+
+ public void setDefaultDataSourceName(String name) {
+ this.defaultDataSourceName = name;
+ }
+}
+....
+
+== Creation of the service provider for the router
+
+To be able to use your router add a file called service-jar.xml under
+META-INF/. For example META-INF/org.router.
+
+This file will contain something like:
+
+....
+<ServiceJar>
+ <ServiceProvider id="DeterminedRouter" service="Resource"
+ type="org.apache.openejb.resource.jdbc.Router" class-name="implementation class">
+ Param defaultValue
+ ParamWithNoDefaultValue
+ </ServiceProvider>
+</ServiceJar>
+....
+
+== openejb.xml
+
+In the openejb.xml file, you have to declare your dynamic database and
+in our example it needs the proxied datasources too:
+
+....
+<Resource id="router" type="<your implementation>" provider="<your provider>">
+ Param value
+</Resource>
+
+<Resource id="route db" type="DataSource" provider="RoutedDataSource">
+ Router router
+</Resource>
+
+<!–- real databases – for our example -->
+<Resource id="db1" type="DataSource">
+ JdbcDriver org.hsqldb.jdbcDriver
+ JdbcUrl jdbc:hsqldb:mem:db1
+ UserName sa
+ Password
+ JtaManaged true
+</Resource>
+<Resource id="db2" type="DataSource">
+ JdbcDriver org.hsqldb.jdbcDriver
+ JdbcUrl jdbc:hsqldb:mem:db2
+ UserName sa
+ Password
+ JtaManaged true
+</Resource>
+<Resource id="db3" type="DataSource">
+ JdbcDriver org.hsqldb.jdbcDriver
+ JdbcUrl jdbc:hsqldb:mem:db3
+ UserName sa
+ Password
+ JtaManaged true
+</Resource>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/dynamic-datasource.md
----------------------------------------------------------------------
diff --git a/docs/dynamic-datasource.md b/docs/dynamic-datasource.md
deleted file mode 100644
index 5f7ca11..0000000
--- a/docs/dynamic-datasource.md
+++ /dev/null
@@ -1,220 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Dynamic Datasource
-~~~~~~
-<a name="DynamicDatasource-OpenEJBdynamicdatasource"></a>
-# OpenEJB dynamic datasource
-
-<a name="DynamicDatasource-Goal"></a>
-## Goal
-
-The openejb dynamic datasource api aims to allow to use multiple data
-sources as one.
-
-It can be useful for technical reasons (load balancing for example) or
-functionnal reasons (filtering, aggregation, enriching...).
-
-<a name="DynamicDatasource-TheAPI"></a>
-## The API
-
-The interface Router (*org.apache.openejb.resource.jdbc.Router*) have
-only one method to get the datasource to use:
-
- Router.getDataSource()
-
-The *org.apache.openejb.resource.jdbc.RoutedDataSource* wraps a classical
-data source. It has to be used to declare your datasource.
-
-You can implement all the policy you want in your Router implementation.
-
-A class called *org.apache.openejb.resource.jdbc.AbstractRouter* is
-available to ease router development.
-
-<a name="DynamicDatasource-Knownlimitation(s)"></a>
-## Known limitation(s)
-
-You have to use the same kind of databases (same version, same
-configuration...).
-
-All database have to be created when you use the router. The way to do it
-automatically can depend of your JPA provider.
-
-<a name="DynamicDatasource-OpenJPA"></a>
-### OpenJPA
-
-OpenJPA initializes its database when the entitymanager is called for the
-first time so you need to initialize all your proxied datasource before
-using the other one. It can be done using an Init EJB doing a find() on
-each proxied datasource.
-
-<a name="DynamicDatasource-Hibernate"></a>
-### Hibernate
-
-Hibernate initializes the database when it starts so if you declare a
-persistence unit by database all databases will be initialized at the start
-up.
-
-<a name="DynamicDatasource-Example"></a>
-## Example
-
-<a name="DynamicDatasource-Thestory(theunittestexample)"></a>
-### The story (the unit test example)
-
-You want to use only one datasource in the code but you have a criteria to
-set to choose the real database to use between three.
-
-So in your code you want something like:
-
- public class RoutedEJBBean {
- @PersistenceContext(unitName = "router")
- private EntityManager em;
-
- // this router is not automatic, we
- // need it to select the database to use
- @Resource(name = "My Router")
- private DeterminedRouter router;
-
- public void persist(int id, String name, String clientDatasource) {
- router.setDataSource(clientDatasource);
- em.persist(new Person(id, name));
- }
- }
-
-
-<a name="DynamicDatasource-Therouterimplementation"></a>
-## The router implementation
-
-The router will simply manage a map to store proxied datasources and a
-field to store the datasource used in the current thread (ThreadLocal).
-
- public class DeterminedRouter implements Router {
- private String dataSourceNames; // used to store configuration (openejb.xml)
- private String defaultDataSourceName; // defautl data source name
- private Map<String, DataSource> dataSources = null; // proxied data sources
- private ThreadLocal<DataSource> currentDataSource = new ThreadLocal<DataSource>(); // the datasource to use or null
-
- /**
- * @param datasourceList datasource resource name, separator is a space
- */
- public void setDataSourceNames(String datasourceList) {
- dataSourceNames = datasourceList;
- }
-
- /**
- * lookup datasource in openejb resources
- */
- private void init() { // looking up datasources declared as proxied
- dataSources = new ConcurrentHashMap<String, DataSource>();
- for (String ds : dataSourceNames.split(" ")) {
- ContainerSystem containerSystem = SystemInstance.get().getComponent(ContainerSystem.class);
-
- Object o = null;
- Context ctx = containerSystem.getJNDIContext();
- try {
- o = ctx.lookup("openejb:Resource/" + ds);
- if (o instanceof DataSource) {
- dataSources.put(ds, (DataSource) o);
- }
- } catch (NamingException ignore) {
- }
- }
- }
-
- /**
- * @return the user selected data source if it is set
- * or the default one
- * @throws IllegalArgumentException if the data source is not found
- */
- public DataSource getDataSource() {
- // lazy init of routed datasources
- if (dataSources == null) {
- init();
- }
-
- // if no datasource is selected use the default one
- if (currentDataSource.get() == null) {
- if (dataSources.containsKey(defaultDataSourceName)) {
- return dataSources.get(defaultDataSourceName);
-
- } else {
- throw new IllegalArgumentException("you have to specify at least one datasource");
- }
- }
-
- // the developper set the datasource to use
- return currentDataSource.get();
- }
-
- /**
- *
- * @param datasourceName data source name
- */
- public void setDataSource(String datasourceName) {
- if (dataSources == null) {
- init();
- }
- if (!dataSources.containsKey(datasourceName)) {
- throw new IllegalArgumentException("data source called " + datasourceName + " can't be found.");
- }
- DataSource ds = dataSources.get(datasourceName);
- currentDataSource.set(ds);
- }
-
- public void setDefaultDataSourceName(String name) {
- this.defaultDataSourceName = name;
- }
- }
-
-
-<a name="DynamicDatasource-Creationoftheserviceproviderfortherouter"></a>
-## Creation of the service provider for the router
-
-To be able to use your router add a file called service-jar.xml under
-META-INF/<package>. For example META-INF/org.router.
-
-This file will contain something like:
-
- <ServiceJar>
- <ServiceProvider id="DeterminedRouter" service="Resource"
- type="org.apache.openejb.resource.jdbc.Router" class-name="implementation class">
- Param defaultValue
- ParamWithNoDefaultValue
- </ServiceProvider>
- </ServiceJar>
-
-## openejb.xml
-
-In the openejb.xml file, you have to declare your dynamic database and in
-our example it needs the proxied datasources too:
-
- <Resource id="router" type="<your implementation>" provider="<your provider>">
- Param value
- </Resource>
-
- <Resource id="route db" type="DataSource" provider="RoutedDataSource">
- Router router
- </Resource>
-
- <!–- real databases – for our example -->
- <Resource id="db1" type="DataSource">
- JdbcDriver org.hsqldb.jdbcDriver
- JdbcUrl jdbc:hsqldb:mem:db1
- UserName sa
- Password
- JtaManaged true
- </Resource>
- <Resource id="db2" type="DataSource">
- JdbcDriver org.hsqldb.jdbcDriver
- JdbcUrl jdbc:hsqldb:mem:db2
- UserName sa
- Password
- JtaManaged true
- </Resource>
- <Resource id="db3" type="DataSource">
- JdbcDriver org.hsqldb.jdbcDriver
- JdbcUrl jdbc:hsqldb:mem:db3
- UserName sa
- Password
- JtaManaged true
- </Resource>
[03/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 3
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/containers-and-resources.md
----------------------------------------------------------------------
diff --git a/docs/containers-and-resources.md b/docs/containers-and-resources.md
deleted file mode 100644
index 941fa0b..0000000
--- a/docs/containers-and-resources.md
+++ /dev/null
@@ -1,483 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=Containers and Resources
-~~~~~~
-
-<div id="PageContent">
- <p><a name="ContainersandResources-containers"></a></p>
-<p><a name="ContainersandResources-DefaultCMPContainercontainer"></a></p>
-<h2><a name="ContainersandResources-CMPENTITY"></a>CMP_ENTITY</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"CMP_ENTITY"</span>></span>
-<span class="code-tag"></Container></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Container?type=CMP_ENTITY</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > CmpEngineFactory </td>
-<td > Default value is <em>org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory</em>.</td>
-</tr>
-</tbody></table>
-</div>
-
-<p><a name="ContainersandResources-TransactionManager"></a></p>
-<h2><a name="ContainersandResources-TxMgr"></a>TransactionManager</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><TransactionManager type=<span class="code-quote">"javax.transaction.TransactionManager"</span>></span>
-<span class="code-tag"></TransactionManager></span>
-</pre>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > defaultTransactionTimeoutSeconds </td>
-<td > Default value is <em>10 minutes</em>.</td>
-</tr>
-</tbody></table>
-</div>
-
-
-<p><a name="ContainersandResources-DefaultBMPContainercontainer"></a></p>
-<h2><a name="ContainersandResources-BMPENTITY"></a>BMP_ENTITY</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"BMP_ENTITY"</span>></span>
-<span class="code-tag"></Container></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Container?type=BMP_ENTITY</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > PoolSize </td>
-<td > Specifies the size of the bean pools for this<br class="atl-forced-newline"> bmp entity container.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>10</em>.</td>
-</tr>
-</tbody></table>
-</div>
-
-
-<p><a name="ContainersandResources-DefaultStatelessContainercontainer"></a></p>
-<h2><a name="ContainersandResources-STATELESS"></a>STATELESS</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"STATELESS"</span>></span>
-<span class="code-tag"></Container></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Container?type=STATELESS</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > TimeOut </td>
-<td > Specifies the time to wait between invocations. This<br class="atl-forced-newline"> value is measured in milliseconds. A value of 5 would<br class="atl-forced-newline"> result in a time-out of 5 milliseconds between invocations.<br class="atl-forced-newline"> A value of zero would mean no timeout.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td>
-</tr>
-<tr>
-<td > PoolSize </td>
-<td > Specifies the size of the bean pools for this<br class="atl-forced-newline"> stateless SessionBean container.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>10</em>.</td>
-</tr>
-<tr>
-<td > StrictPooling </td>
-<td > StrictPooling tells the container what to do when the pool<br class="atl-forced-newline"> reaches it's maximum size and there are incoming requests<br class="atl-forced-newline"> that need instances.<br class="atl-forced-newline"> <br class="atl-forced-newline"> With strict pooling, requests will have to wait for instances<br class="atl-forced-newline"> to become available. The pool size will never grow beyond the<br class="atl-forced-newline"> the set PoolSize value.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Without strict pooling, the container will create temporary<br class="atl-forced-newline"> instances to meet demand. The instances will last for just one<br class="atl-forced-newline"> method invocation and then are removed.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>true</em>.</td>
-</tr>
-</tbody></table>
-</div>
-
-
-<p><a name="ContainersandResources-DefaultStatefulContainercontainer"></a></p>
-<h2><a name="ContainersandResources-STATEFUL"></a>STATEFUL</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"STATEFUL"</span>></span>
-<span class="code-tag"></Container></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Container?type=STATEFUL</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > Passivator </td>
-<td > The passivator is responsible for writing beans to disk<br class="atl-forced-newline"> at passivation time. Different passivators can be used<br class="atl-forced-newline"> by setting this property to the fully qualified class name<br class="atl-forced-newline"> of the PassivationStrategy implementation. The passivator<br class="atl-forced-newline"> is not responsible for invoking any callbacks or other<br class="atl-forced-newline"> processing, its only responsibly is to write the bean state<br class="atl-forced-newline"> to disk.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Known implementations:<br class="atl-forced-newline"> org.apache.openejb.core.stateful.RAFPassivater<br class="atl-forced-newline"> org.apache.openejb.core.stateful.SimplePassivater<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>org.apache.openejb.core.stateful.SimplePassivater</em>.</td>
-</tr>
-<tr>
-<td > TimeOut </td>
-<td > Specifies the time to wait between invocations. This<br class="atl-forced-newline"> value is measured in minutes. A value of 5 would<br class="atl-forced-newline"> result in a time-out of 5 minutes between invocations.<br class="atl-forced-newline"> A value of zero would mean no timeout.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>20</em>.</td>
-</tr>
-<tr>
-<td > PoolSize </td>
-<td > Specifies the size of the bean pools for this<br class="atl-forced-newline"> stateful SessionBean container.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>1000</em>.</td>
-</tr>
-<tr>
-<td > BulkPassivate </td>
-<td > Property name that specifies the number of instances<br class="atl-forced-newline"> to passivate at one time when doing bulk passivation.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>100</em>.</td>
-</tr>
-</tbody></table>
-</div>
-
-
-<p><a name="ContainersandResources-DefaultMDBContainercontainer"></a></p>
-<h2><a name="ContainersandResources-MESSAGE"></a>MESSAGE</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"MESSAGE"</span>></span>
-<span class="code-tag"></Container></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Container?type=MESSAGE</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > ResourceAdapter </td>
-<td > The resource adapter delivers messages to the container<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>Default JMS Resource Adapter</em>.</td>
-</tr>
-<tr>
-<td > MessageListenerInterface </td>
-<td > Specifies the message listener interface handled by this container<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>javax.jms.MessageListener</em>.</td>
-</tr>
-<tr>
-<td > ActivationSpecClass </td>
-<td > Specifies the activation spec class<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>org.apache.activemq.ra.ActiveMQActivationSpec</em>.</td>
-</tr>
-<tr>
-<td > InstanceLimit </td>
-<td > Specifies the maximum number of bean instances that are<br class="atl-forced-newline"> allowed to exist for each MDB deployment.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>10</em>.</td>
-</tr>
-</tbody></table>
-</div>
-
-
-
-<p><a name="ContainersandResources-resources"></a></p>
-<h1><a name="ContainersandResources-Resources"></a>Resources</h1>
-<p><a name="ContainersandResources-DefaultJDBCDatabaseresource"></a></p>
-<h2><a name="ContainersandResources-javax.sql.DataSource"></a>javax.sql.DataSource</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.sql.DataSource"</span>></span>
-<span class="code-tag"></Resource></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Resource?type=javax.sql.DataSource</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > JtaManaged </td>
-<td > Determines wether or not this data source should be JTA managed<br class="atl-forced-newline"> or user managed. If set to 'true' it will automatically be enrolled<br class="atl-forced-newline"> in any ongoing transactions. Calling begin/commit/rollback or setAutoCommit<br class="atl-forced-newline"> on the datasource or connection will not be allowed. If you need to perform<br class="atl-forced-newline"> these functions yourself, set JtaManaged to 'false'<br class="atl-forced-newline"> <br class="atl-forced-newline"> In terms of JPA persistence.xml:<br class="atl-forced-newline"> "JtaManaged=true" can be used as a 'jta-data-source'<br class="atl-forced-newline"> "JtaManaged=false" can be used as a 'non-jta-data-source'<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>true</em>.</td>
-</tr>
-<tr>
-<td > JdbcDriver </td>
-<td > Driver class name<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>org.hsqldb.jdbcDriver</em>.</td>
-</tr>
-<tr>
-<td > JdbcUrl </td>
-<td > Url for creating connections<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>jdbc:hsqldb:file:data/hsqldb/hsqldb</em>.</td>
-</tr>
-<tr>
-<td > UserName </td>
-<td > Default user name<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>sa</em>.</td>
-</tr>
-<tr>
-<td > Password </td>
-<td > Default password</td>
-</tr>
-<tr>
-<td > ConnectionProperties </td>
-<td > The connection properties that will be sent to the JDBC<br class="atl-forced-newline"> driver when establishing new connections<br class="atl-forced-newline"> <br class="atl-forced-newline"> Format of the string must be [propertyName=property;]*<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - The "user" and "password" properties will be passed<br class="atl-forced-newline"> explicitly, so they do not need to be included here.</td>
-</tr>
-<tr>
-<td > DefaultAutoCommit </td>
-<td > The default auto-commit state of new connections<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>true</em>.</td>
-</tr>
-<tr>
-<td > DefaultReadOnly </td>
-<td > The default read-only state of new connections<br class="atl-forced-newline"> If not set then the setReadOnly method will not be called.<br class="atl-forced-newline"> (Some drivers don't support read only mode, ex: Informix)</td>
-</tr>
-<tr>
-<td > DefaultTransactionIsolation </td>
-<td > The default TransactionIsolation state of new connections<br class="atl-forced-newline"> If not set then the setTransactionIsolation method will not<br class="atl-forced-newline"> be called. The allowed values for this property are:<br class="atl-forced-newline"> NONE<br class="atl-forced-newline"> READ_COMMITTED<br class="atl-forced-newline"> READ_UNCOMMITTED<br class="atl-forced-newline"> REPEATABLE_READ<br class="atl-forced-newline"> SERIALIZABLE<br class="atl-forced-newline"> <br class="atl-forced-newline"> Note: Most JDBC drivers do not support all isolation levels</td>
-</tr>
-<tr>
-<td > InitialSize </td>
-<td > The initial number of connections that are created when the<br class="atl-forced-newline"> pool is started<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td>
-</tr>
-<tr>
-<td > MaxActive </td>
-<td > The maximum number of active connections that can be<br class="atl-forced-newline"> allocated from this pool at the same time, or a negative<br class="atl-forced-newline"> number for no limit.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>20</em>.</td>
-</tr>
-<tr>
-<td > MaxIdle </td>
-<td > The maximum number of connections that can remain idle in<br class="atl-forced-newline"> the pool, without extra ones being released, or a negative<br class="atl-forced-newline"> number for no limit.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>20</em>.</td>
-</tr>
-<tr>
-<td > MinIdle </td>
-<td > The minimum number of connections that can remain idle in<br class="atl-forced-newline"> the pool, without extra ones being created, or zero to<br class="atl-forced-newline"> create none.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td>
-</tr>
-<tr>
-<td > MaxWait </td>
-<td > The maximum number of milliseconds that the pool will wait<br class="atl-forced-newline"> (when there are no available connections) for a connection<br class="atl-forced-newline"> to be returned before throwing an exception, or -1 to wait<br class="atl-forced-newline"> indefinitely.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>-1</em>.</td>
-</tr>
-<tr>
-<td > ValidationQuery </td>
-<td > The SQL query that will be used to validate connections from<br class="atl-forced-newline"> this pool before returning them to the caller. If specified,<br class="atl-forced-newline"> this query MUST be an SQL SELECT statement that returns at<br class="atl-forced-newline"> least one row.</td>
-</tr>
-<tr>
-<td > TestOnBorrow </td>
-<td > If true connections will be validated before being borrowed<br class="atl-forced-newline"> from the pool. If the validation fails, the connection is<br class="atl-forced-newline"> destroyed, and a new conection will be retrieved from the<br class="atl-forced-newline"> pool (and validated).<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - for a true value to have any effect, the<br class="atl-forced-newline"> ValidationQuery parameter must be set.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>true</em>.</td>
-</tr>
-<tr>
-<td > TestOnReturn </td>
-<td > If true connections will be validated before being returned<br class="atl-forced-newline"> to the pool. If the validation fails, the connection is<br class="atl-forced-newline"> destroyed instead of being returned to the pool.<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - for a true value to have any effect, the<br class="atl-forced-newline"> ValidationQuery parameter must be set.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>false</em>.</td>
-</tr>
-<tr>
-<td > TestWhileIdle </td>
-<td > If true connections will be validated by the idle connection<br class="atl-forced-newline"> evictor (if any). If the validation fails, the connection is<br class="atl-forced-newline"> destroyed and removed from the pool<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - for a true value to have any effect, the<br class="atl-forced-newline"> timeBetweenEvictionRunsMillis property must be a positive<br class="atl-forced-newline"> number and the ValidationQuery parameter must be set.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>false</em>.</td>
-</tr>
-<tr>
-<td > TimeBetweenEvictionRunsMillis </td>
-<td > The number of milliseconds to sleep between runs of the idle<br class="atl-forced-newline"> connection evictor thread. When set to a negative number, no<br class="atl-forced-newline"> idle connection evictor thread will be run.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>-1</em>.</td>
-</tr>
-<tr>
-<td > NumTestsPerEvictionRun </td>
-<td > The number of connectionss to examine during each run of the<br class="atl-forced-newline"> idle connection evictor thread (if any).<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>3</em>.</td>
-</tr>
-<tr>
-<td > MinEvictableIdleTimeMillis </td>
-<td > The minimum amount of time a connection may sit idle in the<br class="atl-forced-newline"> pool before it is eligable for eviction by the idle<br class="atl-forced-newline"> connection evictor (if any).<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>1800000</em>.</td>
-</tr>
-<tr>
-<td > PoolPreparedStatements </td>
-<td > If true, a statement pool is created for each Connection and<br class="atl-forced-newline"> PreparedStatements created by one of the following methods are<br class="atl-forced-newline"> pooled:<br class="atl-forced-newline"> public PreparedStatement prepareStatement(String sql);<br class="atl-forced-newline"> public PreparedStatement prepareStatement(String sql,<br class="atl-forced-newline"> int resultSetType,<br class="atl-forced-newline"> int resultSetConcurrency)<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>false</em>.</td>
-</tr>
-<tr>
-<td > MaxOpenPreparedStatements </td>
-<td > The maximum number of open statements that can be allocated<br class="atl-forced-newline"> from the statement pool at the same time, or zero for no<br class="atl-forced-newline"> limit.<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - Some drivers have limits on the number of open<br class="atl-forced-newline"> statements, so make sure there are some resources left<br class="atl-forced-newline"> for the other (non-prepared) statements.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td>
-</tr>
-<tr>
-<td > AccessToUnderlyingConnectionAllowed </td>
-<td > If true the raw physical connection to the database can be<br class="atl-forced-newline"> accessed using the following construct:<br class="atl-forced-newline"> Connection conn = ds.getConnection();<br class="atl-forced-newline"> Connection rawConn = ((DelegatingConnection) conn).getInnermostDelegate();<br class="atl-forced-newline"> ...<br class="atl-forced-newline"> conn.close()<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default is false, because misbehaving programs can do harmfull<br class="atl-forced-newline"> things to the raw connection shuch as closing the raw<br class="atl-forced-newline"> connection or continuing to use the raw connection after it<br class="atl-forced-newline"> has been assigned to another logical connection. Be carefull<br class="atl-forced-newline"> and only use when you need direct access to driver specific<br class="atl-f
orced-newline"> extentions.<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE: Do NOT close the underlying connection, only the<br class="atl-forced-newline"> original logical connection wrapper.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>false</em>.</td>
-</tr>
-</tbody></table>
-</div>
-
-
-<p><a name="ContainersandResources-DefaultJMSResourceAdapterresource"></a></p>
-<h2><a name="ContainersandResources-ActiveMQResourceAdapter"></a>ActiveMQResourceAdapter</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"ActiveMQResourceAdapter"</span>></span>
-<span class="code-tag"></Resource></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Resource?type=ActiveMQResourceAdapter</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > BrokerXmlConfig </td>
-<td > Broker configuration<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>broker:(tcp://localhost:61616)?useJmx=false</em>.</td>
-</tr>
-<tr>
-<td > ServerUrl </td>
-<td > Broker address<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>vm://localhost?async=true</em>.</td>
-</tr>
-<tr>
-<td > DataSource </td>
-<td > DataSource for persistence messages<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>Default Unmanaged JDBC Database</em>.</td>
-</tr>
-</tbody></table>
-</div>
-
-
-<p><a name="ContainersandResources-DefaultJMSConnectionFactoryresource"></a></p>
-<h2><a name="ContainersandResources-javax.jms.ConnectionFactory"></a>javax.jms.ConnectionFactory</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.jms.ConnectionFactory"</span>></span>
-<span class="code-tag"></Resource></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Resource?type=javax.jms.ConnectionFactory</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > ResourceAdapter </td>
-<td > Default value is <em>Default JMS Resource Adapter</em>.</td>
-</tr>
-<tr>
-<td > TransactionSupport </td>
-<td > Specifies if the connection is enrolled in global transaction<br class="atl-forced-newline"> allowed values: xa, local or none<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>xa</em>.</td>
-</tr>
-<tr>
-<td > PoolMaxSize </td>
-<td > Maximum number of physical connection to the ActiveMQ broker<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>10</em>.</td>
-</tr>
-<tr>
-<td > PoolMinSize </td>
-<td > Minimum number of physical connection to the ActiveMQ broker<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td>
-</tr>
-<tr>
-<td > ConnectionMaxWaitMilliseconds </td>
-<td > Maximum amount of time to wait for a connection<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>5000</em>.</td>
-</tr>
-<tr>
-<td > ConnectionMaxIdleMinutes </td>
-<td > Maximum amount of time a connection can be idle before being reclaimed<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>15</em>.</td>
-</tr>
-</tbody></table>
-</div>
-
-
-<p><a name="ContainersandResources-DefaultQueueresource"></a></p>
-<h2><a name="ContainersandResources-javax.jms.Queue"></a>javax.jms.Queue</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.jms.Queue"</span>></span>
-<span class="code-tag"></Resource></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Resource?type=javax.jms.Queue</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > destination </td>
-<td > Specifies the name of the queue</td>
-</tr>
-</tbody></table>
-</div>
-
-
-<p><a name="ContainersandResources-DefaultTopicresource"></a></p>
-<h2><a name="ContainersandResources-javax.jms.Topic"></a>javax.jms.Topic</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.jms.Topic"</span>></span>
-<span class="code-tag"></Resource></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Resource?type=javax.jms.Topic</p>
-</div></div>
-<p>Supports the following properties</p>
-<div class="table-wrap">
-<table class="mdtable"> <tbody>
-<tr>
-<th > Property Name </th>
-<th > Description </th>
-</tr>
-<tr>
-<td > destination </td>
-<td > Specifies the name of the topic</td>
-</tr>
-</tbody></table>
-</div>
-
-
-<p><a name="ContainersandResources-DefaultORBresource"></a></p>
-<h2><a name="ContainersandResources-org.omg.CORBA.ORB"></a>org.omg.CORBA.ORB</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"org.omg.CORBA.ORB"</span>></span>
-<span class="code-tag"></Resource></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Resource?type=org.omg.CORBA.ORB</p>
-</div></div>
-<p>No properties.</p>
-
-<p><a name="ContainersandResources-DefaultMailSessionresource"></a></p>
-<h2><a name="ContainersandResources-javax.mail.Session"></a>javax.mail.Session</h2>
-<p>Declarable in tomee.xml via</p>
-<div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.mail.Session"</span>></span>
-<span class="code-tag"></Resource></span>
-</pre>
-</div></div>
-<p>Declarable in properties via</p>
-<div style="border-width: 1px;" class="panel"><div class="panelContent">
-<p>Foo = new://Resource?type=javax.mail.Session</p>
-</div></div>
-<p>No properties.</p>
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/contrib/debug/debug-intellij.adoc
----------------------------------------------------------------------
diff --git a/docs/contrib/debug/debug-intellij.adoc b/docs/contrib/debug/debug-intellij.adoc
new file mode 100644
index 0000000..27da57e
--- /dev/null
+++ b/docs/contrib/debug/debug-intellij.adoc
@@ -0,0 +1,182 @@
+:index-group: IDE
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+#Debugging an Apache
+TomEE App in Intellij IDEA
+
+Stepping through the http://tomee.apache.org/apache-tomee.html[TomEE]
+source code is a must-to-follow step if you want to understand how TomEE
+works and later contribute. This is a guide to quickly start your
+debugging session with TomEE as a TomEE developer.
+
+This guide assumes that:
+
+* Linux is the OS
+* IntelliJ IDEA 13.1.3 is the IDE
+* Maven 3.0.5 or better is installed
+
+###Download the Source Code
+
+For beginners it is recommended not to start with the trunk, because it
+is common to have some blockers or non-stable functionality which could
+bring your learning to a halt. So first start with the latest stable
+released source code. Move to trunk once you are ready to do some code
+modification on TomEE.
+
+http://www.apache.org/dyn/closer.cgi/tomee/tomee-1.7.1/openejb-4.7.1-source-release.zip[Click
+here to download TomEE 1.7.1 Source code]
+
+###Build the Source Code
+
+First extract the zip file named *openejb-4.7.1-source-release.zip* to
+any location. Lets assume it is your home folder.
+
+_______________________________________
+unzip openejb-4.7.1-source-release -d ~
+_______________________________________
+
+The above command will create the *openejb-4.7.1* directory in your home
+directory.
+
+Even though you can do a full build, We will run the following command
+to do a quick build so that you can have your meal before your hunger
+kills you.
+
+_________________________________________________________________________________________________________________________________________________
+mvn -Pquick -Dsurefire.useFile=false -DdisableXmlReport=true
+-DuniqueVersion=false -ff -Dassemble -DskipTests -DfailIfNoTests=false
+clean install
+_________________________________________________________________________________________________________________________________________________
+
+More details about building the product from the source can be found
+http://tomee.apache.org/dev/source-code.html[here].
+
+###Deploy TomEE
+
+The TomEE build builds several distributions (zip & war files) to cater
+the different needs of different users. Here we discuss about the tomee
+plus distribution & TomEE war distribution only. TomEE+ is the full
+feature packed distribution from TomEE.
+
+TomEE+ zip location:
+
+_____________________________________________________________________
+~/openejb-4.7.1/tomee/apache-tomee/target/apache-tomee-plus-1.7.1.zip
+_____________________________________________________________________
+
+Unzip the zip into your home directory (or any other location)
+
+________________________________________________________________________________
+unzip
+~/openejb-4.7.1/tomee/apache-tomee/target/apache-tomee-plus-1.7.1.zip -d
+~
+________________________________________________________________________________
+
+You will find the directory *apache-tomee-plus-1.7.1* in your home
+folder. Lets run the TomEE.
+
+__________________________________________________
+cd ~/apache-tomee-plus-1.7.1/bin ./catalina.sh run
+__________________________________________________
+
+"INFO: Server startup in xxxx ms" is the Green light!
+
+###Prepare your IDE
+
+Lets prepare our IntelliJ IDEA for the debugging session.
+
+Start IntelliJ IDEA and Click the Import Project link
+
+image:idea1.png[image]
+
+Select the ~/openejb-4.7.1 directory and press OK
+
+Select import project from external model & Maven as the external model.
+
+image:idea3.png[image]
+
+Press Next on this screen.
+
+image:idea4.png[image]
+
+Select the main profile.
+
+image:idea6.png[image]
+
+Select the org.apache.openejb:openejb:4.7.1
+
+image:idea7.png[image]
+
+Select the JDK you want to use with.
+
+image:idea8.png[image]
+
+Give the project a name and press Finish.
+
+image:idea9.png[image]
+
+Now your IDE will load the project.
+
+###First Breakpoint
+
+Next step is to put a breakpoint at the place where the code is
+triggered. Lets understand how the code is triggered.
+
+TomEE+ is created on top of Tomcat. TomEE registers a Tomcat Lifecycle
+Listener *"org.apache.tomee.catalina.ServerListener"* on *server.xml*
+file.
+
+All the Tomcat lifecycle events i.e. before_init, after_init, start,
+before_stop etc... are received by the *lifecycleEvent* method of the
+ServerListener.
+
+The execution of TomEE code starts in this lifecycleEvent method. So the
+first breakpoint should be on the lifecycleEvent method.
+
+###Run TomEE+ in debug mode
+
+If you simply run *catalina.sh jpda run* in the bin folder of tomee
+deployment, the server starts in the debug mode but it will quckly pass
+your breakpoint before you attach your IDE to the server process.
+
+So we set** JPDA_SUSPEND="y"** before we start our debugging. This will
+tell the server "Do not proceed until the Debugger tool is attached to
+the process"
+
+The convenient way of doing this is adding this line to catalina.sh file
+right after the #!/bin/sh line.
+
+________________________________________
+#!/bin/sh JPDA_SUSPEND="y"
+
+Now to time to run TomEE+ on debug mode.
+________________________________________
+
+__________________________________________________
+~/apache-tomee-plus-1.7.1/bin/catalina.sh jpda run
+__________________________________________________
+
+The terminal should hang with the message *"Listening for transport
+dt_socket at address: 8000"*
+
+###Attach IntelliJ IDEA debugger
+
+* Menu Bar > Run > Edit Configurations
+* Press the "*+*" button on the top left corner to get the Add new
+configuration menu
+* Select "Remote" from the Add new configuration menu
+* Give a name (I gave "TomEE DEBUG") to this new configuration and set
+the Port to 8000
+* Click OK.
+
+image:idea10.png[image]
+
+To start debugging your TomEE+
+
+Main Menu > Run > Debug TomEE DEBUG
+
+Congratulations! You hit the break point you put at the startup of the
+TomEE code. Carry on with your debugging session to learn more.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/contrib/debug/debug-intellij.md
----------------------------------------------------------------------
diff --git a/docs/contrib/debug/debug-intellij.md b/docs/contrib/debug/debug-intellij.md
deleted file mode 100644
index d467cb0..0000000
--- a/docs/contrib/debug/debug-intellij.md
+++ /dev/null
@@ -1,133 +0,0 @@
-index-group=IDE
-type=page
-status=published
-~~~~~~
-<a name='DEBUGIDE'></a>
-#Debugging an Apache TomEE App in Intellij IDEA
-
-Stepping through the [TomEE](http://tomee.apache.org/apache-tomee.html) source code is a must-to-follow step if you want to understand how TomEE works and later contribute. This is a guide to quickly start your debugging session with TomEE as a TomEE developer.
-
-This guide assumes that:
-
- - Linux is the OS
- - IntelliJ IDEA 13.1.3 is the IDE
- - Maven 3.0.5 or better is installed
-
-
-###Download the Source Code
-
-For beginners it is recommended not to start with the trunk, because it is common to have some blockers or non-stable functionality which could bring your learning to a halt. So first start with the latest stable released source code. Move to trunk once you are ready to do some code modification on TomEE.
-
-[Click here to download TomEE 1.7.1 Source code](http://www.apache.org/dyn/closer.cgi/tomee/tomee-1.7.1/openejb-4.7.1-source-release.zip)
-
-###Build the Source Code
-
-First extract the zip file named **openejb-4.7.1-source-release.zip** to any location. Lets assume it is your home folder.
-
-> unzip openejb-4.7.1-source-release -d ~
-
-The above command will create the **openejb-4.7.1** directory in your home directory.
-
-Even though you can do a full build, We will run the following command to do a quick build so that you can have your meal before your hunger kills you.
-
-> mvn -Pquick -Dsurefire.useFile=false -DdisableXmlReport=true -DuniqueVersion=false -ff -Dassemble -DskipTests -DfailIfNoTests=false clean install
-
-More details about building the product from the source can be found [here](http://tomee.apache.org/dev/source-code.html).
-
-###Deploy TomEE
-
-The TomEE build builds several distributions (zip & war files) to cater the different needs of different users. Here we discuss about the tomee plus distribution & TomEE war distribution only. TomEE+ is the full feature packed distribution from TomEE.
-
-TomEE+ zip location:
-
-> ~/openejb-4.7.1/tomee/apache-tomee/target/apache-tomee-plus-1.7.1.zip
-
-Unzip the zip into your home directory (or any other location)
-
-> unzip ~/openejb-4.7.1/tomee/apache-tomee/target/apache-tomee-plus-1.7.1.zip -d ~
-
-You will find the directory **apache-tomee-plus-1.7.1** in your home folder. Lets run the TomEE.
-
-> cd ~/apache-tomee-plus-1.7.1/bin <br />
-> ./catalina.sh run <br />
-
-"INFO: Server startup in xxxx ms" is the Green light!
-
-###Prepare your IDE
-
-Lets prepare our IntelliJ IDEA for the debugging session.
-
-Start IntelliJ IDEA and Click the Import Project link
-
-
-
-Select the ~/openejb-4.7.1 directory and press OK
-
-Select import project from external model & Maven as the external model.
-
-
-
-Press Next on this screen.
-
-
-
-Select the main profile.
-
-
-
-Select the org.apache.openejb:openejb:4.7.1
-
-
-
-Select the JDK you want to use with.
-
-
-
-Give the project a name and press Finish.
-
-
-
-Now your IDE will load the project.
-
-###First Breakpoint
-
-Next step is to put a breakpoint at the place where the code is triggered. Lets understand how the code is triggered.
-
-TomEE+ is created on top of Tomcat. TomEE registers a Tomcat Lifecycle Listener **"org.apache.tomee.catalina.ServerListener"** on **server.xml** file.
-
-All the Tomcat lifecycle events i.e. before_init, after_init, start, before_stop etc... are received by the **lifecycleEvent** method of the ServerListener.
-
-The execution of TomEE code starts in this lifecycleEvent method. So the first breakpoint should be on the lifecycleEvent method.
-
-###Run TomEE+ in debug mode
-
-If you simply run **catalina.sh jpda run** in the bin folder of tomee deployment, the server starts in the debug mode but it will quckly pass your breakpoint before you attach your IDE to the server process.
-
-So we set** JPDA_SUSPEND="y"** before we start our debugging. This will tell the server "Do not proceed until the Debugger tool is attached to the process"
-
-The convenient way of doing this is adding this line to catalina.sh file right after the #!/bin/sh line.
-
-> \#!/bin/sh
-> JPDA_SUSPEND="y"
->
-Now to time to run TomEE+ on debug mode.
-
-> ~/apache-tomee-plus-1.7.1/bin/catalina.sh jpda run
-
-The terminal should hang with the message **"Listening for transport dt_socket at address: 8000"**
-
-###Attach IntelliJ IDEA debugger
-
-* Menu Bar > Run > Edit Configurations
-* Press the "**+**" button on the top left corner to get the Add new configuration menu
-* Select "Remote" from the Add new configuration menu
-* Give a name (I gave "TomEE DEBUG") to this new configuration and set the Port to 8000
-* Click OK.
-
-</div>
-
-To start debugging your TomEE+
-
-Main Menu > Run > Debug TomEE DEBUG
-
-Congratulations! You hit the break point you put at the startup of the TomEE code. Carry on with your debugging session to learn more.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/custom-injection.adoc
----------------------------------------------------------------------
diff --git a/docs/custom-injection.adoc b/docs/custom-injection.adoc
new file mode 100644
index 0000000..33314f4
--- /dev/null
+++ b/docs/custom-injection.adoc
@@ -0,0 +1,203 @@
+# Custom Injection
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Overview
+
+As noted in the link:injection-of-env-entry-example.html[Injection of
+env-entry Example] , the EJB 3.0 supported env-entry types are fairly
+limited. Also the use of several tags in an ejb-jar.xml can get a bit
+verbose.
+
+OpenEJB does not restrict you to just these data types or require you to
+use an ejb-jar.xml to declare them.
+
+* `@Resource` can be used on any type for which there is
+`java.beans.PropertyEditor`
+* You may `install your own` PropertyEditors and package them with your
+app.
+* Java Generics are supported (e.g. List myURIs)
+* You may use a `META-INF/env-entries.properties` file as an alternative
+to an ejb-jar.xml
+
+See link:built-in-type-converters.html[Built-in Type Converters] for a
+full list of supported env-entry types.
+
+The source for this example is the "custom-injection" directory located
+in the link:downloads.html[openejb-examples.zip] available on the
+http://tomee.apache.org/downloads.html[download page].
+
+# The Code
+
+== Bean Class
+
+....
+@Stateless
+public class Stratocaster {
+
+ @Resource(name = "pickups")
+ private List<Pickup> pickups;
+
+ @Resource(name = "style")
+ private Style style;
+
+ @Resource(name = "dateCreated")
+ private Date dateCreated;
+
+ @Resource(name = "guitarStringGuages")
+ private Map<String, Float> guitarStringGuages;
+
+ @Resource(name = "certificateOfAuthenticity")
+ private File certificateOfAuthenticity;
+
+ public Date getDateCreated() {
+ return dateCreated;
+ }
+
+ /**
+ * Gets the guage of the electric guitar strings
+ * used in this guitar.
+ *
+ * @param string
+ * @return
+ */
+ public float getStringGuage(String string) {
+ return guitarStringGuages.get(string);
+ }
+
+ public List<Pickup> getPickups() {
+ return pickups;
+ }
+
+ public Style getStyle() {
+ return style;
+ }
+
+ public File getCertificateOfAuthenticity() {
+ return certificateOfAuthenticity;
+ }
+}
+....
+
+== The META-INF/env-entries.properties file
+
+....
+guitarStringGuages=E1=0.052\nA=0.042\nD=0.030\nG=0.017\nB=0.013\nE=0.010
+certificateOfAuthenticity=/tmp/strat-certificate.txt
+dateCreated=1962-03-01
+pickups=S,S,S
+style=VINTAGE
+....
+
+== The Custom Type and Editor
+
+Support for java.lang.Enum types is already built-in, but we've decided
+we'd like to allow abbreviated versions of the enum constants to be
+usable. We do this by creating a custom PropertyEditor for our Pickup
+enum like so:
+
+....
+public class PickupEditor extends java.beans.PropertyEditorSupport {
+ public void setAsText(String text) throws IllegalArgumentException {
+ text = text.trim();
+
+ if (text.equalsIgnoreCase("H")) setValue(Pickup.HUMBUCKER);
+ else if (text.equalsIgnoreCase("S")) setValue(Pickup.SINGLE_COIL);
+ else throw new IllegalStateException("H and S are the only supported Pickup aliases");
+ }
+}
+....
+
+We cleverly install this PropertyEditor in a static block in the Pickup
+class that will be executed should someone actually reference the Pickup
+type.
+
+....
+public enum Pickup {
+
+ HUMBUCKER,
+ SINGLE_COIL;
+
+ // Here's the little magic where we register the PickupEditor
+ // which knows how to create this object from a string.
+ // You can add any of your own Property Editors in the same way.
+ static {
+ PropertyEditorManager.registerEditor(Pickup.class, PickupEditor.class);
+ }
+}
+....
+
+# Test Case
+
+....
+public class StratocasterTest extends TestCase {
+
+ @EJB
+ private Stratocaster strat;
+
+ public void test() throws Exception {
+ EJBContainer.createEJBContainer().getContext().bind("inject", this);
+
+ Date date = DateFormat.getDateInstance(DateFormat.MEDIUM, Locale.US).parse("Mar 1, 1962");
+ assertEquals("Strat.getDateCreated()", date, strat.getDateCreated());
+
+ List<Pickup> pickups = asList(Pickup.SINGLE_COIL, Pickup.SINGLE_COIL, Pickup.SINGLE_COIL);
+ assertEquals("Strat.getPickups()", pickups, strat.getPickups());
+
+ assertEquals("Strat.getStyle()", Style.VINTAGE, strat.getStyle());
+
+ assertEquals("Strat.getStringGuage(\"E1\")", 0.052F, strat.getStringGuage("E1"));
+ assertEquals("Strat.getStringGuage(\"A\")", 0.042F, strat.getStringGuage("A"));
+ assertEquals("Strat.getStringGuage(\"D\")", 0.030F, strat.getStringGuage("D"));
+ assertEquals("Strat.getStringGuage(\"G\")", 0.017F, strat.getStringGuage("G"));
+ assertEquals("Strat.getStringGuage(\"B\")", 0.013F, strat.getStringGuage("B"));
+ assertEquals("Strat.getStringGuage(\"E\")", 0.010F, strat.getStringGuage("E"));
+
+ File file = new File("/tmp/strat-certificate.txt");
+ assertEquals("Strat.getCertificateOfAuthenticity()", file,strat.getCertificateOfAuthenticity());
+
+
+ }
+}
+....
+
+# Running it
+
+Running the example is fairly simple. In the "custom-injection"
+directory of the openejb:download.html[examples zip], just run:
+
+___________________
+$ mvn clean install
+___________________
+
+Which should create output like the following.
+
+....
+-------------------------------------------------------
+ T E S T S
+-------------------------------------------------------
+Running org.superbiz.enventries.StratocasterTest
+Apache OpenEJB 3.1-SNAPSHOT build: 20080409-12:05
+http://tomee.apache.org/
+INFO - openejb.home = /Users/dblevins/work/openejb3/examples/custom-injection
+INFO - openejb.base = /Users/dblevins/work/openejb3/examples/custom-injection
+INFO - Configuring Service(id=Default Security Service, type=SecurityService, provider-id=Default Security Service)
+INFO - Configuring Service(id=Default Transaction Manager, type=TransactionManager, provider-id=Default Transaction Manager)
+INFO - Configuring Service(id=Default JDK 1.3 ProxyFactory, type=ProxyFactory, provider-id=Default JDK 1.3 ProxyFactory)
+INFO - Found EjbModule in classpath: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes
+INFO - Configuring app: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes
+INFO - Configuring Service(id=Default Stateless Container, type=Container, provider-id=Default Stateless Container)
+INFO - Auto-creating a container for bean StratocasterImpl: Container(type=STATELESS, id=Default Stateless Container)
+INFO - Loaded Module: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes
+INFO - Assembling app: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes
+INFO - Jndi(name=StratocasterImplLocal) --> Ejb(deployment-id=StratocasterImpl)
+INFO - Created Ejb(deployment-id=StratocasterImpl, ejb-name=StratocasterImpl, container=Default Stateless Container)
+INFO - Deployed Application(path=/Users/dblevins/work/openejb3/examples/custom-injection/target/classes)
+Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.705 sec
+
+Results :
+
+Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/custom-injection.md
----------------------------------------------------------------------
diff --git a/docs/custom-injection.md b/docs/custom-injection.md
deleted file mode 100644
index 2a46922..0000000
--- a/docs/custom-injection.md
+++ /dev/null
@@ -1,193 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Custom Injection
-~~~~~~
-# Overview
-
-As noted in the [Injection of env-entry Example](injection-of-env-entry-example.html)
-, the EJB 3.0 supported env-entry types are fairly limited. Also the use
-of several <env-entry> tags in an ejb-jar.xml can get a bit verbose.
-
-OpenEJB does not restrict you to just these data types or require you to
-use an ejb-jar.xml to declare them.
-
- - `@Resource` can be used on any type for which there is
-`java.beans.PropertyEditor`
- - You may `install your own` PropertyEditors and package them with your
-app.
- - Java Generics are supported (e.g. List<URI> myURIs)
- - You may use a `META-INF/env-entries.properties` file as an alternative
-to an ejb-jar.xml
-
-See [Built-in Type Converters](built-in-type-converters.html)
-for a full list of supported env-entry types.
-
-The source for this example is the "custom-injection" directory located in
-the [openejb-examples.zip](downloads.html)
-available on the [download page](http://tomee.apache.org/downloads.html).
-
-<a name="CustomInjection-TheCode"></a>
-# The Code
-
-<a name="CustomInjection-BeanClass"></a>
-## Bean Class
-
- @Stateless
- public class Stratocaster {
-
- @Resource(name = "pickups")
- private List<Pickup> pickups;
-
- @Resource(name = "style")
- private Style style;
-
- @Resource(name = "dateCreated")
- private Date dateCreated;
-
- @Resource(name = "guitarStringGuages")
- private Map<String, Float> guitarStringGuages;
-
- @Resource(name = "certificateOfAuthenticity")
- private File certificateOfAuthenticity;
-
- public Date getDateCreated() {
- return dateCreated;
- }
-
- /**
- * Gets the guage of the electric guitar strings
- * used in this guitar.
- *
- * @param string
- * @return
- */
- public float getStringGuage(String string) {
- return guitarStringGuages.get(string);
- }
-
- public List<Pickup> getPickups() {
- return pickups;
- }
-
- public Style getStyle() {
- return style;
- }
-
- public File getCertificateOfAuthenticity() {
- return certificateOfAuthenticity;
- }
- }
-
-<a name="CustomInjection-TheMETA-INF/env-entries.propertiesfile"></a>
-## The META-INF/env-entries.properties file
-
- guitarStringGuages=E1=0.052\nA=0.042\nD=0.030\nG=0.017\nB=0.013\nE=0.010
- certificateOfAuthenticity=/tmp/strat-certificate.txt
- dateCreated=1962-03-01
- pickups=S,S,S
- style=VINTAGE
-
-<a name="CustomInjection-TheCustomTypeandEditor"></a>
-## The Custom Type and Editor
-
-Support for java.lang.Enum types is already built-in, but we've decided
-we'd like to allow abbreviated versions of the enum constants to be usable.
- We do this by creating a custom PropertyEditor for our Pickup enum like
-so:
-
- public class PickupEditor extends java.beans.PropertyEditorSupport {
- public void setAsText(String text) throws IllegalArgumentException {
- text = text.trim();
-
- if (text.equalsIgnoreCase("H")) setValue(Pickup.HUMBUCKER);
- else if (text.equalsIgnoreCase("S")) setValue(Pickup.SINGLE_COIL);
- else throw new IllegalStateException("H and S are the only supported Pickup aliases");
- }
- }
-
-We cleverly install this PropertyEditor in a static block in the Pickup
-class that will be executed should someone actually reference the Pickup
-type.
-
- public enum Pickup {
-
- HUMBUCKER,
- SINGLE_COIL;
-
- // Here's the little magic where we register the PickupEditor
- // which knows how to create this object from a string.
- // You can add any of your own Property Editors in the same way.
- static {
- PropertyEditorManager.registerEditor(Pickup.class, PickupEditor.class);
- }
- }
-
-<a name="CustomInjection-TestCase"></a>
-# Test Case
-
- public class StratocasterTest extends TestCase {
-
- @EJB
- private Stratocaster strat;
-
- public void test() throws Exception {
- EJBContainer.createEJBContainer().getContext().bind("inject", this);
-
- Date date = DateFormat.getDateInstance(DateFormat.MEDIUM, Locale.US).parse("Mar 1, 1962");
- assertEquals("Strat.getDateCreated()", date, strat.getDateCreated());
-
- List<Pickup> pickups = asList(Pickup.SINGLE_COIL, Pickup.SINGLE_COIL, Pickup.SINGLE_COIL);
- assertEquals("Strat.getPickups()", pickups, strat.getPickups());
-
- assertEquals("Strat.getStyle()", Style.VINTAGE, strat.getStyle());
-
- assertEquals("Strat.getStringGuage(\"E1\")", 0.052F, strat.getStringGuage("E1"));
- assertEquals("Strat.getStringGuage(\"A\")", 0.042F, strat.getStringGuage("A"));
- assertEquals("Strat.getStringGuage(\"D\")", 0.030F, strat.getStringGuage("D"));
- assertEquals("Strat.getStringGuage(\"G\")", 0.017F, strat.getStringGuage("G"));
- assertEquals("Strat.getStringGuage(\"B\")", 0.013F, strat.getStringGuage("B"));
- assertEquals("Strat.getStringGuage(\"E\")", 0.010F, strat.getStringGuage("E"));
-
- File file = new File("/tmp/strat-certificate.txt");
- assertEquals("Strat.getCertificateOfAuthenticity()", file,strat.getCertificateOfAuthenticity());
-
-
- }
- }
-
-<a name="CustomInjection-Runningit"></a>
-# Running it
-
-Running the example is fairly simple. In the "custom-injection" directory of the [examples zip](openejb:download.html), just run:
-
-> $ mvn clean install
-
-Which should create output like the following.
-
-
- -------------------------------------------------------
- T E S T S
- -------------------------------------------------------
- Running org.superbiz.enventries.StratocasterTest
- Apache OpenEJB 3.1-SNAPSHOT build: 20080409-12:05
- http://tomee.apache.org/
- INFO - openejb.home = /Users/dblevins/work/openejb3/examples/custom-injection
- INFO - openejb.base = /Users/dblevins/work/openejb3/examples/custom-injection
- INFO - Configuring Service(id=Default Security Service, type=SecurityService, provider-id=Default Security Service)
- INFO - Configuring Service(id=Default Transaction Manager, type=TransactionManager, provider-id=Default Transaction Manager)
- INFO - Configuring Service(id=Default JDK 1.3 ProxyFactory, type=ProxyFactory, provider-id=Default JDK 1.3 ProxyFactory)
- INFO - Found EjbModule in classpath: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes
- INFO - Configuring app: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes
- INFO - Configuring Service(id=Default Stateless Container, type=Container, provider-id=Default Stateless Container)
- INFO - Auto-creating a container for bean StratocasterImpl: Container(type=STATELESS, id=Default Stateless Container)
- INFO - Loaded Module: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes
- INFO - Assembling app: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes
- INFO - Jndi(name=StratocasterImplLocal) --> Ejb(deployment-id=StratocasterImpl)
- INFO - Created Ejb(deployment-id=StratocasterImpl, ejb-name=StratocasterImpl, container=Default Stateless Container)
- INFO - Deployed Application(path=/Users/dblevins/work/openejb3/examples/custom-injection/target/classes)
- Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.705 sec
-
- Results :
-
- Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[18/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 7
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 7
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/329eb60a
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/329eb60a
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/329eb60a
Branch: refs/heads/master
Commit: 329eb60a8066516e804dcb9a55bf968786437a8b
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:23 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:07:23 2018 -0800
----------------------------------------------------------------------
docs/local-client-injection.adoc | 88 ++
docs/local-client-injection.md | 87 --
docs/local-server.adoc | 56 +
docs/local-server.md | 61 --
docs/lookup-of-other-ejbs-example.adoc | 146 +++
docs/lookup-of-other-ejbs-example.md | 149 ---
docs/managedcontainer-config.adoc | 42 +
docs/managedcontainer-config.md | 26 -
docs/manual-installation.adoc | 145 +++
docs/manual-installation.md | 224 ----
docs/maven.adoc | 61 ++
docs/maven.md | 42 -
docs/maven/build-mojo.adoc | 1169 ++++++++++++++++++++
docs/maven/build-mojo.md | 1426 ------------------------
docs/maven/configtest-mojo.adoc | 1086 +++++++++++++++++++
docs/maven/configtest-mojo.md | 1328 -----------------------
docs/maven/debug-mojo.adoc | 1139 ++++++++++++++++++++
docs/maven/debug-mojo.md | 1395 ------------------------
docs/maven/deploy-mojo.adoc | 196 ++++
docs/maven/deploy-mojo.md | 255 -----
docs/maven/exec-mojo.adoc | 1277 ++++++++++++++++++++++
docs/maven/exec-mojo.md | 1551 ---------------------------
docs/maven/help-mojo.adoc | 115 ++
docs/maven/help-mojo.md | 149 ---
docs/maven/index.adoc | 176 +++
docs/maven/index.md | 148 ---
docs/maven/list-mojo.adoc | 132 +++
docs/maven/list-mojo.md | 169 ---
docs/maven/run-mojo.adoc | 1139 ++++++++++++++++++++
docs/maven/run-mojo.md | 1395 ------------------------
docs/maven/start-mojo.adoc | 1139 ++++++++++++++++++++
docs/maven/start-mojo.md | 1395 ------------------------
docs/maven/stop-mojo.adoc | 1086 +++++++++++++++++++
docs/maven/stop-mojo.md | 1328 -----------------------
docs/maven/undeploy-mojo.adoc | 159 +++
docs/maven/undeploy-mojo.md | 209 ----
36 files changed, 9351 insertions(+), 11337 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/local-client-injection.adoc
----------------------------------------------------------------------
diff --git a/docs/local-client-injection.adoc b/docs/local-client-injection.adoc
new file mode 100644
index 0000000..d95de42
--- /dev/null
+++ b/docs/local-client-injection.adoc
@@ -0,0 +1,88 @@
+# Local Client Injection
+:index-group: Testing Techniques
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+:jbake-title: OpenEJB 3.1.1 or later required}
+
+The _@LocalClient_ annotation (org.apache.openejb.api.LocalClient) is an
+innovation that crosses concepts of an Java EE Application Client with a
+plain Java SE client. This particular annotation is focused on clients
+of an Embeddable EJB container, i.e. local clients. There is another
+annotation in development called @RemoteClient that will be focused on
+remote clients; clients running outside the vm the container runs.
+
+Any clients annotated with @LocalClient will be scanned at deployment
+time for usage of injection-related annotations. The references in the
+@LocalClient will be processed with the application just as if the class
+was a Java EE Application Client module, but with a few slight
+differences:
+
+[arabic]
+. Declaring field/method injection points as 'static' is not required
+. References to EntityManagers via @PersistenceContext are allowed
+. References to local business interfaces via @EJB is allowed
+. References to UserTransaction via @Resource is allowed
+
+As well since this is not a heavyweight Java EE Application Client, you
+are not required to use any special packaging or command-line parameters
+to run the client. Your client can be a Unit Test or any plain java code
+that needs to pull objects from the Embedded EJB container. Classes with
+@LocalClient can be placed in a Client module or an EJB module. A given
+module may have as many classes annotated with @LocalClient as it
+wishes.
+
+# Injection
+
+The injection occurs via acquiring a LocalInitialContext via the
+LocalInitialContextFactory and calling _bind("inject", instance)_
+passing in the instantiated local client object:
+
+....
+@LocalClient
+public class MoviesTest extends TestCase {
+
+ @EJB
+ private Movies movies;
+
+ @Resource
+ private UserTransaction userTransaction;
+
+ @PersistenceContext
+ private EntityManager entityManager;
+
+ public void setUp() throws Exception {
+ Properties p = new Properties();
+ p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.LocalInitialContextFactory");
+ InitialContext initialContext = new InitialContext(p);
+ initialContext.bind("inject", this);
+ }
+
+ //... other test methods
+}
+....
+
+# Discovery
+
+All EJB modules are scanned for @LocalClient classes, even if those EJB
+Modules are inside .war files as with the
+link:collapsed-ear.html[Collapsed EAR] . As well any modules that
+contain a META-INF/application-client.xml file will be scanned for
+@LocalClient classes.
+
+If you see the following error message and are absolutely sure the
+module containing your @LocalClient class is being properly identified
+as an EJB module or a Client module, than it is possible you are seeing
+some classloading issues.
+
+\{panel} javax.naming.NamingException: Unable to find injection
+meta-data for org.superbiz.MyClient. Ensure that class was annotated
+with @org.apache.openejb.api.LocalClient and was successfully discovered
+and deployed. \{panel}
+
+If you encounter this try setting this openejb-specific boot flag so
+that annotations will be treated specially and always loaded by the
+parent classloader
+
+`openejb.tempclassloader.skip=annotations`
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/local-client-injection.md
----------------------------------------------------------------------
diff --git a/docs/local-client-injection.md b/docs/local-client-injection.md
deleted file mode 100644
index 3504837..0000000
--- a/docs/local-client-injection.md
+++ /dev/null
@@ -1,87 +0,0 @@
-index-group=Testing Techniques
-type=page
-status=published
-title=Local Client Injection
-~~~~~~
-{note:title=OpenEJB 3.1.1 or later required}
-
-The *@LocalClient* annotation (org.apache.openejb.api.LocalClient) is an
-innovation that crosses concepts of an Java EE Application Client with a
-plain Java SE client. This particular annotation is focused on clients of
-an Embeddable EJB container, i.e. local clients. There is another
-annotation in development called @RemoteClient that will be focused on
-remote clients; clients running outside the vm the container runs.
-
-Any clients annotated with @LocalClient will be scanned at deployment time
-for usage of injection-related annotations. The references in the
-@LocalClient will be processed with the application just as if the class
-was a Java EE Application Client module, but with a few slight differences:
-
-1. Declaring field/method injection points as 'static' is not required
-1. References to EntityManagers via @PersistenceContext are allowed
-1. References to local business interfaces via @EJB is allowed
-1. References to UserTransaction via @Resource is allowed
-
-As well since this is not a heavyweight Java EE Application Client, you are
-not required to use any special packaging or command-line parameters to run
-the client. Your client can be a Unit Test or any plain java code that
-needs to pull objects from the Embedded EJB container. Classes with
-@LocalClient can be placed in a Client module or an EJB module. A given
-module may have as many classes annotated with @LocalClient as it wishes.
-
-<a name="LocalClientInjection-Injection"></a>
-# Injection
-
-The injection occurs via acquiring a LocalInitialContext via the
-LocalInitialContextFactory and calling _bind("inject", instance)_ passing
-in the instantiated local client object:
-
-
- @LocalClient
- public class MoviesTest extends TestCase {
-
- @EJB
- private Movies movies;
-
- @Resource
- private UserTransaction userTransaction;
-
- @PersistenceContext
- private EntityManager entityManager;
-
- public void setUp() throws Exception {
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.LocalInitialContextFactory");
- InitialContext initialContext = new InitialContext(p);
- initialContext.bind("inject", this);
- }
-
- //... other test methods
- }
-
-
-<a name="LocalClientInjection-Discovery"></a>
-# Discovery
-
-All EJB modules are scanned for @LocalClient classes, even if those EJB
-Modules are inside .war files as with the [Collapsed EAR](collapsed-ear.html)
-. As well any modules that contain a META-INF/application-client.xml file
-will be scanned for @LocalClient classes.
-
-If you see the following error message and are absolutely sure the module
-containing your @LocalClient class is being properly identified as an EJB
-module or a Client module, than it is possible you are seeing some
-classloading issues.
-
-{panel}
-javax.naming.NamingException: Unable to find injection meta-data for
-org.superbiz.MyClient. Ensure that class was annotated with
-@org.apache.openejb.api.LocalClient and was successfully discovered and
-deployed.
-{panel}
-
-If you encounter this try setting this openejb-specific boot flag so that
-annotations will be treated specially and always loaded by the parent
-classloader
-
-`openejb.tempclassloader.skip=annotations`
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/local-server.adoc
----------------------------------------------------------------------
diff --git a/docs/local-server.adoc b/docs/local-server.adoc
new file mode 100644
index 0000000..a96d1b8
--- /dev/null
+++ b/docs/local-server.adoc
@@ -0,0 +1,56 @@
+# Local Server
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+!http://www.openejb.org/images/diagram-local-server.gif|valign=top,
+align=right, hspace=15! # Accessing EJBs Locally
+
+When OpenEJB embedded in your app, server, IDE, or JUnit, you can use
+what we call the Local Server and avoid the network overhead and enjoy
+an easy way to embedd OpenEJB. Instead of putting the app in the server,
+put the server in the app!
+
+# Say what?! A local server?
+
+Yes, you read correctly. OpenEJB can be embedded and treated as your
+very own personal EJB container.
+
+If they can have Local and Remote EJB's, why not Local and Remote EJB
+Servers too?
+
+Haven't you ever wanted EJBs without the heavy? I mean you need the
+"heavy" eventually, but not while you're developing. Well, there's the
+advantage of an EJB implementation that was designed with a very clean
+and well defined server-container contract, you can cut the server part
+out completely!
+
+So, if you wish to access ejbs locally and not in client/server mode,
+you can do so by embedding OpenEJB as a library and accessing ejbs
+through OpenEJB's built-in IntraVM (Local) Server. Why would someone
+want to do this? * Your application is a server or other middleware *
+You want to write an app that can be both stand alone _and_ distributed
+* To test your EJBs with JUnit and don't want to start/stop servers and
+other nonsense * Imagine the power from being able to use your IDE
+debugger to step from your Client all the way into your EJB and back
+with no remote debugging voodoo.
+
+In this case, your application, test suite, IDE, or client accesses
+beans as you would from any other EJB Server. The EJB Server just
+happens to be running in the same virtual machine as your application.
+This EJB Server is thusly called the IntraVM Server, and, for all
+intense purposes, your application an IntraVM Client.
+
+There are some interesting differences though. The IntraVM Server isn't
+a heavyweight server as one normally associates with EJB. It doesn't
+open connections, launch threads for processing requests, introduce
+complex classloading heirarchies, or any of those "heavy" kind of
+things. All it does is dish out proxies to your app that can be used to
+shoot calls right into the EJB Container. Very light, very fast, very
+easy for testing, debugging, developing, etc.
+
+# Embedding
+
+!http://www.openejb.org/images/diagram-local-server.gif|valign=top,
+align=right, hspace=15! \{include:OPENEJBx30:Embedding}
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/local-server.md
----------------------------------------------------------------------
diff --git a/docs/local-server.md b/docs/local-server.md
deleted file mode 100644
index 55f45c1..0000000
--- a/docs/local-server.md
+++ /dev/null
@@ -1,61 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Local Server
-~~~~~~
-!http://www.openejb.org/images/diagram-local-server.gif|valign=top,
-align=right, hspace=15!
-<a name="LocalServer-AccessingEJBsLocally"></a>
-# Accessing EJBs Locally
-
-When OpenEJB embedded in your app, server, IDE, or JUnit, you can use what
-we call the Local Server and avoid the network overhead and enjoy an easy
-way to embedd OpenEJB. Instead of putting the app in the server, put the
-server in the app!
-
-<a name="LocalServer-Saywhat?!Alocalserver?"></a>
-# Say what?! A local server?
-
-Yes, you read correctly. OpenEJB can be embedded and treated as your very
-own personal EJB container.
-
-If they can have Local and Remote EJB's, why not Local and Remote EJB
-Servers too?
-
-Haven't you ever wanted EJBs without the heavy? I mean you need the "heavy"
-eventually, but not while you're developing. Well, there's the advantage of
-an EJB implementation that was designed with a very clean and well defined
-server-container contract, you can cut the server part out completely!
-
-So, if you wish to access ejbs locally and not in client/server mode, you
-can do so by embedding OpenEJB as a library and accessing ejbs through
-OpenEJB's built-in IntraVM (Local) Server. Why would someone want to do
-this?
-* Your application is a server or other middleware
-* You want to write an app that can be both stand alone *and* distributed
-* To test your EJBs with JUnit and don't want to start/stop servers and
-other nonsense
-* Imagine the power from being able to use your IDE debugger to step from
-your Client all the way into your EJB and back with no remote debugging
-voodoo.
-
-In this case, your application, test suite, IDE, or client accesses beans
-as you would from any other EJB Server. The EJB Server just happens to be
-running in the same virtual machine as your application. This EJB Server is
-thusly called the IntraVM Server, and, for all intense purposes, your
-application an IntraVM Client.
-
-There are some interesting differences though. The IntraVM Server isn't a
-heavyweight server as one normally associates with EJB. It doesn't open
-connections, launch threads for processing requests, introduce complex
-classloading heirarchies, or any of those "heavy" kind of things. All it
-does is dish out proxies to your app that can be used to shoot calls right
-into the EJB Container. Very light, very fast, very easy for testing,
-debugging, developing, etc.
-
-<a name="LocalServer-Embedding"></a>
-# Embedding
-
-!http://www.openejb.org/images/diagram-local-server.gif|valign=top,
-align=right, hspace=15!
-{include:OPENEJBx30:Embedding}
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/lookup-of-other-ejbs-example.adoc
----------------------------------------------------------------------
diff --git a/docs/lookup-of-other-ejbs-example.adoc b/docs/lookup-of-other-ejbs-example.adoc
new file mode 100644
index 0000000..de5fb1f
--- /dev/null
+++ b/docs/lookup-of-other-ejbs-example.adoc
@@ -0,0 +1,146 @@
+# Lookup of other EJBs Example
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Overview
+
+This example shows how to configure JNDI to lookup other EJBs using
+either the _@EJB_ annotation or the _ejb-jar.xml_ deployment descriptor.
+
+There are a couple interesting aspects in this example intended to flush
+out some of the more confusing, and perhaps frustrating, aspects of
+referring to EJBs.
+
+* beans themselves do not have JNDI names (this was only recently added
+in Java EE 6)
+
+This is the most frustrating and hard to accept. Java EE 5 does not have
+a global namespace and therefore there is no _singular_ name for your
+EJB. It does not matter what you do to your EJB, there is no standard
+way to "give" the bean a name that can be used by the application
+globally.
+
+* each EJB owns its own private _java:comp/env_ namespace
+(_java:comp/env_ is not global and cannot be treated that way)
+* names do not magically appear in _java:comp/env_, they must be
+explicitly added.
+* to get a reference to bean _B_ in the _java:comp/env_ namespace of
+bean _A_, bean _A_ must declare a reference to bean _B_.
+
+You read this right. If you have 10 EJBs and all of them want to refer
+to bean _B_, then you must declare bean _B_ as a reference 10 times
+(once for each of the 10 beans). There is no standard way in Java EE 5
+to do this just once for all beans. In Java EE 6 there is a
+"_java:global_" namespace, a "_java:app_" namespace, and a
+"_java:module_" namespace where names can be defined with the desired
+scope. Java EE 5 has only _java:comp_.
+
+There are two things which make this even more confusing:
+
+* Servlets have always defined _java:comp/env_ differently. In a webapp,
+the _java:comp/env_ namespace is shared by all servlets. This is
+essentially equivalent to the _java:module_ namespace in Java EE 6.
+Understand there is a conflict in definition here and that for EJBs,
+_java:comp_ is scoped at the component (the EJB itself) not the module
+as with webapps.
+* All vendors have some proprietary concept of global JNDI. So you may
+be able to lookup "_java:/MyBean_" or "_MyBeanLocal_", but these are
+vendor-specific and non-portable.
+
+As well this example shows some other interesting aspects of referring
+to EJBs:
+
+* Two beans may use the same business interfaces, the interface alone
+does not necessarily identify the exact bean
+* circular references are possible
+
+To illustrate all of this, we have two simple @Stateless beans,
+_RedBean_ and _BlueBean_. Both implement the same business local
+interface, _Friend_. Both _RedBean_ and _BlueBean_ define
+_java:comp/env/myFriend_ differently which is allowed as _java:comp_ is
+a namespace that is private to each bean and not visible to other beans
+-- so the names do not have to match.
+
+# The Code
+
+Here we show the code for _RedBean_ and _BlueBean_ and their shared
+business local interface _Friend_.
+\{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/RedBean.java|lang=java}
+\{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/BlueBean.java|lang=java}
+\{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/Friend.java|lang=java}
+
+The key items in the above are the following: - _@EJB_ has been used at
+the _class level_ to declare _myFriend_ in the _java:comp/env_ namespace
+of each EJB - because both beans share the _same interface_, _Friend_,
+we need to add *beanName* to the _@EJB_ usage to specify the exact EJB
+we want - for _BlueBean_ the _java:comp/env/myFriend_ name has been
+configured to point to _RedBean_ - for _RedBean_ the
+_java:comp/env/myFriend_ name has been configured to point to _BlueBean_
+
+== Alternative to annotations
+
+If there is a desire to not use annotations, the above annotation usage
+is equivalent to the following ejb-jar.xml
+\{snippet:url=openejb3/examples/lookup-of-ejbs-with-descriptor/src/main/resources/META-INF/ejb-jar.xml|lang=xml}
+
+# Writing a unit test for the example
+
+Writing an unit test for this example is quite simple. We need just to
+write a setup method to create and initialize the InitialContext, and
+then write our test methods
+
+\{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/test/java/org/superbiz/ejblookup/EjbDependencyTest.java|lang=java}
+
+# Running
+
+Running the example is fairly simple. In the "lookup-of-ejbs" directory
+of the openejb:download.html[examples zip] , just run:
+
+___________________
+$ mvn clean install
+___________________
+
+Which should create output like the following.
+
+....
+-------------------------------------------------------
+ T E S T S
+-------------------------------------------------------
+Running org.superbiz.ejblookup.EjbDependencyTest
+Apache OpenEJB 3.1.5-SNAPSHOT build: 20101129-09:51
+http://tomee.apache.org/
+INFO - openejb.home =
+....
+
+/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs INFO -
+openejb.base =
+/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs INFO -
+Configuring Service(id=Default Security Service, type=SecurityService,
+provider-id=Default Security Service) INFO - Configuring
+Service(id=Default Transaction Manager, type=TransactionManager,
+provider-id=Default Transaction Manager) INFO - Found EjbModule in
+classpath:
+/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs/target/classes
+INFO - Beginning load:
+/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs/target/classes
+INFO - Configuring enterprise application: classpath.ear INFO -
+Configuring Service(id=Default Stateless Container, type=Container,
+provider-id=Default Stateless Container) INFO - Auto-creating a
+container for bean BlueBean: Container(type=STATELESS, id=Default
+Stateless Container) INFO - Enterprise application "classpath.ear"
+loaded. INFO - Assembling app: classpath.ear INFO -
+Jndi(name=BlueBeanLocal) --> Ejb(deployment-id=BlueBean) INFO -
+Jndi(name=RedBeanLocal) --> Ejb(deployment-id=RedBean) INFO - Created
+Ejb(deployment-id=RedBean, ejb-name=RedBean, container=Default Stateless
+Container) INFO - Created Ejb(deployment-id=BlueBean, ejb-name=BlueBean,
+container=Default Stateless Container) INFO - Deployed
+Application(path=classpath.ear) Tests run: 2, Failures: 0, Errors: 0,
+Skipped: 0, Time elapsed: 1.244 sec
+
+....
+Results :
+
+Tests run: 2, Failures: 0, Errors: 0, Skipped: 0
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/lookup-of-other-ejbs-example.md
----------------------------------------------------------------------
diff --git a/docs/lookup-of-other-ejbs-example.md b/docs/lookup-of-other-ejbs-example.md
deleted file mode 100644
index d4cd99d..0000000
--- a/docs/lookup-of-other-ejbs-example.md
+++ /dev/null
@@ -1,149 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Lookup of other EJBs Example
-~~~~~~
-<a name="LookupofotherEJBsExample-Overview"></a>
-# Overview
-
-This example shows how to configure JNDI to lookup other EJBs using either
-the *@EJB* annotation or the *ejb-jar.xml* deployment descriptor.
-
-There are a couple interesting aspects in this example intended to flush
-out some of the more confusing, and perhaps frustrating, aspects of
-referring to EJBs.
-
- - beans themselves do not have JNDI names (this was only recently added in
-Java EE 6)
-
-This is the most frustrating and hard to accept. Java EE 5 does not have a
-global namespace and therefore there is no *singular* name for your EJB.
-It does not matter what you do to your EJB, there is no standard way to
-"give" the bean a name that can be used by the application globally.
-
- - each EJB owns its own private *java:comp/env* namespace
-(*java:comp/env* is not global and cannot be treated that way)
- - names do not magically appear in *java:comp/env*, they must be
-explicitly added.
- - to get a reference to bean *B* in the *java:comp/env* namespace of
-bean *A*, bean *A* must declare a reference to bean *B*.
-
-You read this right. If you have 10 EJBs and all of them want to refer to
-bean *B*, then you must declare bean *B* as a reference 10 times (once
-for each of the 10 beans). There is no standard way in Java EE 5 to do
-this just once for all beans. In Java EE 6 there is a "*java:global*"
-namespace, a "*java:app*" namespace, and a "*java:module*" namespace
-where names can be defined with the desired scope. Java EE 5 has only
-*java:comp*.
-
-There are two things which make this even more confusing:
-
- - Servlets have always defined *java:comp/env* differently. In a
-webapp, the *java:comp/env* namespace is shared by all servlets. This is
-essentially equivalent to the *java:module* namespace in Java EE 6.
-Understand there is a conflict in definition here and that for EJBs,
-*java:comp* is scoped at the component (the EJB itself) not the module as
-with webapps.
- - All vendors have some proprietary concept of global JNDI. So you may be
-able to lookup "*java:/MyBean*" or "*MyBeanLocal*", but these are
-vendor-specific and non-portable.
-
-As well this example shows some other interesting aspects of referring to
-EJBs:
-
- - Two beans may use the same business interfaces, the interface alone does
-not necessarily identify the exact bean
- - circular references are possible
-
-To illustrate all of this, we have two simple @Stateless beans, *RedBean*
-and *BlueBean*. Both implement the same business local interface,
-*Friend*. Both *RedBean* and *BlueBean* define
-*java:comp/env/myFriend* differently which is allowed as *java:comp* is
-a namespace that is private to each bean and not visible to other beans --
-so the names do not have to match.
-
-
-<a name="LookupofotherEJBsExample-TheCode"></a>
-# The Code
-
-Here we show the code for *RedBean* and *BlueBean* and their shared
-business local interface *Friend*.
-{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/RedBean.java|lang=java}
-{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/BlueBean.java|lang=java}
-{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/Friend.java|lang=java}
-
-The key items in the above are the following:
- - *@EJB* has been used at the *class level* to declare *myFriend* in
-the *java:comp/env* namespace of each EJB
- - because both beans share the *same interface*, *Friend*, we need to
-add **beanName** to the *@EJB* usage to specify the exact EJB we want
- - for *BlueBean* the *java:comp/env/myFriend* name has been configured
-to point to *RedBean*
- - for *RedBean* the *java:comp/env/myFriend* name has been configured
-to point to *BlueBean*
-
-<a name="LookupofotherEJBsExample-Alternativetoannotations"></a>
-## Alternative to annotations
-
-If there is a desire to not use annotations, the above annotation usage is
-equivalent to the following ejb-jar.xml
-{snippet:url=openejb3/examples/lookup-of-ejbs-with-descriptor/src/main/resources/META-INF/ejb-jar.xml|lang=xml}
-
-<a name="LookupofotherEJBsExample-Writingaunittestfortheexample"></a>
-# Writing a unit test for the example
-
-Writing an unit test for this example is quite simple. We need just to
-write a setup method to create and initialize the InitialContext, and then
-write our test methods
-
-{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/test/java/org/superbiz/ejblookup/EjbDependencyTest.java|lang=java}
-
-<a name="LookupofotherEJBsExample-Running"></a>
-# Running
-
-Running the example is fairly simple. In the "lookup-of-ejbs" directory of
-the [examples zip](openejb:download.html)
-, just run:
-
-> $ mvn clean install
-
-Which should create output like the following.
-
-
- -------------------------------------------------------
- T E S T S
- -------------------------------------------------------
- Running org.superbiz.ejblookup.EjbDependencyTest
- Apache OpenEJB 3.1.5-SNAPSHOT build: 20101129-09:51
- http://tomee.apache.org/
- INFO - openejb.home =
-/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs
- INFO - openejb.base =
-/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs
- INFO - Configuring Service(id=Default Security Service,
-type=SecurityService, provider-id=Default Security Service)
- INFO - Configuring Service(id=Default Transaction Manager,
-type=TransactionManager, provider-id=Default Transaction Manager)
- INFO - Found EjbModule in classpath:
-/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs/target/classes
- INFO - Beginning load:
-/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs/target/classes
- INFO - Configuring enterprise application: classpath.ear
- INFO - Configuring Service(id=Default Stateless Container, type=Container,
-provider-id=Default Stateless Container)
- INFO - Auto-creating a container for bean BlueBean:
-Container(type=STATELESS, id=Default Stateless Container)
- INFO - Enterprise application "classpath.ear" loaded.
- INFO - Assembling app: classpath.ear
- INFO - Jndi(name=BlueBeanLocal) --> Ejb(deployment-id=BlueBean)
- INFO - Jndi(name=RedBeanLocal) --> Ejb(deployment-id=RedBean)
- INFO - Created Ejb(deployment-id=RedBean, ejb-name=RedBean,
-container=Default Stateless Container)
- INFO - Created Ejb(deployment-id=BlueBean, ejb-name=BlueBean,
-container=Default Stateless Container)
- INFO - Deployed Application(path=classpath.ear)
- Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.244 sec
-
- Results :
-
- Tests run: 2, Failures: 0, Errors: 0, Skipped: 0
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/managedcontainer-config.adoc
----------------------------------------------------------------------
diff --git a/docs/managedcontainer-config.adoc b/docs/managedcontainer-config.adoc
new file mode 100644
index 0000000..b0ca1a6
--- /dev/null
+++ b/docs/managedcontainer-config.adoc
@@ -0,0 +1,42 @@
+# ManagedContainer Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A ManagedContainer can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Container id="myManagedContainer" type="MANAGED">
+</Container>
+....
+
+Alternatively, a ManagedContainer can be declared via properties in the
+`<tomee-home>/conf/system.properties` file or via Java VirtualMachine
+`-D` properties. The properties can also be used when embedding TomEE
+via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
+
+....
+myManagedContainer = new://Container?type=MANAGED
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared ManagedContainer a
+warning will be logged. If a ManagedContainer is needed by the
+application and one is not declared, TomEE will create one dynamically
+using default settings. Multiple ManagedContainer declarations are
+allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/managedcontainer-config.md
----------------------------------------------------------------------
diff --git a/docs/managedcontainer-config.md b/docs/managedcontainer-config.md
deleted file mode 100644
index 1d95e4f..0000000
--- a/docs/managedcontainer-config.md
+++ /dev/null
@@ -1,26 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=ManagedContainer Configuration
-~~~~~~
-
-
-A ManagedContainer can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Container id="myManagedContainer" type="MANAGED">
- </Container>
-
-Alternatively, a ManagedContainer can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myManagedContainer = new://Container?type=MANAGED
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared ManagedContainer a warning will be logged. If a ManagedContainer is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple ManagedContainer declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/manual-installation.adoc
----------------------------------------------------------------------
diff --git a/docs/manual-installation.adoc b/docs/manual-installation.adoc
new file mode 100644
index 0000000..ab9c7d7
--- /dev/null
+++ b/docs/manual-installation.adoc
@@ -0,0 +1,145 @@
+# Manual Installation
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+== Overview
+
+The manual installation process is significantly harder then the
+link:tomcat.html[automatic installation] which we normally recommend. In
+this installation process you will do the following:
+
+[arabic]
+. Install openejb.war
+. Download openejb.war from the
+http://tomee.apache.org/downloads.html[download page]
+. Make webapps/openejb directory
+. Change to new webapps/openejb directory
+. Unpack the openejb.war file in the new directory
+. Add the OpenEJB listener the conf/server.xml file
+. Update the non-compliant Tomcat annotations-api.jar
+. Add the OpenEJB JavaAgent to the bin/catalina.bat or bin/catalina.bat
+script
+
+##Install openejb.war
+
+Once Tomcat has been link:tomcat-installation.html[installed] , the
+OpenEJB plugin for Tomcat can be installed. The war can be obtained from
+the http://tomee.apache.org/downloads.html[download page]
+
+The commands in this example are executed from within the Tomcat
+installation directory.
+
+== Unpack OpenEJB Tomcat plugin in Tomcat webapps directory
+
+Be careful, this is the most error prone step. A web application does
+not contain a root directory, so if you unpack it in the wrong
+directory, it is difficult to undo. Please, follow this step closely,
+and most importantly make sure you execute the unpack command from
+within the new webapps/openejb directory
+
+Due to the structure of war files, you must create a new directory for
+OpenEJB, change to the new directory and execute the unpack command from
+within the new directory. If you get this wrong, it is difficult to
+undo, so follow the steps closely.
+
+== Add the OpenEJB listener to Tomcat
+
+All Tomcat listener classes must be available in the Tomcat common class
+loader, so the openejb-loader jar must be copied into the Tomcat lib
+directory.
+
+....
+ C:\apache-tomcat-6.0.14>copy webapps\openejb\lib\openejb-loader-3.0.0-SNAPSHOT.jar lib\openejb-loader.jar
+ 1 file(s) copied.
+
+ apache-tomcat-6.0.14$ cp webapps/openejb/lib/openejb-loader-*.jar lib/openejb-loader.jar
+....
+
+Add the following
+`<Listener className="org.apache.openejb.loader.OpenEJBListener" />` to
+your conf/server.xml file to load the OpenEJB listener:
+
+The snippet is shown below
+
+....
+<!-- Note: A "Server" is not itself a "Container", so you may not
+define subcomponents such as "Valves" at this
+level.
+Documentation at /docs/config/server.html
+ -->
+
+<Server port="8005" shutdown="SHUTDOWN">
+<!-- OpenEJB plugin for tomcat -->
+<Listener
+className="org.apache.openejb.loader.OpenEJBListener" />
+
+<!--APR library loader. Documentation at /docs/apr.html -->
+<Listener
+className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
+....
+
+== Update the Tomcat annotations-api.jar file
+
+Tomcat contains an old non-compliant version of the javax.annotation
+classes and these invalid classes must be updated so OpenEJB can process
+annotations. Simply, replace the annotations-api.jar in the Tomcat lib
+directory with the updated annotations-api.jar in the OpenEJB war.
+
+== Add OpenEJB javaagent to Tomcat startup
+
+OpenJPA, the Java Persistence implementation used by OpenEJB, currently
+must enhanced persistence classes to function properly, and this
+requires the installation of a javaagent into the Tomcat startup
+process.
+
+First, copy the OpenEJB JavaAgent jar into the lib directory.
+
+Simply, add the snippet marked below in bin/catalina.bat (Windows) or
+bin/catalina.sh (Unix) file to enable the OpenEJB javaagent:
+
+....
+if not exist "%CATALINA_BASE%\conf\logging.properties" goto noJuli
+set JAVA_OPTS=%JAVA_OPTS%
+-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
+-Djava.util.logging.config.file="%CATALINA_BASE%\conf\logging.properties"
+:noJuli
+
+ # Start of Snippet to add
+ rem Add OpenEJB javaagent if not exist
+ "%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar" goto
+ noOpenEJBJavaagent set
+ JAVA_OPTS="-javaagent:%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar"
+ %JAVA_OPTS% :noOpenEJBJavaagent
+ # End of Snippet to add
+
+
+rem ----- Execute The Requested Command
+---------------------------------------
+echo Using CATALINA_BASE: %CATALINA_BASE%
+echo Using CATALINA_HOME: %CATALINA_HOME%
+
+
+
+# Set juli LogManager if it is present
+if [OPENEJB: -r "$CATALINA_BASE"/conf/logging.properties ](openejb:--r-"$catalina_base"/conf/logging.properties-.html)
+; then
+JAVA_OPTS="$JAVA_OPTS
+"-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager"
+"-Djava.util.logging.config.file="$CATALINA_BASE/conf/logging.properties"
+fi
+
+ #Start of Snippet to add
+ if [OPENEJB: -r "$CATALINA_BASE"/webapps/lib/openejb-javaagent.jar ](openejb:--r-"$catalina_base"/webapps/lib/openejb-javaagent.jar-.html)
+; then
+JAVA_OPTS=""-javaagent:$CATALINA_BASE/lib/openejb-javaagent.jar"
+$JAVA_OPTS"
+fi
+#End of Snippet to add
+....
+
+##Note: The example above is an excerpt from the middle of the
+bin/catalina.sh file. Search for the this section and add the snippet
+shown
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/manual-installation.md
----------------------------------------------------------------------
diff --git a/docs/manual-installation.md b/docs/manual-installation.md
deleted file mode 100644
index b00fe81..0000000
--- a/docs/manual-installation.md
+++ /dev/null
@@ -1,224 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Manual Installation
-~~~~~~
-
-# Overview
-
-The manual installation process is significantly harder then the [automatic installation](tomcat.html)
- which we normally recommend. In this installation process you will do the
-following:
-
-1. Install openejb.war
-1. Download openejb.war from the [download page](http://tomee.apache.org/downloads.html)
-1. Make webapps/openejb directory
-1. Change to new webapps/openejb directory
-1. Unpack the openejb.war file in the new directory
-1. Add the OpenEJB listener the conf/server.xml file
-1. Update the non-compliant Tomcat annotations-api.jar
-1. Add the OpenEJB JavaAgent to the bin/catalina.bat or bin/catalina.bat
-script
-
-##Install openejb.war
-
-Once Tomcat has been [installed](tomcat-installation.html)
-, the OpenEJB plugin for Tomcat can be installed. The war can be obtained
-from the [download page](http://tomee.apache.org/downloads.html)
-
-The commands in this example are executed from within the Tomcat
-installation directory.
-
-<a name="ManualInstallation-UnpackOpenEJBTomcatplugininTomcatwebappsdirectory"></a>
-## Unpack OpenEJB Tomcat plugin in Tomcat webapps directory
-
-Be careful, this is the most error prone step. A web
-application does not contain a root directory, so if you unpack it in the
-wrong directory, it is difficult to undo. Please, follow this step
-closely, and most importantly make sure you execute the unpack command
-from within the new webapps/openejb directory
-
-Due to the structure of war files, you must create a new directory for
-OpenEJB, change to the new directory and execute the unpack command from
-within the new directory. If you get this wrong, it is difficult to undo,
-so follow the steps closely.
-
-<pre><code>
- C:\apache-tomcat-6.0.14>mkdir webapps\openejb
-
- C:\apache-tomcat-6.0.14>cd webapps\openejb
-
- C:\apache-tomcat-6.0.14\webapps\openejb>jar -xvf \openejb.war
- created: WEB-INF/
- created: WEB-INF/classes/
- created: WEB-INF/classes/org/
- created: WEB-INF/classes/org/apache/
- created: WEB-INF/classes/org/apache/openejb/
- ...snip...
-
- C:\apache-tomcat-6.0.14\webapps\openejb>dir
- Volume in drive C has no label.
- Volume Serial Number is 0000-0000
-
- Directory of C:\apache-tomcat-6.0.14\webapps\openejb
-
- 09/21/2007 10:19 AM <DIR> .
- 09/21/2007 10:19 AM <DIR> ..
- 09/21/2007 10:19 AM 1,000 index.html
- 09/21/2007 10:19 AM <DIR> lib
- 09/21/2007 10:19 AM 11,358 LICENSE
- 09/21/2007 10:19 AM <DIR> META-INF
- 09/21/2007 10:19 AM 11,649 NOTICE
- 09/21/2007 10:19 AM 1,018 openejb.xml
- 09/21/2007 10:19 AM 1,886 README.txt
- 09/21/2007 10:19 AM <DIR> tomcat
- 09/21/2007 10:19 AM <DIR> WEB-INF
- 5 File(s) 26,911 bytes
- 6 Dir(s) 4,633,796,608 bytes free
-
- C:\apache-tomcat-6.0.14\webapps\openejb>cd ..\..
-
- C:\apache-tomcat-6.0.14>
-
- {card:label=Unix}{noformat:nopanel=true}
- apache-tomcat-6.0.14$ mkdir webapps/openejb
-
- apache-tomcat-6.0.14$ cd webapps/openejb/
-
- apache-tomcat-6.0.14/webapps/openejb$ jar -xvf path/to/openejb.war
- created: WEB-INF/
- created: WEB-INF/classes/
- created: WEB-INF/classes/org/
- created: WEB-INF/classes/org/apache/
- created: WEB-INF/classes/org/apache/openejb/
- ...snip...
-
- apache-tomcat-6.0.14/webapps/openejb$ ls
- LICENSE META-INF/ NOTICE README.txt WEB-INF/ index.html
- lib/ openejb.xml tomcat/
-
- apache-tomcat-6.0.14/webapps/openejb$ cd ../..
-
- apache-tomcat-6.0.14$
-
-</code></pre>
-
-<a name="ManualInstallation-AddtheOpenEJBlistenertoTomcat"></a>
-## Add the OpenEJB listener to Tomcat
-
-All Tomcat listener classes must be available in the Tomcat common class
-loader, so the openejb-loader jar must be copied into the Tomcat lib
-directory.
-
-
- C:\apache-tomcat-6.0.14>copy webapps\openejb\lib\openejb-loader-3.0.0-SNAPSHOT.jar lib\openejb-loader.jar
- 1 file(s) copied.
-
- apache-tomcat-6.0.14$ cp webapps/openejb/lib/openejb-loader-*.jar lib/openejb-loader.jar
-
-
-Add the following `<Listener
-className="org.apache.openejb.loader.OpenEJBListener" />` to your conf/server.xml file to load the OpenEJB listener:
-
-The snippet is shown below
-
- <!-- Note: A "Server" is not itself a "Container", so you may not
- define subcomponents such as "Valves" at this
- level.
- Documentation at /docs/config/server.html
- -->
-
- <Server port="8005" shutdown="SHUTDOWN">
- <!-- OpenEJB plugin for tomcat -->
- <Listener
- className="org.apache.openejb.loader.OpenEJBListener" />
-
- <!--APR library loader. Documentation at /docs/apr.html -->
- <Listener
- className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
-
-<a name="ManualInstallation-UpdatetheTomcatannotations-api.jarfile"></a>
-## Update the Tomcat annotations-api.jar file
-
-Tomcat contains an old non-compliant version of the javax.annotation
-classes and these invalid classes must be updated so OpenEJB can process
-annotations. Simply, replace the annotations-api.jar in the Tomcat lib
-directory with the updated annotations-api.jar in the OpenEJB war.
-
-<pre><code>
-
-C:\apache-tomcat-6.0.14>copy webapps\openejb\tomcat\annotations-api.jar
-lib\annotations-api.jar
-Overwrite lib\annotations-api.jar? (Yes/No/All): y
- 1 file(s) copied.
-
-apache-tomcat-6.0.14$ cp webapps/openejb/tomcat/annotations-api.jar
-lib/annotations-api.jar
-
-</code></pre>
-
-<a name="ManualInstallation-{anchor:javaagent}AddOpenEJBjavaagenttoTomcatstartup"></a>
-## Add OpenEJB javaagent to Tomcat startup
-
-OpenJPA, the Java Persistence implementation used by OpenEJB, currently
-must enhanced persistence classes to function properly, and this requires
-the installation of a javaagent into the Tomcat startup process.
-
-First, copy the OpenEJB JavaAgent jar into the lib directory.
-
-<pre><code>
-
- C:\apache-tomcat-6.0.14>copy webapps\openejb\lib\openejb-javaagent-3.0.0-SNAPSHOT.jar lib\openejb-javaagent.jar
- 1 file(s) copied.
-
- apache-tomcat-6.0.14$ cp webapps/openejb/lib/openejb-javaagent-*.jar lib/openejb-javaagent.jar
-
-</code></pre>
-
-Simply, add the snippet marked below in
-bin/catalina.bat (Windows) or bin/catalina.sh (Unix) file to enable the
-OpenEJB javaagent:
-
- if not exist "%CATALINA_BASE%\conf\logging.properties" goto noJuli
- set JAVA_OPTS=%JAVA_OPTS%
- -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
- -Djava.util.logging.config.file="%CATALINA_BASE%\conf\logging.properties"
- :noJuli
-
- # Start of Snippet to add
- rem Add OpenEJB javaagent if not exist
- "%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar" goto
- noOpenEJBJavaagent set
- JAVA_OPTS="-javaagent:%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar"
- %JAVA_OPTS% :noOpenEJBJavaagent
- # End of Snippet to add
-
-
- rem ----- Execute The Requested Command
- ---------------------------------------
- echo Using CATALINA_BASE: %CATALINA_BASE%
- echo Using CATALINA_HOME: %CATALINA_HOME%
-
-
-
- # Set juli LogManager if it is present
- if [OPENEJB: -r "$CATALINA_BASE"/conf/logging.properties ](openejb:--r-"$catalina_base"/conf/logging.properties-.html)
- ; then
- JAVA_OPTS="$JAVA_OPTS
- "-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager"
- "-Djava.util.logging.config.file="$CATALINA_BASE/conf/logging.properties"
- fi
-
- #Start of Snippet to add
- if [OPENEJB: -r "$CATALINA_BASE"/webapps/lib/openejb-javaagent.jar ](openejb:--r-"$catalina_base"/webapps/lib/openejb-javaagent.jar-.html)
- ; then
- JAVA_OPTS=""-javaagent:$CATALINA_BASE/lib/openejb-javaagent.jar"
- $JAVA_OPTS"
- fi
- #End of Snippet to add
-
-
-
-##Note:
- The example above is an excerpt from the middle of the
-bin/catalina.sh file. Search for the this section and add the snippet shown
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven.adoc
----------------------------------------------------------------------
diff --git a/docs/maven.adoc b/docs/maven.adoc
new file mode 100644
index 0000000..2923618
--- /dev/null
+++ b/docs/maven.adoc
@@ -0,0 +1,61 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# Maven
+Information
+
+This page is intended to provide an insight into basic
+http://maven.apache.org/[Maven] usage for users that are not all that
+familiar with http://maven.apache.org/[Maven] projects. It is by no
+means a tutorial and is designed to be more of a _quickstart_ to get you
+up and running.
+
+You can find a really good http://maven.apache.org/[Maven] tutorial
+here: http://books.sonatype.com/mvnex-book/reference/public-book.html
+
+It is assumed that:
+
+* You have downloaded and installed http://maven.apache.org/[Maven] and
+that you can run *mvn --version* from any command prompt (or console).
+* You have downloaded and installed
+http://subversion.apache.org/[Subversion] and that you can run *svn
+--version* from any command prompt or console.
+
+It is also assumed you have downloaded one of the following:
+
+* One of the example projects from
+link:[http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples]
+* The entire project source from
+http://svn.apache.org/repos/asf/tomee/tomee/trunk
+
+Use http://subversion.apache.org/[Subversion] to checkout the example
+sources from a console like so:
+
+....
+svn co http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/[example]
+
+....
+
+Or that you may of course also be using your own project pom.xml
+
+If you want to use the latest snapshot locate the __ section in your
+pom.xml and ensure the following repository exists:
+
+....
+<repositories>
+ <repository>
+ <id>apache-m2-snapshot</id>
+ <name>Apache M2 Snapshot Repository</name>
+ <url>http://repository.apache.org/snapshots/</url>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+</repositories>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven.md
----------------------------------------------------------------------
diff --git a/docs/maven.md b/docs/maven.md
deleted file mode 100644
index a68c7a9..0000000
--- a/docs/maven.md
+++ /dev/null
@@ -1,42 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-# Maven Information
-
-This page is intended to provide an insight into basic [Maven](http://maven.apache.org/) usage for users that are not all that familiar with [Maven](http://maven.apache.org/) projects.
-It is by no means a tutorial and is designed to be more of a *quickstart* to get you up and running.
-
-You can find a really good [Maven](http://maven.apache.org/) tutorial here: [http://books.sonatype.com/mvnex-book/reference/public-book.html](http://books.sonatype.com/mvnex-book/reference/public-book.html)
-
-It is assumed that:
-
- - You have downloaded and installed [Maven](http://maven.apache.org/) and that you can run **mvn --version** from any command prompt (or console).
- - You have downloaded and installed [Subversion](http://subversion.apache.org/) and that you can run **svn --version** from any command prompt or console.
-
-It is also assumed you have downloaded one of the following:
-
- - One of the example projects from [http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples]()
- - The entire project source from [http://svn.apache.org/repos/asf/tomee/tomee/trunk](http://svn.apache.org/repos/asf/tomee/tomee/trunk)
-
-Use [Subversion](http://subversion.apache.org/) to checkout the example sources from a console like so:
-
- svn co http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/[example]
-
-Or that you may of course also be using your own project pom.xml
-
-If you want to use the latest snapshot locate the *<repositories>* section in your pom.xml and ensure the following repository exists:
-
- <repositories>
- <repository>
- <id>apache-m2-snapshot</id>
- <name>Apache M2 Snapshot Repository</name>
- <url>http://repository.apache.org/snapshots/</url>
- <releases>
- <enabled>false</enabled>
- </releases>
- <snapshots>
- <enabled>true</enabled>
- </snapshots>
- </repository>
- </repositories>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/build-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/build-mojo.adoc b/docs/maven/build-mojo.adoc
new file mode 100644
index 0000000..b4c938c
--- /dev/null
+++ b/docs/maven/build-mojo.adoc
@@ -0,0 +1,1169 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:build
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:build
+
+Description:
+
+Create but not run a TomEE.
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime+system.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+apacheRepos
+
+String
+
+-
+
+(no description)Default value is: snapshots.User property is:
+tomee-plugin.apache-repos.
+
+appDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: apps.
+
+apps
+
+List
+
+-
+
+(no description)
+
+args
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.args.
+
+attach
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.attach.
+
+bin
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/bin.User property is:
+tomee-plugin.bin.
+
+catalinaBase
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.build.directory}/apache-tomee.User property is:
+tomee-plugin.catalina-base.
+
+checkStarted
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.check-started.
+
+classifier
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.classifier.
+
+classpaths
+
+List
+
+-
+
+(no description)
+
+config
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/conf.User property is:
+tomee-plugin.conf.
+
+context
+
+String
+
+-
+
+rename the current artifact
+
+debug
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.debug.
+
+debugPort
+
+int
+
+-
+
+(no description)Default value is: 5005.User property is:
+tomee-plugin.debugPort.
+
+deployOpenEjbApplication
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.deploy-openejb-internal-application.
+
+docBases
+
+List
+
+-
+
+for TomEE and wars only, which docBase to use for this war.
+
+ejbRemote
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.ejb-remote.
+
+externalRepositories
+
+List
+
+-
+
+for TomEE and wars only, add some external repositories to classloader.
+
+forceReloadable
+
+boolean
+
+-
+
+force webapp to be reloadableDefault value is: false.User property is:
+tomee-plugin.force-reloadable.
+
+javaagents
+
+List
+
+-
+
+(no description)
+
+keepServerXmlAsthis
+
+boolean
+
+-
+
+(Removed since 7.0.0)Default value is: false.User property is:
+tomee-plugin.keep-server-xml.
+
+lib
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/tomee/lib.User property is:
+tomee-plugin.lib.
+
+libDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: lib.
+
+libs
+
+List
+
+-
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+mainDir
+
+File
+
+-
+
+(no description)Default value is: $\{project.basedir}/src/main.
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+quickSession
+
+boolean
+
+-
+
+use a real random instead of secure random. saves few ms at
+startup.Default value is: true.User property is:
+tomee-plugin.quick-session.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+removeDefaultWebapps
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-default-webapps.
+
+removeTomeeWebapp
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.remove-tomee-webapps.
+
+simpleLog
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.simple-log.
+
+skipCurrentProject
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.skipCurrentProject.
+
+skipWarResources
+
+boolean
+
+-
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.Default value is: false.User property is:
+tomee-plugin.skipWarResources.
+
+systemVariables
+
+Map
+
+-
+
+(no description)
+
+target
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.directory}.
+
+tomeeAjpPort
+
+int
+
+-
+
+(no description)Default value is: 8009.User property is:
+tomee-plugin.ajp.
+
+tomeeAlreadyInstalled
+
+boolean
+
+-
+
+(no description)Default value is: false.User property is:
+tomee-plugin.exiting.
+
+tomeeArtifactId
+
+String
+
+-
+
+(no description)Default value is: apache-tomee.User property is:
+tomee-plugin.artifactId.
+
+tomeeClassifier
+
+String
+
+-
+
+(no description)Default value is: webprofile.User property is:
+tomee-plugin.classifier.
+
+tomeeGroupId
+
+String
+
+-
+
+(no description)Default value is: org.apache.openejb.User property is:
+tomee-plugin.groupId.
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+tomeeHttpsPort
+
+Integer
+
+-
+
+(no description)User property is: tomee-plugin.https.
+
+tomeeShutdownCommand
+
+String
+
+-
+
+(no description)Default value is: SHUTDOWN.User property is:
+tomee-plugin.shutdown-command.
+
+tomeeShutdownPort
+
+int
+
+-
+
+(no description)Default value is: 8005.User property is:
+tomee-plugin.shutdown.
+
+tomeeVersion
+
+String
+
+-
+
+(no description)Default value is: -1.User property is:
+tomee-plugin.version.
+
+useConsole
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.use-console.
+
+useOpenEJB
+
+boolean
+
+-
+
+use openejb-standalone automatically instead of TomEEDefault value is:
+false.User property is: tomee-plugin.openejb.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+warFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}.
+
+webappClasses
+
+File
+
+-
+
+(no description)Default value is: $\{project.build.outputDirectory}.User
+property is: tomee-plugin.webappClasses.
+
+webappDefaultConfig
+
+boolean
+
+-
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)Default value is: false.User property is:
+tomee-plugin.webappDefaultConfig.
+
+webappDir
+
+String
+
+-
+
+relative to tomee.base.Default value is: webapps.
+
+webappResources
+
+File
+
+-
+
+(no description)Default value is:
+$\{project.basedir}/src/main/webapp.User property is:
+tomee-plugin.webappResources.
+
+webapps
+
+List
+
+-
+
+(no description)
+
+zip
+
+boolean
+
+-
+
+(no description)Default value is: true.User property is:
+tomee-plugin.zip.
+
+zipFile
+
+File
+
+-
+
+(no description)Default value is:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.zip.User
+property is: tomee-plugin.zip-file.
+
+Parameter Details
+
+apacheRepos:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.apache-repos
+
+Default: snapshots
+
+appDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: apps
+
+apps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+args:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.args
+
+attach:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.attach
+
+Default: true
+
+bin:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.bin
+
+Default: $\{project.basedir}/src/main/tomee/bin
+
+catalinaBase:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.catalina-base
+
+Default: $\{project.build.directory}/apache-tomee
+
+checkStarted:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.check-started
+
+Default: false
+
+classifier:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.classifier
+
+classpaths:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+config:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.conf
+
+Default: $\{project.basedir}/src/main/tomee/conf
+
+context:
+
+rename the current artifact
+
+Type: java.lang.String
+
+Required: No
+
+debug:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.debug
+
+Default: false
+
+debugPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.debugPort
+
+Default: 5005
+
+deployOpenEjbApplication:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.deploy-openejb-internal-application
+
+Default: false
+
+docBases:
+
+for TomEE and wars only, which docBase to use for this war.
+
+Type: java.util.List
+
+Required: No
+
+ejbRemote:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.ejb-remote
+
+Default: true
+
+externalRepositories:
+
+for TomEE and wars only, add some external repositories to classloader.
+
+Type: java.util.List
+
+Required: No
+
+forceReloadable:
+
+force webapp to be reloadable
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.force-reloadable
+
+Default: false
+
+javaagents:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+keepServerXmlAsthis:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.keep-server-xml
+
+Default: false
+
+lib:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.lib
+
+Default: $\{project.basedir}/src/main/tomee/lib
+
+libDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: lib
+
+libs:
+
+supported formats: --> groupId:artifactId:version... -->
+unzip:groupId:artifactId:version... --> remove:prefix (often prefix =
+artifactId)
+
+Type: java.util.List
+
+Required: No
+
+mainDir:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.basedir}/src/main
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+quickSession:
+
+use a real random instead of secure random. saves few ms at startup.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.quick-session
+
+Default: true
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+removeDefaultWebapps:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-default-webapps
+
+Default: true
+
+removeTomeeWebapp:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.remove-tomee-webapps
+
+Default: true
+
+simpleLog:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.simple-log
+
+Default: false
+
+skipCurrentProject:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipCurrentProject
+
+Default: false
+
+skipWarResources:
+
+when you set docBases to src/main/webapp setting it to true will allow
+hot refresh.
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.skipWarResources
+
+Default: false
+
+systemVariables:
+
+(no description)
+
+Type: java.util.Map
+
+Required: No
+
+target:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default: $\{project.build.directory}
+
+tomeeAjpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.ajp
+
+Default: 8009
+
+tomeeAlreadyInstalled:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.exiting
+
+Default: false
+
+tomeeArtifactId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.artifactId
+
+Default: apache-tomee
+
+tomeeClassifier:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.classifier
+
+Default: webprofile
+
+tomeeGroupId:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.groupId
+
+Default: org.apache.openejb
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+tomeeHttpsPort:
+
+(no description)
+
+Type: java.lang.Integer
+
+Required: No
+
+User Property: tomee-plugin.https
+
+tomeeShutdownCommand:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.shutdown-command
+
+Default: SHUTDOWN
+
+tomeeShutdownPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.shutdown
+
+Default: 8005
+
+tomeeVersion:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.version
+
+Default: -1
+
+useConsole:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.use-console
+
+Default: true
+
+useOpenEJB:
+
+use openejb-standalone automatically instead of TomEE
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.openejb
+
+Default: false
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
+
+warFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}
+
+webappClasses:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappClasses
+
+Default: $\{project.build.outputDirectory}
+
+webappDefaultConfig:
+
+forcing nice default for war development (WEB-INF/classes and web
+resources)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.webappDefaultConfig
+
+Default: false
+
+webappDir:
+
+relative to tomee.base.
+
+Type: java.lang.String
+
+Required: No
+
+Default: webapps
+
+webappResources:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.webappResources
+
+Default: $\{project.basedir}/src/main/webapp
+
+webapps:
+
+(no description)
+
+Type: java.util.List
+
+Required: No
+
+zip:
+
+(no description)
+
+Type: boolean
+
+Required: No
+
+User Property: tomee-plugin.zip
+
+Default: true
+
+zipFile:
+
+(no description)
+
+Type: java.io.File
+
+Required: No
+
+User Property: tomee-plugin.zip-file
+
+Default:
+latexmath:[${project.build.directory}/$]\{project.build.finalName}.zip
[29/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 5
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 5
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/54346fb9
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/54346fb9
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/54346fb9
Branch: refs/heads/master
Commit: 54346fb9e5d273dc94fc01bc0ea5ce7525017d15
Parents: 6bbcdc1
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 23:06:54 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 23:06:54 2018 -0800
----------------------------------------------------------------------
docs/ejb-failover.adoc | 5 ++---
docs/embedded-and-remotable.adoc | 2 +-
docs/failover-logging.adoc | 3 +--
3 files changed, 4 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/54346fb9/docs/ejb-failover.adoc
----------------------------------------------------------------------
diff --git a/docs/ejb-failover.adoc b/docs/ejb-failover.adoc
index 04f0ee3..de4cd50 100644
--- a/docs/ejb-failover.adoc
+++ b/docs/ejb-failover.adoc
@@ -1,9 +1,8 @@
-:index-group: Discovery
-and Failover
+# EJB Client/Server Failover
+:index-group: Discovery and Failover
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: EJB Client/Server Failover
OpenEJB supports stateless failover. Specifically, the ability for an
http://git-wip-us.apache.org/repos/asf/tomee/blob/54346fb9/docs/embedded-and-remotable.adoc
----------------------------------------------------------------------
diff --git a/docs/embedded-and-remotable.adoc b/docs/embedded-and-remotable.adoc
index ee6cc5e..aa22bf5 100644
--- a/docs/embedded-and-remotable.adoc
+++ b/docs/embedded-and-remotable.adoc
@@ -66,7 +66,7 @@ you call _listen_ to get your answer.
\{snippet:id=code|url=openejb3/examples/telephone-stateful/src/main/java/org/superbiz/telephone/Telephone.java|lang=java}
-:jbake-title: EJB3 Notes} The bean class uses the annotation _@Remote_ but
+{title= EJB3 Notes} The bean class uses the annotation _@Remote_ but
does not specify a list of interfaces as is normally required. Per EJB3
rules, if the bean implements exactly _one business interface_ it may
use @Remote with no other values and that business interface is then
http://git-wip-us.apache.org/repos/asf/tomee/blob/54346fb9/docs/failover-logging.adoc
----------------------------------------------------------------------
diff --git a/docs/failover-logging.adoc b/docs/failover-logging.adoc
index 76c23a9..84c4045 100644
--- a/docs/failover-logging.adoc
+++ b/docs/failover-logging.adoc
@@ -1,5 +1,4 @@
-:index-group: Discovery
-and Failover
+:index-group: Discovery and Failover
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
[37/44] tomee git commit: This closes apache/tomee#247
Posted by jl...@apache.org.
This closes apache/tomee#247
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/f36b2085
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/f36b2085
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/f36b2085
Branch: refs/heads/master
Commit: f36b2085989dbdcb2e6594e5286e9d453f7faca6
Parents: a175e04 4ac0e33
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:51:36 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:51:36 2018 +0100
----------------------------------------------------------------------
docs/datasource-config.adoc | 527 ++++++++++++++++++++
docs/datasource-config.md | 541 ---------------------
docs/datasource-configuration-by-creator.adoc | 160 ++++++
docs/datasource-configuration-by-creator.md | 155 ------
docs/datasource-password-encryption.adoc | 159 ++++++
docs/datasource-password-encryption.md | 128 -----
docs/deamon/lin-service.adoc | 24 +
docs/deamon/lin-service.md | 17 -
docs/deamon/win-service.adoc | 24 +
docs/deamon/win-service.md | 17 -
docs/declaring-references.adoc | 6 +
docs/declaring-references.md | 6 -
docs/deploy-tool.adoc | 166 +++++++
docs/deploy-tool.md | 165 -------
docs/deploying-in-tomee.adoc | 73 +++
docs/deploying-in-tomee.md | 73 ---
docs/deployment-id.adoc | 231 +++++++++
docs/deployment-id.md | 231 ---------
docs/deployments.adoc | 146 ++++++
docs/deployments.md | 135 -----
docs/details-on-openejb-jar.adoc | 152 ++++++
docs/details-on-openejb-jar.md | 156 ------
docs/documentation.adoc | 103 ++++
docs/documentation.md | 106 ----
docs/documentation.old.adoc | 98 ++++
docs/documentation.old.md | 102 ----
docs/dynamic-datasource.adoc | 219 +++++++++
docs/dynamic-datasource.md | 220 ---------
28 files changed, 2088 insertions(+), 2052 deletions(-)
----------------------------------------------------------------------
[23/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 10
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/statelesscontainer-config.adoc
----------------------------------------------------------------------
diff --git a/docs/statelesscontainer-config.adoc b/docs/statelesscontainer-config.adoc
new file mode 100644
index 0000000..a923fa1
--- /dev/null
+++ b/docs/statelesscontainer-config.adoc
@@ -0,0 +1,441 @@
+# StatelessContainer Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A StatelessContainer can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Container id="myStatelessContainer" type="STATELESS">
+ accessTimeout = 30 seconds
+ callbackThreads = 5
+ closeTimeout = 5 minutes
+ garbageCollection = false
+ idleTimeout = 0 minutes
+ maxAge = 0 hours
+ maxAgeOffset = -1
+ maxSize = 10
+ minSize = 0
+ replaceAged = true
+ replaceFlushed = false
+ strictPooling = true
+ sweepInterval = 5 minutes
+</Container>
+....
+
+Alternatively, a StatelessContainer can be declared via properties in
+the `<tomee-home>/conf/system.properties` file or via Java
+VirtualMachine `-D` properties. The properties can also be used when
+embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or
+`InitialContext`
+
+....
+myStatelessContainer = new://Container?type=STATELESS
+myStatelessContainer.accessTimeout = 30 seconds
+myStatelessContainer.callbackThreads = 5
+myStatelessContainer.closeTimeout = 5 minutes
+myStatelessContainer.garbageCollection = false
+myStatelessContainer.idleTimeout = 0 minutes
+myStatelessContainer.maxAge = 0 hours
+myStatelessContainer.maxAgeOffset = -1
+myStatelessContainer.maxSize = 10
+myStatelessContainer.minSize = 0
+myStatelessContainer.replaceAged = true
+myStatelessContainer.replaceFlushed = false
+myStatelessContainer.strictPooling = true
+myStatelessContainer.sweepInterval = 5 minutes
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared StatelessContainer a
+warning will be logged. If a StatelessContainer is needed by the
+application and one is not declared, TomEE will create one dynamically
+using default settings. Multiple StatelessContainer declarations are
+allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+accessTimeout
+
+time
+
+30 seconds
+
+Specifies the time an invokation should wait for an instance of the pool
+to become available.
+
+callbackThreads
+
+int
+
+5
+
+The number of threads for constructing and destroying beans.
+
+closeTimeout
+
+time
+
+5 minutes
+
+Maximum time to wait for instances to be destroyed when shutting down
+the pool
+
+garbageCollection
+
+boolean
+
+false
+
+Allows Garbage Collection to be used as a mechanism for shrinking the
+pool.
+
+idleTimeout
+
+time
+
+0 minutes
+
+Specifies the maximum time that an instance should be allowed to sit
+idly in the pool without use before it should be retired and removed.
+
+maxAge
+
+time
+
+0 hours
+
+Specifies the maximum time that an instance should live before it should
+be retired and removed from use.
+
+maxAgeOffset
+
+int
+
+-1
+
+Applies to MaxAge usage and would rarely be changed, but is a nice
+feature to understand.
+
+maxSize
+
+int
+
+10
+
+Specifies the size of the instance pool for this stateless SessionBean
+container.
+
+minSize
+
+int
+
+0
+
+Specifies the minimum number of bean instances that should be in the
+pool for each bean.
+
+replaceAged
+
+boolean
+
+true
+
+When `ReplaceAged` is enabled, any instances in the pool that expire due
+to reaching their `MaxAge` will be replaced immediately so that the pool
+will remain at its current size.
+
+replaceFlushed
+
+boolean
+
+false
+
+When `ReplaceFlushed` is enabled, any instances in the pool that are
+flushed will be replaced immediately so that the pool will remain at its
+current size.
+
+strictPooling
+
+boolean
+
+true
+
+StrictPooling tells the container what to do when the pool reaches it's
+maximum size and there are incoming requests that need instances.
+
+sweepInterval
+
+time
+
+5 minutes
+
+The frequency in which the container will sweep the pool and evict
+expired instances.
+
+== accessTimeout
+
+Specifies the time an invokation should wait for an instance of the pool
+to become available.
+
+After the timeout is reached, if an instance in the pool cannot be
+obtained, the method invocation will fail.
+
+Usable time units: nanoseconds, microsecons, milliseconds, seconds,
+minutes, hours, days. Or any combination such as "1 hour and 27 minutes
+and 10 seconds"
+
+Any usage of the `javax.ejb.AccessTimeout` annotation will override this
+setting for the bean or method where the annotation is used.
+
+== callbackThreads
+
+The number of threads for constructing and destroying beans.
+
+When sweeping the pool for expired instances a thread pool is used to
+process calling `@PreDestroy` on expired instances as well as creating
+new instances as might be required to fill the pool to the minimum after
+a Flush or `MaxAge` expiration. The `CallbackThreads` setting dictates
+the size of the thread pool and is shared by all beans deployed in the
+container.
+
+== closeTimeout
+
+Maximum time to wait for instances to be destroyed when shutting down
+the pool
+
+PostConstruct methods are invoked on all instances in the pool when the
+bean is undeployed and its pool is closed. The `CloseTimeout` specifies
+the maximum time to wait for the pool to close and `PostConstruct`
+methods to be invoked.
+
+Usable time units: nanoseconds, microsecons, milliseconds, seconds,
+minutes, hours, days. Or any combination such as
+`1 hour and 27 minutes and 10 seconds`
+
+== garbageCollection
+
+Allows Garbage Collection to be used as a mechanism for shrinking the
+pool.
+
+When set to true all instances in the pool, excluding the minimum, are
+eligible for garbage collection by the virtual machine as per the rules
+of `java.lang.ref.SoftReference` and can be claimed by the JVM to free
+memory. Instances garbage collected will have their `@PreDestroy`
+methods called during finalization.
+
+In the OpenJDK VM the `-XX:SoftRefLRUPolicyMSPerMB` flag can adjust how
+aggressively SoftReferences are collected. The default OpenJDK setting
+is 1000, resulting in inactive pooled instances living one second of
+lifetime per free megabyte in the heap, which is very aggressive. The
+setting should be increased to get the most out of the
+`GarbageCollection` feature of the pool. Much higher settings are safe.
+Even a setting as high as 3600000 (1 hour per free MB in the heap) does
+not affect the ability for the VM to garbage collect SoftReferences in
+the event that memory is needed to avoid an `OutOfMemoryException`.
+
+== idleTimeout
+
+Specifies the maximum time that an instance should be allowed to sit
+idly in the pool without use before it should be retired and removed.
+
+Only instances in surplus of the pool's `MinSize` are eligible to expire
+via `IdleTimeout` Instances that expire due to `IdleTimeout` will have
+their `@PreDestroy` methods invoked before being completely destroyed.
+
+Usable time units: nanoseconds, microsecons, milliseconds, seconds,
+minutes, hours, days. Or any combination such as "1 hour and 27 minutes
+and 10 seconds"
+
+== maxAge
+
+Specifies the maximum time that an instance should live before it should
+be retired and removed from use.
+
+This will happen gracefully. Useful for situations where bean instances
+are designed to hold potentially expensive resources such as memory or
+file handles and need to be periodically cleared out.
+
+Usable time units: nanoseconds, microsecons, milliseconds, seconds,
+minutes, hours, days. Or any combination such as
+`1 hour and 27 minutes and 10 seconds`
+
+== maxAgeOffset
+
+Applies to MaxAge usage and would rarely be changed, but is a nice
+feature to understand.
+
+When the container first starts and the pool is filled to the minimum
+size, all those "minimum" instances will have the same creation time and
+therefore all expire at the same time dictated by the `MaxAge` setting.
+To protect against this sudden drop scenario and provide a more gradual
+expiration from the start the container will spread out the age of the
+instances that fill the pool to the minimum using an offset.
+
+The `MaxAgeOffset` is not the final value of the offset, but rather it
+is used in creating the offset and allows the spreading to push the
+initial ages into the future or into the past. The pool is filled at
+startup as follows:
+
+....
+for (int i = 0; i < poolMin; i++) {
+ long ageOffset = (maxAge / poolMin * i * maxAgeOffset) % maxAge;
+ pool.add(new Bean(), ageOffset));
+}
+....
+
+The default `MaxAgeOffset` is -1 which causes the initial instances in
+the pool to live a bit longer before expiring. As a concrete example,
+let's say the MinSize is 4 and the MaxAge is 100 years. The generated
+offsets for the four instances created at startup would be 0, -25, -50,
+-75. So the first instance would be "born" at age 0, die at 100, living
+100 years. The second instance would be born at -25, die at 100, living
+a total of 125 years. The third would live 150 years. The fourth 175
+years.
+
+A `MaxAgeOffset` of 1 would cause instances to be "born" older and
+therefore die sooner. Using the same example `MinSize` of 4 and `MaxAge`
+of `100 years`, the life spans of these initial four instances would be
+100, 75, 50, and 25 years respectively.
+
+A `MaxAgeOffset` of 0 will cause no "spreading" of the age of the first
+instances used to fill the pool to the minimum and these instances will
+of course reach their MaxAge at the same time. It is possible to set to
+decimal values such as -0.5, 0.5, -1.2, or 1.2.
+
+== maxSize
+
+Specifies the size of the instance pool for this stateless SessionBean
+container.
+
+Each `@Stateless` bean will get its own instance pool. If StrictPooling
+is not used, instances will still be created beyond this number if there
+is demand, but they will not be returned to the pool and instead will be
+immediately expire.
+
+== minSize
+
+Specifies the minimum number of bean instances that should be in the
+pool for each bean.
+
+Pools are prefilled to the minimum on startup. Note this will create
+start order dependencies between other beans that also eagerly start,
+such as other `@Stateless` beans with a minimum or `@Singleton` beans
+using `@Startup`. The `@DependsOn` annotation can be used to
+appropriately influence start order.
+
+The minimum pool size is rigidly maintained. Instances in the minimum
+side of the pool are not eligible for `IdleTimeout` or
+`GarbageCollection`, but are subject to `MaxAge` and flushing.
+
+If the pool is flushed it is immediately refilled to the minimum size
+with `MaxAgeOffset` applied. If an instance from the minimum side of the
+pool reaches its `MaxAge`, it is also immediately replaced. Replacement
+is done in a background queue using the number of threads specified by
+`CallbackThreads`.
+
+== replaceAged
+
+When `ReplaceAged` is enabled, any instances in the pool that expire due
+to reaching their `MaxAge` will be replaced immediately so that the pool
+will remain at its current size.
+
+Replacement is done in a background queue so that incoming threads will
+not have to wait for instance creation.
+
+The aim of his option is to prevent user requests from paying the
+instance creation cost as `MaxAge` is enforced, potentially while under
+heavy load at peak hours.
+
+Instances from the minimum side of the pool are always replaced when
+they reach their `MaxAge`, this setting dictates the treatment of
+non-minimum instances.
+
+== replaceFlushed
+
+When `ReplaceFlushed` is enabled, any instances in the pool that are
+flushed will be replaced immediately so that the pool will remain at its
+current size.
+
+Replacement is done in a background queue so that incoming threads will
+not have to wait for instance creation.
+
+The aim of his option is to prevent user requests from paying the
+instance creation cost if a flush performed while under heavy load at
+peak hours.
+
+Instances from the minimum side of the pool are always replaced when
+they are flushed, this setting dictates the treatment of non-minimum
+instances.
+
+A bean may flush its pool by casting the `SessionContext` to `Flushable`
+and calling `flush()`. See `SweepInterval` for details on how flush is
+performed.
+
+....
+import javax.annotation.Resource;
+import javax.ejb.SessionContext;
+import javax.ejb.Stateless;
+import java.io.Flushable;
+import java.io.IOException;
+
+public class MyBean {
+
+ private SessionContext sessionContext;
+
+ public void flush() throws IOException {
+
+ ((Flushable) sessionContext).flush();
+ }
+}
+....
+
+== strictPooling
+
+StrictPooling tells the container what to do when the pool reaches it's
+maximum size and there are incoming requests that need instances.
+
+With strict pooling, requests will have to wait for instances to become
+available. The pool size will never grow beyond the the set `MaxSize`
+value. The maximum amount of time a request should wait is specified via
+the `AccessTimeout` setting.
+
+Without strict pooling, the container will create temporary instances to
+meet demand. The instances will last for just one method invocation and
+then are removed.
+
+Setting `StrictPooling` to `false` and `MaxSize` to `0` will result in
+no pooling. Instead instances will be created on demand and live for
+exactly one method call before being removed.
+
+== sweepInterval
+
+The frequency in which the container will sweep the pool and evict
+expired instances.
+
+Eviction is how the `IdleTimeout`, `MaxAge`, and pool "flush"
+functionality is enforced. Higher intervals are better.
+
+Instances in use are excluded from sweeping. Should an instance expire
+while in use it will be evicted immediately upon return to the pool.
+Effectively `MaxAge` and flushes will be enforced as a part of normal
+activity or sweeping, while IdleTimeout is only enforcable via sweeping.
+This makes aggressive sweeping less important for a pool under moderate
+load.
+
+Usable time units: nanoseconds, microsecons, milliseconds, seconds,
+minutes, hours, days. Or any combination such as
+`1 hour and 27 minutes and 10 seconds`
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/statelesscontainer-config.md
----------------------------------------------------------------------
diff --git a/docs/statelesscontainer-config.md b/docs/statelesscontainer-config.md
deleted file mode 100644
index b89627b..0000000
--- a/docs/statelesscontainer-config.md
+++ /dev/null
@@ -1,461 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=StatelessContainer Configuration
-~~~~~~
-
-
-A StatelessContainer can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Container id="myStatelessContainer" type="STATELESS">
- accessTimeout = 30 seconds
- callbackThreads = 5
- closeTimeout = 5 minutes
- garbageCollection = false
- idleTimeout = 0 minutes
- maxAge = 0 hours
- maxAgeOffset = -1
- maxSize = 10
- minSize = 0
- replaceAged = true
- replaceFlushed = false
- strictPooling = true
- sweepInterval = 5 minutes
- </Container>
-
-Alternatively, a StatelessContainer can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myStatelessContainer = new://Container?type=STATELESS
- myStatelessContainer.accessTimeout = 30 seconds
- myStatelessContainer.callbackThreads = 5
- myStatelessContainer.closeTimeout = 5 minutes
- myStatelessContainer.garbageCollection = false
- myStatelessContainer.idleTimeout = 0 minutes
- myStatelessContainer.maxAge = 0 hours
- myStatelessContainer.maxAgeOffset = -1
- myStatelessContainer.maxSize = 10
- myStatelessContainer.minSize = 0
- myStatelessContainer.replaceAged = true
- myStatelessContainer.replaceFlushed = false
- myStatelessContainer.strictPooling = true
- myStatelessContainer.sweepInterval = 5 minutes
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared StatelessContainer a warning will be logged. If a StatelessContainer is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple StatelessContainer declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td><a href="#accessTimeout">accessTimeout</a></td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>30 seconds</td>
- <td>
-Specifies the time an invokation should wait for an instance
-of the pool to become available.
-</td>
-</tr>
-<tr>
- <td><a href="#callbackThreads">callbackThreads</a></td>
- <td>int</td>
- <td>5</td>
- <td>
-The number of threads for constructing and destroying beans.
-</td>
-</tr>
-<tr>
- <td><a href="#closeTimeout">closeTimeout</a></td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>5 minutes</td>
- <td>
-Maximum time to wait for instances to be destroyed when shutting down the pool
-</td>
-</tr>
-<tr>
- <td><a href="#garbageCollection">garbageCollection</a></td>
- <td>boolean</td>
- <td>false</td>
- <td>
-Allows Garbage Collection to be used as a mechanism for shrinking
-the pool.
-</td>
-</tr>
-<tr>
- <td><a href="#idleTimeout">idleTimeout</a></td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>0 minutes</td>
- <td>
-Specifies the maximum time that an instance should be allowed to
-sit idly in the pool without use before it should be retired and
-removed.
-</td>
-</tr>
-<tr>
- <td><a href="#maxAge">maxAge</a></td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>0 hours</td>
- <td>
-Specifies the maximum time that an instance should live before
-it should be retired and removed from use.
-</td>
-</tr>
-<tr>
- <td><a href="#maxAgeOffset">maxAgeOffset</a></td>
- <td>int</td>
- <td>-1</td>
- <td>
-Applies to MaxAge usage and would rarely be changed, but is a
-nice feature to understand.
-</td>
-</tr>
-<tr>
- <td><a href="#maxSize">maxSize</a></td>
- <td>int</td>
- <td>10</td>
- <td>
-Specifies the size of the instance pool for this stateless
-SessionBean container.
-</td>
-</tr>
-<tr>
- <td><a href="#minSize">minSize</a></td>
- <td>int</td>
- <td>0</td>
- <td>
-Specifies the minimum number of bean instances that should be in
-the pool for each bean.
-</td>
-</tr>
-<tr>
- <td><a href="#replaceAged">replaceAged</a></td>
- <td>boolean</td>
- <td>true</td>
- <td>
-When `ReplaceAged` is enabled, any instances in the pool that
-expire due to reaching their `MaxAge` will be replaced immediately
-so that the pool will remain at its current size.
-</td>
-</tr>
-<tr>
- <td><a href="#replaceFlushed">replaceFlushed</a></td>
- <td>boolean</td>
- <td>false</td>
- <td>
-When `ReplaceFlushed` is enabled, any instances in the pool that
-are flushed will be replaced immediately so that the pool will
-remain at its current size.
-</td>
-</tr>
-<tr>
- <td><a href="#strictPooling">strictPooling</a></td>
- <td>boolean</td>
- <td>true</td>
- <td>
-StrictPooling tells the container what to do when the pool
-reaches it's maximum size and there are incoming requests that
-need instances.
-</td>
-</tr>
-<tr>
- <td><a href="#sweepInterval">sweepInterval</a></td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>5 minutes</td>
- <td>
-The frequency in which the container will sweep the pool and
-evict expired instances.
-</td>
-</tr>
-</table>
-
-
-
-<a name="accessTimeout"></a>
-## accessTimeout
-
-Specifies the time an invokation should wait for an instance
-of the pool to become available.
-
-After the timeout is reached, if an instance in the pool cannot
-be obtained, the method invocation will fail.
-
-Usable time units: nanoseconds, microsecons, milliseconds,
-seconds, minutes, hours, days. Or any combination such as
-"1 hour and 27 minutes and 10 seconds"
-
-Any usage of the `javax.ejb.AccessTimeout` annotation will
-override this setting for the bean or method where the
-annotation is used.
-
-
-<a name="callbackThreads"></a>
-## callbackThreads
-
-The number of threads for constructing and destroying beans.
-
-When sweeping the pool for expired instances a thread pool is
-used to process calling `@PreDestroy` on expired instances as well
-as creating new instances as might be required to fill the pool
-to the minimum after a Flush or `MaxAge` expiration. The
-`CallbackThreads` setting dictates the size of the thread pool and
-is shared by all beans deployed in the container.
-
-
-<a name="closeTimeout"></a>
-## closeTimeout
-
-Maximum time to wait for instances to be destroyed when shutting down the pool
-
-PostConstruct methods are invoked on all instances in the pool
-when the bean is undeployed and its pool is closed. The
-`CloseTimeout` specifies the maximum time to wait for the pool to
-close and `PostConstruct` methods to be invoked.
-
-Usable time units: nanoseconds, microsecons, milliseconds,
-seconds, minutes, hours, days. Or any combination such as
-`1 hour and 27 minutes and 10 seconds`
-
-
-<a name="garbageCollection"></a>
-## garbageCollection
-
-Allows Garbage Collection to be used as a mechanism for shrinking
-the pool.
-
-When set to true all instances in the pool, excluding
-the minimum, are eligible for garbage collection by the virtual
-machine as per the rules of `java.lang.ref.SoftReference` and can be
-claimed by the JVM to free memory. Instances garbage collected
-will have their `@PreDestroy` methods called during finalization.
-
-In the OpenJDK VM the `-XX:SoftRefLRUPolicyMSPerMB` flag can adjust
-how aggressively SoftReferences are collected. The default
-OpenJDK setting is 1000, resulting in inactive pooled instances
-living one second of lifetime per free megabyte in the heap, which
-is very aggressive. The setting should be increased to get the
-most out of the `GarbageCollection` feature of the pool. Much
-higher settings are safe. Even a setting as high as 3600000 (1
-hour per free MB in the heap) does not affect the ability for the
-VM to garbage collect SoftReferences in the event that memory is
-needed to avoid an `OutOfMemoryException`.
-
-
-<a name="idleTimeout"></a>
-## idleTimeout
-
-Specifies the maximum time that an instance should be allowed to
-sit idly in the pool without use before it should be retired and
-removed.
-
-Only instances
-in surplus of the pool's `MinSize` are eligible to expire via `IdleTimeout`
-Instances that expire due to `IdleTimeout` will have their `@PreDestroy`
-methods invoked before being completely destroyed.
-
-Usable time units: nanoseconds, microsecons, milliseconds,
-seconds, minutes, hours, days. Or any combination such as
-"1 hour and 27 minutes and 10 seconds"
-
-
-<a name="maxAge"></a>
-## maxAge
-
-Specifies the maximum time that an instance should live before
-it should be retired and removed from use.
-
-This will happen
-gracefully. Useful for situations where bean instances are
-designed to hold potentially expensive resources such as memory
-or file handles and need to be periodically cleared out.
-
-Usable time units: nanoseconds, microsecons, milliseconds,
-seconds, minutes, hours, days. Or any combination such as
-`1 hour and 27 minutes and 10 seconds`
-
-
-<a name="maxAgeOffset"></a>
-## maxAgeOffset
-
-Applies to MaxAge usage and would rarely be changed, but is a
-nice feature to understand.
-
-When the container first starts and the pool is filled to the
-minimum size, all those "minimum" instances will have the same
-creation time and therefore all expire at the same time dictated
-by the `MaxAge` setting. To protect against this sudden drop
-scenario and provide a more gradual expiration from the start
-the container will spread out the age of the instances that fill
-the pool to the minimum using an offset.
-
-The `MaxAgeOffset` is not the final value of the offset, but
-rather it is used in creating the offset and allows the
-spreading to push the initial ages into the future or into the
-past. The pool is filled at startup as follows:
-
- for (int i = 0; i < poolMin; i++) {
- long ageOffset = (maxAge / poolMin * i * maxAgeOffset) % maxAge;
- pool.add(new Bean(), ageOffset));
- }
-
-The default `MaxAgeOffset` is -1 which causes the initial
-instances in the pool to live a bit longer before expiring. As
-a concrete example, let's say the MinSize is 4 and the MaxAge is
-100 years. The generated offsets for the four instances created
-at startup would be 0, -25, -50, -75. So the first instance
-would be "born" at age 0, die at 100, living 100 years. The
-second instance would be born at -25, die at 100, living a total
-of 125 years. The third would live 150 years. The fourth 175
-years.
-
-A `MaxAgeOffset` of 1 would cause instances to be "born" older
-and therefore die sooner. Using the same example `MinSize` of 4
-and `MaxAge` of `100 years`, the life spans of these initial four
-instances would be 100, 75, 50, and 25 years respectively.
-
-A `MaxAgeOffset` of 0 will cause no "spreading" of the age of the
-first instances used to fill the pool to the minimum and these
-instances will of course reach their MaxAge at the same time.
-It is possible to set to decimal values such as -0.5, 0.5, -1.2,
-or 1.2.
-
-
-<a name="maxSize"></a>
-## maxSize
-
-Specifies the size of the instance pool for this stateless
-SessionBean container.
-
-Each `@Stateless` bean will get its own instance pool.
-If StrictPooling is not used, instances
-will still be created beyond this number if there is demand, but
-they will not be returned to the pool and instead will be
-immediately expire.
-
-
-<a name="minSize"></a>
-## minSize
-
-Specifies the minimum number of bean instances that should be in
-the pool for each bean.
-
-Pools are prefilled to the minimum on
-startup. Note this will create start order dependencies between
-other beans that also eagerly start, such as other `@Stateless`
-beans with a minimum or `@Singleton` beans using `@Startup`. The
-`@DependsOn` annotation can be used to appropriately influence
-start order.
-
-The minimum pool size is rigidly maintained. Instances in the
-minimum side of the pool are not eligible for `IdleTimeout` or
-`GarbageCollection`, but are subject to `MaxAge` and flushing.
-
-If the pool is flushed it is immediately refilled to the minimum
-size with `MaxAgeOffset` applied. If an instance from the minimum
-side of the pool reaches its `MaxAge`, it is also immediately
-replaced. Replacement is done in a background queue using the
-number of threads specified by `CallbackThreads`.
-
-
-<a name="replaceAged"></a>
-## replaceAged
-
-When `ReplaceAged` is enabled, any instances in the pool that
-expire due to reaching their `MaxAge` will be replaced immediately
-so that the pool will remain at its current size.
-
-Replacement
-is done in a background queue so that incoming threads will not
-have to wait for instance creation.
-
-The aim of his option is to prevent user requests from paying
-the instance creation cost as `MaxAge` is enforced, potentially
-while under heavy load at peak hours.
-
-Instances from the minimum side of the pool are always replaced
-when they reach their `MaxAge`, this setting dictates the
-treatment of non-minimum instances.
-
-
-<a name="replaceFlushed"></a>
-## replaceFlushed
-
-When `ReplaceFlushed` is enabled, any instances in the pool that
-are flushed will be replaced immediately so that the pool will
-remain at its current size.
-
-Replacement is done in a background
-queue so that incoming threads will not have to wait for
-instance creation.
-
-The aim of his option is to prevent user requests from paying
-the instance creation cost if a flush performed while under
-heavy load at peak hours.
-
-Instances from the minimum side of the pool are always replaced
-when they are flushed, this setting dictates the treatment of
-non-minimum instances.
-
-A bean may flush its pool by casting the `SessionContext` to
-`Flushable` and calling `flush()`. See `SweepInterval` for details on
-how flush is performed.
-
- import javax.annotation.Resource;
- import javax.ejb.SessionContext;
- import javax.ejb.Stateless;
- import java.io.Flushable;
- import java.io.IOException;
-
- public class MyBean {
-
- private SessionContext sessionContext;
-
- public void flush() throws IOException {
-
- ((Flushable) sessionContext).flush();
- }
- }
-
-
-<a name="strictPooling"></a>
-## strictPooling
-
-StrictPooling tells the container what to do when the pool
-reaches it's maximum size and there are incoming requests that
-need instances.
-
-With strict pooling, requests will have to wait for instances to
-become available. The pool size will never grow beyond the the
-set `MaxSize` value. The maximum amount of time a request should
-wait is specified via the `AccessTimeout` setting.
-
-Without strict pooling, the container will create temporary
-instances to meet demand. The instances will last for just one
-method invocation and then are removed.
-
-Setting `StrictPooling` to `false` and `MaxSize` to `0` will result in
-no pooling. Instead instances will be created on demand and live
-for exactly one method call before being removed.
-
-
-<a name="sweepInterval"></a>
-## sweepInterval
-
-The frequency in which the container will sweep the pool and
-evict expired instances.
-
-Eviction is how the `IdleTimeout`,
-`MaxAge`, and pool "flush" functionality is enforced. Higher
-intervals are better.
-
-Instances in use are excluded from sweeping. Should an instance
-expire while in use it will be evicted immediately upon return
-to the pool. Effectively `MaxAge` and flushes will be enforced as
-a part of normal activity or sweeping, while IdleTimeout is only
-enforcable via sweeping. This makes aggressive sweeping less
-important for a pool under moderate load.
-
-Usable time units: nanoseconds, microsecons, milliseconds,
-seconds, minutes, hours, days. Or any combination such as
-`1 hour and 27 minutes and 10 seconds`
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/system-properties-files.adoc
----------------------------------------------------------------------
diff --git a/docs/system-properties-files.adoc b/docs/system-properties-files.adoc
new file mode 100644
index 0000000..ec742bf
--- /dev/null
+++ b/docs/system-properties-files.adoc
@@ -0,0 +1,25 @@
+# System Properties Files
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+== OpenEJB System Properties File
+
+OpenEJB and TomEE are really configurable in particular through system
+properties.
+
+What is not so known is these system properties can be read from several
+places. The order is important, it means if the second place provides
+the same property than the first one, the first one will be omitted.
+
+Here how it works:
+
+* JVM system properties: -Dxxx=yyy
+* user system.properties: the file
+$\{user.home}/.openejb/system.properties
+* instance system.properties: conf/system.properties
+
+Note: generally you place in the user system properties file the contant
+configuration (check my openejb version for instance).
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/system-properties-files.md
----------------------------------------------------------------------
diff --git a/docs/system-properties-files.md b/docs/system-properties-files.md
deleted file mode 100644
index d6902da..0000000
--- a/docs/system-properties-files.md
+++ /dev/null
@@ -1,22 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=System Properties Files
-~~~~~~
-
-# OpenEJB System Properties File
-
-OpenEJB and TomEE are really configurable in particular through system properties.
-
-What is not so known is these system properties can be read from several places. The order is important,
-it means if the second place provides the same property than the first one, the first one will be
-omitted.
-
-Here how it works:
-
-* JVM system properties: -Dxxx=yyy
-* user system.properties: the file ${user.home}/.openejb/system.properties
-* instance system.properties: conf/system.properties
-
-Note: generally you place in the user system properties file the contant configuration (check my openejb
-version for instance).
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/system-properties.adoc
----------------------------------------------------------------------
diff --git a/docs/system-properties.adoc b/docs/system-properties.adoc
new file mode 100644
index 0000000..f61ea79
--- /dev/null
+++ b/docs/system-properties.adoc
@@ -0,0 +1,68 @@
+# System Properties
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+You can find a list of properties link:properties-listing.html[here].
+But read on to understand how these can be used.
+
+== Overriding openejb.xml
+
+Anything in the openejb.xml file can be overridden via system properties
+of the format:
+
+`-D<id>.<property-name>=<property-value>`
+
+..where id is the value in the config file for example:
+
+....
+<Connector id="mysql">
+ JdbcDriver com.mysql.jdbc.Driver
+ JdbcUrl jdbc:mysql://localhost/test
+ UserName test
+</Connector>
+....
+
+Could be overridden as follows via system properties on the command
+line:
+
+______________________________________________________________________________________________________________________________
+./bin/openejb start -Dmysql.JdbcDriver=com.mysql.jdbc.Driver
+-Dmysql.JdbcUrl=jdbc:mysql://localhost/test -Dmysql.UserName=test
+______________________________________________________________________________________________________________________________
+
+== Overriding Server Services
+
+Any server service installed into OpenEJB can be overridden in the same
+fashion as things in the openejb.xml file.
+
+For example, when OpenEJB starts it prints out the following:
+
+....
+ ** Starting Services **
+ NAME IP PORT
+ httpejbd 0.0.0.0 4204
+ telnet 0.0.0.0 4202
+ ejbd 0.0.0.0 4201
+ hsql 0.0.0.0 9001
+ activemq 127.0.0.1 4206
+ derbynet 0.0.0.0 4205
+ admin thread 0.0.0.0 4200
+....
+
+Each of those has the same standard xinet.d-like properties which can
+also be configured as such:
+
+`-D<id>.<property-name>=<property-value>`
+
+... where 'id' is the name of the server service and 'property-name' is
+one of the following: bind, port, threads, disabled, only_from.
+
+So to set the address and port the ejbd service will bind to, simply
+specify this on the command line:
+
+....
+./bin/openejb start -Dejbd.bind=192.168.1.12 -Dejbd.port=9988
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/system-properties.md
----------------------------------------------------------------------
diff --git a/docs/system-properties.md b/docs/system-properties.md
deleted file mode 100644
index 2c3714b..0000000
--- a/docs/system-properties.md
+++ /dev/null
@@ -1,68 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=System Properties
-~~~~~~
-
-<a name="SystemProperties-Overridingopenejb.xml"></a>
-
-You can find a list of properties [here](properties-listing.html). But read on to understand how these can be used.
-
-# Overriding openejb.xml
-
-Anything in the openejb.xml file can be overridden via system properties of
-the format:
-
-
- `-D<id>.<property-name>=<property-value>`
-
-..where id is the value in the config file for example:
-
-
- <Connector id="mysql">
- JdbcDriver com.mysql.jdbc.Driver
- JdbcUrl jdbc:mysql://localhost/test
- UserName test
- </Connector>
-
-
-Could be overridden as follows via system properties on the command line:
-
-> ./bin/openejb start -Dmysql.JdbcDriver=com.mysql.jdbc.Driver
-> -Dmysql.JdbcUrl=jdbc:mysql://localhost/test -Dmysql.UserName=test
-
-<a name="SystemProperties-OverridingServerServices"></a>
-
-# Overriding Server Services
-
-Any server service installed into OpenEJB can be overridden in the same
-fashion as things in the openejb.xml file.
-
-For example, when OpenEJB starts it prints out the following:
-
-
- ** Starting Services **
- NAME IP PORT
- httpejbd 0.0.0.0 4204
- telnet 0.0.0.0 4202
- ejbd 0.0.0.0 4201
- hsql 0.0.0.0 9001
- activemq 127.0.0.1 4206
- derbynet 0.0.0.0 4205
- admin thread 0.0.0.0 4200
-
-
-Each of those has the same standard xinet.d-like properties which can also
-be configured as such:
-
-
- `-D<id>.<property-name>=<property-value>`
-
-
-... where 'id' is the name of the server service and 'property-name' is one
-of the following: bind, port, threads, disabled, only_from.
-
-So to set the address and port the ejbd service will bind to, simply
-specify this on the command line:
-
- ./bin/openejb start -Dejbd.bind=192.168.1.12 -Dejbd.port=9988
[24/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 10
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 10
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/de7099c5
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/de7099c5
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/de7099c5
Branch: refs/heads/master
Commit: de7099c54f139c45c373b593638e677594c6dd70
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:26 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:07:26 2018 -0800
----------------------------------------------------------------------
docs/spring-and-openejb-3.0.adoc | 224 +++++++++++++++
docs/spring-and-openejb-3.0.md | 190 -------------
docs/spring-ejb-and-jpa.adoc | 195 +++++++++++++
docs/spring-ejb-and-jpa.md | 173 ------------
docs/spring.adoc | 139 ++++++++++
docs/spring.md | 124 ---------
docs/ssh.adoc | 63 +++++
docs/ssh.md | 51 ----
docs/standalone-server.adoc | 24 ++
docs/standalone-server.md | 27 --
docs/startup.adoc | 267 ++++++++++++++++++
docs/startup.md | 296 --------------------
docs/statefulcontainer-config.adoc | 165 +++++++++++
docs/statefulcontainer-config.md | 160 -----------
docs/statelesscontainer-config.adoc | 441 +++++++++++++++++++++++++++++
docs/statelesscontainer-config.md | 461 -------------------------------
docs/system-properties-files.adoc | 25 ++
docs/system-properties-files.md | 22 --
docs/system-properties.adoc | 68 +++++
docs/system-properties.md | 68 -----
20 files changed, 1611 insertions(+), 1572 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/spring-and-openejb-3.0.adoc
----------------------------------------------------------------------
diff --git a/docs/spring-and-openejb-3.0.adoc b/docs/spring-and-openejb-3.0.adoc
new file mode 100644
index 0000000..ea2c24c
--- /dev/null
+++ b/docs/spring-and-openejb-3.0.adoc
@@ -0,0 +1,224 @@
+:jbake-title: Spring and OpenEJB 3.0
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+\{note}OpenEJB 3.1 and later users should refer to the [Spring]
+page.\{note} # Bootstrapping OpenEJB in Spring
+
+If you wish to use OpenEJB inside Spring you can do so pretty easily.
+Include OpenEJB and its dependencies in your classpath as you would in a
+plain embedded scenario then add a custom factory like the following:
+
+....
+public class OpenEjbFactoryBean implements org.springframework.beans.factory.FactoryBean {
+
+ private Properties properties = new Properties();
+
+ public OpenEjbFactoryBean() {
+ properties.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.LocalInitialContextFactory");
+ }
+
+ public Properties getJndiEnvironment() {
+ return properties;
+ }
+
+ public void setJndiEnvironment(Properties properties) {
+ this.properties.putAll(properties);
+ }
+
+ public Object getObject() {
+ try {
+ return new InitialContext(properties);
+ } catch (NamingException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ public Class getObjectType(){
+ return Context.class;
+ }
+
+ boolean isSingleton() {
+ return true;
+ }
+}
+....
+
+And include that at the top of your spring xml file as follows:
+
+....
+<bean id="OpenEjbContext" class="org.acme.OpenEjbFactoryBean">
+ <property name="jndiEnvironment">
+ <props>
+ <prop key="myDs">new://Resource?type=DataSource</prop>
+ <prop key="myDs.JdbcDriver">com.mysql.jdbc.Driver</prop>
+ <prop key="myDs.JdbcUrl">jdbc:mysql://localhost/midastest?createDatabaseIfNotExist=true</prop>
+ <prop key="myDs.UserName">root</prop>
+ <prop key="myDs.Password"></prop>
+ </props>
+ </property>
+</bean>
+....
+
+The value of is meant to be illustrative of the kinds of properties you
+can pass into OpenEJB. It's possible to create any number of
+datasources, topics, queues, containers and more this way.
+
+Just as with Unit Testing, OpenEJB will find and automatically deploy
+all the EJB beans it [finds in the classpath|Application discovery via
+the classpath]. You can then expose any of these things to other Spring
+components with custom factory beans.
+
+== Injecting OpenEJB-created resources into Spring components
+
+If you want to have any of the Topics, Queues, DataSources,
+EntityManagers or more that OpenEJB creates injected into components
+that Spring creates, here's one technique....
+
+Let's say you have a persistence unit called "_OrangeUnit_" declared in
+a persistence.xml file. One way to get the related _EntityManager_
+created by OpenEJB is to do as follows. Create an @Stateless bean with
+an @PersistenceContext ref in it, then use a factory bean to look it up,
+pull the EntityManager out and return it
+
+OrangeUnitBean.java
+
+....
+/*
+ * OpenEJB will automatically find this bean. Just put it in the same jar
+ * that your META-INF/persistence.xml file is located in and make sure that
+ * that same jar file also has a META-INF/ejb-jar.xml file. The ejb-jar.xml
+ * need only contain the text "<ejb-jar/>" at minimum.
+ */
+@Stateless
+public class OrangeUnitBean implements OrangeUnitLocal {
+
+ @PersistenceContext(unitName="OrangeUnit")
+ private EntityManager entityManager;
+
+ public EntityManager getEntityManager() {
+ return entityManager;
+ }
+}
+....
+
+OrangeUnitLocal.java
+
+....
+/**
+ * The local interface for the OrangeUnitBean
+ */
+public interface OrangeUnitLocal {
+ public EntityManager getEntityManager();
+}
+....
+
+OrangeUnitFactoryBean.java
+
+....
+/**
+ * This factory bean will lookup the OrangeUnitBean using the javax.naming.Context
+ * that is created via the OpenEjbFactoryBean above. It will simply grab the EntityManager
+ * from that bean and hand it over to Spring. Anyone in Spring-land can then easily get
+ * a reference to the EntityManager by simply referencing this factory bean.
+ */
+public class OrangeUnitFactoryBean implements org.springframework.beans.factory.FactoryBean {
+ private Context context;
+
+ public Context getContext() {
+ return context;
+ }
+
+ public void setContext(Context context) {
+ this.context = context;
+ }
+
+ public Object getObject() {
+ try {
+ ResourceLocal bean = (ResourceLocal) context.lookup("OrangeUnitBeanLocal");
+ return bean.getEntityManager();
+ } catch (NamingException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ public Class getObjectType(){
+ return EntityManager.class;
+ }
+
+ boolean isSingleton() {
+ return true;
+ }
+}
+....
+
+The factory bean would then be declared in your spring xml file as
+follows:
+
+....
+<bean id="OrangeUnit" class="org.acme.OrangeUnitFactoryBean">
+ <property name="context" ref="OpenEjbContext">
+</bean>
+....
+
+The EntityManager can then easily be consumed by a spring bean.
+
+....
+public class SomePojo {
+
+ private EntityManager entityManager;
+
+ public void setEntityManager(EntityManager entityManager) {
+ this.entityManager = entityManager;
+ }
+
+ ...
+}
+....
+
+In the spring xml
+
+....
+<bean id="SomePojo" class="org.acme.SomePojo">
+ <property name="entityManager" ref="OrangeUnit">
+</bean>
+....
+
+Here's what all three declarations would look like together in your
+spring xml:
+
+Spring bean definitions combined
+
+....
+<bean id="OpenEjbContext" class="org.acme.OpenEjbFactoryBean">
+ <property name="jndiEnvironment">
+ <props>
+ <prop key="myDs">new://Resource?type=DataSource</prop>
+ <prop key="myDs.JdbcDriver">com.mysql.jdbc.Driver</prop>
+ <prop key="myDs.JdbcUrl">jdbc:mysql://localhost/midastest?createDatabaseIfNotExist=true</prop>
+ <prop key="myDs.UserName">root</prop>
+ <prop key="myDs.Password"></prop>
+ </props>
+ </property>
+</bean>
+
+<bean id="OrangeUnit" class="org.acme.OrangeUnitFactoryBean">
+ <property name="context" ref="OpenEjbContext">
+</bean>
+
+<bean id="SomePojo" class="org.acme.SomePojo">
+ <property name="entityManager" ref="OrangeUnit">
+</bean>
+....
+
+:jbake-title: Some more useful info.} Here is a bunch of links suggested
+by a user. If anybody has time to go through them and write a doc, that
+would be great. These links explain how to make available spring
+components to openejb
+http://twasink.net/blog/archives/2007/01/using_spring_wi.html
+http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/ejb/interceptor/SpringBeanAutowiringInterceptor.html
+http://wiki.netbeans.org/MavenSpringEJBsOnGlassfish
+
+\{info}
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/spring-and-openejb-3.0.md
----------------------------------------------------------------------
diff --git a/docs/spring-and-openejb-3.0.md b/docs/spring-and-openejb-3.0.md
deleted file mode 100644
index 7ac4cce..0000000
--- a/docs/spring-and-openejb-3.0.md
+++ /dev/null
@@ -1,190 +0,0 @@
-title=Spring and OpenEJB 3.0
-type=page
-status=published
-~~~~~~
-
-{note}OpenEJB 3.1 and later users should refer to the [Spring] page.{note}
-# Bootstrapping OpenEJB in Spring
-
-If you wish to use OpenEJB inside Spring you can do so pretty easily. Include OpenEJB and its dependencies in your classpath as you would in a plain embedded scenario then add a custom factory like the following:
-
- public class OpenEjbFactoryBean implements org.springframework.beans.factory.FactoryBean {
-
- private Properties properties = new Properties();
-
- public OpenEjbFactoryBean() {
- properties.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.LocalInitialContextFactory");
- }
-
- public Properties getJndiEnvironment() {
- return properties;
- }
-
- public void setJndiEnvironment(Properties properties) {
- this.properties.putAll(properties);
- }
-
- public Object getObject() {
- try {
- return new InitialContext(properties);
- } catch (NamingException e) {
- throw new RuntimeException(e);
- }
- }
-
- public Class getObjectType(){
- return Context.class;
- }
-
- boolean isSingleton() {
- return true;
- }
- }
-
-And include that at the top of your spring xml file as follows:
-
- <bean id="OpenEjbContext" class="org.acme.OpenEjbFactoryBean">
- <property name="jndiEnvironment">
- <props>
- <prop key="myDs">new://Resource?type=DataSource</prop>
- <prop key="myDs.JdbcDriver">com.mysql.jdbc.Driver</prop>
- <prop key="myDs.JdbcUrl">jdbc:mysql://localhost/midastest?createDatabaseIfNotExist=true</prop>
- <prop key="myDs.UserName">root</prop>
- <prop key="myDs.Password"></prop>
- </props>
- </property>
- </bean>
-
-The value of <props> is meant to be illustrative of the kinds of properties you can pass into OpenEJB. It's possible to create any number of datasources, topics, queues, containers and more this way.
-
-Just as with Unit Testing, OpenEJB will find and automatically deploy all the EJB beans it [finds in the classpath|Application discovery via the classpath]. You can then expose any of these things to other Spring components with custom factory beans.
-
-# Injecting OpenEJB-created resources into Spring components
-
-If you want to have any of the Topics, Queues, DataSources, EntityManagers or more that OpenEJB creates injected into components that Spring creates, here's one technique....
-
-Let's say you have a persistence unit called "*OrangeUnit*" declared in a persistence.xml file. One way to get the related *EntityManager* created by OpenEJB is to do as follows. Create an @Stateless bean with an @PersistenceContext ref in it, then use a factory bean to look it up, pull the EntityManager out and return it
-
-OrangeUnitBean.java
-
- /*
- * OpenEJB will automatically find this bean. Just put it in the same jar
- * that your META-INF/persistence.xml file is located in and make sure that
- * that same jar file also has a META-INF/ejb-jar.xml file. The ejb-jar.xml
- * need only contain the text "<ejb-jar/>" at minimum.
- */
- @Stateless
- public class OrangeUnitBean implements OrangeUnitLocal {
-
- @PersistenceContext(unitName="OrangeUnit")
- private EntityManager entityManager;
-
- public EntityManager getEntityManager() {
- return entityManager;
- }
- }
-
-OrangeUnitLocal.java
-
- /**
- * The local interface for the OrangeUnitBean
- */
- public interface OrangeUnitLocal {
- public EntityManager getEntityManager();
- }
-
-OrangeUnitFactoryBean.java
-
- /**
- * This factory bean will lookup the OrangeUnitBean using the javax.naming.Context
- * that is created via the OpenEjbFactoryBean above. It will simply grab the EntityManager
- * from that bean and hand it over to Spring. Anyone in Spring-land can then easily get
- * a reference to the EntityManager by simply referencing this factory bean.
- */
- public class OrangeUnitFactoryBean implements org.springframework.beans.factory.FactoryBean {
- private Context context;
-
- public Context getContext() {
- return context;
- }
-
- public void setContext(Context context) {
- this.context = context;
- }
-
- public Object getObject() {
- try {
- ResourceLocal bean = (ResourceLocal) context.lookup("OrangeUnitBeanLocal");
- return bean.getEntityManager();
- } catch (NamingException e) {
- throw new RuntimeException(e);
- }
- }
-
- public Class getObjectType(){
- return EntityManager.class;
- }
-
- boolean isSingleton() {
- return true;
- }
- }
-
-The factory bean would then be declared in your spring xml file as follows:
-
-
- <bean id="OrangeUnit" class="org.acme.OrangeUnitFactoryBean">
- <property name="context" ref="OpenEjbContext">
- </bean>
-
-The EntityManager can then easily be consumed by a spring bean.
-
- public class SomePojo {
-
- private EntityManager entityManager;
-
- public void setEntityManager(EntityManager entityManager) {
- this.entityManager = entityManager;
- }
-
- ...
- }
-
-In the spring xml
-
- <bean id="SomePojo" class="org.acme.SomePojo">
- <property name="entityManager" ref="OrangeUnit">
- </bean>
-
-Here's what all three declarations would look like together in your spring xml:
-
-Spring bean definitions combined
-
- <bean id="OpenEjbContext" class="org.acme.OpenEjbFactoryBean">
- <property name="jndiEnvironment">
- <props>
- <prop key="myDs">new://Resource?type=DataSource</prop>
- <prop key="myDs.JdbcDriver">com.mysql.jdbc.Driver</prop>
- <prop key="myDs.JdbcUrl">jdbc:mysql://localhost/midastest?createDatabaseIfNotExist=true</prop>
- <prop key="myDs.UserName">root</prop>
- <prop key="myDs.Password"></prop>
- </props>
- </property>
- </bean>
-
- <bean id="OrangeUnit" class="org.acme.OrangeUnitFactoryBean">
- <property name="context" ref="OpenEjbContext">
- </bean>
-
- <bean id="SomePojo" class="org.acme.SomePojo">
- <property name="entityManager" ref="OrangeUnit">
- </bean>
-
-{info:title=Some more useful info.}
-Here is a bunch of links suggested by a user. If anybody has time to go through them and write a doc, that would be great. These links explain how to make available spring components to openejb
-http://twasink.net/blog/archives/2007/01/using_spring_wi.html
-http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/ejb/interceptor/SpringBeanAutowiringInterceptor.html
-http://wiki.netbeans.org/MavenSpringEJBsOnGlassfish
-
-{info}
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/spring-ejb-and-jpa.adoc
----------------------------------------------------------------------
diff --git a/docs/spring-ejb-and-jpa.adoc b/docs/spring-ejb-and-jpa.adoc
new file mode 100644
index 0000000..416fa4e
--- /dev/null
+++ b/docs/spring-ejb-and-jpa.adoc
@@ -0,0 +1,195 @@
+# Spring EJB and JPA
+:index-group: Spring
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+\{note}OpenEJB 3.1 or later required\{note} This example shows
+how to combine Spring, OpenEJB and Hibernate using the integration code
+provided by OpenEJB. Here, OpenEJB is used as an embeddable EJB
+container inside of Spring. See the link:spring.html[Spring] page for
+details.
+
+We use the basic Movie example and expand it to include more objects to
+demonstrate both Spring beans, EJB Session beans, and JPA persistent
+objects in one application. The premise of the example is a Cineplex
+that has a number of Theaters (viewing screens), each playing a number
+of Movies. The basic object layout is as follows:
+
+Object
+
+Type
+
+Description
+
+http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/CineplexImpl.java[CineplexImpl]
+
+@Stateless
+
+Shows the use of @Resource to have Spring beans injected. Specifically,
+the _Theaters_ Spring bean
+
+http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/Theaters.java[Theaters]
+
+Spring bean
+
+Simple wrapper object injected into _CineplexImpl_
+
+http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/Theater.java[Theater]
+
+Spring bean
+
+Shows that EJBs can be injected into Spring beans. Uses both the
+_Movies_ EJB and the _Movie_ JPA objects
+
+http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/MoviesImpl.java[MoviesImpl]
+
+@Stateful
+
+Wraps a JPA EntityManager and provides transactional access to the
+persistent _Movie_ objects
+
+http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/Movie.java[Movie]
+
+@Entity
+
+Basic JPA bean that is used both by Spring beans and EJBs. The same
+_Movie_ object as in all the other persistence related examples.
+
+http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/AvailableMovies.java[AvailableMovies]
+
+Spring bean
+
+Simple object used as a clever way to seed the EntityManager (and
+really, the database) with persistent _Movie_ objects
+
+# Required jars
+
+To setup the integration you'll need:
+
+[arabic]
+. The standard OpenEJB 3.1 libraries
+. The
+https://repository.apache.org/content/groups/public/org/apache/openejb/openejb-spring/3.1.2/openejb-spring-3.1.2.jar[openejb-spring-3.1.jar]
+or later
+. Spring 2.5 or other (any version should work)
+
+In Maven2 this can be done by adding the following dependencies to your
+pom.xml
+\{snippet:id=required|url=openejb3/examples/spring-integration/pom.xml|lang=xml}
+For other environments, you can simply link:downloads.html[download an
+openejb-3.1.zip] or later and include all the jars under the lib/
+directory in your classpath. Then download and add the
+[openejb-spring-3.1.jar|http://people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/openejb/openejb-spring/3.1/openejb-spring-3.1.jar]
+along with your Spring jars.
+
+# The Spring xml
+
+Bootstrapping and Configuring OpenEJB is fairly simple.
+\{snippet:id=bootstrapping|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
+As well, you can optionally declare any resources or containers.
+Anything declarable as a or in the openejb.xml can instead be declared
+in the Spring xml file as shown here.
+\{snippet:id=resources|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
+And finally our Spring beans.
+\{snippet:id=pojos|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
+:jbake-title: Don't forget}
+\{snippet:id=annotations|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
+It allows various annotations to be detected in bean classes: Spring's
+@Required and @Autowired, as well as JSR 250's @PostConstruct,
+@PreDestroy and @Resource (if available), JAX-WS's @WebServiceRef (if
+available), EJB3's @EJB (if available), and JPA's @PersistenceContext
+and @PersistenceUnit (if available). Alternatively, you may choose to
+activate the individual BeanPostProcessors for those annotations.
+\{note}
+
+# The Code
+
+In efforts to keep the example page somewhat short, we'll show just
+three beans, each demonstrating a particular relationship.
+
+The first is the CineplexImpl EJB which shows EJB -> Spring.
+\{snippet:id=code|url=openejb3/examples/spring-integration/src/main/java/org/superbiz/spring/CineplexImpl.java|lang=java}
+
+The second is the Theater Spring bean which shows Spring -> EJB.
+\{snippet:id=code|url=openejb3/examples/spring-integration/src/main/java/org/superbiz/spring/Theater.java|lang=java}
+
+The last is the AvailableMovies Spring bean which Shows Spring -> EJB ->
+JPA
+\{snippet:id=code|url=openejb3/examples/spring-integration/src/main/java/org/superbiz/spring/AvailableMovies.java|lang=java}
+
+# The TestCase
+
+The JUnit TestCase uses a ClassPathXmlApplicationContext to load the
+Spring ApplicationContext. Anything that loads your Spring xml file
+should work fine. The following code would work a plain java app as
+well.
+
+\{snippet:id=code|url=openejb3/examples/spring-integration/src/test/java/org/superbiz/spring/MoviesTest.java|lang=java}
+
+# Running
+
+The source for this example can be downloaded from svn via:
+
+$ svn co
+http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration
+
+Then, in the "spring-integration" directory, run:
+
+$ mvn clean install
+
+Which should create output like the following.
+
+....
+-------------------------------------------------------
+ T E S T S
+-------------------------------------------------------
+Running org.superbiz.spring.MoviesTest
+log4j:WARN No appenders could be found for logger
+....
+
+(org.springframework.context.support.ClassPathXmlApplicationContext).
+log4j:WARN Please initialize the log4j system properly. Apache OpenEJB
+3.1 build: 20081009-03:31 http://tomee.apache.org/ INFO - openejb.home =
+/Users/dblevins/work/openejb3/examples/spring-integration INFO -
+openejb.base = /Users/dblevins/work/openejb3/examples/spring-integration
+INFO - Configuring Service(id=Default JDK 1.3 ProxyFactory,
+type=ProxyFactory, provider-id=Default JDK 1.3 ProxyFactory) INFO -
+Configuring Service(id=MovieDatabase, type=Resource, provider-id=Default
+JDBC Database) INFO - Configuring Service(id=MovieDatabaseUnmanaged,
+type=Resource, provider-id=Default JDBC Database) INFO - Found EjbModule
+in classpath:
+/Users/dblevins/work/openejb3/examples/spring-integration/target/classes
+INFO - Beginning load:
+/Users/dblevins/work/openejb3/examples/spring-integration/target/classes
+INFO - Configuring enterprise application: classpath.ear INFO -
+Configuring Service(id=Default Stateless Container, type=Container,
+provider-id=Default Stateless Container) INFO - Auto-creating a
+container for bean CineplexImpl: Container(type=STATELESS, id=Default
+Stateless Container) INFO - Auto-linking resource-ref
+'org.superbiz.spring.CineplexImpl/theaters' in bean CineplexImpl to
+Resource(id=theaters) INFO - Configuring Service(id=Default Stateful
+Container, type=Container, provider-id=Default Stateful Container) INFO
+- Auto-creating a container for bean Movies: Container(type=STATEFUL,
+id=Default Stateful Container) INFO - Configuring
+PersistenceUnit(name=movie-unit,
+provider=org.hibernate.ejb.HibernatePersistence) INFO - Enterprise
+application "classpath.ear" loaded. INFO - Assembling app: classpath.ear
+INFO - PersistenceUnit(name=movie-unit,
+provider=org.hibernate.ejb.HibernatePersistence) INFO -
+Jndi(name=CineplexImplLocal) --> Ejb(deployment-id=CineplexImpl) INFO -
+Jndi(name=MoviesLocal) --> Ejb(deployment-id=Movies) INFO - Created
+Ejb(deployment-id=Movies, ejb-name=Movies, container=Default Stateful
+Container) INFO - Created Ejb(deployment-id=CineplexImpl,
+ejb-name=CineplexImpl, container=Default Stateless Container) INFO -
+Deployed Application(path=classpath.ear) INFO - Exported EJB Movies with
+interface org.superbiz.spring.Movies to Spring bean MoviesLocal INFO -
+Exported EJB CineplexImpl with interface org.superbiz.spring.Cineplex to
+Spring bean CineplexImplLocal Tests run: 1, Failures: 0, Errors: 0,
+Skipped: 0, Time elapsed: 3.141 sec
+
+....
+Results :
+
+Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/spring-ejb-and-jpa.md
----------------------------------------------------------------------
diff --git a/docs/spring-ejb-and-jpa.md b/docs/spring-ejb-and-jpa.md
deleted file mode 100644
index 8b1512b..0000000
--- a/docs/spring-ejb-and-jpa.md
+++ /dev/null
@@ -1,173 +0,0 @@
-index-group=Spring
-type=page
-status=published
-title=Spring EJB and JPA
-~~~~~~
-{note}OpenEJB 3.1 or later required{note}
-This example shows how to combine Spring, OpenEJB and Hibernate using the
-integration code provided by OpenEJB. Here, OpenEJB is used as an
-embeddable EJB container inside of Spring. See the [Spring](spring.html)
- page for details.
-
-We use the basic Movie example and expand it to include more objects to
-demonstrate both Spring beans, EJB Session beans, and JPA persistent
-objects in one application. The premise of the example is a Cineplex that
-has a number of Theaters (viewing screens), each playing a number of
-Movies. The basic object layout is as follows:
-
-<table class="mdtable">
-<tr><th> Object </th><th> Type </th><th> Description </th></tr>
-<tr><td> [CineplexImpl](http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/CineplexImpl.java)
- </td><td> @Stateless </td><td> Shows the use of @Resource to have Spring beans injected.
-Specifically, the _Theaters_ Spring bean </td></tr>
-<tr><td> [Theaters](http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/Theaters.java)
- </td><td> Spring bean </td><td> Simple wrapper object injected into _CineplexImpl_ </td></tr>
-<tr><td> [Theater](http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/Theater.java)
- </td><td> Spring bean </td><td> Shows that EJBs can be injected into Spring beans. Uses
-both the _Movies_ EJB and the _Movie_ JPA objects </td></tr>
-<tr><td> [MoviesImpl](http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/MoviesImpl.java)
- </td><td> @Stateful </td><td> Wraps a JPA EntityManager and provides transactional access
-to the persistent _Movie_ objects </td></tr>
-<tr><td> [Movie](http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/Movie.java)
- </td><td> @Entity </td><td> Basic JPA bean that is used both by Spring beans and EJBs.
-The same _Movie_ object as in all the other persistence related examples. </td></tr>
-<tr><td> [AvailableMovies](http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration/src/main/java/org/superbiz/spring/AvailableMovies.java)
- </td><td> Spring bean </td><td> Simple object used as a clever way to seed the
-EntityManager (and really, the database) with persistent _Movie_ objects </td></tr>
-</table>
-
-<a name="SpringEJBandJPA-Requiredjars"></a>
-# Required jars
-
-To setup the integration you'll need:
-
-1. The standard OpenEJB 3.1 libraries
-1. The [openejb-spring-3.1.jar](https://repository.apache.org/content/groups/public/org/apache/openejb/openejb-spring/3.1.2/openejb-spring-3.1.2.jar)
- or later
-1. Spring 2.5 or other (any version should work)
-
-In Maven2 this can be done by adding the following dependencies to your
-pom.xml
-{snippet:id=required|url=openejb3/examples/spring-integration/pom.xml|lang=xml}
-For other environments, you can simply [download an openejb-3.1.zip](downloads.html)
- or later and include all the jars under the lib/ directory in your
-classpath. Then download and add the [openejb-spring-3.1.jar|http://people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/openejb/openejb-spring/3.1/openejb-spring-3.1.jar]
- along with your Spring jars.
-
-<a name="SpringEJBandJPA-TheSpringxml"></a>
-# The Spring xml
-
-Bootstrapping and Configuring OpenEJB is fairly simple.
-{snippet:id=bootstrapping|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
-As well, you can optionally declare any resources or containers. Anything
-declarable as a <Resource> or <Container> in the openejb.xml can instead be
-declared in the Spring xml file as shown here.
-{snippet:id=resources|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
-And finally our Spring beans.
-{snippet:id=pojos|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
-{note:title=Don't forget}
-{snippet:id=annotations|url=openejb3/examples/spring-integration/src/main/resources/movies.xml|lang=xml}
-It allows various annotations to be detected in bean classes: Spring's
-@Required and @Autowired, as well as JSR 250's @PostConstruct, @PreDestroy
-and @Resource (if available), JAX-WS's @WebServiceRef (if available),
-EJB3's @EJB (if available), and JPA's @PersistenceContext and
-@PersistenceUnit (if available). Alternatively, you may choose to activate
-the individual BeanPostProcessors for those annotations.
-{note}
-
-<a name="SpringEJBandJPA-TheCode"></a>
-# The Code
-
-In efforts to keep the example page somewhat short, we'll show just three
-beans, each demonstrating a particular relationship.
-
-The first is the CineplexImpl EJB which shows EJB \-> Spring.
-{snippet:id=code|url=openejb3/examples/spring-integration/src/main/java/org/superbiz/spring/CineplexImpl.java|lang=java}
-
-The second is the Theater Spring bean which shows Spring \-> EJB.
-{snippet:id=code|url=openejb3/examples/spring-integration/src/main/java/org/superbiz/spring/Theater.java|lang=java}
-
-The last is the AvailableMovies Spring bean which Shows Spring \-> EJB \->
-JPA
-{snippet:id=code|url=openejb3/examples/spring-integration/src/main/java/org/superbiz/spring/AvailableMovies.java|lang=java}
-
-<a name="SpringEJBandJPA-TheTestCase"></a>
-# The TestCase
-
-The JUnit TestCase uses a ClassPathXmlApplicationContext to load the Spring
-ApplicationContext. Anything that loads your Spring xml file should work
-fine. The following code would work a plain java app as well.
-
-{snippet:id=code|url=openejb3/examples/spring-integration/src/test/java/org/superbiz/spring/MoviesTest.java|lang=java}
-
-<a name="SpringEJBandJPA-Running"></a>
-# Running
-
-The source for this example can be downloaded from svn via:
-
-$ svn co [http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration](http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/spring-integration)
-
-Then, in the "spring-integration" directory, run:
-
-$ mvn clean install
-
-Which should create output like the following.
-
-
- -------------------------------------------------------
- T E S T S
- -------------------------------------------------------
- Running org.superbiz.spring.MoviesTest
- log4j:WARN No appenders could be found for logger
-(org.springframework.context.support.ClassPathXmlApplicationContext).
- log4j:WARN Please initialize the log4j system properly.
- Apache OpenEJB 3.1 build: 20081009-03:31
- http://tomee.apache.org/
- INFO - openejb.home =
-/Users/dblevins/work/openejb3/examples/spring-integration
- INFO - openejb.base =
-/Users/dblevins/work/openejb3/examples/spring-integration
- INFO - Configuring Service(id=Default JDK 1.3 ProxyFactory,
-type=ProxyFactory, provider-id=Default JDK 1.3 ProxyFactory)
- INFO - Configuring Service(id=MovieDatabase, type=Resource,
-provider-id=Default JDBC Database)
- INFO - Configuring Service(id=MovieDatabaseUnmanaged, type=Resource,
-provider-id=Default JDBC Database)
- INFO - Found EjbModule in classpath:
-/Users/dblevins/work/openejb3/examples/spring-integration/target/classes
- INFO - Beginning load:
-/Users/dblevins/work/openejb3/examples/spring-integration/target/classes
- INFO - Configuring enterprise application: classpath.ear
- INFO - Configuring Service(id=Default Stateless Container, type=Container,
-provider-id=Default Stateless Container)
- INFO - Auto-creating a container for bean CineplexImpl:
-Container(type=STATELESS, id=Default Stateless Container)
- INFO - Auto-linking resource-ref
-'org.superbiz.spring.CineplexImpl/theaters' in bean CineplexImpl to
-Resource(id=theaters)
- INFO - Configuring Service(id=Default Stateful Container, type=Container,
-provider-id=Default Stateful Container)
- INFO - Auto-creating a container for bean Movies: Container(type=STATEFUL,
-id=Default Stateful Container)
- INFO - Configuring PersistenceUnit(name=movie-unit,
-provider=org.hibernate.ejb.HibernatePersistence)
- INFO - Enterprise application "classpath.ear" loaded.
- INFO - Assembling app: classpath.ear
- INFO - PersistenceUnit(name=movie-unit,
-provider=org.hibernate.ejb.HibernatePersistence)
- INFO - Jndi(name=CineplexImplLocal) --> Ejb(deployment-id=CineplexImpl)
- INFO - Jndi(name=MoviesLocal) --> Ejb(deployment-id=Movies)
- INFO - Created Ejb(deployment-id=Movies, ejb-name=Movies, container=Default
-Stateful Container)
- INFO - Created Ejb(deployment-id=CineplexImpl, ejb-name=CineplexImpl,
-container=Default Stateless Container)
- INFO - Deployed Application(path=classpath.ear)
- INFO - Exported EJB Movies with interface org.superbiz.spring.Movies to
-Spring bean MoviesLocal
- INFO - Exported EJB CineplexImpl with interface
-org.superbiz.spring.Cineplex to Spring bean CineplexImplLocal
- Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 3.141 sec
-
- Results :
-
- Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/spring.adoc
----------------------------------------------------------------------
diff --git a/docs/spring.adoc b/docs/spring.adoc
new file mode 100644
index 0000000..7f2e5b3
--- /dev/null
+++ b/docs/spring.adoc
@@ -0,0 +1,139 @@
+# Spring
+:index-group: Spring
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+\{note} This document and the related feature is considered a prototype
+and will change based on user feedback. All comments suggestions
+welcome. \{note}
+
+# Introduction
+
+The OpenEJB Spring integration makes all Spring defined beans injectable
+to Java EE components, and all Java EE components can be injected to
+Spring beans. The injection system supports arbitrarily complex nesting
+(e.g., Spring bean injected into a Java EE component, which is then
+injected into another Spring bean), including:
+
+* @Resouce injection of any Spring bean into EJB
+* Injection of any Java EE resource into a Spring bean, including: **
+EJB 3.0 beans ** EJB 3.1 Singleton Bean ** JDBC Connector ** JMS
+Connector ** JMS Queue and Topic ** Generic Java EE Connector (JCA)
+
+In addition, the OpenEJB Spring integration add support for discovery
+and deployment of standard Java EE packages within a Spring context,
+including:
+
+* EAR
+* EJB Jar
+* Persistence Unit
+* RAR
+
+_Requirements:_ * OpenEJB 3.1+ * Spring X.X * Java 1.5 or 1.6
+
+# Spring Beans
+
+The following beans are usable in any spring xml file.
+
+Class
+
+Description
+
+org.apache.openejb.spring.ClassPathApplication
+
+Scrapes the classpath for all EJB, RAR, and Persistence applications,
+deploys them, and imports them into the current ApplicationContext. All
+applications found are treated as one big EAR unless the
+_classpathAsEar_ property is set to _false_
+
+org.apache.openejb.spring.Application
+
+Scrapes an individual jar file for EJB, RAR, and Persistence
+applications, deploys them, and imports them into the current
+ApplicationContext. The 'jarFile' property is required. The application
+is treated as it's own self-contained EAR, separate from other uses of
+'Application'
+
+org.apache.openejb.spring.Resource
+
+Allows an OpenEJB to be declared in the Spring ApplicationContext
+
+org.apache.openejb.spring.OpenEJBResource
+
+A FactoryBean that imports a Resource from OpenEJB into the Spring
+ApplicationContext. Has the following properties: _type_ such as
+javax.sql.DataSource, and _resourceId_. In the future this bean will not
+be required and all OpenEJB Resources will automatically be imported
+into the Spring ApplicationContext
+
+org.apache.openejb.spring.BmpContainer
+
+Allows an OpenEJB BMP to be declared in the Spring ApplicationContext.
+Has the following properties: _poolSize_
+
+org.apache.openejb.spring.CmpContainer
+
+Allows an OpenEJB CMP to be declared in the Spring ApplicationContext.
+
+org.apache.openejb.spring.SingletonContainer
+
+Allows an OpenEJB Singleton to be declared in the Spring
+ApplicationContext. Has the following properties: _accessTimeout_
+
+org.apache.openejb.spring.StatefulContainer
+
+Allows an OpenEJB Stateful to be declared in the Spring
+ApplicationContext. Has the following properties: _timeOut_
+
+org.apache.openejb.spring.StatelessContainer
+
+Allows an OpenEJB Stateful to be declared in the Spring
+ApplicationContext. Has the following properties: _timeOut_, _poolSize_,
+and _strictPooling_
+
+org.apache.openejb.spring.MdbContainer
+
+Allows an OpenEJB Message-Driven to be declared in the Spring
+ApplicationContext. Has the following properties: _resourceAdapter_,
+_messageListenerInterface_, _activationSpecClass_, and _instanceLimit_
+
+org.apache.openejb.spring.EJB
+
+A FactoryBean that imports an EJB from OpenEJB into the Spring
+ApplicationContext. One of these is automatically created for each
+interface of each EJB, but explicit use can be nice if you desire to
+import an EJB with a specific name. Has the following properties:
+_deploymentId_, _interface_
+
+# Examples
+
+See the link:spring-ejb-and-jpa.html[Spring EJB and JPA] page for
+example code and a working Spring xml file.
+
+# \{anchor:problems} Problems?
+
+If you are having problems with the installation, please send a message
+to the OpenEJB users link:mailing-lists.html[mailing list] containing
+any error message(s) and the following information:
+
+* OpenEJB Version
+* Spring Version
+* Java Version (execute java -version)
+* Operating System Type and Version
+
+# Limitations
+
+_JavaAgent_ - OpenEJB uses OpenJPA to provide JPA and CMP persistence,
+and OpenJPA currently requires a JavaAgent to function properly in a
+Java 1.5 environment. OpenJPA does not require a JavaAgent in Java 1.6.
+Use Hibernate as your the provider in your persistence.xml files if you
+wish to avoid this requirement.
+
+_EntityManager_ - Having an OpenEJB created EntityManager or
+EntityManagerFactory injected into Spring beans is currently not
+supported. This will be added to the next release. A small workaround
+for this is to use an EJB as a factory by adding a 'getEntityManager'
+method an using it as a
+http://static.springframework.org/spring/docs/2.5.x/reference/beans.html#beans-factory-class-instance-factory-method[Spring
+instance factory method] .
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/spring.md
----------------------------------------------------------------------
diff --git a/docs/spring.md b/docs/spring.md
deleted file mode 100644
index a815b74..0000000
--- a/docs/spring.md
+++ /dev/null
@@ -1,124 +0,0 @@
-index-group=Spring
-type=page
-status=published
-title=Spring
-~~~~~~
-{note}
-This document and the related feature is considered a prototype and will
-change based on user feedback. All comments suggestions welcome.
-{note}
-
-<a name="Spring-Introduction"></a>
-# Introduction
-
-The OpenEJB Spring integration makes all Spring defined beans injectable to
-Java EE components, and all Java EE components can be injected to Spring beans.
-The injection system supports arbitrarily complex nesting (e.g., Spring
-bean injected into a Java EE component, which is then injected into another
-Spring bean), including:
-
- * @Resouce injection of any Spring bean into EJB
- * Injection of any Java EE resource into a Spring bean, including:
- ** EJB 3.0 beans
- ** EJB 3.1 Singleton Bean
- ** JDBC Connector
- ** JMS Connector
- ** JMS Queue and Topic
- ** Generic Java EE Connector (JCA)
-
-In addition, the OpenEJB Spring integration add support for discovery and
-deployment of standard Java EE packages within a Spring context, including:
-
- * EAR
- * EJB Jar
- * Persistence Unit
- * RAR
-
-*Requirements:*
- * OpenEJB 3.1+
- * Spring X.X
- * Java 1.5 or 1.6
-
-<a name="Spring-SpringBeans"></a>
-# Spring Beans
-
-The following beans are usable in any spring xml file.
-
-<table class="mdtable">
-<tr><th> Class </th><th> Description </th></tr>
-<tr><td> org.apache.openejb.spring.ClassPathApplication </td><td> Scrapes the classpath
-for all EJB, RAR, and Persistence applications, deploys them, and imports
-them into the current ApplicationContext. All applications found are
-treated as one big EAR unless the _classpathAsEar_ property is set to
-_false_ </td></tr>
-<tr><td> org.apache.openejb.spring.Application </td><td> Scrapes an individual jar file
-for EJB, RAR, and Persistence applications, deploys them, and imports them
-into the current ApplicationContext. The 'jarFile' property is required.
-The application is treated as it's own self-contained EAR, separate from
-other uses of 'Application' </td></tr>
-<tr><td> org.apache.openejb.spring.Resource </td><td> Allows an OpenEJB <Resource> to be
-declared in the Spring ApplicationContext </td></tr>
-<tr><td> org.apache.openejb.spring.OpenEJBResource </td><td> A FactoryBean that imports a
-Resource from OpenEJB into the Spring ApplicationContext. Has the
-following properties: _type_ such as javax.sql.DataSource, and
-_resourceId_. In the future this bean will not be required and all OpenEJB
-Resources will automatically be imported into the Spring ApplicationContext
-</td></tr>
-<tr><td> org.apache.openejb.spring.BmpContainer </td><td> Allows an OpenEJB BMP
-<Container> to be declared in the Spring ApplicationContext. Has the
-following properties: _poolSize_ </td></tr>
-<tr><td> org.apache.openejb.spring.CmpContainer </td><td> Allows an OpenEJB CMP
-<Container> to be declared in the Spring ApplicationContext. </td></tr>
-<tr><td> org.apache.openejb.spring.SingletonContainer </td><td> Allows an OpenEJB
-Singleton <Container> to be declared in the Spring ApplicationContext. Has
-the following properties: _accessTimeout_ </td></tr>
-<tr><td> org.apache.openejb.spring.StatefulContainer </td><td> Allows an OpenEJB Stateful
-<Container> to be declared in the Spring ApplicationContext. Has the
-following properties: _timeOut_</td></tr>
-<tr><td> org.apache.openejb.spring.StatelessContainer </td><td> Allows an OpenEJB Stateful
-<Container> to be declared in the Spring ApplicationContext. Has the
-following properties: _timeOut_, _poolSize_, and _strictPooling_ </td></tr>
-<tr><td> org.apache.openejb.spring.MdbContainer </td><td> Allows an OpenEJB Message-Driven
-<Container> to be declared in the Spring ApplicationContext. Has the
-following properties: _resourceAdapter_, _messageListenerInterface_,
-_activationSpecClass_, and _instanceLimit_ </td></tr>
-<tr><td> org.apache.openejb.spring.EJB </td><td> A FactoryBean that imports an EJB from
-OpenEJB into the Spring ApplicationContext. One of these is automatically
-created for each interface of each EJB, but explicit use can be nice if you
-desire to import an EJB with a specific name. Has the following
-properties: _deploymentId_, _interface_ </td></tr>
-</table>
-
-<a name="Spring-Examples"></a>
-# Examples
-
-See the [Spring EJB and JPA](spring-ejb-and-jpa.html)
- page for example code and a working Spring xml file.
-
-<a name="Spring-{anchor:problems}Problems?"></a>
-# {anchor:problems} Problems?
-
-If you are having problems with the installation, please send a message to
-the OpenEJB users [mailing list](mailing-lists.html)
- containing any error message(s) and the following information:
-
-* OpenEJB Version
-* Spring Version
-* Java Version (execute java -version)
-* Operating System Type and Version
-
-<a name="Spring-Limitations"></a>
-# Limitations
-
- *JavaAgent* - OpenEJB uses OpenJPA to provide JPA and CMP persistence, and
-OpenJPA currently requires a JavaAgent to function properly in a Java 1.5
-environment. OpenJPA does not require a JavaAgent in Java 1.6. Use
-Hibernate as your the provider in your persistence.xml files if you wish to
-avoid this requirement.
-
- *EntityManager* - Having an OpenEJB created EntityManager or
-EntityManagerFactory injected into Spring beans is currently not supported.
- This will be added to the next release. A small workaround for this is to
-use an EJB as a factory by adding a 'getEntityManager' method an using it
-as a [Spring instance factory method](http://static.springframework.org/spring/docs/2.5.x/reference/beans.html#beans-factory-class-instance-factory-method)
-.
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/ssh.adoc
----------------------------------------------------------------------
diff --git a/docs/ssh.adoc b/docs/ssh.adoc
new file mode 100644
index 0000000..fd09c95
--- /dev/null
+++ b/docs/ssh.adoc
@@ -0,0 +1,63 @@
+# SSH
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+== Connecting To OpenEJB or TomEE Through SSH
+
+=== Description
+
+It can be very useful to connect to the server to get some informations.
+
+=== Solution
+
+For such a case OpenEJB/TomEE proposes to start with the Java EE server
+a SSH server. Currently the security is based on JAAS (see how to
+configure JAAS for TomEE for more information about it).
+
+=== Installation
+
+Simply extract the openejb-ssh jar in the lib of tomee
+(webapps/tomee/lib) or openejb libs (lib folder). Then simply connect
+using your JAAS credential.
+
+Note: you can use the provisioning features of openejb to do this job!
+
+Then simply activate the service manage: it is done setting the system
+property openejb.servicemanager.enabled to true.
+
+Note: it can be done through the conf/system.properties file. Note2:
+please take care to not add space after true (not 'true ' for instance).
+
+=== OpenEJB SSH Shell
+
+Once you are connected you get some commands:
+
+* deploy : deploy an application
+* undeploy : undeploy an application
+* list: list deployed EJBs
+* classloader : print the classloader tree of the app specified by the
+id
+* jmx : interact with JMX ** jmx list: list mbeans ** jmx get ** jmx set
+** jmx invoke ([, ...)
+* properties: print server configuration as properties
+* script
++
++
+: execute the following script code using the following language with
+the JSR 223
+* script file
++
++
+: execute the following script using the language (from the extension of
+the file) with the JSR 223
+* ls []: list the file in path is specified or in the base of the server
+if not
+* cat : print a file
+* part - : print the part of a file
+
+Note1: JSR 223 can need to add some jar to openejb/tomee lib folder
+(groovy-all for instance to use groovy) Note2: ls, part, cat commands
+have to use $home and $base properties to specified the path
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/ssh.md
----------------------------------------------------------------------
diff --git a/docs/ssh.md b/docs/ssh.md
deleted file mode 100644
index 88788f4..0000000
--- a/docs/ssh.md
+++ /dev/null
@@ -1,51 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=SSH
-~~~~~~
-
-# Connecting To OpenEJB or TomEE Through SSH
-## Description
-
-It can be very useful to connect to the server to get some informations.
-
-## Solution
-
-For such a case OpenEJB/TomEE proposes to start with the Java EE server a SSH server. Currently the security
-is based on JAAS (see how to configure JAAS for TomEE for more information about it).
-
-## Installation
-
-Simply extract the openejb-ssh jar in the lib of tomee (webapps/tomee/lib) or openejb libs (lib folder).
-Then simply connect using your JAAS credential.
-
-Note: you can use the provisioning features of openejb to do this job!
-
-Then simply activate the service manage: it is done setting the system property
-openejb.servicemanager.enabled to true.
-
-Note: it can be done through the conf/system.properties file.
-Note2: please take care to not add space after true (not 'true ' for instance).
-
-## OpenEJB SSH Shell
-
-Once you are connected you get some commands:
-
-* deploy <path>: deploy an application
-* undeploy <path>: undeploy an application
-* list: list deployed EJBs
-* classloader <app id>: print the classloader tree of the app specified by the id
-* jmx <operation> <options>: interact with JMX
-** jmx list: list mbeans
-** jmx get <attribute> <objectname>
-** jmx set <attribute> <objectname> <new value>
-** jmx invoke <methodname>([<arg1>, ...) <objectname>
-* properties: print server configuration as properties
-* script <language> <script code>: execute the following script code using the following language with the JSR 223
-* script file <script file>: execute the following script using the language (from the extension of the file) with the JSR 223
-* ls [<path>]: list the file in path is specified or in the base of the server if not
-* cat <path>: print a file
-* part <start>-<end> <path>: print the part of a file
-
-Note1: JSR 223 can need to add some jar to openejb/tomee lib folder (groovy-all for instance to use groovy)
-Note2: ls, part, cat commands have to use $home and $base properties to specified the path
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/standalone-server.adoc
----------------------------------------------------------------------
diff --git a/docs/standalone-server.adoc b/docs/standalone-server.adoc
new file mode 100644
index 0000000..d9c0867
--- /dev/null
+++ b/docs/standalone-server.adoc
@@ -0,0 +1,24 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+NOTE: Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership. The
+ASF licenses this file to you 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.
+
+#Links to guide you through OpenEJB-Standalone-Server
+
+* link:startup.html[Startup]
+* link:deploy-tool.html[Deploy Tool]
+* link:properties-tool.html[Properties Tool]
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/standalone-server.md
----------------------------------------------------------------------
diff --git a/docs/standalone-server.md b/docs/standalone-server.md
deleted file mode 100644
index 4f8963a..0000000
--- a/docs/standalone-server.md
+++ /dev/null
@@ -1,27 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=
-~~~~~~
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-#Links to guide you through OpenEJB-Standalone-Server
-
-- [Startup](startup.html)
-- [Deploy Tool](deploy-tool.html)
-- [Properties Tool](properties-tool.html)
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/startup.adoc
----------------------------------------------------------------------
diff --git a/docs/startup.adoc b/docs/startup.adoc
new file mode 100644
index 0000000..8fa8c63
--- /dev/null
+++ b/docs/startup.adoc
@@ -0,0 +1,267 @@
+:index-group: OpenEJB
+Standalone Server
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: Startup
+
+# NAME
+
+openejb start - OpenEJB Remote Server
+
+# SYNOPSIS
+
+openejb start link:#options.html[#options]
+
+# NOTE
+
+The OpenEJB Remote Server can be started by running the openejb.bat
+script for windows and the openejb script for Linux and other Unix based
+OSes. Before running these scripts you need to set the environment
+variable _OPENEJB_HOME_ to the path of the directory where you unpacked
+the OpenEJB installation.
+
+From now on we will refer to this directory as and assume that you
+unpacked OpenEJB into the directory _C:-3.0_ The startup scripts are
+present in the /bin directory. You can set this directory in the system
+_PATH_ for starting openejb from the command shell.
+
+In Windows, the remote server can be executed as follows:
+
+_C:-3.0> binstart_
+
+In UNIX, Linux, or Mac OS X, the deploy tool can be executed as follows:
+
+`\[user@host openejb-3.0](user@host-openejb-3.0.html) # ./bin/openejb start`
+
+Depending on your OpenEJB version, you may need to change execution bits
+to make the scripts executable. You can do this with the following
+command.
+
+`\[user@host openejb-3.0](user@host-openejb-3.0.html) # chmod 755 bin/openejb`
+
+From here on out, it will be assumed that you know how to execute the
+right openejb script for your operating system and commands will appear
+in shorthand as show below.
+
+_openejb start -help_
+
+# DESCRIPTION
+
+Starts OpenEJB as an EJB Server that can be accessed by remote clients
+via the OpenEJB Remote Server.
+
+ALWAYS check your openejb.log file for warnings immediately after
+starting the Remote Server.
+
+OpenEJB issues warnings when it works around a potential problem,
+encounters something it didn't expect, or when OpenEJB wants to let you
+know something may not work as you expected it.
+
+OpenEJB itself is configured with the OpenEJB configuration file, which
+is extremely simple and self-documenting. This file is located at
+c:-3.0.xml.
+
+# OPTIONS
+
+| _-D=_ | Specifies a system property passed into OpenEJB at startup. |
+| _--admin-bind _ | Sets the host to which the admin service should be
+bound.| | _--admin-port _ | Sets the port to which the admin service
+should be bound.| | _--conf _ | Sets the OpenEJB configuration to the
+specified file. | | _--ejbd-bind _ | Sets the host to which the ejbd
+service should be bound. | | _--ejbd-port _ | Sets the port to which the
+ejbd service should be bound. | +
+| _--examples_ | Show examples of how to use the options. | | -h,
+--_help_ | Print this help message. | | _--hsql-bind _ | Sets the host
+to which the hsql service should be bound.| | _--hsql-port _ | Sets the
+port to which the hsql service should be bound.| | _--httpejbd-bind _ |
+Sets the host to which the httpejbd service should be bound.| |
+_--httpejbd-port _ | Sets the port to which the httpejbd service should
+be bound.| | _--local-copy _ | Instructs the container system to marshal
+(ie, copy) all calls between beans. | | _--telnet-bind _ | Sets the host
+to which the telnet service should be bound.| | _--telnet-port _ | Sets
+the port to which the telnet service should be bound.| | -v, --_version_
+| Print the version. |
+
+# EXAMPLES
+
+== Example: Simplest scenario
+
+_openejb start_
+
+That's it. The ejbd will start up and bind to IP 127.0.0.1 and port
+4201.
+
+The following properties would then be used to get an InitialContext
+from the Remote Server.
+
+....
+java.naming.factory.initial =
+....
+
+org.apache.openejb.client.RemoteInitialContextFactory
+java.naming.provider.url = ejbd://127.0.0.1:4201
+java.naming.security.principal = myuser java.naming.security.credentials
+= mypass
+
+== Example: --conf=file
+
+_openejb start --conf=C:-3.0.conf_
+
+Sets the openejb.configuration system variable to the file _C:.conf_.
+When the server starts up and initializes OpenEJB, this configuration
+will be used to assemble the container system and load beans.
+
+== Example: --local-copy
+
+The local-copy option controls whether Remote interface arguments and
+results are always copied.
+
+_openejb start --local-copy=true_ (default)
+
+Remote interface business method arguments and results are always copied
+(via serialization), which is compliant with the EJB standard.
+
+_openejb start --local-copy=false_
+
+Remote interface business method arguments and results are copied only
+when the client is in a different JVM. Otherwise, they are passed by
+reference - as if it were a Local interface. This is faster, of course,
+but non-compliant with the EJB standard.
+
+Local interfaces are not affected; their arguments and results are
+passed by reference and never copied.
+
+== CONFIG OVERRIDE EXAMPLES
+
+== Example: -D.bind=
+
+_openejb start -Dejbd.bind=10.45.67.8_
+
+This is the most common way to use the EJBd Server Service. The service
+will start up and bind to IP 10.45.67.8 and port 4201. The following
+properties would then be used to get an InitialContext from the EJBd
+Server Service.
+
+....
+ java.naming.factory.initial =
+....
+
+org.apache.openejb.client.RemoteInitialContextFactory
+java.naming.provider.url = ejbd://10.45.67.8:4201
+java.naming.security.principal = myuser java.naming.security.credentials
+= mypass
+
+DNS names can also be used.
+
+_openejb start -Dejbd.bind=myhost.foo.com_
+
+The following properties would then be used to get an InitialContext
+from the Remote Server.
+
+....
+ java.naming.factory.initial =
+....
+
+org.apache.openejb.client.RemoteInitialContextFactory
+java.naming.provider.url = ejbd://myhost.foo.com:4201
+java.naming.security.principal = myuser java.naming.security.credentials
+= mypass
+
+_openejb start -Dtelnet.bind=myhost.foo.com_
+
+The following properties would then be used to log into the server via a
+telnet client as such:
+
+_telnet myhost.foo.com 4202_
+
+== Example: -D.port=
+
+_openejb start -Dejbd.port=8765_
+
+The server will start up and bind to IP 127.0.0.1 and port 8765.
+
+The following properties would then be used to get an InitialContext
+from the Remote Server.
+
+....
+ java.naming.factory.initial =
+....
+
+org.apache.openejb.client.RemoteInitialContextFactory
+java.naming.provider.url = ejbd://127.0.0.1:8765
+java.naming.security.principal = myuser java.naming.security.credentials
+= mypass
+
+_openejb start -Dhttpejbd.port=8888_
+
+The server will start up and the EJB over HTTP service will bind to IP
+127.0.0.1 and port 8888.
+
+The following properties would then be used to get an InitialContext
+from the HTTP/Remote Server.
+
+....
+ java.naming.factory.initial =
+....
+
+org.apache.openejb.client.RemoteInitialContextFactory
+java.naming.provider.url = http://127.0.0.1:8888/openejb
+java.naming.security.principal = myuser java.naming.security.credentials
+= mypass
+
+== Example: -D.only_from=
+
+_openejb start -Dadmin.only_from=192.168.1.12_
+
+Adds 192.168.1.12 to the list of IP addresses that are authorized to
+shutdown the server or access the server via a telnet client. The host
+that this server was started on is always allowed to administer the
+server.
+
+Multiple hosts can be given administrative access to this server by
+listing all the host names separated by commas as such:
+
+_openejb start -Dadmin.only_from=192.168.1.12,joe.foo.com,robert_
+
+The first host in the string names the host explicitly using an IP
+address (192.168.1.12).
+
+The second host uses a DNS name (joe.foo.com) to refer to the hosts IP
+address. The DNS name will be resolved and the IP will be added to the
+admin list.
+
+The third address refers to a the host by a name (robert)that the
+opperating system is able to resolve into a valid IP address. This is
+usually done via a hosts file, interal DNS server, or Windows Domain
+Server.
+
+== Example: -D.threads=
+
+_openejb start -Dejbd.threads=200_
+
+Sets the max number of concurrent threads that can enter the EJBd Server
+Service to 200.
+
+== Example: -D.disabled=
+
+_openejb start -Dtelnet.disabled=true_
+
+Prevents the Telnet Server Service from starting when the OpenEJB Server
+starts.
+
+# CONSOLE OUTPUT
+
+Once you start OpenEJB using the _openejb start_ command the following
+output will be seen on the console
+
+....
+Apache OpenEJB 3.0 build: 20070825-01:10
+http://tomee.apache.org/
+OpenEJB ready.
+[OPENEJB:init]
+....
+
+OpenEJB Remote Server ** Starting Services ** NAME IP PORT httpejbd
+0.0.0.0 4204 telnet 0.0.0.0 4202 ejbd 0.0.0.0 4201 hsql 0.0.0.0 9001
+admin thread 0.0.0.0 4200 ------- Ready!
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/startup.md
----------------------------------------------------------------------
diff --git a/docs/startup.md b/docs/startup.md
deleted file mode 100644
index c4a92ec..0000000
--- a/docs/startup.md
+++ /dev/null
@@ -1,296 +0,0 @@
-index-group=OpenEJB Standalone Server
-type=page
-status=published
-title=Startup
-~~~~~~
-<a name="Startup-NAME"></a>
-# NAME
-
-openejb start - OpenEJB Remote Server
-
-<a name="Startup-SYNOPSIS"></a>
-# SYNOPSIS
-
-openejb start [#options](#options.html)
-
-<a name="Startup-NOTE"></a>
-# NOTE
-
-The OpenEJB Remote Server can be started by running the openejb.bat script
-for windows and the openejb script for Linux and other Unix based OSes.
-Before running these scripts you need to set the environment variable
-_OPENEJB_HOME_ to the path of the directory where you unpacked the OpenEJB
-installation.
-
-From now on we will refer to this directory as <OPENEJB_HOME> and assume
-that you unpacked OpenEJB into the directory *C:\openejb-3.0* The startup
-scripts are present in the <OPENEJB_HOME>/bin directory. You can set this
-directory in the system _PATH_ for starting openejb from the command shell.
-
-In Windows, the remote server can be executed as follows:
-
-*C:\openejb-3.0> bin\openejb start*
-
-In UNIX, Linux, or Mac OS X, the deploy tool can be executed as follows:
-
-`\[user@host openejb-3.0](user@host-openejb-3.0.html)
-# ./bin/openejb start`
-
-Depending on your OpenEJB version, you may need to change execution bits to
-make the scripts executable. You can do this with the following command.
-
-`\[user@host openejb-3.0](user@host-openejb-3.0.html)
-# chmod 755 bin/openejb`
-
-From here on out, it will be assumed that you know how to execute the right
-openejb script for your operating system and commands will appear in
-shorthand as show below.
-
-*openejb start -help*
-
-<a name="Startup-DESCRIPTION"></a>
-# DESCRIPTION
-
-Starts OpenEJB as an EJB Server that can be accessed by remote clients via
-the OpenEJB Remote Server.
-
-ALWAYS check your openejb.log file for warnings immediately after starting
-the Remote Server.
-
-OpenEJB issues warnings when it works around a potential problem,
-encounters something it didn't expect, or when OpenEJB wants to let you
-know something may not work as you expected it.
-
-OpenEJB itself is configured with the OpenEJB configuration file, which is
-extremely simple and self-documenting. This file is located at
-c:\openejb-3.0\conf\openejb.xml.
-
-<a name="Startup-OPTIONS"></a>
-# OPTIONS
-
- | _-D<name>=<value>_ | Specifies a system property passed
-into OpenEJB at startup. |
- | _--admin-bind <host>_ | Sets the host to which the admin
-service should be bound.|
- | _--admin-port <int>_ | Sets the port to which the admin
-service should be bound.|
- | _--conf <file>_ | Sets the OpenEJB configuration to
-the specified file. |
- | _--ejbd-bind <host>_ | Sets the host to which the ejbd
-service should be bound. |
- | _--ejbd-port <int>_ | Sets the port to which the ejbd
-service should be bound. |
- | _--examples_ | Show examples of how to use the
-options. |
- | -h, --_help_ | Print this help message. |
- | _--hsql-bind <host>_ | Sets the host to which the hsql
-service should be bound.|
- | _--hsql-port <int>_ | Sets the port to which the hsql
-service should be bound.|
- | _--httpejbd-bind <host>_ | Sets the host to which the httpejbd
-service should be bound.|
- | _--httpejbd-port <int>_ | Sets the port to which the httpejbd
-service should be bound.|
- | _--local-copy <boolean>_ | Instructs the container system to
-marshal (ie, copy) all calls between beans. |
- | _--telnet-bind <host>_ | Sets the host to which the telnet
-service should be bound.|
- | _--telnet-port <int>_ | Sets the port to which the telnet
-service should be bound.|
- | -v, --_version_ | Print the version. |
-
-<a name="Startup-EXAMPLES"></a>
-# EXAMPLES
-
-<a name="Startup-Example:Simplestscenario"></a>
-## Example: Simplest scenario
-
-*openejb start*
-
-That's it. The ejbd will start up and bind to IP 127.0.0.1 and port 4201.
-
-The following properties would then be used to get an InitialContext from
-the Remote Server.
-
-
- java.naming.factory.initial =
-org.apache.openejb.client.RemoteInitialContextFactory
- java.naming.provider.url = ejbd://127.0.0.1:4201
- java.naming.security.principal = myuser
- java.naming.security.credentials = mypass
-
-
-<a name="Startup-Example:--conf=file"></a>
-## Example: --conf=file
-
-*openejb start --conf=C:\openejb-3.0\conf\mytest.conf*
-
- Sets the openejb.configuration system variable to the file
-*C:\openejb\conf\mytest.conf*. When the server starts up and initializes
-OpenEJB, this configuration will be used to assemble the container system
-and load beans.
-
-<a name="Startup-Example:--local-copy"></a>
-## Example: --local-copy
-
-The local-copy option controls whether Remote interface arguments and
-results are always copied.
-
-*openejb start --local-copy=true* (default)
-
-Remote interface business method arguments and results are always copied
-(via serialization), which is compliant with the EJB standard.
-
-*openejb start --local-copy=false*
-
-Remote interface business method arguments and results are copied only when
-the client is in a different JVM. Otherwise, they are passed by reference -
-as if it were a Local interface. This is faster, of course, but
-non-compliant with the EJB standard.
-
-Local interfaces are not affected; their arguments and results are passed
-by reference and never copied.
-
-<a name="Startup-CONFIGOVERRIDEEXAMPLES"></a>
-## CONFIG OVERRIDE EXAMPLES
-
-<a name="Startup-Example:-D<service>.bind=<address>"></a>
-## Example: -D<service>.bind=<address>
-
- *openejb start -Dejbd.bind=10.45.67.8*
-
- This is the most common way to use the EJBd Server Service. The service
-will start up and bind to IP 10.45.67.8 and port 4201. The following
-properties would then be used to get an InitialContext from the EJBd Server
-Service.
-
-
- java.naming.factory.initial =
-org.apache.openejb.client.RemoteInitialContextFactory
- java.naming.provider.url = ejbd://10.45.67.8:4201
- java.naming.security.principal = myuser
- java.naming.security.credentials = mypass
-
-
- DNS names can also be used.
-
- *openejb start -Dejbd.bind=myhost.foo.com*
-
- The following properties would then be used to get an InitialContext from
-the Remote Server.
-
-
- java.naming.factory.initial =
-org.apache.openejb.client.RemoteInitialContextFactory
- java.naming.provider.url = ejbd://myhost.foo.com:4201
- java.naming.security.principal = myuser
- java.naming.security.credentials = mypass
-
-
- *openejb start -Dtelnet.bind=myhost.foo.com*
-
- The following properties would then be used to log into the server via a
-telnet client as such:
-
- *telnet myhost.foo.com 4202*
-
-
-<a name="Startup-Example:-D<service>.port=<port>"></a>
-## Example: -D<service>.port=<port>
-
- *openejb start -Dejbd.port=8765*
-
- The server will start up and bind to IP 127.0.0.1 and port 8765.
-
- The following properties would then be used to get an InitialContext from
-the Remote Server.
-
-
- java.naming.factory.initial =
-org.apache.openejb.client.RemoteInitialContextFactory
- java.naming.provider.url = ejbd://127.0.0.1:8765
- java.naming.security.principal = myuser
- java.naming.security.credentials = mypass
-
-
- *openejb start -Dhttpejbd.port=8888*
-
- The server will start up and the EJB over HTTP service will bind to IP
-127.0.0.1 and port 8888.
-
- The following properties would then be used to get an InitialContext from
-the HTTP/Remote Server.
-
-
- java.naming.factory.initial =
-org.apache.openejb.client.RemoteInitialContextFactory
- java.naming.provider.url = http://127.0.0.1:8888/openejb
- java.naming.security.principal = myuser
- java.naming.security.credentials = mypass
-
-
-<a name="Startup-Example:-D<service>.only_from=<addresses>"></a>
-## Example: -D<service>.only_from=<addresses>
-
- *openejb start -Dadmin.only_from=192.168.1.12*
-
- Adds 192.168.1.12 to the list of IP addresses that are authorized to
-shutdown the server or access the server
- via a telnet client. The host that this server was started on is always
-allowed to administer the server.
-
- Multiple hosts can be given administrative access to this server by
-listing all the host names separated
- by commas as such:
-
- *openejb start -Dadmin.only_from=192.168.1.12,joe.foo.com,robert*
-
- The first host in the string names the host explicitly using an IP address
-(192.168.1.12).
-
- The second host uses a DNS name (joe.foo.com) to refer to the hosts IP
-address. The DNS name will be resolved and the IP will be added to the
-admin list.
-
- The third address refers to a the host by a name (robert)that the
-opperating system is able to resolve into a valid IP address. This is
-usually done via a hosts file, interal DNS server, or Windows Domain
-Server.
-
-<a name="Startup-Example:-D<service>.threads=<max>"></a>
-## Example: -D<service>.threads=<max>
-
- *openejb start -Dejbd.threads=200*
-
- Sets the max number of concurrent threads that can enter the EJBd Server
-Service to 200.
-
-<a name="Startup-Example:-D<service>.disabled=<true/false>"></a>
-## Example: -D<service>.disabled=<true/false>
-
- *openejb start -Dtelnet.disabled=true*
-
- Prevents the Telnet Server Service from starting when the OpenEJB Server
-starts.
-
-<a name="Startup-CONSOLEOUTPUT"></a>
-# CONSOLE OUTPUT
-
-Once you start OpenEJB using the *openejb start* command the following
-output will be seen on the console
-
-
- Apache OpenEJB 3.0 build: 20070825-01:10
- http://tomee.apache.org/
- OpenEJB ready.
- [OPENEJB:init]
- OpenEJB Remote Server
- ** Starting Services **
- NAME IP PORT
- httpejbd 0.0.0.0 4204
- telnet 0.0.0.0 4202
- ejbd 0.0.0.0 4201
- hsql 0.0.0.0 9001
- admin thread 0.0.0.0 4200
- -------
- Ready!
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/statefulcontainer-config.adoc
----------------------------------------------------------------------
diff --git a/docs/statefulcontainer-config.adoc b/docs/statefulcontainer-config.adoc
new file mode 100644
index 0000000..c54da1b
--- /dev/null
+++ b/docs/statefulcontainer-config.adoc
@@ -0,0 +1,165 @@
+# StatefulContainer Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A StatefulContainer can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Container id="myStatefulContainer" type="STATEFUL">
+ accessTimeout = 30 seconds
+ bulkPassivate = 100
+ cache = org.apache.openejb.core.stateful.SimpleCache
+ capacity = 1000
+ frequency = 60
+ passivator = org.apache.openejb.core.stateful.SimplePassivater
+ timeOut = 20
+</Container>
+....
+
+Alternatively, a StatefulContainer can be declared via properties in the
+`<tomee-home>/conf/system.properties` file or via Java VirtualMachine
+`-D` properties. The properties can also be used when embedding TomEE
+via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
+
+....
+myStatefulContainer = new://Container?type=STATEFUL
+myStatefulContainer.accessTimeout = 30 seconds
+myStatefulContainer.bulkPassivate = 100
+myStatefulContainer.cache = org.apache.openejb.core.stateful.SimpleCache
+myStatefulContainer.capacity = 1000
+myStatefulContainer.frequency = 60
+myStatefulContainer.passivator = org.apache.openejb.core.stateful.SimplePassivater
+myStatefulContainer.timeOut = 20
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared StatefulContainer a
+warning will be logged. If a StatefulContainer is needed by the
+application and one is not declared, TomEE will create one dynamically
+using default settings. Multiple StatefulContainer declarations are
+allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+accessTimeout
+
+time
+
+30 seconds
+
+Specifies the maximum time an invocation could wait for the `@Stateful`
+bean instance to become available before giving up.
+
+bulkPassivate
+
+int
+
+100
+
+Property name that specifies the number of instances to passivate at one
+time when doing bulk passivation.
+
+cache
+
+String
+
+org.apache.openejb.core.stateful.SimpleCache
+
+The cache is responsible for managing stateful bean instances. The cache
+can page instances to disk as memory is filled and can destroy abandoned
+instances. A different cache implementation can be used by setting this
+property to the fully qualified class name of the Cache implementation.
+
+capacity
+
+int
+
+1000
+
+Specifies the size of the bean pools for this stateful SessionBean
+container.
+
+frequency
+
+int
+
+60
+
+Specifies the frequency (in seconds) at which the bean cache is checked
+for idle beans.
+
+passivator
+
+String
+
+org.apache.openejb.core.stateful.SimplePassivater
+
+The passivator is responsible for writing beans to disk at passivation
+time. Different passivators can be used by setting this property to the
+fully qualified class name of the `PassivationStrategy` implementation.
+The passivator is not responsible for invoking any callbacks or other
+processing, its only responsibly is to write the bean state to disk.
+
+timeOut
+
+time
+
+20
+
+Specifies the time a bean can be idle before it is removed by the
+container.
+
+== accessTimeout
+
+Specifies the maximum time an invocation could wait for the `@Stateful`
+bean instance to become available before giving up.
+
+After the timeout is reached a
+`javax.ejb.ConcurrentAccessTimeoutException` will be thrown.
+
+Usable time units: nanoseconds, microsecons, milliseconds, seconds,
+minutes, hours, days. Or any combination such as "1 hour and 27 minutes
+and 10 seconds"
+
+Any usage of the `javax.ejb.AccessTimeout` annotation will override this
+setting for the bean or method where the annotation is used.
+
+== passivator
+
+The passivator is responsible for writing beans to disk at passivation
+time. Different passivators can be used by setting this property to the
+fully qualified class name of the `PassivationStrategy` implementation.
+The passivator is not responsible for invoking any callbacks or other
+processing, its only responsibly is to write the bean state to disk.
+
+Known implementations:
+
+* org.apache.openejb.core.stateful.RAFPassivater
+* org.apache.openejb.core.stateful.SimplePassivater
+
+== timeOut
+
+Specifies the time a bean can be idle before it is removed by the
+container.
+
+This value is measured in minutes. A value of 5 would result in a
+time-out of 5 minutes between invocations. A value of -1 would mean no
+timeout. A value of 0 would mean a bean can be immediately removed by
+the container.
+
+Any usage of the `javax.ejb.StatefulTimeout` annotation will override
+this setting for the bean where the annotation is used.
http://git-wip-us.apache.org/repos/asf/tomee/blob/de7099c5/docs/statefulcontainer-config.md
----------------------------------------------------------------------
diff --git a/docs/statefulcontainer-config.md b/docs/statefulcontainer-config.md
deleted file mode 100644
index ea2668e..0000000
--- a/docs/statefulcontainer-config.md
+++ /dev/null
@@ -1,160 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=StatefulContainer Configuration
-~~~~~~
-
-
-A StatefulContainer can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Container id="myStatefulContainer" type="STATEFUL">
- accessTimeout = 30 seconds
- bulkPassivate = 100
- cache = org.apache.openejb.core.stateful.SimpleCache
- capacity = 1000
- frequency = 60
- passivator = org.apache.openejb.core.stateful.SimplePassivater
- timeOut = 20
- </Container>
-
-Alternatively, a StatefulContainer can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myStatefulContainer = new://Container?type=STATEFUL
- myStatefulContainer.accessTimeout = 30 seconds
- myStatefulContainer.bulkPassivate = 100
- myStatefulContainer.cache = org.apache.openejb.core.stateful.SimpleCache
- myStatefulContainer.capacity = 1000
- myStatefulContainer.frequency = 60
- myStatefulContainer.passivator = org.apache.openejb.core.stateful.SimplePassivater
- myStatefulContainer.timeOut = 20
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared StatefulContainer a warning will be logged. If a StatefulContainer is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple StatefulContainer declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td><a href="#accessTimeout">accessTimeout</a></td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>30 seconds</td>
- <td>
-Specifies the maximum time an invocation could wait for the
-`@Stateful` bean instance to become available before giving up.
-</td>
-</tr>
-<tr>
- <td>bulkPassivate</td>
- <td>int</td>
- <td>100</td>
- <td>
-Property name that specifies the number of instances
-to passivate at one time when doing bulk passivation.
-</td>
-</tr>
-<tr>
- <td>cache</td>
- <td>String</td>
- <td>org.apache.openejb.core.stateful.SimpleCache</td>
- <td>
-The cache is responsible for managing stateful bean
-instances. The cache can page instances to disk as memory
-is filled and can destroy abandoned instances. A different
-cache implementation can be used by setting this property
-to the fully qualified class name of the Cache implementation.
-</td>
-</tr>
-<tr>
- <td>capacity</td>
- <td>int</td>
- <td>1000</td>
- <td>
-Specifies the size of the bean pools for this
-stateful SessionBean container.
-</td>
-</tr>
-<tr>
- <td>frequency</td>
- <td>int</td>
- <td>60</td>
- <td>
-Specifies the frequency (in seconds) at which the bean cache is checked for
-idle beans.
-</td>
-</tr>
-<tr>
- <td><a href="#passivator">passivator</a></td>
- <td>String</td>
- <td>org.apache.openejb.core.stateful.SimplePassivater</td>
- <td>
-The passivator is responsible for writing beans to disk
-at passivation time. Different passivators can be used
-by setting this property to the fully qualified class name
-of the `PassivationStrategy` implementation. The passivator
-is not responsible for invoking any callbacks or other
-processing, its only responsibly is to write the bean state
-to disk.
-</td>
-</tr>
-<tr>
- <td><a href="#timeOut">timeOut</a></td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>20</td>
- <td>
-Specifies the time a bean can be idle before it is removed by the container.
-</td>
-</tr>
-</table>
-
-
-
-<a name="accessTimeout"></a>
-## accessTimeout
-
-Specifies the maximum time an invocation could wait for the
-`@Stateful` bean instance to become available before giving up.
-
-After the timeout is reached a `javax.ejb.ConcurrentAccessTimeoutException`
-will be thrown.
-
-Usable time units: nanoseconds, microsecons, milliseconds,
-seconds, minutes, hours, days. Or any combination such as
-"1 hour and 27 minutes and 10 seconds"
-
-Any usage of the `javax.ejb.AccessTimeout` annotation will
-override this setting for the bean or method where the
-annotation is used.
-
-
-<a name="passivator"></a>
-## passivator
-
-The passivator is responsible for writing beans to disk
-at passivation time. Different passivators can be used
-by setting this property to the fully qualified class name
-of the `PassivationStrategy` implementation. The passivator
-is not responsible for invoking any callbacks or other
-processing, its only responsibly is to write the bean state
-to disk.
-
-Known implementations:
-
-- org.apache.openejb.core.stateful.RAFPassivater
-- org.apache.openejb.core.stateful.SimplePassivater
-
-
-<a name="timeOut"></a>
-## timeOut
-
-Specifies the time a bean can be idle before it is removed by the container.
-
-This value is measured in minutes. A value of 5 would
-result in a time-out of 5 minutes between invocations.
-A value of -1 would mean no timeout.
-A value of 0 would mean a bean can be immediately removed by the container.
-
-Any usage of the `javax.ejb.StatefulTimeout` annotation will
-override this setting for the bean where the annotation is used.
[10/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 5
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 5
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/513cf17a
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/513cf17a
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/513cf17a
Branch: refs/heads/master
Commit: 513cf17a686c20e82648eafdd2c4e46d3b9e50e9
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:22 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:07:22 2018 -0800
----------------------------------------------------------------------
docs/generating-ejb-3-annotations.adoc | 63 ++++
docs/generating-ejb-3-annotations.md | 61 ----
docs/getting-started.adoc | 170 +++++++++++
docs/getting-started.md | 172 -----------
docs/hello-world.adoc | 247 ++++++++++++++++
docs/hello-world.md | 250 ----------------
docs/hibernate.adoc | 101 +++++++
docs/hibernate.md | 98 -------
docs/initialcontext-config.adoc | 42 +++
docs/initialcontext-config.md | 26 --
docs/installation-drop-in-war.adoc | 55 ++++
docs/installation-drop-in-war.md | 45 ---
docs/installation.adoc | 35 +++
docs/installation.md | 34 ---
docs/installing-tomee.adoc | 83 ++++++
docs/installing-tomee.md | 71 -----
docs/java7.adoc | 40 +++
docs/java7.md | 40 ---
docs/javaagent-with-maven-surefire.adoc | 35 +++
docs/javaagent-with-maven-surefire.md | 57 ----
docs/javaagent.adoc | 64 ++++
docs/javaagent.md | 61 ----
docs/javaee7-status.adoc | 218 ++++++++++++++
docs/javaee7-status.md | 185 ------------
docs/javamailsession-config.adoc | 42 +++
docs/javamailsession-config.md | 26 --
docs/jms-resources-and-mdb-container.adoc | 356 ++++++++++++++++++++++
docs/jms-resources-and-mdb-container.md | 283 ------------------
docs/jmsconnectionfactory-config.adoc | 102 +++++++
docs/jmsconnectionfactory-config.md | 87 ------
docs/jndi-names.adoc | 390 +++++++++++++++++++++++++
docs/jndi-names.md | 372 -----------------------
docs/jpa-concepts.adoc | 223 ++++++++++++++
docs/jpa-concepts.md | 220 --------------
docs/jpa-usage.adoc | 48 +++
docs/jpa-usage.md | 52 ----
36 files changed, 2314 insertions(+), 2140 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/generating-ejb-3-annotations.adoc
----------------------------------------------------------------------
diff --git a/docs/generating-ejb-3-annotations.adoc b/docs/generating-ejb-3-annotations.adoc
new file mode 100644
index 0000000..b678931
--- /dev/null
+++ b/docs/generating-ejb-3-annotations.adoc
@@ -0,0 +1,63 @@
+# Generating EJB 3 annotations
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Generating EJB 3 annotations
+
+The OpenEJB Eclipse plugin is able to provide some assistance in helping
+you migrate EJB 2.x projects to EJB 3.0, by analyzing your ejb-jar.xml
+file, and adding EJB annotations to your source code. This page will
+show you how to use this functionality.
+
+First of all you will need to add the EJB 3.0 API jars to the classpath
+of your project. If you are using Maven, you can add the following to
+your POM (you will need to update your Eclipse project using mvn
+eclipse:eclipse afterwards)
+
+....
+ <dependencies>
+ ...
+ <dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>javaee-api</artifactId>
+ <version>5.0-1</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+....
+
+Alternatively, import the API jars into your project, and add them to
+your build path.
+
+Next, click the 'OpenEJB' menu on the menubar, and select 'Generate
+Annotations'.
+
+!http://www.jrg.me.uk/openejb/annotations_step_1.jpg!
+
+Select the project you would like to work with, if it isn't already
+selected. Click 'Next'.
+
+!http://www.jrg.me.uk/openejb/annotations_step_2.jpg!
+
+Select your ejb-jar.xml and (optionally) your openejb-jar.xml files.
+Select or deselect the other options as appropriate, and select 'Next'.
+
+Options:
+
+....
+* Alter SessionBean interfaces - This option makes your session beans
+....
+
+implement your remote / local interfaces as opposed to
+javax.ejb.SessionBean, and stops your remote / local interfaces
+extending javax.ejb.EJBObject. * Add @Remote and @RemoteHome annotations
+- This adds @Remote and @RemoteHome annotations appropriately * Convert
+entity beans to POJOs - This options converts abstract CMP classes to
+POJOs generating simple getters and setters.
+
+!http://www.jrg.me.uk/openejb/annotations_step_3.jpg!
+
+Review the changes that the plugin will make to your source code.
+Uncheck any changes you don't want to apply, and click 'Finish'.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/generating-ejb-3-annotations.md
----------------------------------------------------------------------
diff --git a/docs/generating-ejb-3-annotations.md b/docs/generating-ejb-3-annotations.md
deleted file mode 100644
index 8f3dfe3..0000000
--- a/docs/generating-ejb-3-annotations.md
+++ /dev/null
@@ -1,61 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Generating EJB 3 annotations
-~~~~~~
-<a name="GeneratingEJB3annotations-GeneratingEJB3annotations"></a>
-# Generating EJB 3 annotations
-
-The OpenEJB Eclipse plugin is able to provide some assistance in helping
-you migrate EJB 2.x projects to EJB 3.0, by analyzing your ejb-jar.xml
-file, and adding EJB annotations to your source code. This page will show
-you how to use this functionality.
-
-First of all you will need to add the EJB 3.0 API jars to the classpath of
-your project. If you are using Maven, you can add the following to your POM
-(you will need to update your Eclipse project using mvn eclipse:eclipse
-afterwards)
-
-
- <dependencies>
- ...
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>javaee-api</artifactId>
- <version>5.0-1</version>
- <scope>provided</scope>
- </dependency>
- </dependencies>
-
-
-Alternatively, import the API jars into your project, and add them to your
-build path.
-
-Next, click the 'OpenEJB' menu on the menubar, and select 'Generate
-Annotations'.
-
-!http://www.jrg.me.uk/openejb/annotations_step_1.jpg!
-
-Select the project you would like to work with, if it isn't already
-selected. Click 'Next'.
-
-!http://www.jrg.me.uk/openejb/annotations_step_2.jpg!
-
-Select your ejb-jar.xml and (optionally) your openejb-jar.xml files. Select
-or deselect the other options as appropriate, and select 'Next'.
-
-Options:
-
- * Alter SessionBean interfaces - This option makes your session beans
-implement your remote / local interfaces as opposed to
-javax.ejb.SessionBean, and stops your remote / local interfaces extending
-javax.ejb.EJBObject.
- * Add @Remote and @RemoteHome annotations - This adds @Remote and
-@RemoteHome annotations appropriately
- * Convert entity beans to POJOs - This options converts abstract CMP
-classes to POJOs generating simple getters and setters.
-
-!http://www.jrg.me.uk/openejb/annotations_step_3.jpg!
-
-Review the changes that the plugin will make to your source code. Uncheck
-any changes you don't want to apply, and click 'Finish'.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/getting-started.adoc
----------------------------------------------------------------------
diff --git a/docs/getting-started.adoc b/docs/getting-started.adoc
new file mode 100644
index 0000000..f832bce
--- /dev/null
+++ b/docs/getting-started.adoc
@@ -0,0 +1,170 @@
+# Getting Started
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+##The following instructions are written using Eclipse 3.2. We
+will refer to the install location of OpenEJB as OPENEJB_HOME
+
+Here are some basic steps you need to perform to get started with
+OpenEJB 1. Download and install OpenEJB 1. Setup your development
+environment 1. Write an EJB 1. Write an EJB client 1. Start the server
+1. Deploy the EJB 1. Run the client 1. Stop the server
+
+##1. Download and Install OpenEJB
+
+Follow
+these http://cwiki.apache.org/confluence/display/OPENEJB/Quickstart[instructions]
+
+##2. Setup your development environment
+
+###Eclipse
+
+* Open eclipse and create a new java project. Name it EJBProject
+* Add the following jars to the build path of your project --
+OPENEJB_HOME/lib/geronimo-ejb_3.0_spec-1.0.jar
+* Now create another project named EJBClient. This is where we will
+write a test client
+* Add the following jars to the build path of this project --
+OPENEJB_HOME/lib/openejb-client-3.0.0-SNAPSHOT.jar
+* Add the EJBProject to the classpath of the EJBClient project
+
+##3. Start the Server
+
+Open the command prompt and run the following command:
+
+....
+d:\openejb-3.0.0-SNAPSHOT\bin\openejb start
+....
+
+You will get the following message on the console:
+
+....
+D:\openejb-3.0.0-SNAPSHOT>bin\openejb start
+Apache OpenEJB 3.0.0-SNAPSHOT build: 20070830-07:53
+http://tomee.apache.org/
+OpenEJB ready.
+[OPENEJB:init]
+ OpenEJB Remote Server
+ ** Starting Services **
+ NAME IP PORT
+ httpejbd 0.0.0.0 4204
+ admin thread 0.0.0.0 4200
+ ejbd 0.0.0.0 4201
+ hsql 0.0.0.0 9001
+ telnet 0.0.0.0 4202
+ -------
+ Ready!
+....
+
+##4. Write an EJB
+
+In the EJB project create a new interface named Greeting
+
+....
+package com.myejbs;
+
+import javax.ejb.Remote;
+
+@Remote
+public interface Greeting {
+ public String greet();
+}
+....
+
+Now create a new class named GreetingBean which implements the above
+interface (shown below)
+
+....
+package com.myejbs;
+
+import javax.ejb.Stateless;
+
+@Stateless
+public class GreetingBean implements Greeting {
+
+ public String greet() {
+ return "My First Remote Stateless Session Bean";
+ }
+
+}
+....
+
+== 5. Deploy the EJB
+
+[arabic]
+. Export the EJBProject as a jar file. Name it greeting.jar and put it
+in the OPENEJB_HOME/apps directory.
+. Open the command prompt and type in the following command:
++
+d:-3.0.0-SNAPSHOT > bindeploy apps.jar
+
+This should give you the following output:
+
+....
+D:\openejb-3.0.0-SNAPSHOT>bin\openejb deploy apps\greeting.jar
+
+Application deployed successfully at \{0\}
+
+App(id=D:\openejb-3.0.0-SNAPSHOT\apps\greeting.jar)
+
+ EjbJar(id=greeting.jar, path=D:\openejb-3.0.0-SNAPSHOT\apps\greeting.jar)
+
+ Ejb(ejb-name=GreetingBean, id=GreetingBean)
+
+ Jndi(name=GreetingBeanRemote)
+....
+
+\{color:#330000}\{_}Notice the Jndi(name=GreetingBeanRemote)
+information. Keep this handy as this is the JNDI name of the bean which
+the client will use for lookup\{_}\{color}
+
+##6. Write the Client
+
+In the EJBClient project, create a class named Client (shown below)
+
+....
+package com.myclient;
+
+import com.myejbs.Greeting;
+
+import javax.naming.InitialContext;
+import java.util.Properties;
+
+public class Client {
+ public static void main(String[] args) {
+
+ try {
+ Properties p = new Properties();
+ p.put("java.naming.factory.initial", "org.openejb.client.RemoteInitialContextFactory");
+ p.put("java.naming.provider.url", "ejbd://127.0.0.1:4201");
+ InitialContext ctx = new InitialContext(p);
+ Greeting greeter = (Greeting) ctx.lookup("GreetingBeanRemote");
+ String message = greeter.greet();
+ System.out.println(message);
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+ }
+}
+....
+
+##7. Run the Client
+
+Open Client.java in eclipse and run it as a java application. You should
+see the following message in the console view:
+
+....
+My First Remote Stateless Session Bean
+....
+
+##8. Stop the server
+
+There are two ways to stop the server: 1. You can press Ctrl+c on the
+command prompt to stop the server 1. On the command prompt type in the
+following command:
+
+....
+D:\openejb-3.0.0-SNAPSHOT>bin\openejb stop
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/getting-started.md
----------------------------------------------------------------------
diff --git a/docs/getting-started.md b/docs/getting-started.md
deleted file mode 100644
index 4104749..0000000
--- a/docs/getting-started.md
+++ /dev/null
@@ -1,172 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Getting Started
-~~~~~~
-##The following instructions are written using Eclipse 3.2. We will
-refer to the install location of OpenEJB as OPENEJB_HOME
-
-Here are some basic steps you need to perform to get started with OpenEJB
-1. Download and install OpenEJB
-1. Setup your development environment
-1. Write an EJB
-1. Write an EJB client
-1. Start the server
-1. Deploy the EJB
-1. Run the client
-1. Stop the server
-
->
-
-<a name="GettingStarted- 1.DownloadandInstallOpenEJB"></a>
-##1. Download and Install OpenEJB
-
-Follow these [instructions](http://cwiki.apache.org/confluence/display/OPENEJB/Quickstart)
-
-<a name="GettingStarted- 2.Setupyourdevelopmentenvironment"></a>
-##2. Setup your development environment
-
-
-<a name="GettingStarted- Eclipse"></a>
-###Eclipse
-
-- Open eclipse and create a new java project. Name it EJBProject
-- Add the following jars to the build path of your project
--- OPENEJB_HOME/lib/geronimo-ejb_3.0_spec-1.0.jar
-- Now create another project named EJBClient. This is where we will write a test client
-- Add the following jars to the build path of this project
--- OPENEJB_HOME/lib/openejb-client-3.0.0-SNAPSHOT.jar
-- Add the EJBProject to the classpath of the EJBClient project
-
-<a name="GettingStarted- 3.StarttheServer"></a>
-##3. Start the Server
-
-Open the command prompt and run the following command:
-
- d:\openejb-3.0.0-SNAPSHOT\bin\openejb start
-
-You will get the following message on the console:
-
- D:\openejb-3.0.0-SNAPSHOT>bin\openejb start
- Apache OpenEJB 3.0.0-SNAPSHOT build: 20070830-07:53
- http://tomee.apache.org/
- OpenEJB ready.
- [OPENEJB:init]
- OpenEJB Remote Server
- ** Starting Services **
- NAME IP PORT
- httpejbd 0.0.0.0 4204
- admin thread 0.0.0.0 4200
- ejbd 0.0.0.0 4201
- hsql 0.0.0.0 9001
- telnet 0.0.0.0 4202
- -------
- Ready!
-
-
-<a name="GettingStarted- 4.WriteanEJB"></a>
-##4. Write an EJB
-
-In the EJB project create a new interface named Greeting
-
- package com.myejbs;
-
- import javax.ejb.Remote;
-
- @Remote
- public interface Greeting {
- public String greet();
- }
-
-Now create a new class named GreetingBean which implements the above
-interface (shown below)
-
- package com.myejbs;
-
- import javax.ejb.Stateless;
-
- @Stateless
- public class GreetingBean implements Greeting {
-
- public String greet() {
- return "My First Remote Stateless Session Bean";
- }
-
- }
-
-
-<a name="GettingStarted- 5.DeploytheEJB"></a>
-## 5. Deploy the EJB
-
-1. Export the EJBProject as a jar file. Name it greeting.jar and put it in
-the OPENEJB_HOME/apps directory.
-1. Open the command prompt and type in the following command:
-
-
- d:\openejb-3.0.0-SNAPSHOT > bin\openejb deploy apps\greeting.jar
-
-This should give you the following output:
-
- D:\openejb-3.0.0-SNAPSHOT>bin\openejb deploy apps\greeting.jar
-
- Application deployed successfully at \{0\}
-
- App(id=D:\openejb-3.0.0-SNAPSHOT\apps\greeting.jar)
-
- EjbJar(id=greeting.jar, path=D:\openejb-3.0.0-SNAPSHOT\apps\greeting.jar)
-
- Ejb(ejb-name=GreetingBean, id=GreetingBean)
-
- Jndi(name=GreetingBeanRemote)
-
-{color:#330000}{*}Notice the Jndi(name=GreetingBeanRemote) information.
-Keep this handy as this is the JNDI name of the bean which the client will
-use for lookup{*}{color}
-
-<a name="GettingStarted- 6.WritetheClient"></a>
-##6. Write the Client
-
-In the EJBClient project, create a class named Client (shown below)
-
- package com.myclient;
-
- import com.myejbs.Greeting;
-
- import javax.naming.InitialContext;
- import java.util.Properties;
-
- public class Client {
- public static void main(String[] args) {
-
- try {
- Properties p = new Properties();
- p.put("java.naming.factory.initial", "org.openejb.client.RemoteInitialContextFactory");
- p.put("java.naming.provider.url", "ejbd://127.0.0.1:4201");
- InitialContext ctx = new InitialContext(p);
- Greeting greeter = (Greeting) ctx.lookup("GreetingBeanRemote");
- String message = greeter.greet();
- System.out.println(message);
- } catch (Exception e) {
- e.printStackTrace();
- }
- }
- }
-
-
-<a name="GettingStarted- 7.RuntheClient"></a>
-##7. Run the Client
-
-Open Client.java in eclipse and run it as a java application. You should
-see the following message in the console view:
-
- My First Remote Stateless Session Bean
-
-
-<a name="GettingStarted- 8.Stoptheserver"></a>
-##8. Stop the server
-
-There are two ways to stop the server:
-1. You can press Ctrl+c on the command prompt to stop the server
-1. On the command prompt type in the following command:
-
- D:\openejb-3.0.0-SNAPSHOT>bin\openejb stop
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/hello-world.adoc
----------------------------------------------------------------------
diff --git a/docs/hello-world.adoc b/docs/hello-world.adoc
new file mode 100644
index 0000000..6d4871f
--- /dev/null
+++ b/docs/hello-world.adoc
@@ -0,0 +1,247 @@
+# Hello World
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+This page shows the basic steps required to create, build, and
+run an EJB and EJB client in its most minimum form. It does not hide
+steps or rely on special build tools or IDEs and is about the most
+stripped down you can get.
+
+_See the link:examples.html[Examples] page for a full list of examples
+that range from [@Stateles|Simple Stateless Example] and
+[@Stateful|Simple Stateful Example] beans, to [Dependency
+Injection|Injection of env-entry Example] , JDBC [DataSources|Injection
+of DataSource Example] , JPA [EntityManagers|Injection of EntityManager
+Example] and more._
+
+== A basic EJB example
+
+Here are some basic steps you need to perform to get started with
+OpenEJB
+
+[arabic]
+. Download and install OpenEJB
+. Setup your development environment
+. Write an EJB
+. Write an EJB client
+. Start the server
+. Deploy the EJB
+. Run the client
+. Stop the server
+
+== Download and install OpenEJB
+
+This example pertains to OpenEJB 3.0 which can be
+http://archive.apache.org/dist/openejb/3.0[downloaded here] . Once you
+have downloaded OpenEJB, you can then simply extract the contents of the
+downloaded file to whichever directory you want to install OpenEJB in.
+
+After extracting the file contents, you should now see a directory named
+openejb-3.0. If you look under this directory, you will find a few more
+directories: - _bin_: Contains commands to start/stop the server (You
+can also do a lot of other stuff like deploy/undeploy, but we will just
+talk about things needed to get you started) - _lib_: Contains several
+jar files (you only need of few of these jars in your classpath to do
+EJB development) - _apps_: Once you create your EJB's and jar them up,
+you can place your jar file in this directory and start the server. The
+server will automatically deploy all the EJB's contained in this JAR. -
+_conf_: This directory contains all the configuration files. Although
+you may not see any file except for a README.txt file right now, but
+after you start the server, the required configuration files will be
+automatically created. It is highly recommeded to read the README.txt
+file under this directory - _logs_: Contains log files.
+
+== Setup your development environment
+
+=== Create a working directory Assuming you are in your home directory,
+create a directory named projects
+
+....
+karan@poweredge:~$ mkdir projects
+....
+
+Go to the projects directory
+
+....
+karan@poweredge:~$ cd projects
+....
+
+We will do all our work in this directory. ### Install Java Download and
+install Java (version 5 or higher). Also set it up so that you can run
+the java and javac commands from any directory ### Set OPENEJB_HOME We
+will setup this variable to refer to the openejb install location.
+
+....
+karan@poweredge:~/projects$ export
+....
+
+OPENEJB_HOME=/home/karan/install/openejb-3.0
+
+== Write an EJB Whatever files you create should be placed under the
+projects directory ### Create the Remote Interface Using your favorite
+editor, create a file named Hello.java (shown below)
+
+....
+package org.acme;
+import javax.ejb.Remote;
+@Remote
+public interface Hello{
+ public String sayHello();
+}
+....
+
+=== Create the Bean Class Now create a file named HelloBean.java (shown
+below)
+
+....
+package org.acme;
+import javax.ejb.Stateless;
+@Stateless
+public class HelloBean implements Hello{
+ public String sayHello(){
+ return "Hello World!!!!";
+ }
+}
+....
+
+=== Compile the source code Since we have imported the
+javax.ejb.Stateless and javax.ejb.Remote annotations, we need these in
+our classpath to compile our source code. These annotations can be found
+in the $OPENEJB_HOME/lib/javaee-5.0-1.jar. Lets compile our source (make
+sure you are in the projects directory)
+
+....
+karan@poweredge:~/projects$ javac -cp $OPENEJB_HOME/lib/javaee-5.0-1.jar -d
+....
+
+. *.java
+
+The above will compile all the .java files and also create the required
+packages. You should now see a package named org under the projects
+directory. All class files should be under org/acme directory. ###
+Package the EJB To package the EJB into a JAR, run the following command
+while you are in the projects directory
+
+....
+karan@poweredge:~/projects$ jar cvf hello.jar org
+....
+
+The above command will package everything under the org directory
+(including the org directory itself) into a jar file named hello.jar.
+Below is the output from running the above command:
+
+....
+karan@poweredge:~/projects$ jar cvf hello.jar org
+added manifest
+adding: org/(in = 0) (out= 0)(stored 0%)
+adding: org/acme/(in = 0) (out= 0)(stored 0%)
+adding: org/acme/Hello.class(in = 203) (out= 168)(deflated 17%)
+adding: org/acme/HelloBean.class(in = 383) (out= 275)(deflated 28%)
+....
+
+== Write an EJB Client Now we will write a Client class which will
+lookup the EJB , invoke the sayHello() business method and print the
+value returned from the method. While you are in the projects directory,
+create a new file named HelloClient.java . Add the following to this
+file:
+
+....
+package org.acme;
+import java.util.Properties;
+import javax.naming.InitialContext;
+import javax.naming.Context;
+import javax.rmi.PortableRemoteObject;
+public class HelloClient{
+ public static void main(String[]
+....
+
+args) throws Exception\{ Properties props = new Properties();
+
+props.put(Context.INITIAL_CONTEXT_FACTORY,"org.apache.openejb.client.RemoteInitialContextFactory");
+props.put(Context.PROVIDER_URL,"ejbd://127.0.0.1:4201"); Context ctx =
+new InitialContext(props); Object ref = ctx.lookup("HelloBeanRemote");
+Hello h = (Hello)PortableRemoteObject.narrow(ref,Hello.class); String
+result = h.sayHello(); System.out.println(result); } }
+
+=== Compile HelloClient.java Run the following command:
+
+....
+karan@poweredge:~/projects$ javac -d . HelloClient.java
+....
+
+== Start the Server Go to the OpenEJB install directory (i.e.
+OPENEJB_HOME) and run the following command:
+
+....
+karan@poweredge:~/install/openejb-3.0$ bin/openejb start
+....
+
+Once the Server starts, you will see an output similar to the below in
+your console:
+
+....
+karan@poweredge:~/install/openejb-3.0$ bin/openejb start
+Apache OpenEJB 3.0 build: 20070926-12:34
+http://tomee.apache.org/
+OpenEJB ready.
+[OPENEJB:init]
+....
+
+OpenEJB Remote Server ** Starting Services ** NAME IP PORT +
+httpejbd 0.0.0.0 4204 +
+telnet 0.0.0.0 4202 +
+ejbd 0.0.0.0 4201 +
+hsql 0.0.0.0 9001 +
+admin thread 0.0.0.0 4200 +
+------- Ready!
+
+Take out a minute to browse through the conf and logs directories. You
+should now see some configuration and log files under the respective
+directories. ## Deploy the EJB We will now use the deploy command to
+deploy the EJB in hello.jar. While you are in the projects directory,
+run the following command:
+
+....
+karan@poweredge:~/projects$ $OPENEJB_HOME/bin/openejb deploy hello.jar
+....
+
+The above command should give you the following output:
+
+....
+karan@poweredge:~/projects$ $OPENEJB_HOME/bin/openejb deploy hello.jar
+Application deployed successfully at "hello.jar"
+App(id=/home/karan/projects/hello.jar)
+ EjbJar(id=hello.jar, path=/home/karan/projects/hello.jar)
+ Ejb(ejb-name=HelloBean, id=HelloBean)
+ Jndi(name=HelloBeanRemote)
+....
+
+Notice how the output neatly lays out various deployment details. One
+thing you might want to note from the output is the JNDI name. This is
+the JNDI name we used in the client to lookup the EJB ## Run the Client
+While you are in the projects directory, run the following command to
+run the client:
+
+....
+karan@poweredge:~/projects$ java -cp
+....
+
+latexmath:[$OPENEJB_HOME/lib/openejb-client-3.0.jar:$]OPENEJB_HOME/lib/javaee-5.0-1.jar:.
+org.acme.HelloClient
+
+The above should give you the following output:
+
+....
+Hello World!!!!
+....
+
+== Help! , it didn't work for me!!. No problem, we are here to help.
+Just send us an email at users@tomee.apache.org. If possible, send us
+the contents of logs/openejb.log file in the email.
+
+# Looking for more?
+
+More EJB 3.0 examples, sample applications, tutorials and howtos
+available link:examples.html[here] .
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/hello-world.md
----------------------------------------------------------------------
diff --git a/docs/hello-world.md b/docs/hello-world.md
deleted file mode 100644
index 1b08f95..0000000
--- a/docs/hello-world.md
+++ /dev/null
@@ -1,250 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Hello World
-~~~~~~
-This page shows the basic steps required to create, build, and run an EJB
-and EJB client in its most minimum form. It does not hide steps or rely on
-special build tools or IDEs and is about the most stripped down you can
-get.
-
-_See the [Examples](examples.html)
- page for a full list of examples that range from [@Stateles|Simple Stateless Example]
- and [@Stateful|Simple Stateful Example]
- beans, to [Dependency Injection|Injection of env-entry Example]
-, JDBC [DataSources|Injection of DataSource Example]
-, JPA [EntityManagers|Injection of EntityManager Example]
- and more._
-
-<a name="HelloWorld-AbasicEJBexample"></a>
-## A basic EJB example
-
-Here are some basic steps you need to perform to get started with OpenEJB
-
-1. Download and install OpenEJB
-1. Setup your development environment
-1. Write an EJB
-1. Write an EJB client
-1. Start the server
-1. Deploy the EJB
-1. Run the client
-1. Stop the server
-
-<a name="HelloWorld-DownloadandinstallOpenEJB"></a>
-## Download and install OpenEJB
-
-This example pertains to OpenEJB 3.0 which can be [downloaded here](http://archive.apache.org/dist/openejb/3.0)
-. Once you have downloaded OpenEJB, you can then simply extract the
-contents of the downloaded file to whichever directory you want to install
-OpenEJB in.
-
-After extracting the file contents, you should now see a directory named
-openejb-3.0. If you look under this directory, you will find a few more
-directories:
-- *bin*: Contains commands to start/stop the server (You can also do a lot
-of other stuff like deploy/undeploy, but we will just talk about things
-needed to get you started)
-- *lib*: Contains several jar files (you only need of few of these jars in
-your classpath to do EJB development)
-- *apps*: Once you create your EJB's and jar them up, you can place your
-jar file in this directory and start the server. The server will
-automatically deploy all the EJB's contained in this JAR.
-- *conf*: This directory contains all the configuration files. Although you
-may not see any file except for a README.txt file right now, but after you
-start the server, the required configuration files will be automatically
-created. It is highly recommeded to read the README.txt file under this
-directory
-- *logs*: Contains log files.
-
-<a name="HelloWorld-Setupyourdevelopmentenvironment"></a>
-## Setup your development environment
-
-<a name="HelloWorld-Createaworkingdirectory"></a>
-### Create a working directory
-Assuming you are in your home directory, create a directory named projects
-
- karan@poweredge:~$ mkdir projects
-
-Go to the projects directory
-
- karan@poweredge:~$ cd projects
-
-We will do all our work in this directory.
-<a name="HelloWorld-InstallJava"></a>
-### Install Java
-Download and install Java (version 5 or higher). Also set it up so that you
-can run the java and javac commands from any directory
-<a name="HelloWorld-SetOPENEJB_HOME"></a>
-### Set OPENEJB_HOME
-We will setup this variable to refer to the openejb install location.
-
- karan@poweredge:~/projects$ export
-OPENEJB_HOME=/home/karan/install/openejb-3.0
-
-<a name="HelloWorld-WriteanEJB"></a>
-## Write an EJB
-Whatever files you create should be placed under the projects directory
-<a name="HelloWorld-CreatetheRemoteInterface"></a>
-### Create the Remote Interface
-Using your favorite editor, create a file named Hello.java (shown below)
-
- package org.acme;
- import javax.ejb.Remote;
- @Remote
- public interface Hello{
- public String sayHello();
- }
-
-
-<a name="HelloWorld-CreatetheBeanClass"></a>
-### Create the Bean Class
-Now create a file named HelloBean.java (shown below)
-
- package org.acme;
- import javax.ejb.Stateless;
- @Stateless
- public class HelloBean implements Hello{
- public String sayHello(){
- return "Hello World!!!!";
- }
- }
-
-
-<a name="HelloWorld-Compilethesourcecode"></a>
-### Compile the source code
-Since we have imported the javax.ejb.Stateless and javax.ejb.Remote
-annotations, we need these in our classpath to compile our source code.
-These annotations can be found in the $OPENEJB_HOME/lib/javaee-5.0-1.jar.
-Lets compile our source (make sure you are in the projects directory)
-
- karan@poweredge:~/projects$ javac -cp $OPENEJB_HOME/lib/javaee-5.0-1.jar -d
-. *.java
-
-The above will compile all the .java files and also create the required
-packages. You should now see a package named org under the projects
-directory. All class files should be under org/acme directory.
-<a name="HelloWorld-PackagetheEJB"></a>
-### Package the EJB
-To package the EJB into a JAR, run the following command while you are in
-the projects directory
-
- karan@poweredge:~/projects$ jar cvf hello.jar org
-
-The above command will package everything under the org directory
-(including the org directory itself) into a jar file named hello.jar. Below
-is the output from running the above command:
-
- karan@poweredge:~/projects$ jar cvf hello.jar org
- added manifest
- adding: org/(in = 0) (out= 0)(stored 0%)
- adding: org/acme/(in = 0) (out= 0)(stored 0%)
- adding: org/acme/Hello.class(in = 203) (out= 168)(deflated 17%)
- adding: org/acme/HelloBean.class(in = 383) (out= 275)(deflated 28%)
-
-<a name="HelloWorld-WriteanEJBClient"></a>
-## Write an EJB Client
-Now we will write a Client class which will lookup the EJB , invoke the
-sayHello() business method and print the value returned from the method.
-While you are in the projects directory, create a new file named
-HelloClient.java . Add the following to this file:
-
- package org.acme;
- import java.util.Properties;
- import javax.naming.InitialContext;
- import javax.naming.Context;
- import javax.rmi.PortableRemoteObject;
- public class HelloClient{
- public static void main(String[]
- args) throws Exception{
- Properties props = new Properties();
-
-props.put(Context.INITIAL_CONTEXT_FACTORY,"org.apache.openejb.client.RemoteInitialContextFactory");
- props.put(Context.PROVIDER_URL,"ejbd://127.0.0.1:4201");
- Context ctx = new InitialContext(props);
- Object ref = ctx.lookup("HelloBeanRemote");
- Hello h =
-(Hello)PortableRemoteObject.narrow(ref,Hello.class);
- String result = h.sayHello();
- System.out.println(result);
- }
- }
-
-
-<a name="HelloWorld-CompileHelloClient.java"></a>
-### Compile HelloClient.java
-Run the following command:
-
- karan@poweredge:~/projects$ javac -d . HelloClient.java
-
-<a name="HelloWorld-StarttheServer"></a>
-## Start the Server
-Go to the OpenEJB install directory (i.e. OPENEJB_HOME) and run the
-following command:
-
- karan@poweredge:~/install/openejb-3.0$ bin/openejb start
-
-Once the Server starts, you will see an output similar to the below in your
-console:
-
- karan@poweredge:~/install/openejb-3.0$ bin/openejb start
- Apache OpenEJB 3.0 build: 20070926-12:34
- http://tomee.apache.org/
- OpenEJB ready.
- [OPENEJB:init]
- OpenEJB Remote Server
- ** Starting Services **
- NAME IP PORT
- httpejbd 0.0.0.0 4204
- telnet 0.0.0.0 4202
- ejbd 0.0.0.0 4201
- hsql 0.0.0.0 9001
- admin thread 0.0.0.0 4200
- -------
- Ready!
-
-Take out a minute to browse through the conf and logs directories. You
-should now see some configuration and log files under the respective
-directories.
-<a name="HelloWorld-DeploytheEJB"></a>
-## Deploy the EJB
-We will now use the deploy command to deploy the EJB in hello.jar. While
-you are in the projects directory, run the following command:
-
- karan@poweredge:~/projects$ $OPENEJB_HOME/bin/openejb deploy hello.jar
-
-The above command should give you the following output:
-
- karan@poweredge:~/projects$ $OPENEJB_HOME/bin/openejb deploy hello.jar
- Application deployed successfully at "hello.jar"
- App(id=/home/karan/projects/hello.jar)
- EjbJar(id=hello.jar, path=/home/karan/projects/hello.jar)
- Ejb(ejb-name=HelloBean, id=HelloBean)
- Jndi(name=HelloBeanRemote)
-
-Notice how the output neatly lays out various deployment details. One thing
-you might want to note from the output is the JNDI name. This is the JNDI
-name we used in the client to lookup the EJB
-<a name="HelloWorld-RuntheClient"></a>
-## Run the Client
-While you are in the projects directory, run the following command to run
-the client:
-
- karan@poweredge:~/projects$ java -cp
-$OPENEJB_HOME/lib/openejb-client-3.0.jar:$OPENEJB_HOME/lib/javaee-5.0-1.jar:.
- org.acme.HelloClient
-
-The above should give you the following output:
-
- Hello World!!!!
-
-<a name="HelloWorld-Help!,itdidn'tworkforme!!."></a>
-## Help! , it didn't work for me!!.
-No problem, we are here to help. Just send us an email at
-users@tomee.apache.org. If possible, send us the contents of
-logs/openejb.log file in the email.
-
-<a name="HelloWorld-Lookingformore?"></a>
-# Looking for more?
-
-More EJB 3.0 examples, sample applications, tutorials and howtos available [here](examples.html)
-.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/hibernate.adoc
----------------------------------------------------------------------
diff --git a/docs/hibernate.adoc b/docs/hibernate.adoc
new file mode 100644
index 0000000..3c60aa3
--- /dev/null
+++ b/docs/hibernate.adoc
@@ -0,0 +1,101 @@
+# Hibernate
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Sample persistence.xml
+
+For a unit called "movie-unit" using two datasources called
+"movieDatabase" and "movieDatabaseUnmanaged" the following
+persistence.xml would work.
+
+....
+<persistence version="1.0"
+ xmlns="http://java.sun.com/xml/ns/persistence"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
+ http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd">
+
+ <persistence-unit name="movie-unit">
+ <provider>org.hibernate.ejb.HibernatePersistence</provider>
+ <jta-data-source>movieDatabase</jta-data-source>
+ <non-jta-data-source>movieDatabaseUnmanaged</non-jta-data-source>
+
+ <properties>
+ <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
+ <property name="hibernate.transaction.manager_lookup_class"
+ value="org.apache.openejb.hibernate.TransactionManagerLookup"/>
+ </properties>
+ </persistence-unit>
+</persistence>
+....
+
+Note that as of OpenEJB 3.1 you do not need to set the
+`hibernate.transaction.manager_lookup_class` as it will be set for you
+automatically and will overwrite any "org.hibernate.transaction."
+strategy class already set while leaving any custom strategy class you
+may have implemented untouched.
+
+The result is that you can leave your
+`hibernate.transaction.manager_lookup_class` property configured to your
+production environment and OpenEJB will update it just for the scope
+testing. On the other hand if you have implemented a custom
+`org.hibernate.transaction.TransactionManagerLookup` strategy it will
+always be used and never replaced by OpenEJB.
+
+Note that if you need more functionality in this area we are always
+happy to add it.
+
+== Not using OpenEJB in production?
+
+If you're using OpenEJB 3.0 which does not support the dynamic switching
+of the `hibernate.transaction.manager_lookup_class` this is one way to
+achieve it.
+
+A custom implementation of Hibernate's _TransactionManagerLookup_
+strategy like the following will do the trick. This
+"DynamicTransactionManagerLookup" class can be packed in your jar and
+deployed with your app.
+
+....
+import org.hibernate.HibernateException;
+import org.hibernate.transaction.TransactionManagerLookup;
+import javax.transaction.TransactionManager;
+import java.util.Properties;
+
+public class DynamicTransactionManagerLookup implements TransactionManagerLookup {
+
+ private TransactionManagerLookup impl;
+
+ public DynamicTransactionManagerLookup() {
+ String[] strategies = {
+ "org.apache.openejb.hibernate.TransactionManagerLookup",
+ "org.hibernate.transaction.JBossTransactionManagerLookup"
+ };
+
+ for (String className : strategies) {
+ try {
+ Class<?> clazz = this.getClass().getClassLoader().loadClass(className);
+ impl = (TransactionManagerLookup) clazz.newInstance();
+ break;
+ } catch (Exception e) {
+ }
+ }
+
+ if (impl == null) throw new IllegalStateException("No TransactionManagerLookup available");
+ }
+
+ public TransactionManager getTransactionManager(Properties properties) throws HibernateException {
+ return impl.getTransactionManager(properties);
+ }
+
+ public String getUserTransactionName() {
+ return impl.getUserTransactionName();
+ }
+}
+....
+
+Then set the Hibernate specific configuration property
+_hibernate.transaction.manager_lookup_class_ to the name of the factory
+that you just created.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/hibernate.md
----------------------------------------------------------------------
diff --git a/docs/hibernate.md b/docs/hibernate.md
deleted file mode 100644
index 1e1f124..0000000
--- a/docs/hibernate.md
+++ /dev/null
@@ -1,98 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Hibernate
-~~~~~~
-<a name="Hibernate-Samplepersistence.xml"></a>
-# Sample persistence.xml
-
-For a unit called "movie-unit" using two datasources called "movieDatabase"
-and "movieDatabaseUnmanaged" the following persistence.xml would work.
-
- <persistence version="1.0"
- xmlns="http://java.sun.com/xml/ns/persistence"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
- http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd">
-
- <persistence-unit name="movie-unit">
- <provider>org.hibernate.ejb.HibernatePersistence</provider>
- <jta-data-source>movieDatabase</jta-data-source>
- <non-jta-data-source>movieDatabaseUnmanaged</non-jta-data-source>
-
- <properties>
- <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
- <property name="hibernate.transaction.manager_lookup_class"
- value="org.apache.openejb.hibernate.TransactionManagerLookup"/>
- </properties>
- </persistence-unit>
- </persistence>
-
-
-Note that as of OpenEJB 3.1 you do not need to set the
-`hibernate.transaction.manager_lookup_class` as it will be set for you
-automatically and will overwrite any "org.hibernate.transaction." strategy
-class already set while leaving any custom strategy class you may have
-implemented untouched.
-
-The result is that you can leave your
-`hibernate.transaction.manager_lookup_class` property configured to your
-production environment and OpenEJB will update it just for the scope
-testing. On the other hand if you have implemented a custom
-`org.hibernate.transaction.TransactionManagerLookup` strategy it will
-always be used and never replaced by OpenEJB.
-
-Note that if you need more functionality in this area we are always happy
-to add it.
-
-# Not using OpenEJB in production?
-
-If you're using OpenEJB 3.0 which does not support the dynamic switching of
-the `hibernate.transaction.manager_lookup_class` this is one way to achieve
-it.
-
-A custom implementation of Hibernate's *TransactionManagerLookup* strategy
-like the following will do the trick. This
-"DynamicTransactionManagerLookup" class can be packed in your jar and
-deployed with your app.
-
- import org.hibernate.HibernateException;
- import org.hibernate.transaction.TransactionManagerLookup;
- import javax.transaction.TransactionManager;
- import java.util.Properties;
-
- public class DynamicTransactionManagerLookup implements TransactionManagerLookup {
-
- private TransactionManagerLookup impl;
-
- public DynamicTransactionManagerLookup() {
- String[] strategies = {
- "org.apache.openejb.hibernate.TransactionManagerLookup",
- "org.hibernate.transaction.JBossTransactionManagerLookup"
- };
-
- for (String className : strategies) {
- try {
- Class<?> clazz = this.getClass().getClassLoader().loadClass(className);
- impl = (TransactionManagerLookup) clazz.newInstance();
- break;
- } catch (Exception e) {
- }
- }
-
- if (impl == null) throw new IllegalStateException("No TransactionManagerLookup available");
- }
-
- public TransactionManager getTransactionManager(Properties properties) throws HibernateException {
- return impl.getTransactionManager(properties);
- }
-
- public String getUserTransactionName() {
- return impl.getUserTransactionName();
- }
- }
-
-
-Then set the Hibernate specific configuration property
-*hibernate.transaction.manager_lookup_class* to the name of the factory
-that you just created.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/initialcontext-config.adoc
----------------------------------------------------------------------
diff --git a/docs/initialcontext-config.adoc b/docs/initialcontext-config.adoc
new file mode 100644
index 0000000..0dbd7c4
--- /dev/null
+++ b/docs/initialcontext-config.adoc
@@ -0,0 +1,42 @@
+# InitialContext Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A InitialContext can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<JndiProvider id="myInitialContext" type="javax.naming.InitialContext">
+</JndiProvider>
+....
+
+Alternatively, a InitialContext can be declared via properties in the
+`<tomee-home>/conf/system.properties` file or via Java VirtualMachine
+`-D` properties. The properties can also be used when embedding TomEE
+via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
+
+....
+myInitialContext = new://JndiProvider?type=javax.naming.InitialContext
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared InitialContext a
+warning will be logged. If a InitialContext is needed by the application
+and one is not declared, TomEE will create one dynamically using default
+settings. Multiple InitialContext declarations are allowed. # Supported
+Properties
+
+Property
+
+Type
+
+Default
+
+Description
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/initialcontext-config.md
----------------------------------------------------------------------
diff --git a/docs/initialcontext-config.md b/docs/initialcontext-config.md
deleted file mode 100644
index 8e60fbb..0000000
--- a/docs/initialcontext-config.md
+++ /dev/null
@@ -1,26 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=InitialContext Configuration
-~~~~~~
-
-
-A InitialContext can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <JndiProvider id="myInitialContext" type="javax.naming.InitialContext">
- </JndiProvider>
-
-Alternatively, a InitialContext can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myInitialContext = new://JndiProvider?type=javax.naming.InitialContext
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared InitialContext a warning will be logged. If a InitialContext is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple InitialContext declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/installation-drop-in-war.adoc
----------------------------------------------------------------------
diff --git a/docs/installation-drop-in-war.adoc b/docs/installation-drop-in-war.adoc
new file mode 100644
index 0000000..127d7e4
--- /dev/null
+++ b/docs/installation-drop-in-war.adoc
@@ -0,0 +1,55 @@
+:index-group: Tips
+and Tricks
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: Installing TomEE using the drop-in .war approach
+
+NOTE: Licensed to the
+Apache Software Foundation (ASF) under one or more contributor license
+agreements. See the NOTICE file distributed with this work for
+additional information regarding copyright ownership. The ASF licenses
+this file to you 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.
+
+If you prefer, TomEE can be setup by deploying a .war file into an
+existing Tomcat 7.x installation, as opposed to using the all-in-one
+bundle. This guide provides a set of step-by-step instructions to this
+approach. Please note that TomEE 1.7.x does not recommend Tomcat
+versions less than 7.0.54. Tomcat 8 is not currently supported in the
+released version, but you can check out the developer branch to see
+progress link:dev/source-code.html[here].
+
+* Download the Apache Tomcat 7.0.55 server.
+http://tomcat.apache.org/download-70.cgi
+* Unzip the Tomcat distribution file.
+* Update $CATALINA_HOME/conf/tomcat-users.xml to add a tomee user to
+allow access to the installer page.
++
+....
+ <!-- Activate/create these lines to get access to TomEE GUI -->
+ <role rolename="tomee-admin" />
+ <user username="tomee" password="tomee" roles="tomee-admin" />
+....
+* Download the .war file you wish to use - either the
+tomee-webapp-1.7.1.war (for the webprofile installation) or
+tomee-webapp-plus-1.7.1.war (for the plus version).
+* Copy and rename the .war file to $CATALINA_HOME/webapps/tomee.war (the
+.war filename is important).
+* Start Tomcat.
+* Go to the TomEE installer webapp (http://localhost:8080/tomee/) and
+login with the user you added to tomcat-users.xml.
+* Verify the values and click "Confirm".
+
+image:http://people.apache.org/~tveronezi/tomee/tomee_site/tomee_installer.png[alt
+text]
+
+* Restart Tomcat.
+* Your TomEE installation is now complete!
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/installation-drop-in-war.md
----------------------------------------------------------------------
diff --git a/docs/installation-drop-in-war.md b/docs/installation-drop-in-war.md
deleted file mode 100644
index b5191b6..0000000
--- a/docs/installation-drop-in-war.md
+++ /dev/null
@@ -1,45 +0,0 @@
-index-group=Tips and Tricks
-type=page
-status=published
-title=Installing TomEE using the drop-in .war approach
-~~~~~~
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-If you prefer, TomEE can be setup by deploying a .war file into an existing Tomcat 7.x installation, as opposed to using the all-in-one bundle. This guide provides a set of step-by-step instructions to this approach. Please note that TomEE 1.7.x does not recommend Tomcat versions less than 7.0.54. Tomcat 8 is not currently supported in the released version, but you can check out the developer branch to see progress [here](dev/source-code.html).
-
- - Download the Apache Tomcat 7.0.55 server. <a href="http://tomcat.apache.org/download-70.cgi" target="_blank">http://tomcat.apache.org/download-70.cgi</a>
- - Unzip the Tomcat distribution file.
- - Update $CATALINA_HOME/conf/tomcat-users.xml to add a tomee user to allow access to the installer page.
-
- <!-- Activate/create these lines to get access to TomEE GUI -->
- <role rolename="tomee-admin" />
- <user username="tomee" password="tomee" roles="tomee-admin" />
-
- - Download the .war file you wish to use - either the tomee-webapp-1.7.1.war (for the webprofile installation) or tomee-webapp-plus-1.7.1.war (for the plus version).
- - Copy and rename the .war file to $CATALINA_HOME/webapps/tomee.war (the .war filename is important).
- - Start Tomcat.
- - Go to the TomEE installer webapp (<a href="http://localhost:8080/tomee/">http://localhost:8080/tomee/</a>) and login with the user you added to tomcat-users.xml.
- - Verify the values and click "Confirm".
-
- ![alt text][1]
-
- - Restart Tomcat.
- - Your TomEE installation is now complete!
-
-
- [1]: http://people.apache.org/~tveronezi/tomee/tomee_site/tomee_installer.png
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/installation.adoc
----------------------------------------------------------------------
diff --git a/docs/installation.adoc b/docs/installation.adoc
new file mode 100644
index 0000000..6a2cde2
--- /dev/null
+++ b/docs/installation.adoc
@@ -0,0 +1,35 @@
+# Installation
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Installation
+
+Installation is easiest from an update site. In Eclipse, select Help,
+Software Updates, Find and install...
+
+!http://jrg.me.uk/openejb/install_step_1.jpg!
+
+Select 'Search for new features to install'
+
+!http://jrg.me.uk/openejb/install_step_2.jpg!
+
+Select 'New Remote site'. Enter 'OpenEJB' for the name and
+http://people.apache.org/~jgallimore/update-site/ for the URL. Click
+'Ok' and make sure your new update site is selected. Then select
+'Finish'
+
+!http://jrg.me.uk/openejb/install_step_3.jpg!
+
+Check the box to install the OpenEJB feature. Click 'Next'
+
+!http://jrg.me.uk/openejb/install_step_4.jpg!
+
+Read and make sure you're happy with the license agreement.
+
+Check the installation location, and change it if you wish to. Select
+'Finish'.
+
+Restarting the workbench when the installation is finished is
+recommended.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/installation.md
----------------------------------------------------------------------
diff --git a/docs/installation.md b/docs/installation.md
deleted file mode 100644
index ec92778..0000000
--- a/docs/installation.md
+++ /dev/null
@@ -1,34 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Installation
-~~~~~~
-<a name="Installation-Installation"></a>
-# Installation
-
-Installation is easiest from an update site. In Eclipse, select Help,
-Software Updates, Find and install...
-
-!http://jrg.me.uk/openejb/install_step_1.jpg!
-
-Select 'Search for new features to install'
-
-!http://jrg.me.uk/openejb/install_step_2.jpg!
-
-Select 'New Remote site'. Enter 'OpenEJB' for the name and
-http://people.apache.org/~jgallimore/update-site/ for the URL. Click 'Ok'
-and make sure your new update site is selected. Then select 'Finish'
-
-!http://jrg.me.uk/openejb/install_step_3.jpg!
-
-Check the box to install the OpenEJB feature. Click 'Next'
-
-!http://jrg.me.uk/openejb/install_step_4.jpg!
-
-
-Read and make sure you're happy with the license agreement.
-
-Check the installation location, and change it if you wish to. Select
-'Finish'.
-
-Restarting the workbench when the installation is finished is recommended.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/installing-tomee.adoc
----------------------------------------------------------------------
diff --git a/docs/installing-tomee.adoc b/docs/installing-tomee.adoc
new file mode 100644
index 0000000..774cfae
--- /dev/null
+++ b/docs/installing-tomee.adoc
@@ -0,0 +1,83 @@
+# Installing TomEE
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+NOTE: Licensed to the Apache Software Foundation (ASF) under
+one or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information regarding
+copyright ownership. The ASF licenses this file to you 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.
+
+== Downloading a Distribution Archive
+
+Download a distribution archive of the latest TomEE release from the
+link:downloads.html[Downloads] page. If you are not sure which one to
+use, take apache-tomee-webprofile-x.y.z.zip.
+
+If you want to try out the latest development snapshot (e.g. to test a
+bugfix which has not yet been released), then download an archive
+directly from the
+https://repository.apache.org/content/groups/snapshots/org/apache/openejb/apache-tomee[Apache
+Maven Snapshots Repository] instead.
+
+The instructions on this page work with the webprofile distribution but
+apply to all TomEE distributions (webprofile, jaxrs or plus). If you
+work with the jaxrs or plus distribution, simply replace the name where
+appropriate.
+
+== Unpacking the Archive
+
+Unpack the archive in any directory. The top-level directory of the
+unpacked archive is called apache-tomee-webprofile-x.y.z/. We refer to
+this directory as $CATALINA_HOME in the following.
+
+== Prerequisites for Running TomEE
+
+* A Java 6 or 7 runtime environment is in your PATH.
+* TCP ports 8080, 8005 and 8009 are free.
+
+== Starting TomEE
+
+To start TomEE as a background process, invoke
+
+....
+$CATALINA_HOME/bin/startup.sh
+....
+
+To start TomEE in foreground, invoke
+
+....
+$CATALINA_HOME/bin/catalina.sh run
+....
+
+== Log Messages
+
+When running TomEE in foreground, it will print all log messages to the
+console.
+
+When running TomEE in background, it will only print a couple of
+environment variables. The log messages go to a file
+
+....
+$CATALINA_HOME/logs/catalina.out
+....
+
+== Stopping TomEE
+
+To stop TomEE, invoke
+
+....
+$CATALINA_HOME/bin/shutdown.sh
+....
+
+If you started TomEE in foreground via `catalina.sh run`, it is safe to
+simply type `Ctrl-C`.
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/installing-tomee.md
----------------------------------------------------------------------
diff --git a/docs/installing-tomee.md b/docs/installing-tomee.md
deleted file mode 100644
index ed0b5ac..0000000
--- a/docs/installing-tomee.md
+++ /dev/null
@@ -1,71 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Installing TomEE
-~~~~~~
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-# Downloading a Distribution Archive
-
-Download a distribution archive of the latest TomEE release from the [Downloads](downloads.html) page.
-If you are not sure which one to use, take apache-tomee-webprofile-x.y.z.zip.
-
-If you want to try out the latest development snapshot (e.g. to test a bugfix which has not yet been released), then download an
-archive directly from the [Apache Maven Snapshots Repository][1] instead.
-
-The instructions on this page work with the webprofile distribution but apply to all TomEE distributions (webprofile, jaxrs or plus).
-If you work with the jaxrs or plus distribution, simply replace the name where appropriate.
-
-# Unpacking the Archive
-
-Unpack the archive in any directory. The top-level directory of the unpacked archive is called apache-tomee-webprofile-x.y.z/.
-We refer to this directory as $CATALINA_HOME in the following.
-
-# Prerequisites for Running TomEE
-
-* A Java 6 or 7 runtime environment is in your PATH.
-* TCP ports 8080, 8005 and 8009 are free.
-
-# Starting TomEE
-
-To start TomEE as a background process, invoke
-
- $CATALINA_HOME/bin/startup.sh
-
-To start TomEE in foreground, invoke
-
- $CATALINA_HOME/bin/catalina.sh run
-
-# Log Messages
-
-When running TomEE in foreground, it will print all log messages to the console.
-
-When running TomEE in background, it will only print a couple of environment variables. The log messages go to a file
-
- $CATALINA_HOME/logs/catalina.out
-
-# Stopping TomEE
-
-To stop TomEE, invoke
-
- $CATALINA_HOME/bin/shutdown.sh
-
-If you started TomEE in foreground via `catalina.sh run`, it is safe to simply type `Ctrl-C`.
-
-
- [1]: https://repository.apache.org/content/groups/snapshots/org/apache/openejb/apache-tomee
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/java7.adoc
----------------------------------------------------------------------
diff --git a/docs/java7.adoc b/docs/java7.adoc
new file mode 100644
index 0000000..71b15dd
--- /dev/null
+++ b/docs/java7.adoc
@@ -0,0 +1,40 @@
+# TomEE and Java 7
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+NOTE: Licensed to the Apache Software Foundation (ASF) under
+one or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information regarding
+copyright ownership. The ASF licenses this file to you 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.
+
+If you compile your applications on JDK7 you have to run Apache TomEE
+1.0 on jdk7
+
+== Configuring TomEE to use JDK7
+
+If you have multiple JDK installed on your system you should set
+JAVA_HOME in your stratup scripts. For example if your `JAVA_HOME` is
+`/usr/local/java/current` edit `catalina.sh` and add a line
+
+`JAVA_HOME=/usr/local/java/current/bin`
+
+Alternatively, set `JAVA_HOME` as an environment variable prior to
+calling `<tomee-home>/bin/startup.sh`
+
+== Endorsed libraries directory
+
+TomEE 1.0 package comes with and "endorsed" direcotry which contains
+updates for core JDK6 libraries. If you are running JDK7 you should
+remove al files in this directory.
+
+TomEE 1.1 will detect JDK7 and will not load those files
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/java7.md
----------------------------------------------------------------------
diff --git a/docs/java7.md b/docs/java7.md
deleted file mode 100644
index e9e0898..0000000
--- a/docs/java7.md
+++ /dev/null
@@ -1,40 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=TomEE and Java 7
-~~~~~~
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-If you compile your applications on JDK7 you have to run Apache TomEE 1.0 on jdk7
-
-Configuring TomEE to use JDK7
--------
-If you have multiple JDK installed on your system you should set JAVA_HOME in your stratup scripts.
-For example if your `JAVA_HOME` is `/usr/local/java/current` edit `catalina.sh`
-and add a line
-
-`JAVA_HOME=/usr/local/java/current/bin`
-
-Alternatively, set `JAVA_HOME` as an environment variable prior to calling `<tomee-home>/bin/startup.sh`
-
-Endorsed libraries directory
--------
-TomEE 1.0 package comes with and "endorsed" direcotry which contains updates for core JDK6 libraries.
-If you are running JDK7 you should remove al files in this directory.
-
-TomEE 1.1 will detect JDK7 and will not load those files
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/javaagent-with-maven-surefire.adoc
----------------------------------------------------------------------
diff --git a/docs/javaagent-with-maven-surefire.adoc b/docs/javaagent-with-maven-surefire.adoc
new file mode 100644
index 0000000..eaa3f42
--- /dev/null
+++ b/docs/javaagent-with-maven-surefire.adoc
@@ -0,0 +1,35 @@
+# JavaAgent with Maven Surefire
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+== Maven2
+
+In maven2 you can enable the javaagent for your tests by adding this to
+your pom.xml file:
+
+....
+<build>
+ <plugins>
+ <!-- this configures the surefire plugin to run your tests with the
+....
+
+javaagent enabled --> org.apache.maven.plugins maven-surefire-plugin
+pertest
+
+-javaagent:latexmath:[${basedir}/target/openejb-javaagent-3.0.jar</argLine> <workingDirectory>$]\{basedir}/target
+
+....
+ <!-- this tells maven to copy the openejb-javaagent jar into your
+....
+
+target/ directory --> org.apache.maven.plugins maven-dependency-plugin
+copy process-resources copy org.apache.openejb openejb-javaagent 3.0
+
+$\{project.build.directory}
+
+....
+ </plugins>
+</build>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/javaagent-with-maven-surefire.md
----------------------------------------------------------------------
diff --git a/docs/javaagent-with-maven-surefire.md b/docs/javaagent-with-maven-surefire.md
deleted file mode 100644
index 2d769aa..0000000
--- a/docs/javaagent-with-maven-surefire.md
+++ /dev/null
@@ -1,57 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=JavaAgent with Maven Surefire
-~~~~~~
-<a name="JavaAgentwithMavenSurefire-Maven2"></a>
-## Maven2
-
-In maven2 you can enable the javaagent for your tests by adding this to
-your pom.xml file:
-
-
- <build>
- <plugins>
- <!-- this configures the surefire plugin to run your tests with the
-javaagent enabled -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- <configuration>
- <forkMode>pertest</forkMode>
-
-<argLine>-javaagent:${basedir}/target/openejb-javaagent-3.0.jar</argLine>
- <workingDirectory>${basedir}/target</workingDirectory>
- </configuration>
- </plugin>
-
- <!-- this tells maven to copy the openejb-javaagent jar into your
-target/ directory -->
- <!-- where surefire can see it -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-dependency-plugin</artifactId>
- <executions>
- <execution>
- <id>copy</id>
- <phase>process-resources</phase>
- <goals>
- <goal>copy</goal>
- </goals>
- <configuration>
- <artifactItems>
- <artifactItem>
- <groupId>org.apache.openejb</groupId>
- <artifactId>openejb-javaagent</artifactId>
- <version>3.0</version>
-
-<outputDirectory>${project.build.directory}</outputDirectory>
- </artifactItem>
- </artifactItems>
- </configuration>
- </execution>
- </executions>
- </plugin>
-
- </plugins>
- </build>
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/javaagent.adoc
----------------------------------------------------------------------
diff --git a/docs/javaagent.adoc b/docs/javaagent.adoc
new file mode 100644
index 0000000..e4cc685
--- /dev/null
+++ b/docs/javaagent.adoc
@@ -0,0 +1,64 @@
+# JavaAgent
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# Adding a JavaAgent
+
+NOTE: The java agent is only required if using OpenJPA as your
+persistence provider or if using CMP.
+
+Adding a java agent is done via a vm parameter as follows:
+
+....
+java -javaagent:openejb-javaagent-4.6.0.jar _\[other params...](other-params....html)
+....
+
+== Maven2
+
+In maven2 you can enable the javaagent for your tests by adding this to
+your pom.xml file:
+
+....
+<build>
+ <plugins>
+ <!-- this configures the surefire plugin to run your tests with the javaagent enabled -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <configuration>
+ <forkMode>pertest</forkMode>
+ <argLine>-javaagent:${project.basedir}/target/openejb-javaagent-4.6.0.jar</argLine>
+ <workingDirectory>${project.basedir}/target</workingDirectory>
+ </configuration>
+ </plugin>
+ <!-- this tells maven to copy the openejb-javaagent jar into your target/ directory -->
+ <!-- where surefire can see it -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>copy</id>
+ <phase>process-resources</phase>
+ <goals>
+ <goal>copy</goal>
+ </goals>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>openejb-javaagent</artifactId>
+ <version>4.6.0</version>
+ <outputDirectory>${project.build.directory}</outputDirectory>
+ </artifactItem>
+ </artifactItems>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+</build>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/javaagent.md
----------------------------------------------------------------------
diff --git a/docs/javaagent.md b/docs/javaagent.md
deleted file mode 100644
index 9e4f8c4..0000000
--- a/docs/javaagent.md
+++ /dev/null
@@ -1,61 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=JavaAgent
-~~~~~~
-
-<a name="JavaAgent-AddingaJavaAgent"></a>
-# Adding a JavaAgent
-
-NOTE: The java agent is only required if using OpenJPA as your persistence
-provider or if using CMP.
-
-Adding a java agent is done via a vm parameter as follows:
-
- java -javaagent:openejb-javaagent-4.6.0.jar _\[other params...](other-params....html)
-
-<a name="JavaAgent-Maven2"></a>
-## Maven2
-
-In maven2 you can enable the javaagent for your tests by adding this to
-your pom.xml file:
-
- <build>
- <plugins>
- <!-- this configures the surefire plugin to run your tests with the javaagent enabled -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- <configuration>
- <forkMode>pertest</forkMode>
- <argLine>-javaagent:${project.basedir}/target/openejb-javaagent-4.6.0.jar</argLine>
- <workingDirectory>${project.basedir}/target</workingDirectory>
- </configuration>
- </plugin>
- <!-- this tells maven to copy the openejb-javaagent jar into your target/ directory -->
- <!-- where surefire can see it -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-dependency-plugin</artifactId>
- <executions>
- <execution>
- <id>copy</id>
- <phase>process-resources</phase>
- <goals>
- <goal>copy</goal>
- </goals>
- <configuration>
- <artifactItems>
- <artifactItem>
- <groupId>org.apache.openejb</groupId>
- <artifactId>openejb-javaagent</artifactId>
- <version>4.6.0</version>
- <outputDirectory>${project.build.directory}</outputDirectory>
- </artifactItem>
- </artifactItems>
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/javaee7-status.adoc
----------------------------------------------------------------------
diff --git a/docs/javaee7-status.adoc b/docs/javaee7-status.adoc
new file mode 100644
index 0000000..2d2af1f
--- /dev/null
+++ b/docs/javaee7-status.adoc
@@ -0,0 +1,218 @@
+# Java EE 7 Implementation Status
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+This page shows the current implementation status for the Java EE 7
+specification compabitility of Apache Tomme 7.0.0-M1. Currently, we are
+working on the certification for Java EE 7.
+
+Version
+
+JSR
+
+TomEE
+
+TomEE+
+
+Java Servlets
+
+3.1
+
+340
+
+(/)
+
+(/)
+
+JavaServer Pages (JSP)
+
+2.3
+
+245
+
+(/)
+
+(/)
+
+Expression Language (EL)
+
+3.0
+
+341
+
+(/)
+
+(/)
+
+JavaServer Faces (JSF)
+
+2.2
+
+344
+
+(/)
+
+(/)
+
+Java API for Websocket
+
+1.0
+
+356
+
+(/)
+
+(/)
+
+Java API for JSON Processing (JSON-P)
+
+1.0
+
+353
+
+(/)
+
+(/)
+
+Batch Applications for the Java Platform
+
+1.0
+
+352
+
+(/)
+
+Concurrency Utilities for Java EE
+
+1.0
+
+236
+
+(/)
+
+Contexts and Dependency Injection (CDI)
+
+1.1
+
+346
+
+(/)
+
+(/)
+
+Bean Validation
+
+1.1
+
+349
+
+(/)
+
+(/)
+
+Enterprise JavaBeans (EJB)
+
+3.2
+
+345
+
+(/)
+
+(/)
+
+Interceptors
+
+1.2
+
+318
+
+(/)
+
+(/)
+
+Java EE Connector Architecture
+
+1.6
+
+322
+
+1.7 not supported yet
+
+Java Persistence API (JPA)
+
+2.1
+
+338
+
+API 2.1 supported, default provider still 2.0.
+
+API 2.1 supported, default provider still 2.0.
+
+Java Messaging Service (JMS)
+
+1.1
+
+343
+
+2.0 not supported yet.
+
+Java Transaction API (JTA)
+
+1.2
+
+907
+
+(/)
+
+(/)
+
+JavaMail API
+
+1.5
+
+919
+
+(/)
+
+(/)
+
+Java API for RESTful Web Services (JAX-RS)
+
+2.0
+
+339
+
+(/)
+
+(/)
+
+Java API for XML Web Services (JAX-WS)
+
+2.2
+
+224
+
+(/)
+
+Java Authentication Service Provider Interface for Containers (JAAS)
+
+1.1
+
+196
+
+(/)
+
+(/)
+
+Java Authorization Contract for Coners (JACC)
+
+1.5
+
+115
+
+(/)
+
+(/)
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/javaee7-status.md
----------------------------------------------------------------------
diff --git a/docs/javaee7-status.md b/docs/javaee7-status.md
deleted file mode 100644
index a1e50d1..0000000
--- a/docs/javaee7-status.md
+++ /dev/null
@@ -1,185 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Java EE 7 Implementation Status
-~~~~~~
-
-This page shows the current implementation status for the Java EE 7 specification compabitility of Apache Tomme 7.0.0-M1. Currently, we are working on the certification for Java EE 7.
-
-<table class="mdtable">
- <tr>
- <th></th>
- <th>Version</th>
- <th>JSR</th>
- <th>TomEE</th>
- <th>TomEE+</th>
- </tr>
-
- <tr>
- <td>Java Servlets</td>
- <td>3.1</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=340">340</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>JavaServer Pages (JSP)</td>
- <td>2.3</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=245">245</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Expression Language (EL)</td>
- <td>3.0</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=341">341</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>JavaServer Faces (JSF)</td>
- <td>2.2</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=344">344</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Java API for Websocket</td>
- <td>1.0</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=356">356</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Java API for JSON Processing (JSON-P)</td>
- <td>1.0</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=353">353</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Batch Applications for the Java Platform</td>
- <td>1.0</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=352">352</a></td>
- <td></td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Concurrency Utilities for Java EE</td>
- <td>1.0</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=236">236</a></td>
- <td></td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Contexts and Dependency Injection (CDI)</td>
- <td>1.1</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=346">346</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Bean Validation</td>
- <td>1.1</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=349">349</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Enterprise JavaBeans (EJB)</td>
- <td>3.2</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=345">345</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Interceptors</td>
- <td>1.2</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=318">318</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Java EE Connector Architecture</td>
- <td>1.6</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=322">322</a></td>
- <td></td>
- <td>1.7 not supported yet</td>
- </tr>
-
- <tr>
- <td>Java Persistence API (JPA)</td>
- <td>2.1</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=338">338</a></td>
- <td>API 2.1 supported, default provider still 2.0.</td>
- <td>API 2.1 supported, default provider still 2.0.</td>
- </tr>
-
- <tr>
- <td>Java Messaging Service (JMS)</td>
- <td>1.1</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=343">343</a></td>
- <td></td>
- <td>2.0 not supported yet.</td>
- </tr>
-
- <tr>
- <td>Java Transaction API (JTA)</td>
- <td>1.2</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=907">907</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>JavaMail API</td>
- <td>1.5</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=919">919</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Java API for RESTful Web Services (JAX-RS)</td>
- <td>2.0</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=339">339</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Java API for XML Web Services (JAX-WS)</td>
- <td>2.2</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=224">224</a></td>
- <td></td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Java Authentication Service Provider Interface for Containers (JAAS)</td>
- <td>1.1</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=196">196</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-
- <tr>
- <td>Java Authorization Contract for Coners (JACC)</td>
- <td>1.5</td>
- <td><a href="http://jcp.org/en/jsr/detail?id=115">115</a></td>
- <td>(/)</td>
- <td>(/)</td>
- </tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/javamailsession-config.adoc
----------------------------------------------------------------------
diff --git a/docs/javamailsession-config.adoc b/docs/javamailsession-config.adoc
new file mode 100644
index 0000000..70e1500
--- /dev/null
+++ b/docs/javamailsession-config.adoc
@@ -0,0 +1,42 @@
+# JavaMailSession Configuration
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A JavaMailSession can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Resource id="myJavaMailSession" type="javax.mail.Session">
+</Resource>
+....
+
+Alternatively, a JavaMailSession can be declared via properties in the
+`<tomee-home>/conf/system.properties` file or via Java VirtualMachine
+`-D` properties. The properties can also be used when embedding TomEE
+via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
+
+....
+myJavaMailSession = new://Resource?type=javax.mail.Session
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared JavaMailSession a
+warning will be logged. If a JavaMailSession is needed by the
+application and one is not declared, TomEE will create one dynamically
+using default settings. Multiple JavaMailSession declarations are
+allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
http://git-wip-us.apache.org/repos/asf/tomee/blob/513cf17a/docs/javamailsession-config.md
----------------------------------------------------------------------
diff --git a/docs/javamailsession-config.md b/docs/javamailsession-config.md
deleted file mode 100644
index 5f82e7c..0000000
--- a/docs/javamailsession-config.md
+++ /dev/null
@@ -1,26 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=JavaMailSession Configuration
-~~~~~~
-
-
-A JavaMailSession can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Resource id="myJavaMailSession" type="javax.mail.Session">
- </Resource>
-
-Alternatively, a JavaMailSession can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myJavaMailSession = new://Resource?type=javax.mail.Session
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared JavaMailSession a warning will be logged. If a JavaMailSession is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple JavaMailSession declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-</table>
[06/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 4
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 4
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/b45a3d00
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/b45a3d00
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/b45a3d00
Branch: refs/heads/master
Commit: b45a3d00ad9751bc33e27af30ef6c14fb0f3c099
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:20 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:07:20 2018 -0800
----------------------------------------------------------------------
docs/datasource-config.adoc | 527 ++++++++++++++++++++
docs/datasource-config.md | 541 ---------------------
docs/datasource-configuration-by-creator.adoc | 160 ++++++
docs/datasource-configuration-by-creator.md | 155 ------
docs/datasource-password-encryption.adoc | 159 ++++++
docs/datasource-password-encryption.md | 128 -----
docs/deamon/lin-service.adoc | 24 +
docs/deamon/lin-service.md | 17 -
docs/deamon/win-service.adoc | 24 +
docs/deamon/win-service.md | 17 -
docs/declaring-references.adoc | 6 +
docs/declaring-references.md | 6 -
docs/deploy-tool.adoc | 167 +++++++
docs/deploy-tool.md | 165 -------
docs/deploying-in-tomee.adoc | 73 +++
docs/deploying-in-tomee.md | 73 ---
docs/deployment-id.adoc | 231 +++++++++
docs/deployment-id.md | 231 ---------
docs/deployments.adoc | 146 ++++++
docs/deployments.md | 135 -----
docs/details-on-openejb-jar.adoc | 152 ++++++
docs/details-on-openejb-jar.md | 156 ------
docs/documentation.adoc | 103 ++++
docs/documentation.md | 106 ----
docs/documentation.old.adoc | 98 ++++
docs/documentation.old.md | 102 ----
docs/dynamic-datasource.adoc | 219 +++++++++
docs/dynamic-datasource.md | 220 ---------
28 files changed, 2089 insertions(+), 2052 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/datasource-config.adoc
----------------------------------------------------------------------
diff --git a/docs/datasource-config.adoc b/docs/datasource-config.adoc
new file mode 100644
index 0000000..3260b89
--- /dev/null
+++ b/docs/datasource-config.adoc
@@ -0,0 +1,527 @@
+# DataSource Configuration
+:index-group: Datasource
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A DataSource can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<Resource id="myDataSource" type="javax.sql.DataSource">
+ accessToUnderlyingConnectionAllowed = false
+ alternateUsernameAllowed = false
+ connectionProperties =
+ defaultAutoCommit = true
+ defaultReadOnly =
+ definition =
+ ignoreDefaultValues = false
+ initialSize = 0
+ jdbcDriver = org.hsqldb.jdbcDriver
+ jdbcUrl = jdbc:hsqldb:mem:hsqldb
+ jtaManaged = true
+ maxActive = 20
+ maxIdle = 20
+ maxOpenPreparedStatements = 0
+ maxWaitTime = -1 millisecond
+ minEvictableIdleTime = 30 minutes
+ minIdle = 0
+ numTestsPerEvictionRun = 3
+ password =
+ passwordCipher = PlainText
+ poolPreparedStatements = false
+ serviceId =
+ testOnBorrow = true
+ testOnReturn = false
+ testWhileIdle = false
+ timeBetweenEvictionRuns = -1 millisecond
+ userName = sa
+ validationQuery =
+</Resource>
+....
+
+Alternatively, a DataSource can be declared via properties in the
+`<tomee-home>/conf/system.properties` file or via Java VirtualMachine
+`-D` properties. The properties can also be used when embedding TomEE
+via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
+
+....
+myDataSource = new://Resource?type=javax.sql.DataSource
+myDataSource.accessToUnderlyingConnectionAllowed = false
+myDataSource.alternateUsernameAllowed = false
+myDataSource.connectionProperties =
+myDataSource.defaultAutoCommit = true
+myDataSource.defaultReadOnly =
+myDataSource.definition =
+myDataSource.ignoreDefaultValues = false
+myDataSource.initialSize = 0
+myDataSource.jdbcDriver = org.hsqldb.jdbcDriver
+myDataSource.jdbcUrl = jdbc:hsqldb:mem:hsqldb
+myDataSource.jtaManaged = true
+myDataSource.maxActive = 20
+myDataSource.maxIdle = 20
+myDataSource.maxOpenPreparedStatements = 0
+myDataSource.maxWaitTime = -1 millisecond
+myDataSource.minEvictableIdleTime = 30 minutes
+myDataSource.minIdle = 0
+myDataSource.numTestsPerEvictionRun = 3
+myDataSource.password =
+myDataSource.passwordCipher = PlainText
+myDataSource.poolPreparedStatements = false
+myDataSource.serviceId =
+myDataSource.testOnBorrow = true
+myDataSource.testOnReturn = false
+myDataSource.testWhileIdle = false
+myDataSource.timeBetweenEvictionRuns = -1 millisecond
+myDataSource.userName = sa
+myDataSource.validationQuery =
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared DataSource a warning
+will be logged. If a DataSource is needed by the application and one is
+not declared, TomEE will create one dynamically using default settings.
+Multiple DataSource declarations are allowed.
+
+See the link:common-datasource-configurations.html[Common DataSource
+Configurations] page for examples of configuring datasources for Derby,
+MySQL, Oracle and other common databases.
+
+== Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+accessToUnderlyingConnectionAllowed
+
+boolean
+
+false
+
+If true the raw physical connection to the database can be accessed
+
+alternateUsernameAllowed
+
+boolean
+
+false
+
+If true allow an alternate username and password to be specified on the
+connection, rather than those specified in the DataSource definition..
+
+connectionProperties
+
+String
+
+The connection properties that will be sent to the JDBC driver when
+establishing new connections
+
+defaultAutoCommit
+
+boolean
+
+true
+
+The default auto-commit state of new connections
+
+defaultReadOnly
+
+String
+
+The default read-only state of new connections If not set then the
+setReadOnly method will not be called. (Some drivers don't support read
+only mode, ex: Informix)
+
+definition
+
+String
+
+ignoreDefaultValues
+
+boolean
+
+false
+
+use only all set values in this config will need a lot of properties but
+allow to not set some values
+
+initialSize
+
+int
+
+0
+
+The size to reach when creating the datasource.
+
+jdbcDriver
+
+String
+
+org.hsqldb.jdbcDriver
+
+Driver class name
+
+jdbcUrl
+
+java.net.URI
+
+jdbc:hsqldb:mem:hsqldb
+
+Url for creating connections
+
+jtaManaged
+
+boolean
+
+true
+
+Determines wether or not this data source should be JTA managed or user
+managed.
+
+maxActive
+
+int
+
+20
+
+The maximum number of active connections that can be allocated from this
+pool at the same time, or a negative number for no limit. N.B. When
+using dbcp2 with TomEE 7 ("DataSourceCreator dbcp"), "MaxTotal" should
+be used as opposed to "MaxActive".
+
+maxIdle
+
+int
+
+20
+
+The maximum number of connections that can remain idle in the pool,
+without extra ones being released, or a negative number for no limit.
+
+maxOpenPreparedStatements
+
+int
+
+0
+
+The maximum number of open statements that can be allocated from the
+statement pool at the same time, or zero for no limit.
+
+maxWaitTime
+
+time
+
+-1 millisecond
+
+The maximum number of time that the pool will wait (when there are no
+available connections) for a connection to be returned before throwing
+an exception, or -1 to wait indefinitely.
+
+minEvictableIdleTime
+
+time
+
+30 minutes
+
+The minimum amount of time a connection may sit idle in the pool before
+it is eligable for eviction by the idle connection evictor (if any).
+
+minIdle
+
+int
+
+0
+
+The minimum number of connections that can remain idle in the pool,
+without extra ones being created, or zero to create none.
+
+numTestsPerEvictionRun
+
+int
+
+3
+
+The number of connectionss to examine during each run of the idle
+connection evictor thread (if any).
+
+password
+
+String
+
+Default password
+
+passwordCipher
+
+String
+
+PlainText
+
+poolPreparedStatements
+
+boolean
+
+false
+
+If true, a statement pool is created for each Connection and
+PreparedStatements created by one of the following methods are pooled:
+
+serviceId
+
+String
+
+testOnBorrow
+
+boolean
+
+true
+
+If true connections will be validated before being returned from the
+pool. If the validation fails, the connection is destroyed, and a new
+conection will be retrieved from the pool (and validated).
+
+testOnReturn
+
+boolean
+
+false
+
+If true connections will be validated before being returned to the pool.
+If the validation fails, the connection is destroyed instead of being
+returned to the pool.
+
+testWhileIdle
+
+boolean
+
+false
+
+If true connections will be validated by the idle connection evictor (if
+any). If the validation fails, the connection is destroyed and removed
+from the pool
+
+timeBetweenEvictionRuns
+
+time
+
+-1 millisecond
+
+The number of milliseconds to sleep between runs of the idle connection
+evictor thread. When set to a negative number, no idle connection
+evictor thread will be run.
+
+userName
+
+String
+
+sa
+
+Default user name
+
+validationQuery
+
+String
+
+The SQL query that will be used to validate connections from this pool
+before returning them to the caller. If specified, this query MUST be an
+SQL SELECT statement that returns at least one row.
+
+LogSql
+
+boolean
+
+false
+
+Wether SQL queries should be logged or not
+
+== accessToUnderlyingConnectionAllowed
+
+If true the raw physical connection to the database can be accessed
+using the following construct:
+
+....
+Connection conn = ds.getConnection();
+Connection rawConn = ((DelegatingConnection) conn).getInnermostDelegate();
+...
+conn.close()
+....
+
+Default is false, because misbehaving programs can do harmfull things to
+the raw connection shuch as closing the raw connection or continuing to
+use the raw connection after it has been assigned to another logical
+connection. Be careful and only use when you need direct access to
+driver specific extensions.
+
+NOTE: Do NOT close the underlying connection, only the original logical
+connection wrapper.
+
+== connectionProperties
+
+The connection properties that will be sent to the JDBC driver when
+establishing new connections
+
+Format of the string must be [propertyName=property;]*
+
+NOTE - The "user" and "password" properties will be passed explicitly,
+so they do not need to be included here.
+
+== TransactionIsolation
+
+The default TransactionIsolation state of new connections.
+
+If not set then the `setTransactionIsolation` method will not be called.
+The allowed values for this property are:
+
+* `NONE`
+* `READ_COMMITTED`
+* `READ_UNCOMMITTED`
+* `REPEATABLE_READ`
+* `SERIALIZABLE`
+
+Note: Most JDBC drivers do not support all isolation levels
+DefaultTransactionIsolation
+
+== initialSize
+
+The initial size to initialize the pool of connections.
+
+== jtaManaged
+
+Determines wether or not this data source should be JTA managed or user
+managed.
+
+If set to 'true' it will automatically be enrolled in any ongoing
+transactions. Calling begin/commit/rollback or setAutoCommit on the
+datasource or connection will not be allowed. If you need to perform
+these functions yourself, set `JtaManaged` to `false`
+
+In terms of JPA persistence.xml:
+
+* `JtaManaged=true` can be used as a 'jta-data-source'
+* `JtaManaged=false` can be used as a 'non-jta-data-source'
+
+== maxOpenPreparedStatements
+
+The maximum number of open statements that can be allocated from the
+statement pool at the same time, or zero for no limit.
+
+NOTE - Some drivers have limits on the number of open statements, so
+make sure there are some resources left for the other (non-prepared)
+statements.
+
+== poolPreparedStatements
+
+If true, a statement pool is created for each Connection and
+PreparedStatements created by one of the following methods are pooled:
+
+....
+public PreparedStatement prepareStatement(String sql);
+public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
+....
+
+== testOnBorrow
+
+If true connections will be validated before being returned from the
+pool. If the validation fails, the connection is destroyed, and a new
+conection will be retrieved from the pool (and validated).
+
+NOTE - for a true value to have any effect, the ValidationQuery
+parameter must be set.
+
+== testOnReturn
+
+If true connections will be validated before being returned to the pool.
+If the validation fails, the connection is destroyed instead of being
+returned to the pool.
+
+NOTE - for a true value to have any effect, the ValidationQuery
+parameter must be set.
+
+== testWhileIdle
+
+If true connections will be validated by the idle connection evictor (if
+any). If the validation fails, the connection is destroyed and removed
+from the pool
+
+NOTE - for a true value to have any effect, the
+timeBetweenEvictionRunsMillis property must be a positive number and the
+ValidationQuery parameter must be set.
+
+== XADataSource
+
+There are several ways to configure a XADataSource. Depending the
+underlying datasource (Oracle, MySQL one or the other solution can be
+more adapted.
+
+This part deals with `JtaManaged` XaDataSource since a not managed
+XaDataSource can be defined as a standard resource using `class-name`.
+
+=== Single definition
+
+First solution is to define as `JdbcDriver` an XADataSource:
+
+....
+<Resource id="myXaDs" type="DataSource">
+ JdbcDriver = org.foo.MyXaDataSource
+
+ myXaProperty = value
+
+ myPoolProperty = 10
+</Resource>
+....
+
+This solution merges properties for the XaDataSource and the pool
+(tomcat-jdbc for TomEE, dbcp for OpenEJB by default but still
+configurable with DataSourceCreator).
+
+Note: in this case for Oracle for instance you'll define UserName for
+the pool and User for the datasource which can look weird if you don't
+know properties are used for 2 instances (pool and datasource).
+
+Note: this solution uses the same logic than @DataSourceDefinition
+factory mecanism.
+
+=== Two resources definition
+
+An alternative is to define a resource for the XaDataSource:
+
+....
+<Resource id="myXa" class-name="org.foo.MyXaDataSource">
+ myXaProperty = value
+</Resource>
+....
+
+And then wrap it in the pool:
+
+....
+<Resource id="myXaDs" type="DataSource">
+ DataSourceCreator = [dbcp|dbcp-alternative]
+ myPoolProperty = 10
+</Resource>
+....
+
+Note: `dbcp` is more adapted than `dbcp-alternative` in most of the case
+because it is reusing direct dbcp JTA management.
+
+=== Known issues
+
+For TomEE 1.7.0/1.7.1 you can need to add the property:
+
+....
+ openejb.datasource.pool = true
+....
+
+in resource properties to ensure the resource is pooled.
+
+=== Details about DataSource and their factories (advanced configuration)
+
+link:datasource-configuration-by-creator.html[Configuration by creator]
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/datasource-config.md
----------------------------------------------------------------------
diff --git a/docs/datasource-config.md b/docs/datasource-config.md
deleted file mode 100644
index 3ad7494..0000000
--- a/docs/datasource-config.md
+++ /dev/null
@@ -1,541 +0,0 @@
-index-group=Datasource
-type=page
-status=published
-title=DataSource Configuration
-~~~~~~
-
-A DataSource can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Resource id="myDataSource" type="javax.sql.DataSource">
- accessToUnderlyingConnectionAllowed = false
- alternateUsernameAllowed = false
- connectionProperties =
- defaultAutoCommit = true
- defaultReadOnly =
- definition =
- ignoreDefaultValues = false
- initialSize = 0
- jdbcDriver = org.hsqldb.jdbcDriver
- jdbcUrl = jdbc:hsqldb:mem:hsqldb
- jtaManaged = true
- maxActive = 20
- maxIdle = 20
- maxOpenPreparedStatements = 0
- maxWaitTime = -1 millisecond
- minEvictableIdleTime = 30 minutes
- minIdle = 0
- numTestsPerEvictionRun = 3
- password =
- passwordCipher = PlainText
- poolPreparedStatements = false
- serviceId =
- testOnBorrow = true
- testOnReturn = false
- testWhileIdle = false
- timeBetweenEvictionRuns = -1 millisecond
- userName = sa
- validationQuery =
- </Resource>
-
-Alternatively, a DataSource can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myDataSource = new://Resource?type=javax.sql.DataSource
- myDataSource.accessToUnderlyingConnectionAllowed = false
- myDataSource.alternateUsernameAllowed = false
- myDataSource.connectionProperties =
- myDataSource.defaultAutoCommit = true
- myDataSource.defaultReadOnly =
- myDataSource.definition =
- myDataSource.ignoreDefaultValues = false
- myDataSource.initialSize = 0
- myDataSource.jdbcDriver = org.hsqldb.jdbcDriver
- myDataSource.jdbcUrl = jdbc:hsqldb:mem:hsqldb
- myDataSource.jtaManaged = true
- myDataSource.maxActive = 20
- myDataSource.maxIdle = 20
- myDataSource.maxOpenPreparedStatements = 0
- myDataSource.maxWaitTime = -1 millisecond
- myDataSource.minEvictableIdleTime = 30 minutes
- myDataSource.minIdle = 0
- myDataSource.numTestsPerEvictionRun = 3
- myDataSource.password =
- myDataSource.passwordCipher = PlainText
- myDataSource.poolPreparedStatements = false
- myDataSource.serviceId =
- myDataSource.testOnBorrow = true
- myDataSource.testOnReturn = false
- myDataSource.testWhileIdle = false
- myDataSource.timeBetweenEvictionRuns = -1 millisecond
- myDataSource.userName = sa
- myDataSource.validationQuery =
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared DataSource a warning will be logged. If a DataSource is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple DataSource declarations are allowed.
-
-See the [Common DataSource Configurations](common-datasource-configurations.html) page for examples of configuring datasources for Derby, MySQL, Oracle and other common databases.
-
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td><a href="#accessToUnderlyingConnectionAllowed">accessToUnderlyingConnectionAllowed</a></td>
- <td>boolean</td>
- <td>false</td>
- <td>
-If true the raw physical connection to the database can be
-accessed
-</td>
-</tr>
-</tr>
-<tr>
- <td><a href="#alternateUsernameAllowed">alternateUsernameAllowed</a></td>
- <td>boolean</td>
- <td>false</td>
- <td>
-If true allow an alternate username and password to be specified on the connection, rather than those specified in the DataSource definition..
-</td>
-</tr>
-<tr>
- <td><a href="#connectionProperties">connectionProperties</a></td>
- <td>String</td>
- <td></td>
- <td>
-The connection properties that will be sent to the JDBC
-driver when establishing new connections
-</td>
-</tr>
-<tr>
- <td>defaultAutoCommit</td>
- <td>boolean</td>
- <td>true</td>
- <td>
-The default auto-commit state of new connections
-</td>
-</tr>
-<tr>
- <td>defaultReadOnly</td>
- <td>String</td>
- <td></td>
- <td>
-The default read-only state of new connections
-If not set then the setReadOnly method will not be called.
-(Some drivers don't support read only mode, ex: Informix)
-</td>
-</tr>
-<tr>
- <td>definition</td>
- <td>String</td>
- <td></td>
- <td>
-
-</td>
-</tr>
-<tr>
- <td>ignoreDefaultValues</td>
- <td>boolean</td>
- <td>false</td>
- <td>
-use only all set values in this config
-will need a lot of properties but allow to not set some values
-</td>
-</tr>
-<tr>
- <td><a href="#initialSize">initialSize</a></td>
- <td>int</td>
- <td>0</td>
- <td>
-The size to reach when creating the datasource.
-</td>
-</tr>
-<tr>
- <td>jdbcDriver</td>
- <td>String</td>
- <td>org.hsqldb.jdbcDriver</td>
- <td>
-Driver class name
-</td>
-</tr>
-<tr>
- <td>jdbcUrl</td>
- <td>java.net.URI</td>
- <td>jdbc:hsqldb:mem:hsqldb</td>
- <td>
-Url for creating connections
-</td>
-</tr>
-<tr>
- <td><a href="#jtaManaged">jtaManaged</a></td>
- <td>boolean</td>
- <td>true</td>
- <td>
-Determines wether or not this data source should be JTA managed
-or user managed.
-</td>
-</tr>
-<tr>
- <td>maxActive</td>
- <td>int</td>
- <td>20</td>
- <td>
-The maximum number of active connections that can be
-allocated from this pool at the same time, or a negative
-number for no limit. N.B. When using dbcp2 with TomEE 7 ("DataSourceCreator dbcp"), "MaxTotal" should be used as opposed to "MaxActive".
-</td>
-</tr>
-<tr>
- <td>maxIdle</td>
- <td>int</td>
- <td>20</td>
- <td>
-The maximum number of connections that can remain idle in
-the pool, without extra ones being released, or a negative
-number for no limit.
-</td>
-</tr>
-<tr>
- <td><a href="#maxOpenPreparedStatements">maxOpenPreparedStatements</a></td>
- <td>int</td>
- <td>0</td>
- <td>
-The maximum number of open statements that can be allocated
-from the statement pool at the same time, or zero for no
-limit.
-</td>
-</tr>
-<tr>
- <td>maxWaitTime</td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>-1 millisecond</td>
- <td>
-The maximum number of time that the pool will wait
-(when there are no available connections) for a connection
-to be returned before throwing an exception, or -1 to wait
-indefinitely.
-</td>
-</tr>
-<tr>
- <td>minEvictableIdleTime</td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>30 minutes</td>
- <td>
-The minimum amount of time a connection may sit idle in the
-pool before it is eligable for eviction by the idle
-connection evictor (if any).
-</td>
-</tr>
-<tr>
- <td>minIdle</td>
- <td>int</td>
- <td>0</td>
- <td>
-The minimum number of connections that can remain idle in
-the pool, without extra ones being created, or zero to
-create none.
-</td>
-</tr>
-<tr>
- <td>numTestsPerEvictionRun</td>
- <td>int</td>
- <td>3</td>
- <td>
-The number of connectionss to examine during each run of the
-idle connection evictor thread (if any).
-</td>
-</tr>
-<tr>
- <td>password</td>
- <td>String</td>
- <td></td>
- <td>
-Default password
-</td>
-</tr>
-<tr>
- <td>passwordCipher</td>
- <td>String</td>
- <td>PlainText</td>
- <td>
-
-</td>
-</tr>
-<tr>
- <td><a href="#poolPreparedStatements">poolPreparedStatements</a></td>
- <td>boolean</td>
- <td>false</td>
- <td>
-If true, a statement pool is created for each Connection and
-PreparedStatements created by one of the following methods are
-pooled:
-</td>
-</tr>
-<tr>
- <td>serviceId</td>
- <td>String</td>
- <td></td>
- <td>
-
-</td>
-</tr>
-<tr>
- <td><a href="#testOnBorrow">testOnBorrow</a></td>
- <td>boolean</td>
- <td>true</td>
- <td>
-If true connections will be validated before being returned
-from the pool. If the validation fails, the connection is
-destroyed, and a new conection will be retrieved from the
-pool (and validated).
-</td>
-</tr>
-<tr>
- <td><a href="#testOnReturn">testOnReturn</a></td>
- <td>boolean</td>
- <td>false</td>
- <td>
-If true connections will be validated before being returned
-to the pool. If the validation fails, the connection is
-destroyed instead of being returned to the pool.
-</td>
-</tr>
-<tr>
- <td><a href="#testWhileIdle">testWhileIdle</a></td>
- <td>boolean</td>
- <td>false</td>
- <td>
-If true connections will be validated by the idle connection
-evictor (if any). If the validation fails, the connection is
-destroyed and removed from the pool
-</td>
-</tr>
-<tr>
- <td>timeBetweenEvictionRuns</td>
- <td><a href="configuring-durations.html">time</a></td>
- <td>-1 millisecond</td>
- <td>
-The number of milliseconds to sleep between runs of the idle
-connection evictor thread. When set to a negative number, no
-idle connection evictor thread will be run.
-</td>
-</tr>
-<tr>
- <td>userName</td>
- <td>String</td>
- <td>sa</td>
- <td>
-Default user name
-</td>
-</tr>
-<tr>
- <td>validationQuery</td>
- <td>String</td>
- <td></td>
- <td>
-The SQL query that will be used to validate connections from
-this pool before returning them to the caller. If specified,
-this query MUST be an SQL SELECT statement that returns at
-least one row.
-</td>
-</tr>
-<tr>
-<td>LogSql</td>
-<td>boolean</td>
-<td>false</td>
-<td>Wether SQL queries should be logged or not</td>
-</tr>
-</table>
-
-
-
-<a name="accessToUnderlyingConnectionAllowed"></a>
-## accessToUnderlyingConnectionAllowed
-
-If true the raw physical connection to the database can be
-accessed using the following construct:
-
- Connection conn = ds.getConnection();
- Connection rawConn = ((DelegatingConnection) conn).getInnermostDelegate();
- ...
- conn.close()
-
-Default is false, because misbehaving programs can do harmfull
-things to the raw connection shuch as closing the raw
-connection or continuing to use the raw connection after it
-has been assigned to another logical connection. Be careful
-and only use when you need direct access to driver specific
-extensions.
-
-NOTE: Do NOT close the underlying connection, only the
-original logical connection wrapper.
-
-
-<a name="connectionProperties"></a>
-## connectionProperties
-
-The connection properties that will be sent to the JDBC
-driver when establishing new connections
-
-Format of the string must be [propertyName=property;]*
-
-NOTE - The "user" and "password" properties will be passed
-explicitly, so they do not need to be included here.
-
-
-<a name="TransactionIsolation"></a>
-## TransactionIsolation
-
-
-The default TransactionIsolation state of new connections.
-
-If not set then the `setTransactionIsolation` method will not
-be called. The allowed values for this property are:
-
-- `NONE`
-- `READ_COMMITTED`
-- `READ_UNCOMMITTED`
-- `REPEATABLE_READ`
-- `SERIALIZABLE`
-
-Note: Most JDBC drivers do not support all isolation levels
-DefaultTransactionIsolation
-
-<a name="initialSize"></a>
-## initialSize
-
-The initial size to initialize the pool of connections.
-
-<a name="jtaManaged"></a>
-## jtaManaged
-
-Determines wether or not this data source should be JTA managed
-or user managed.
-
-If set to 'true' it will automatically be enrolled
-in any ongoing transactions. Calling begin/commit/rollback or setAutoCommit
-on the datasource or connection will not be allowed. If you need to perform
-these functions yourself, set `JtaManaged` to `false`
-
-In terms of JPA persistence.xml:
-
-- `JtaManaged=true` can be used as a 'jta-data-source'
-- `JtaManaged=false` can be used as a 'non-jta-data-source'
-
-
-<a name="maxOpenPreparedStatements"></a>
-## maxOpenPreparedStatements
-
-The maximum number of open statements that can be allocated
-from the statement pool at the same time, or zero for no
-limit.
-
-NOTE - Some drivers have limits on the number of open
-statements, so make sure there are some resources left
-for the other (non-prepared) statements.
-
-
-<a name="poolPreparedStatements"></a>
-## poolPreparedStatements
-
-If true, a statement pool is created for each Connection and
-PreparedStatements created by one of the following methods are
-pooled:
-
- public PreparedStatement prepareStatement(String sql);
- public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
-
-
-<a name="testOnBorrow"></a>
-## testOnBorrow
-
-If true connections will be validated before being returned
-from the pool. If the validation fails, the connection is
-destroyed, and a new conection will be retrieved from the
-pool (and validated).
-
-NOTE - for a true value to have any effect, the
-ValidationQuery parameter must be set.
-
-
-<a name="testOnReturn"></a>
-## testOnReturn
-
-If true connections will be validated before being returned
-to the pool. If the validation fails, the connection is
-destroyed instead of being returned to the pool.
-
-NOTE - for a true value to have any effect, the
-ValidationQuery parameter must be set.
-
-
-<a name="testWhileIdle"></a>
-## testWhileIdle
-
-If true connections will be validated by the idle connection
-evictor (if any). If the validation fails, the connection is
-destroyed and removed from the pool
-
-NOTE - for a true value to have any effect, the
-timeBetweenEvictionRunsMillis property must be a positive
-number and the ValidationQuery parameter must be set.
-
-# XADataSource
-
-There are several ways to configure a XADataSource. Depending the underlying datasource (Oracle, MySQL one or the other
-solution can be more adapted.
-
-This part deals with `JtaManaged` XaDataSource since a not managed XaDataSource can be defined as a standard
-resource using `class-name`.
-
-## Single definition
-
-First solution is to define as `JdbcDriver` an XADataSource:
-
- <Resource id="myXaDs" type="DataSource">
- JdbcDriver = org.foo.MyXaDataSource
-
- myXaProperty = value
-
- myPoolProperty = 10
- </Resource>
-
-This solution merges properties for the XaDataSource and the pool (tomcat-jdbc for TomEE, dbcp for OpenEJB by default
-but still configurable with DataSourceCreator).
-
-Note: in this case for Oracle for instance you'll define UserName for the pool and User for the datasource which
-can look weird if you don't know properties are used for 2 instances (pool and datasource).
-
-Note: this solution uses the same logic than @DataSourceDefinition factory mecanism.
-
-## Two resources definition
-
-An alternative is to define a resource for the XaDataSource:
-
- <Resource id="myXa" class-name="org.foo.MyXaDataSource">
- myXaProperty = value
- </Resource>
-
-And then wrap it in the pool:
-
- <Resource id="myXaDs" type="DataSource">
- DataSourceCreator = [dbcp|dbcp-alternative]
- myPoolProperty = 10
- </Resource>
-
-Note: `dbcp` is more adapted than `dbcp-alternative` in most of the case because it is reusing direct dbcp JTA management.
-
-## Known issues
-
-For TomEE 1.7.0/1.7.1 you can need to add the property:
-
- openejb.datasource.pool = true
-
-in resource properties to ensure the resource is pooled.
-
-
-## Details about DataSource and their factories (advanced configuration)
-
-
-[Configuration by creator](datasource-configuration-by-creator.html)
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/datasource-configuration-by-creator.adoc
----------------------------------------------------------------------
diff --git a/docs/datasource-configuration-by-creator.adoc b/docs/datasource-configuration-by-creator.adoc
new file mode 100644
index 0000000..118481b
--- /dev/null
+++ b/docs/datasource-configuration-by-creator.adoc
@@ -0,0 +1,160 @@
+# DataSource Creator
+:index-group: Datasource
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+TomEE uses `creator` to create the connection pool factory. In other
+terms it means you can use any pool you want for DataSource in TomEE.
+
+Default provided pools are DBCP (default in embedded mode) and Tomcat
+JDBC (default in TomEE to be aligned on Tomcat).
+
+Depending which one you use the accept configuration are not 100% the
+same even if we try to align the most common entries to the historical
+configuration (ie DBCP).
+
+Here are a more detailled list of accepted properties by creator.
+
+== DBCP2 (TomEE 7.x and 8.x)
+
+Note: details are at
+http://tomee.apache.org/containers-and-resources.html (note:
+http://commons.apache.org/proper/commons-dbcp/configuration.html uses
+the latest version of DBCP but TomEE 1.7.x is not using this version).
+
+* AccessToUnderlyingConnectionAllowed
+* ConnectionInitSqls
+* ConnectionProperties
+* DefaultAutoCommit
+* DefaultCatalog
+* DefaultReadOnly
+* DefaultTransactionIsolation
+* Delegate
+* InitialSize
+* JdbcDriver
+* JdbcUrl
+* LogAbandoned
+* LogWriter
+* LoginTimeout
+* MaxActive
+* MaxIdle
+* MaxOpenPreparedStatements
+* MaxWait
+* MinEvictableIdleTimeMillis
+* MinIdle
+* Name
+* NumTestsPerEvictionRun
+* Password
+* PasswordCipher
+* PoolPreparedStatements
+* RemoveAbandoned
+* RemoveAbandonedTimeout
+* TestOnBorrow
+* TestOnReturn
+* TestWhileIdle
+* TimeBetweenEvictionRunsMillis
+* UserName
+* ValidationQuery
+* ValidationQueryTimeout
+
+== Tomcat JDBC
+
+Note: details are at
+https://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html
+
+* AbandonWhenPercentageFull
+* AccessToUnderlyingConnectionAllowed
+* AlternateUsernameAllowed
+* CommitOnReturn
+* ConnectionProperties
+* DataSource
+* DataSourceJNDI
+* DbProperties
+* DefaultAutoCommit
+* DefaultCatalog
+* DefaultReadOnly
+* DefaultTransactionIsolation
+* DriverClassName
+* FairQueue
+* IgnoreExceptionOnPreLoad
+* InitSQL
+* InitialSize
+* JdbcInterceptors
+* JmxEnabled
+* LogAbandoned
+* LogValidationErrors
+* LogWriter
+* LoginTimeout
+* MaxActive
+* MaxAge
+* MaxIdle
+* MaxWait
+* MinEvictableIdleTimeMillis
+* MinIdle
+* Name
+* NumTestsPerEvictionRun
+* Password
+* PasswordCipher
+* PoolProperties
+* PropagateInterruptState
+* RemoveAbandoned
+* RemoveAbandonedTimeout
+* RollbackOnReturn
+* SuspectTimeout
+* TestOnBorrow
+* TestOnConnect
+* TestOnReturn
+* TestWhileIdle
+* TimeBetweenEvictionRunsMillis
+* Url
+* UseDisposableConnectionFacade
+* UseEquals
+* UseLock
+* Username
+* ValidationInterval
+* ValidationQuery
+* ValidationQueryTimeout
+* Validator
+* ValidatorClassName
+
+== DBCP2 (TomEE 7.x)
+
+Note: details are at
+http://commons.apache.org/proper/commons-dbcp/configuration.html
+
+* AccessToUnderlyingConnectionAllowed
+* ConnectionInitSqls
+* ConnectionProperties
+* DefaultAutoCommit
+* DefaultCatalog
+* DefaultReadOnly
+* DefaultTransactionIsolation
+* Delegate
+* InitialSize
+* JdbcDriver
+* JdbcUrl
+* LogAbandoned
+* LogWriter
+* LoginTimeout
+* MaxTotal
+* MaxIdle
+* MaxOpenPreparedStatements
+* MaxWait
+* MinEvictableIdleTimeMillis
+* MinIdle
+* Name
+* NumTestsPerEvictionRun
+* Password
+* PasswordCipher
+* PoolPreparedStatements
+* RemoveAbandonedOnBorrow
+* RemoveAbandonedOnMaintenance
+* RemoveAbandonedTimeout
+* TestOnBorrow
+* TestOnReturn
+* TestWhileIdle
+* TimeBetweenEvictionRunsMillis
+* UserName
+* ValidationQuery
+* ValidationQueryTimeout
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/datasource-configuration-by-creator.md
----------------------------------------------------------------------
diff --git a/docs/datasource-configuration-by-creator.md b/docs/datasource-configuration-by-creator.md
deleted file mode 100644
index 4c3136d..0000000
--- a/docs/datasource-configuration-by-creator.md
+++ /dev/null
@@ -1,155 +0,0 @@
-index-group=Datasource
-type=page
-status=published
-title=DataSource Creator
-~~~~~~
-
-TomEE uses `creator` to create the connection pool factory. In other terms it means you can
-use any pool you want for DataSource in TomEE.
-
-Default provided pools are DBCP (default in embedded mode) and Tomcat JDBC (default in TomEE to be aligned on Tomcat).
-
-Depending which one you use the accept configuration are not 100% the same even if we try to
-align the most common entries to the historical configuration (ie DBCP).
-
-Here are a more detailled list of accepted properties by creator.
-
-
-## DBCP (TomEE 1.7.x)
-
-Note: details are at http://tomee.apache.org/containers-and-resources.html
-(note: http://commons.apache.org/proper/commons-dbcp/configuration.html uses the latest version of DBCP but TomEE 1.7.x is not using this version).
-
-- AccessToUnderlyingConnectionAllowed
-- ConnectionInitSqls
-- ConnectionProperties
-- DefaultAutoCommit
-- DefaultCatalog
-- DefaultReadOnly
-- DefaultTransactionIsolation
-- Delegate
-- InitialSize
-- JdbcDriver
-- JdbcUrl
-- LogAbandoned
-- LogWriter
-- LoginTimeout
-- MaxActive
-- MaxIdle
-- MaxOpenPreparedStatements
-- MaxWait
-- MinEvictableIdleTimeMillis
-- MinIdle
-- Name
-- NumTestsPerEvictionRun
-- Password
-- PasswordCipher
-- PoolPreparedStatements
-- RemoveAbandoned
-- RemoveAbandonedTimeout
-- TestOnBorrow
-- TestOnReturn
-- TestWhileIdle
-- TimeBetweenEvictionRunsMillis
-- UserName
-- ValidationQuery
-- ValidationQueryTimeout
-
-## Tomcat JDBC
-
-Note: details are at https://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html
-
-- AbandonWhenPercentageFull
-- AccessToUnderlyingConnectionAllowed
-- AlternateUsernameAllowed
-- CommitOnReturn
-- ConnectionProperties
-- DataSource
-- DataSourceJNDI
-- DbProperties
-- DefaultAutoCommit
-- DefaultCatalog
-- DefaultReadOnly
-- DefaultTransactionIsolation
-- DriverClassName
-- FairQueue
-- IgnoreExceptionOnPreLoad
-- InitSQL
-- InitialSize
-- JdbcInterceptors
-- JmxEnabled
-- LogAbandoned
-- LogValidationErrors
-- LogWriter
-- LoginTimeout
-- MaxActive
-- MaxAge
-- MaxIdle
-- MaxWait
-- MinEvictableIdleTimeMillis
-- MinIdle
-- Name
-- NumTestsPerEvictionRun
-- Password
-- PasswordCipher
-- PoolProperties
-- PropagateInterruptState
-- RemoveAbandoned
-- RemoveAbandonedTimeout
-- RollbackOnReturn
-- SuspectTimeout
-- TestOnBorrow
-- TestOnConnect
-- TestOnReturn
-- TestWhileIdle
-- TimeBetweenEvictionRunsMillis
-- Url
-- UseDisposableConnectionFacade
-- UseEquals
-- UseLock
-- Username
-- ValidationInterval
-- ValidationQuery
-- ValidationQueryTimeout
-- Validator
-- ValidatorClassName
-
-## DBCP2 (TomEE 7.x and 8.x)
-
-Note: details are at http://commons.apache.org/proper/commons-dbcp/configuration.html
-
-- AccessToUnderlyingConnectionAllowed
-- ConnectionInitSqls
-- ConnectionProperties
-- DefaultAutoCommit
-- DefaultCatalog
-- DefaultReadOnly
-- DefaultTransactionIsolation
-- Delegate
-- InitialSize
-- JdbcDriver
-- JdbcUrl
-- LogAbandoned
-- LogWriter
-- LoginTimeout
-- MaxTotal
-- MaxIdle
-- MaxOpenPreparedStatements
-- MaxWait
-- MinEvictableIdleTimeMillis
-- MinIdle
-- Name
-- NumTestsPerEvictionRun
-- Password
-- PasswordCipher
-- PoolPreparedStatements
-- RemoveAbandonedOnBorrow
-- RemoveAbandonedOnMaintenance
-- RemoveAbandonedTimeout
-- TestOnBorrow
-- TestOnReturn
-- TestWhileIdle
-- TimeBetweenEvictionRunsMillis
-- UserName
-- ValidationQuery
-- ValidationQueryTimeout
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/datasource-password-encryption.adoc
----------------------------------------------------------------------
diff --git a/docs/datasource-password-encryption.adoc b/docs/datasource-password-encryption.adoc
new file mode 100644
index 0000000..6d6b3bc
--- /dev/null
+++ b/docs/datasource-password-encryption.adoc
@@ -0,0 +1,159 @@
+# DataSource Password Encryption
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+_Apache OpenEJB 3.1.2 or later required_
+
+_TomEE 1.5.0 switched from Apache Commons-DBCP to Tomcat-pool. On that
+specific version, password encryption is not available. You can still
+switch back to Apache Commons DBCP buy adding the following property:
+DataSourceCreator dbcp. On all following versions, the database
+encryption will be ported and hence available on Tomcat-pool as well._
+
+# Ciphering passwords Apache OpenEJB now provides an easy and extensible
+way to cipher databases passwords. Not that by default, this feature is
+not activated so plain passwords are used.
+
+== Usage
+
+Default Plain text password example:
+
+....
+<Resource id="MySQL Database" type="DataSource">
+ # MySQL example
+ #
+ # This connector will not work until you download the driver at:
+ # http://www.mysql.com/downloads/api-jdbc-stable.html
+
+ JdbcDriver com.mysql.jdbc.Driver
+ JdbcUrl jdbc:mysql://localhost/test
+ UserName test
+ Password Passw0rd
+</Resource>
+....
+
+3DES ciphered password example.
+
+Note that the built in 3DES implementation uses _a static key_ to
+encode/decode your password. _It's only meant to be a sample on how to
+implement a Codec. On a real enterprise life, you should implement your
+how relying on an HSM for example._ The easiest way to do it is to
+implement the _org.apache.openejb.resource.jdbc.cipher.PasswordCipher_
+interface.
+
+....
+<Resource id="MySQL Database" type="DataSource">
+ # MySQL example
+ #
+ # This connector will not work until you download the driver at:
+ # http://www.mysql.com/downloads/api-jdbc-stable.html
+
+ JdbcDriver com.mysql.jdbc.Driver
+ JdbcUrl jdbc:mysql://localhost/test
+ UserName test
+
+ # ciphered value for Passw0rd using Static3DES codec is
+ xMH5uM1V9vQzVUv5LG7YLA==
+ Password xMH5uM1V9vQzVUv5LG7YLA==
+ PasswordCipher Static3DES
+</Resource>
+....
+
+== Hint
+
+You can plug your own algorithm to extend Apache OpenEJB built in ones.
+To do such, you just need to implement the
+
+=== Command line tool
+
+Apache OpenEJB also provides a command line tool allowing password
+cipher algorithm. Actually, it's useful to get the ciphered value of a
+plain text value using a given algorithm.
+
+==== NAME
+
+openejb cipher - OpenEJB Cypher Tool
+
+==== SYNOPSIS
+
+....
+openejb cipher [#options]
+....
+
+==== DESCRIPTION
+
+The OpenEJB Cipher tool is an OPTIONAL tool that allows you to use
+`PasswordCipher` algorithm to encode/decode values.
+
+_This tool isn't package by default on TomEE 1.5.0. It's only available
+on the standalone distribution. After 1.5.0, it's in TomEE as well._
+
+The OpenEJB Cipher tool can be executed from any directory as long as
+`<OPENEJB_HOME>/bin` is in the system PATH. Before running this tool you
+need to set the environment variable OPENEJB_HOME to the path of the
+directory where you unpacked the OpenEJB installation. For for the
+remainder of this document we will assume you unpacked OpenEJB into the
+directory C:-3.1.2.
+
+In Windows, the cipher tool can be executed as follows:
+
+....
+`C:\openejb-3.1.2> bin\openejb cipher --help`
+....
+
+In UNIX, Linux, or Mac OS X, the cipher tool can be executed as follows:
+
+....
+`\[user@host openejb-3.1.2]# bin/openejb cipher --help`
+....
+
+Depending on your OpenEJB version, you may need to change execution bits
+to make the scripts executable. You can do this with the following
+command.
+
+....
+`\[user@host openejb-3.1.2]# chmod 755 bin/openejb`
+....
+
+From here on out, it will be assumed that you know how to execute the
+right openejb script for your operating system and commands will appear
+in shorthand as show below.
+
+....
+`openejb cipher --help`
+....
+
+==== OPTIONS
+
+-h, --_help_
+
+Lists these options and exit.
+
+-c, --_cipher_
+
+Specifies the password cipher implementation to use (default is
+Static3DES).
+
+-d, --_decrypt_
+
+Switches command line tool to decrypt.
+
+-e, --_encrypt_
+
+Switches command line tool to encrypt (default).
+
+==== EXAMPLES
+
+Encrypt a plain password using the default algorithm.
+
+....
+`openejb cipher Passw0rd`
+....
+
+Output
+
+....
+xMH5uM1V9vQzVUv5LG7YLA==
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/datasource-password-encryption.md
----------------------------------------------------------------------
diff --git a/docs/datasource-password-encryption.md b/docs/datasource-password-encryption.md
deleted file mode 100644
index f8aa7cc..0000000
--- a/docs/datasource-password-encryption.md
+++ /dev/null
@@ -1,128 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=DataSource Password Encryption
-~~~~~~
-_Apache OpenEJB 3.1.2 or later required_
-
-_TomEE 1.5.0 switched from Apache Commons-DBCP to Tomcat-pool. On that specific version, password encryption is not
-available. You can still switch back to Apache Commons DBCP buy adding the following property: DataSourceCreator dbcp.
-On all following versions, the database encryption will be ported and hence available on Tomcat-pool as well._
-
-<a name="DataSourcePasswordEncryption-Cipheringpasswords"></a>
-# Ciphering passwords
-Apache OpenEJB now provides an easy and extensible way to cipher databases
-passwords. Not that by default, this feature is not activated so plain
-passwords are used.
-
-<a name="DataSourcePasswordEncryption-Usage"></a>
-## Usage
-
-Default Plain text password example:
-
- <Resource id="MySQL Database" type="DataSource">
- # MySQL example
- #
- # This connector will not work until you download the driver at:
- # http://www.mysql.com/downloads/api-jdbc-stable.html
-
- JdbcDriver com.mysql.jdbc.Driver
- JdbcUrl jdbc:mysql://localhost/test
- UserName test
- Password Passw0rd
- </Resource>
-
-
-3DES ciphered password example.
-
-Note that the built in 3DES implementation uses *a static key* to
-encode/decode your password. _It's only meant to be a sample on how to implement a Codec. On a real
-enterprise life, you should implement your how relying on an HSM for example._
-The easiest way to do it is to implement the *org.apache.openejb.resource.jdbc.cipher.PasswordCipher* interface.
-
- <Resource id="MySQL Database" type="DataSource">
- # MySQL example
- #
- # This connector will not work until you download the driver at:
- # http://www.mysql.com/downloads/api-jdbc-stable.html
-
- JdbcDriver com.mysql.jdbc.Driver
- JdbcUrl jdbc:mysql://localhost/test
- UserName test
-
- # ciphered value for Passw0rd using Static3DES codec is
- xMH5uM1V9vQzVUv5LG7YLA==
- Password xMH5uM1V9vQzVUv5LG7YLA==
- PasswordCipher Static3DES
- </Resource>
-
-
-# Hint
-You can plug your own algorithm to extend Apache OpenEJB built in ones. To
-do such, you just need to implement the
-
-## Command line tool
-
-Apache OpenEJB also provides a command line tool allowing password cipher
-algorithm. Actually, it's useful to get the ciphered value of a plain text
-value using a given algorithm.
-
-### NAME
-
-openejb cipher - OpenEJB Cypher Tool
-
-### SYNOPSIS
-
- openejb cipher [#options]
-
-### DESCRIPTION
-
-The OpenEJB Cipher tool is an OPTIONAL tool that allows you to use
-`PasswordCipher` algorithm to encode/decode values.
-
-*This tool isn't package by default on TomEE 1.5.0. It's only available on the standalone distribution. After 1.5.0, it's in TomEE as well.*
-
-The OpenEJB Cipher tool can be executed from any directory as long as
-`<OPENEJB_HOME>/bin` is in the system PATH. Before running this tool you need
-to set the environment variable OPENEJB_HOME to the path of the directory
-where you unpacked the OpenEJB installation. For for the remainder of this
-document we will assume you unpacked OpenEJB into the directory
-C:\openejb-3.1.2.
-
-In Windows, the cipher tool can be executed as follows:
-
- `C:\openejb-3.1.2> bin\openejb cipher --help`
-
-In UNIX, Linux, or Mac OS X, the cipher tool can be executed as follows:
-
- `\[user@host openejb-3.1.2]# bin/openejb cipher --help`
-
-Depending on your OpenEJB version, you may need to change execution bits to
-make the scripts executable. You can do this with the following command.
-
- `\[user@host openejb-3.1.2]# chmod 755 bin/openejb`
-
-From here on out, it will be assumed that you know how to execute the right
-openejb script for your operating system and commands will appear in
-shorthand as show below.
-
- `openejb cipher --help`
-
-### OPTIONS
-
-<table class="mdtable">
-<tr><td>-h, --_help_ <td></td>Lists these options and exit.</td></tr>
-<tr><td>-c, --_cipher_ <td></td>Specifies the password cipher implementation to use (default is Static3DES).</td></tr>
-<tr><td>-d, --_decrypt_ <td></td>Switches command line tool to decrypt.</td></tr>
-<tr><td>-e, --_encrypt_ <td></td>Switches command line tool to encrypt (default).</td></tr>
-</table>
-
-### EXAMPLES
-
-Encrypt a plain password using the default algorithm.
-
- `openejb cipher Passw0rd`
-
-Output
-
- xMH5uM1V9vQzVUv5LG7YLA==
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deamon/lin-service.adoc
----------------------------------------------------------------------
diff --git a/docs/deamon/lin-service.adoc b/docs/deamon/lin-service.adoc
new file mode 100644
index 0000000..bafa638
--- /dev/null
+++ b/docs/deamon/lin-service.adoc
@@ -0,0 +1,24 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+###Installing
+TomEE as a Windows® Service
+
+The different architecture exe's are as follows (so always use the one
+that matches your system):
+
+TomEE.amd64.exe = 64bit OS TomEE.ia64.exe = Itanium OS TomEE.x86.exe =
+32bit OS
+
+The only difference to Tomcat is that they ship with 'like named'
+binaries, but in sub-directories - Or offer separate downloads for your
+OS. We just modified the batch files to detect your arch-type and use
+the correct binaries. Everything is all in the 'bin' directory so we
+only have a one zip fits all approach.
+
+Definitive documentation can be found here:
+
+http://commons.apache.org/proper/commons-daemon/procrun.html
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deamon/lin-service.md
----------------------------------------------------------------------
diff --git a/docs/deamon/lin-service.md b/docs/deamon/lin-service.md
deleted file mode 100644
index f5bc18c..0000000
--- a/docs/deamon/lin-service.md
+++ /dev/null
@@ -1,17 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-###Installing TomEE as a Windows® Service
-
-The different architecture exe's are as follows (so always use the one that matches your system):
-
-TomEE.amd64.exe = 64bit OS
-TomEE.ia64.exe = Itanium OS
-TomEE.x86.exe = 32bit OS
-
-The only difference to Tomcat is that they ship with 'like named' binaries, but in sub-directories - Or offer separate downloads for your OS. We just modified the batch files to detect your arch-type and use the correct binaries. Everything is all in the 'bin' directory so we only have a one zip fits all approach.
-
-Definitive documentation can be found here:
-
-http://commons.apache.org/proper/commons-daemon/procrun.html
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deamon/win-service.adoc
----------------------------------------------------------------------
diff --git a/docs/deamon/win-service.adoc b/docs/deamon/win-service.adoc
new file mode 100644
index 0000000..bafa638
--- /dev/null
+++ b/docs/deamon/win-service.adoc
@@ -0,0 +1,24 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+###Installing
+TomEE as a Windows® Service
+
+The different architecture exe's are as follows (so always use the one
+that matches your system):
+
+TomEE.amd64.exe = 64bit OS TomEE.ia64.exe = Itanium OS TomEE.x86.exe =
+32bit OS
+
+The only difference to Tomcat is that they ship with 'like named'
+binaries, but in sub-directories - Or offer separate downloads for your
+OS. We just modified the batch files to detect your arch-type and use
+the correct binaries. Everything is all in the 'bin' directory so we
+only have a one zip fits all approach.
+
+Definitive documentation can be found here:
+
+http://commons.apache.org/proper/commons-daemon/procrun.html
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deamon/win-service.md
----------------------------------------------------------------------
diff --git a/docs/deamon/win-service.md b/docs/deamon/win-service.md
deleted file mode 100644
index f5bc18c..0000000
--- a/docs/deamon/win-service.md
+++ /dev/null
@@ -1,17 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-###Installing TomEE as a Windows® Service
-
-The different architecture exe's are as follows (so always use the one that matches your system):
-
-TomEE.amd64.exe = 64bit OS
-TomEE.ia64.exe = Itanium OS
-TomEE.x86.exe = 32bit OS
-
-The only difference to Tomcat is that they ship with 'like named' binaries, but in sub-directories - Or offer separate downloads for your OS. We just modified the batch files to detect your arch-type and use the correct binaries. Everything is all in the 'bin' directory so we only have a one zip fits all approach.
-
-Definitive documentation can be found here:
-
-http://commons.apache.org/proper/commons-daemon/procrun.html
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/declaring-references.adoc
----------------------------------------------------------------------
diff --git a/docs/declaring-references.adoc b/docs/declaring-references.adoc
new file mode 100644
index 0000000..c6c3107
--- /dev/null
+++ b/docs/declaring-references.adoc
@@ -0,0 +1,6 @@
+# Declaring References
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/declaring-references.md
----------------------------------------------------------------------
diff --git a/docs/declaring-references.md b/docs/declaring-references.md
deleted file mode 100644
index 5cfabca..0000000
--- a/docs/declaring-references.md
+++ /dev/null
@@ -1,6 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Declaring References
-~~~~~~
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deploy-tool.adoc
----------------------------------------------------------------------
diff --git a/docs/deploy-tool.adoc b/docs/deploy-tool.adoc
new file mode 100644
index 0000000..f269dfe
--- /dev/null
+++ b/docs/deploy-tool.adoc
@@ -0,0 +1,167 @@
+:index-group: OpenEJB
+Standalone Server
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: Deploy Tool
+
+
+# NAME
+
+openejb deploy - OpenEJB Deploy Tool
+
+# SYNOPSIS
+
+____________________________________________________________________
+openejb deploy link:#DeployTool-OPTIONS[options] <file> [<file> ...]
+____________________________________________________________________
+
+# NOTE
+
+The OpenEJB Deploy tool is an OPTIONAL tool that allows you to deploy
+into a running server and get feedback as if the app was deployed and
+how it was deployed (deploymentIds, jndi names, etc.).
+
+It can be used to deploy into an offline server, however in this
+scenario it simply copies the archive into the deployment directory (by
+default `openejb.base/apps`) which is something that can be done
+manually with a simple copy command or drag and drop.
+
+The OpenEJB Deploy tool can be executed from any directory as long as
+`openejb.home/bin` is in the system PATH. `openejb.home` is the
+directory where OpenEJB was installed or unpacked. For for the remainder
+of this document we will assume you unpacked OpenEJB into the directory
+`C:\openejb-3.0` under Windows.
+
+In Windows, the deploy tool can be executed as follows:
+
+________________________
+C:-3.0> bindeploy --help
+________________________
+
+In UNIX, Linux, or Mac OS X, the deploy tool can be executed as follows:
+
+____________________________________
+user@host# bin/openejb deploy --help
+____________________________________
+
+Depending on your OpenEJB version, you may need to change execution bits
+to make the scripts executable. You can do this with the following
+command.
+
+_______________________________
+user@host# chmod +x bin/openejb
+_______________________________
+
+From here on out, it will be assumed that you know how to execute the
+right openejb script for your operating system and commands will appear
+in shorthand as show below.
+
+_____________________
+openejb deploy --help
+_____________________
+
+# DESCRIPTION
+
+The files passed to the Deploy Tool can be any combination of the
+following:
+
+* EJB 1.1, 2.0, 2.1, 3.0 or 3.1 jar
+* application client jar
+* EAR file containing only libraries, EJBs and application clients --
+everything else will be ignored.
+
+The type of the files passed is determined as follows:
+
+* Archives ending in `.ear` or containing a `META-INF/application.xml`
+are assumed to be EAR files.
+* Archives containing a `META-INF/ejb-jar.xml` file or any classes
+annotated with `@Stateless`, `@Stateful` or `@MessageDriven`, are
+assumed to be _EJB_ applications. EJB applications older that EJB 3.0
+should contain a complete `META-INF/ejb-jar.xml` inside the jar, however
+we do not strictly enforce that -- the act of it being incomplete makes
+it an EJB 3.0 application by nature.
+* Archives containing a `META-INF/application-client.xml` or with a
+`META-INF/MANIFEST.MF` containing the `Main-Class` attribute, are
+assumed to be _Application Client_ archives.
+
+# OPTIONS
+
+-d, --debug
+
+Increases the level of detail on validation errors and deployment
+summary.
+
+--dir
+
+Sets the destination directory where the app will be deployed. The
+default is /apps/ directory. Note when changing this setting make sure
+the directory is listed in the openejb.xml via a tag or the app will not
+be picked up again on restart.
+
+-conf file
+
+Sets the OpenEJB configuration to the specified file.
+
+-h, --help
+
+Lists these options and exit.
+
+-o, --offline
+
+Deploys the app to an offline server by copying the archive into the
+server's apps/ directory. The app will be deployed when the server is
+started. The default is online.
+
+-q, --quiet
+
+Decreases the level of detail on validation and skips the deployment
+summary.
+
+-s, --server-url <url>
+
+Sets the url of the OpenEJB server to which the app will be deployed.
+The value should be the same as the JNDI Provider URL used to lookup
+EJBs. The default is 'ejbd://localhost:4201'.
+
+-v, --version
+
+Prints the OpenEJB version and exits.
+
+# EXAMPLES
+
+== Deploying multiple jar files
+
+__________________________________
+openejb deploy myapp.jar myapp.jar
+__________________________________
+
+Deploys the beans in the fooEjbs.jar first, then deploys the beans in
+the barEjbs.jar. Wildcards can be used as well.
+
+_________________________
+openejb deploy myapp*.jar
+_________________________
+
+# OUTPUT
+
+On running the deploy tool with a valid EJB jar the following output is
+printed on the console
+
+....
+Application deployed successfully at {0}
+App(id=C:\samples\Calculator-new\hello-addservice.jar)
+ EjbJar(id=hello-addservice.jar, path=C:\samples\Calculator-new\hello-addservice.jar)
+ Ejb(ejb-name=HelloBean, id=HelloBean)
+ Jndi(name=HelloBean)
+ Jndi(name=HelloBeanLocal)
+
+ Ejb(ejb-name=AddServiceBean, id=AddServiceBean)
+ Jndi(name=AddServiceBean)
+ Jndi(name=AddServiceBeanLocal)
+....
+
+Note: In the above case the command used is: > openejb deploy
+hello-addservice.jar
+
+The JAR file contains two EJBs: AddServiceBean and HelloBean.
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deploy-tool.md
----------------------------------------------------------------------
diff --git a/docs/deploy-tool.md b/docs/deploy-tool.md
deleted file mode 100644
index df0137d..0000000
--- a/docs/deploy-tool.md
+++ /dev/null
@@ -1,165 +0,0 @@
-index-group=OpenEJB Standalone Server
-type=page
-status=published
-title=Deploy Tool
-~~~~~~
-
-<a name="DeployTool-NAME"></a>
-# NAME
-
-openejb deploy - OpenEJB Deploy Tool
-
-<a name="DeployTool-SYNOPSIS"></a>
-# SYNOPSIS
-
-> openejb deploy [options](#DeployTool-OPTIONS) <file> \[<file> ...\]
-
-<a name="DeployTool-NOTE"></a>
-# NOTE
-
-
-The OpenEJB Deploy tool is an OPTIONAL tool that allows you to deploy into
-a running server and get feedback as if the app was deployed and how it was
-deployed (deploymentIds, jndi names, etc.).
-
-It can be used to deploy into an offline server, however in this scenario
-it simply copies the archive into the deployment directory (by default `openejb.base/apps`) which is
-something that can be done manually with a simple copy command or drag and
-drop.
-
-The OpenEJB Deploy tool can be executed from any directory as long as
-`openejb.home/bin` is in the system PATH. `openejb.home` is the directory
-where OpenEJB was installed or unpacked. For for the remainder of this
-document we will assume you unpacked OpenEJB into the directory
-`C:\openejb-3.0` under Windows.
-
-In Windows, the deploy tool can be executed as follows:
-
-> C:\openejb-3.0> bin\openejb deploy --help
-
-In UNIX, Linux, or Mac OS X, the deploy tool can be executed as follows:
-
-> user@host# bin/openejb deploy --help
-
-Depending on your OpenEJB version, you may need to change execution bits to
-make the scripts executable. You can do this with the following command.
-
-> user@host# chmod +x bin/openejb
-
-From here on out, it will be assumed that you know how to execute the right
-openejb script for your operating system and commands will appear in
-shorthand as show below.
-
-> openejb deploy --help
-
-
-<a name="DeployTool-DESCRIPTION"></a>
-# DESCRIPTION
-
-The files passed to the Deploy Tool can be any combination of the
-following:
-
-* EJB 1.1, 2.0, 2.1, 3.0 or 3.1 jar
-* application client jar
-* EAR file containing only libraries, EJBs and application clients --
-everything else will be ignored.
-
-The type of the files passed is determined as follows:
-
-* Archives ending in `.ear` or containing a `META-INF/application.xml` are
-assumed to be EAR files.
-* Archives containing a `META-INF/ejb-jar.xml` file or any classes annotated
-with `@Stateless`, `@Stateful` or `@MessageDriven`, are assumed to be *EJB*
-applications. EJB applications older that EJB 3.0 should contain a
-complete `META-INF/ejb-jar.xml` inside the jar, however we do not strictly
-enforce that -- the act of it being incomplete makes it an EJB 3.0
-application by nature.
-* Archives containing a `META-INF/application-client.xml` or with a
-`META-INF/MANIFEST.MF` containing the `Main-Class` attribute, are assumed to
-be *Application Client* archives.
-
-
-<a name="DeployTool-OPTIONS"></a>
-# OPTIONS
-
-<table class="mdtable">
-<tr>
-<td>-d, --debug </td>
-<td>Increases the level of detail on validation errors and
-deployment summary.</td>
-</tr>
-
-<tr><td>--dir </td>
-<td>Sets the destination directory where the app will be deployed.
-The default is <OPENEJB_HOME>/apps/ directory. Note when changing this
-setting make sure the directory is listed in the openejb.xml via a
-<Deployments dir=""/> tag or the app will not be picked up again on
-restart.
-</tr>
-
-<tr><td>-conf file </td>
-<td>Sets the OpenEJB configuration to the specified file.</td></tr>
-
-<tr><td>-h, --help </td>
-<td>Lists these options and exit.</td></tr>
-
-<tr><td>-o, --offline</td>
-<td>Deploys the app to an offline server by copying the
-archive into the server's apps/ directory. The app will be deployed when
-the server is started. The default is online.</td></tr>
-
-<tr><td>-q, --quiet </td>
-<td> Decreases the level of detail on validation and skips the
-deployment summary.</td></tr>
-
-<tr><td>-s, --server-url <url> </td>
-<td> Sets the url of the OpenEJB server to which
-the app will be deployed. The value should be the same as the JNDI
-Provider URL used to lookup EJBs. The default is 'ejbd://localhost:4201'.
-</td></tr>
-
-<tr><td>-v, --version</td>
-<td> Prints the OpenEJB version and exits. </td></tr>
-</table>
-
-
-<a name="DeployTool-EXAMPLES"></a>
-# EXAMPLES
-
-
-<a name="DeployTool-Deployingmultiplejarfiles"></a>
-## Deploying multiple jar files
-
-
-> openejb deploy myapp\fooEjbs.jar myapp\barEjbs.jar
-
-
-Deploys the beans in the fooEjbs.jar first, then deploys the beans in the
-barEjbs.jar. Wildcards can be used as well.
-
-> openejb deploy myapp\*.jar
-
-
-<a name="DeployTool-OUTPUT"></a>
-# OUTPUT
-
-On running the deploy tool with a valid EJB jar the following output is
-printed on the console
-
-
- Application deployed successfully at {0}
- App(id=C:\samples\Calculator-new\hello-addservice.jar)
- EjbJar(id=hello-addservice.jar, path=C:\samples\Calculator-new\hello-addservice.jar)
- Ejb(ejb-name=HelloBean, id=HelloBean)
- Jndi(name=HelloBean)
- Jndi(name=HelloBeanLocal)
-
- Ejb(ejb-name=AddServiceBean, id=AddServiceBean)
- Jndi(name=AddServiceBean)
- Jndi(name=AddServiceBeanLocal)
-
-
-Note: In the above case the command used is:
-> openejb deploy hello-addservice.jar
-
-The JAR file contains two EJBs: AddServiceBean and HelloBean.
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deploying-in-tomee.adoc
----------------------------------------------------------------------
diff --git a/docs/deploying-in-tomee.adoc b/docs/deploying-in-tomee.adoc
new file mode 100644
index 0000000..7d1c322
--- /dev/null
+++ b/docs/deploying-in-tomee.adoc
@@ -0,0 +1,73 @@
+:index-group: General Information
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+NOTE: Licensed to the Apache Software Foundation (ASF) under
+one or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information regarding
+copyright ownership. The ASF licenses this file to you 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.
+
+#Deploying in TomEE
+
+Deploying applications in TomEE is as simple as deploying them in
+Tomcat.
+
+You could deploy your application in Eclipse just like how you would
+deploy with Tomcat. For an example,
+link:tomee-and-eclipse.html[tomee-and-eclipse] shows how to use TomEE
+with Eclipse.
+
+Or you can simply package your application as a standard *WAR* file and
+copy it to the *[TomEE]/webapps* folder, or as an *EAR* file and copy it
+to the *[TomEE]/apps* folder.
+
+Read on to learn more about packaging EJBs in a WAR file.
+
+== Packaging
+
+==== One archive
+
+The basic idea of this approach is that your Servlets and EJBs are
+together in your WAR file as one application.
+
+* No classloader boundaries between Servlets and EJBs
+* EJBs and Servlets can share all third-party libraries (like Spring!)
+* No EAR required.
+* Can put the web.xml and ejb-jar.xml in the same archive (the WAR file)
+* EJBs can see Servlet classes and vice versa
+
+==== Not quite J2EE (But it is Java EE 6)
+
+This is very different than J2EE or Java EE 5 as there are not several
+levels of separation and classloader hierarchy any more. +
+This may take some getting used to and it is important to understand
+that this style of packaging is *not* J2EE compliant. +
+You should not worry though, as it is an accepted feature of Java EE 6.
+
+=== J2EE classloading rules:
+
+* You cannot ever have EJBs and Servlets in the same classloader.
+* Three classloader minimum; a classloader for the ear, one for each
+ejb-jar, and one for each WAR file.
+* Servlets can see EJBs, but EJBs cannot see Servlets.
+
+To pull that off, J2EE has to kill you on packaging: - You cannot have
+EJB classes and Servlet classes in the same archive.
+
+* You need at least three archives to combine Servlets and EJBs; 1 EAR
+containing 1 EJB jar and 1 Servlet WAR.
+* Shared libraries must go in the EAR and be included in a specially
+formatted 'Class-Path' entry in the EAR's MANIFEST file.
+
+Critically speaking, forcing more than one classloader on an application
+is where J2EE "jumps the shark" for a large majority of people's needs.
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deploying-in-tomee.md
----------------------------------------------------------------------
diff --git a/docs/deploying-in-tomee.md b/docs/deploying-in-tomee.md
deleted file mode 100644
index 63f1d42..0000000
--- a/docs/deploying-in-tomee.md
+++ /dev/null
@@ -1,73 +0,0 @@
-index-group=General Information
-type=page
-status=published
-title=
-~~~~~~
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-#Deploying in TomEE
-
-Deploying applications in TomEE is as simple as deploying them in Tomcat.
-
-You could deploy your application in Eclipse just like how you would deploy with Tomcat. For an example, [tomee-and-eclipse](tomee-and-eclipse.html) shows how to use TomEE with Eclipse.
-
-Or you can simply package your application as a standard **WAR** file and copy it to the **[TomEE]/webapps** folder, or as an **EAR** file and copy it to the **[TomEE]/apps** folder.
-
-Read on to learn more about packaging EJBs in a WAR file.
-
-
-### Packaging
-
-<a name="CollapsedEAR-Onearchive"></a>
-#### One archive
-
-The basic idea of this approach is that your Servlets and EJBs are together in your WAR file as one application.
-
- - No classloader boundaries between Servlets and EJBs
-
- - EJBs and Servlets can share all third-party libraries (like Spring\!)
-
- - No EAR required.
-
- - Can put the web.xml and ejb-jar.xml in the same archive (the WAR file)
-
- - EJBs can see Servlet classes and vice versa
-
-<a name="CollapsedEAR-NotquiteJ2EE(itistrulyJava EE6)"></a>
-#### Not quite J2EE (But it is Java EE 6)
-
-This is very different than J2EE or Java EE 5 as there are not several levels of separation and classloader hierarchy any more.
-This may take some getting used to and it is important to understand that this style of packaging is **not** J2EE compliant.
-You should not worry though, as it is an accepted feature of Java EE 6.
-
-#### J2EE classloading rules:
- - You cannot ever have EJBs and Servlets in the same classloader.
-
- - Three classloader minimum; a classloader for the ear, one for each
-ejb-jar, and one for each WAR file.
-
- - Servlets can see EJBs, but EJBs cannot see Servlets.
-
- To pull that off, J2EE has to kill you on packaging:
- - You cannot have EJB classes and Servlet classes in the same archive.
-
- - You need at least three archives to combine Servlets and EJBs; 1 EAR containing 1 EJB jar and 1 Servlet WAR.
-
- - Shared libraries must go in the EAR and be included in a specially formatted 'Class-Path' entry in the EAR's MANIFEST file.
-
- Critically speaking, forcing more than one classloader on an application is where J2EE "jumps the shark" for a large majority of people's needs.
http://git-wip-us.apache.org/repos/asf/tomee/blob/b45a3d00/docs/deployment-id.adoc
----------------------------------------------------------------------
diff --git a/docs/deployment-id.adoc b/docs/deployment-id.adoc
new file mode 100644
index 0000000..0855413
--- /dev/null
+++ b/docs/deployment-id.adoc
@@ -0,0 +1,231 @@
+# Deployment ID
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# What is a Deployment ID?
+
+Every bean deployed in OpenEJB has a unique deployment-id that
+identifies it within the scope of the entire container system. The
+server and container system refer beans at run-time using the bean's
+deployment id.
+
+== Like ejb-name
+
+This deployment id is much like the element of the ejb-jar.xml , with
+one very important difference. The is only required to be unique within
+the scope of the ejb-jar.xml in the bean's jar. The deployment id is
+required to be unique across all beans and jars in OpenEJB. This is a
+subtle, but important, distinction.
+
+Remember that the EJB specification was designed so that enterprise
+beans could be create, packaged, and sold by vendors (EJB Providers).
+Furthermore, users should be able to buy a packaged set of beans (a jar
+with an ejb-jar.xml in it) and deploy it into an EJB Container without
+modification.
+
+== The ejb-name is not unique
+
+Let's consider this, what happens if two vendors each sell a package
+(jar) that contains a bean with the PurchaseOrder? Both are completely
+different in terms functionality and are different beans in every other
+respect. The EJB spec says, this is fine, ejb-names only have to unique
+within the jar and that jar's ejb-jar.xml file. It's ridiculous to
+expect EJB Providers to call each other up and ask, "Are you already
+using the name 'PurchaseOrder' in your jar?" Remember that the EJB
+specification was designed so that enterprise beans could be create,
+packaged, and sold by vendors (EJB Providers). Furthermore, users should
+be able to buy a packaged set of beans (a jar with an ejb-jar.xml in it)
+and deploy it into an EJB Container without modification. This is all
+fine and dandy, but it still leaves it up to the EJB Container/Server
+providers to settle the difference.
+
+== The deployment-id is unique
+
+OpenEJB solves this with the OpenEJB-specific deployment id. By
+requiring that each bean deployed into OpenEJB has a unique name, we can
+guarantee that we are always referring to the right bean at all times.
+Furthermore, it allows you to deploy different versions of the same
+package several times in the same container system, each time giving the
+beans new deployment ids.
+
+== Using ejb-name as deployment-id anyway
+
+If you're lazy -- as any truly great programmer should be -- and don't
+want to type a deployment id for each bean every time you deploy a jar,
+you can use the -D option of the Deploy Tool. This will throw caution to
+the wind, and automatically assign the bean's ejb-name as the value of
+the bean's OpenEJB deployment id. This leaves up to you to guarantee
+that bean's ejb-name will be unique across all beans and jars in the
+container system. In other words, be very careful with the -D option!
+
+# How is it used?
+
+== In the container system
+
+In the container system, the deployment id is used to index the bean in
+a system-wide registry. This registry is refereed to on every call made
+in the container system. Being able to safely hash and cache bean
+information by id is a must. This stresses the importance of unique ids
+for every bean deployed in OpenEJB.
+
+== In the Local Server
+
+The Local (IntraVM) Server is an integral part of the container system
+and the two are, in many ways, inseparable. The Local Server takes care
+of all bean to bean and client to bean invocations made inside the
+virtual machine. For this reason, it often refered to as the IntraVM
+Server.
+
+For bean to bean communications, the Local Server must create a JNDI
+namespace (JNDI ENC) for each bean as defined by the bean's , , and
+elements of the bean's ejb-jar.xml file. Every bean literally gets its
+very own JNDI namespace. When a bean makes a JNDI call, the Local Server
+intercepts this call and uses the deployment id of the calling bean to
+retrieve that bean's private JNDI namespace from the container system's
+index. The Local Server then carries out the lookup on that bean's
+namespace.
+
+All non-bean clients share one big global namespace. Since non-bean
+clients are not deployed and do not have a deployment descriptor like an
+ejb-jar.xml, the Local Server is unable to taylor a namespace for each
+non-bean client as it can for bean clients. The Local server cannot
+identify non-bean clients as they have no deployment id. All JNDI calls
+made by clients that the Local Server cannot identify go to the public,
+global namespace. The public, global JNDI namespace contains all beans
+and resources in the container system. name.
+
+Each bean is added to the public, global namespace using it's deployment
+id as its JNDI lookup. For example, if a bean had a deployment-id of
+"/my/bean/foo", a non-bean client could lookup that bean as follows.
+
+....
+...
+Object bean = initialContext.lookup("/my/bean/Foo");
+...
+....
+
+If a bean in the container system made the above JNDI call, the Local
+Server would see the bean's identity (deployment id) hidden in the
+Thread, go get the bean's private JNDI namespace and finish the lookup
+on that. Since all names in bean's JNDI namespace are required start
+with "java:comp/env", the lookup would fail and the bean would receive a
+javax.naming.NameNotFoundException.
+
+In short...
+
+For beans: - Each bean has it's own private, personalized JNDI namespace
+- The names in it are the same names it uses in its ejb-jar.xml - Beans
+can only access their private namespace, period
+
+For non-beans (everyone else): - Non-bean clients share the public,
+global JNDI namespace - The names in it are the deployment ids of all
+the beans - Non-bean clients can only access the one global namespace
+
+== In the Remote Server
+
+The Remote Server has a public, global namespace just as the Local
+Server does. The difference being that the Remote Server only serves
+clients outside the container system and outside the virtual machine.
+So, all clients from the perspective of the Remote Server are non-bean
+clients. As a result, the Remote Server only has the one public, global
+JNDI namespace. Just as in the Local Server, the names in this namespace
+consist of the deployment ids of the beans in the container system.
+
+Just as before, clients can lookup beans from the Remote Server using
+the bean's deployment id. For example, if a bean had a deployment-id of
+"/my/bean/foo", a client could lookup that bean as follows.
+
+....
+...
+Object bean = initialContext.lookup("/my/bean/Foo");
+...
+....
+
+== In the CORBA Adapter
+
+The CORBA Adapter is separate than the Remote Server. It adapts the
+OpenEJB Container System and the Local Server into OpenORB as an
+embedded library. It provides users of OpenORB the ability to lookup and
+execute beans (EJBs) via the RMI-IIOP protocol. All the EJBHome and
+EJBObject interfaces of beans in OpenEJB are implemented by OpenORB as
+CORBA stubs and ties.
+
+The beans are exported into OpenORB's naming service by deployment id.
+So, just as with the Local Server and Remote Server, clients can lookup
+beans using the bean's deployment id. OpenORB has a JNDI implementation
+of their naming service, so lookups can be done just as before.
+
+....
+...
+String[] args = ...
+
+// The ORB and Object
+org.omg.CORBA.ORB orb = null;
+org.omg.CORBA.Object bean = null.
+
+// The Naming Service and Object Name
+org.omg.CosNaming.NamingContext context = null;
+org.omg.CosNaming.NameComponent[] name = null;
+
+// Get the ORB
+orb = org.omg.CORBA.ORB.init( args, null );
+
+// Get the Naming Service
+org.omg.CORBA.Object ref = null;
+ref = orb.resolve_initial_references("NameService");
+context = org.omg.CosNaming.NamingContextHelper.narrow( ref );
+
+// Get the Name as a component
+// Note: the string is the bean's deployment id
+name = new org.omg.CosNaming.NameComponent[ 1 ];
+name[0] = new org.omg.CosNaming.NameComponent("/my/bean/foo","");
+
+// Finally, get the bean as a CORBA object
+// Equvalent to an InitialContext.lookup("/my/bean/foo");
+bean = context.resolve( name );
+...
+....
+
+# What happens if there is a duplicate deployment ID?
+
+The deployment ID uniquely identifies the bean in the OpenEJB container
+system. Therefore, no two beans can share the same deployment ID.
+
+If a bean attempts to use a deployment ID that is already in use by
+another bean, the second bean and all beans in it's jar will not be
+loaded. In addition, the system will log a warning like the following
+one asking you to redeploy the jar and choose an different deployment ID
+for the bean.
+
+....
+WARN : Jar C:\openejb\beans\fooEjbs.jar cannot be loaded. The Deployment ID "/my/bean/foo" is already in use. Please redeploy this jar and assign a different deployment ID to the bean with the ejb-name "FooBean".
+....
+
+For example, the acmeEjbs.jar contains a bean with the ejb-name
+"DaffyDuckBean". The disneyEjbs.jar contains contains a bean with the
+ejb-name "DonaldDuckBean".
+
+We deploy the acmeEjbs.jar and give the "DaffyDuckBean" the deployment
+ID of "/my/favorite/duck". Sometime afterwards, we deploy the
+disneyEjbs.jar and assign the "DonaldDuckBean" the deployment ID
+"/my/favorite/duck", having forgotten that we already gave that unique
+ID to the "DaffyDuckBean" in the acmeEjbs.jar.
+
+When the container system is started, the system will begin loading all
+the beans one jar at a time. It will first load the acmeEjbs.jar and
+index each bean by deployment ID. But, when the system reaches the
+disneyEjbs.jar, it will discover that it cannot index the
+"DonaldDuckBean" using the deployment ID "/my/favorite/duck" because
+that index is already taken.
+
+The system cannot load the "DonaldDuckBean" and must also ignore the
+rest of the beans in the disneyEjbs.jar as they may need the
+"DonaldDuckBean" bean to function properly. The disneyEjbs.jar is
+skipped and the following warning is logged.
+
+....
+WARN : Jar C:\openejb\beans\disneyEjbs.jar cannot be loaded. The Deployment ID "/my/favorite/duck" is already in use. Please redeploy this jar and assign a different deployment ID to the bean with the ejb-name "DonaldDuckBean".
+....
[43/44] tomee git commit: This closes apache/tomee#253
Posted by jl...@apache.org.
This closes apache/tomee#253
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/74134bb6
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/74134bb6
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/74134bb6
Branch: refs/heads/master
Commit: 74134bb630c7e5eec92cd4628f2afae47398e243
Parents: d52a46d cf397de
Author: Jean-Louis Monteiro <je...@gmail.com>
Authored: Thu Dec 6 09:52:11 2018 +0100
Committer: Jean-Louis Monteiro <je...@gmail.com>
Committed: Thu Dec 6 09:52:11 2018 +0100
----------------------------------------------------------------------
docs/spring-and-openejb-3.0.adoc | 224 +++++++++++++++
docs/spring-and-openejb-3.0.md | 190 -------------
docs/spring-ejb-and-jpa.adoc | 195 +++++++++++++
docs/spring-ejb-and-jpa.md | 173 ------------
docs/spring.adoc | 139 ++++++++++
docs/spring.md | 124 ---------
docs/ssh.adoc | 63 +++++
docs/ssh.md | 51 ----
docs/standalone-server.adoc | 24 ++
docs/standalone-server.md | 27 --
docs/startup.adoc | 266 ++++++++++++++++++
docs/startup.md | 296 --------------------
docs/statefulcontainer-config.adoc | 165 +++++++++++
docs/statefulcontainer-config.md | 160 -----------
docs/statelesscontainer-config.adoc | 441 +++++++++++++++++++++++++++++
docs/statelesscontainer-config.md | 461 -------------------------------
docs/system-properties-files.adoc | 25 ++
docs/system-properties-files.md | 22 --
docs/system-properties.adoc | 68 +++++
docs/system-properties.md | 68 -----
20 files changed, 1610 insertions(+), 1572 deletions(-)
----------------------------------------------------------------------
[19/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 8
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb-jsr-107-integration.md
----------------------------------------------------------------------
diff --git a/docs/openejb-jsr-107-integration.md b/docs/openejb-jsr-107-integration.md
deleted file mode 100644
index f32eddf..0000000
--- a/docs/openejb-jsr-107-integration.md
+++ /dev/null
@@ -1,25 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=OpenEJB JSR-107 Integration
-~~~~~~
-
-<a name="OpenEJBJSR-107Integration-OpenEJBJSR-107(JCACHE)Integration"></a>
-# OpenEJB JSR-107 (JCACHE) Integration
-
-This page is for the collaboration for those involved with the integration
-of JSR-107 into OpenEJB.
-
-<a name="OpenEJBJSR-107Integration-Overview"></a>
-### Overview
-
-The idea here is to add a caching layer to OpenEJB. The overall objective
-is to improve performance in OpenEJB where applicable through caching EJBs.
-
-<a name="OpenEJBJSR-107Integration-Status"></a>
-### Status
-
-Dain and myself (Jeremy) have deciphered the JSR-107 spec and how I am
-working on the first crude integration of JCACHE into OpenEJB. Anyone
-interested in helping or providing any feedback/suggestions, please contact
-me via the developer mailing list.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb.xml.adoc
----------------------------------------------------------------------
diff --git a/docs/openejb.xml.adoc b/docs/openejb.xml.adoc
new file mode 100644
index 0000000..00dd7f6
--- /dev/null
+++ b/docs/openejb.xml.adoc
@@ -0,0 +1,96 @@
+:jbake-title: openejb.xml
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# Overview
+
+The openejb.xml is the main configuration file for the container system
+and its services such as transaction, security, and data sources.
+
+The format is a mix of xml and properties inspired by the format of the
+httpd configuration file. Basically:
+
+....
+<tag id="">
+ ...properties...
+</tag>
+....
+
+Such as:
+
+....
+<Resource id="MyDataSource" type="DataSource">
+ username foo
+ password bar
+</Resource>
+....
+
+_Note the space_. White space is a valid name/value pair separator in
+any java properties file (along with semi-colon). So the above is
+equivalent to:
+
+....
+<Resource id="MyDataSource" type="DataSource">
+ username = foo
+ password = bar
+</Resource>
+....
+
+You are free to use white space, ":", or "=" for your name/value pair
+separator with no effect on OpenEJB.
+
+== Property Defaults and Overriding
+
+The openejb.xml file itself functions as an override, default values are
+specified via other means (service-jar.xml files in the classpath),
+therefore you only need to specify property values here for 2 reasons:
+1. you wish to for documentation purposes 2. you need to change the
+default value
+
+The default openejb.xml file has most of the useful properties for each
+component explicitly listed with default values for documentation
+purposes. It is safe to delete them and be assured that no behavior will
+change if a smaller config file is desired.
+
+Overriding can also be done via the command line or plain Java system
+properties. See link:system-properties.html[System Properties] for
+details.
+
+== What properties are available?
+
+To know what properties can be overriden the './bin/openejb properties'
+command is very useful: see link:properties-tool.html[Properties Tool]
+
+Its function is to connect to a running server and print a canonical
+list of all properties OpenEJB can see via the various means of
+configuration. When sending requests for help to the users list or jira,
+it is highly encouraged to send the output of this tool with your
+message.
+
+== Not configurable via openejb.xml
+
+The only thing not yet configurable via this file are ServerServices due
+to OpenEJB's embeddable nature and resulting long standing tradition of
+keeping the container system separate from the server layer. This may
+change someday, but untill then ServerServices are configurable via
+conf/.properties files such as conf/ejbd.properties to configure the
+main protocol that services EJB client requests.
+
+The format of those properties files is greatly adapted from the xinet.d
+style of configuration and even shares similar functionality and
+properties such as host-based authorization (HBA) via the 'only_from'
+property.
+
+== Restoring openejb.xml to the defaults
+
+To restore this file to its original default state, you can simply
+delete it or rename it and OpenEJB will see it's missing and unpack
+another openejb.xml into the conf/ directory when it starts.
+
+This is not only handy for recovering from a non-functional config, but
+also for upgrading as OpenEJB will not overwrite your existing
+configuration file should you choose to unpack an new distro over the
+top of an old one -- this style of upgrade is safe provided you move
+your old lib/ directory first.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openejb.xml.md
----------------------------------------------------------------------
diff --git a/docs/openejb.xml.md b/docs/openejb.xml.md
deleted file mode 100644
index 1836d35..0000000
--- a/docs/openejb.xml.md
+++ /dev/null
@@ -1,96 +0,0 @@
-title=openejb.xml
-type=page
-status=published
-~~~~~~
-
-<a name="openejb.xml-Overview"></a>
-# Overview
-
-The openejb.xml is the main configuration file for the container system and
-its services such as transaction, security, and data sources.
-
-The format is a mix of xml and properties inspired by the format of the
-httpd configuration file. Basically:
-
-
- <tag id="">
- ...properties...
- </tag>
-
-
-Such as:
-
-
- <Resource id="MyDataSource" type="DataSource">
- username foo
- password bar
- </Resource>
-
-
-*Note the space*. White space is a valid name/value pair separator in any
-java properties file (along with semi-colon). So the above is equivalent
-to:
-
- <Resource id="MyDataSource" type="DataSource">
- username = foo
- password = bar
- </Resource>
-
-You are free to use white space, ":", or "=" for your name/value pair
-separator with no effect on OpenEJB.
-
-<a name="openejb.xml-PropertyDefaultsandOverriding"></a>
-## Property Defaults and Overriding
-
-The openejb.xml file itself functions as an override, default values are
-specified via other means (service-jar.xml files in the classpath),
-therefore you only need to specify property values here for 2 reasons:<br/>
-1. you wish to for documentation purposes<br/>
-2. you need to change the default value
-
-The default openejb.xml file has most of the useful properties for each
-component explicitly listed with default values for documentation purposes.
- It is safe to delete them and be assured that no behavior will change if a
-smaller config file is desired.
-
-Overriding can also be done via the command line or plain Java system
-properties. See [System Properties](system-properties.html)
- for details.
-
-<a name="openejb.xml-Whatpropertiesareavailable?"></a>
-## What properties are available?
-
-To know what properties can be overriden the './bin/openejb properties'
-command is very useful: see [Properties Tool](properties-tool.html)
-
-Its function is to connect to a running server and print a canonical list
-of all properties OpenEJB can see via the various means of configuration.
-When sending requests for help to the users list or jira, it is highly
-encouraged to send the output of this tool with your message.
-
-<a name="openejb.xml-Notconfigurableviaopenejb.xml"></a>
-## Not configurable via openejb.xml
-
-The only thing not yet configurable via this file are ServerServices due to
-OpenEJB's embeddable nature and resulting long standing tradition of
-keeping the container system separate from the server layer. This may
-change someday, but untill then ServerServices are configurable via
-conf/<service-id>.properties files such as conf/ejbd.properties to
-configure the main protocol that services EJB client requests.
-
-The format of those properties files is greatly adapted from the xinet.d style
-of configuration and even shares similar functionality and properties such
-as host-based authorization (HBA) via the 'only_from' property.
-
-<a name="openejb.xml-Restoringopenejb.xmltothedefaults"></a>
-## Restoring openejb.xml to the defaults
-
-To restore this file to its original default state, you can simply delete
-it or rename it and OpenEJB will see it's missing and unpack another
-openejb.xml into the conf/ directory when it starts.
-
-This is not only handy for recovering from a non-functional config, but
-also for upgrading as OpenEJB will not overwrite your existing
-configuration file should you choose to unpack an new distro over the top
-of an old one -- this style of upgrade is safe provided you move your old
-lib/ directory first.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openjpa.adoc
----------------------------------------------------------------------
diff --git a/docs/openjpa.adoc b/docs/openjpa.adoc
new file mode 100644
index 0000000..92d4ff7
--- /dev/null
+++ b/docs/openjpa.adoc
@@ -0,0 +1,125 @@
+# OpenJPA
+:index-group: JPA
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+OpenJPA is bundled with OpenEJB as the default persistence provider.
+
+An example of working `persistence.xml` for OpenJPA:
+
+....
+<persistence xmlns="http://java.sun.com/xml/ns/persistence" version="1.0">
+
+ <persistence-unit name="movie-unit">
+ <jta-data-source>movieDatabase</jta-data-source>
+ <non-jta-data-source>movieDatabaseUnmanaged</non-jta-data-source>
+ <class>org.superbiz.injection.jpa.Movie</class>
+
+ <properties>
+ <property name="openjpa.jdbc.SynchronizeMappings" value="buildSchema(ForeignKeys=true)"/>
+ </properties>
+ </persistence-unit>
+</persistence>
+....
+
+Where the datasources above are configured in your openejb.xml as
+follows:
+
+....
+<Resource id="movieDatabase" type="DataSource">
+ JdbcDriver = org.hsqldb.jdbcDriver
+ JdbcUrl = jdbc:hsqldb:mem:moviedb
+</Resource>
+
+<Resource id="movieDatabaseUnmanaged" type="DataSource">
+ JdbcDriver = org.hsqldb.jdbcDriver
+ JdbcUrl = jdbc:hsqldb:mem:moviedb
+ JtaManaged = false
+</Resource>
+....
+
+Or in properties as follows:
+
+....
+p.put("movieDatabase", "new://Resource?type=DataSource");
+p.put("movieDatabase.JdbcDriver", "org.hsqldb.jdbcDriver");
+p.put("movieDatabase.JdbcUrl", "jdbc:hsqldb:mem:moviedb");
+
+p.put("movieDatabaseUnmanaged", "new://Resource?type=DataSource");
+p.put("movieDatabaseUnmanaged.JdbcDriver", "org.hsqldb.jdbcDriver");
+p.put("movieDatabaseUnmanaged.JdbcUrl", "jdbc:hsqldb:mem:moviedb");
+p.put("movieDatabaseUnmanaged.JtaManaged", "false");
+....
+
+== Common exceptions
+
+=== Table not found in statement
+
+Or as derby will report it "Table 'abc.xyz' doesn't exist"
+
+Someone has to create the database structure for your persistent
+objects. If you add the _openjpa.jdbc.SynchronizeMappings_ property as
+shown below OpenJPA will auto-create all your tables, all your primary
+keys and all foreign keys exactly to match your objects.
+
+....
+<persistence xmlns="http://java.sun.com/xml/ns/persistence" version="1.0">
+
+ <persistence-unit name="movie-unit">
+ <!-- your other stuff -->
+
+ <properties>
+ <property name="openjpa.jdbc.SynchronizeMappings" value="buildSchema(ForeignKeys=true)"/>
+ </properties>
+ </persistence-unit>
+</persistence>
+....
+
+== Auto-commit can not be set while enrolled in a transaction
+
+Pending
+
+== This broker is not configured to use managed transactions.
+
+=== Setup
+
+Using a EXTENDED persistence context ...
+
+....
+@PersistenceContext(unitName = "movie-unit", type = PersistenceContextType.EXTENDED)
+EntityManager entityManager;
+....
+
+on a persistence unit setup as RESOURCE_LOCAL ...
+
+....
+<persistence-unit name="movie-unit" transaction-type="RESOURCE_LOCAL">
+ ...
+</persistence-unit>
+....
+
+inside of a transaction.
+
+....
+@TransactionAttribute(TransactionAttributeType.REQUIRED)
+public void addMovie(Movie movie) throws Exception {
+ entityManager.persist(movie);
+}
+....
+
+Note the default transaction attribute for any ejb method is REQUIRED
+unless explicitly set otherwise in the bean class or method in question.
+
+=== Solutions
+
+You can either:
+
+[arabic]
+. Change your bean or it's method to use
+`TransactionAttributeType.NOT_REQUIRED` or
+`TransactionAttributeType.NEVER` which will guarantee it will not be
+invoked in a JTA transaction.
+. Change your persistence.xml so the persistence-unit uses
+`transaction-type="TRANSACTION"` making it capable of participating in a
+JTA transaction.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/openjpa.md
----------------------------------------------------------------------
diff --git a/docs/openjpa.md b/docs/openjpa.md
deleted file mode 100644
index 2ea21b6..0000000
--- a/docs/openjpa.md
+++ /dev/null
@@ -1,113 +0,0 @@
-index-group=JPA
-type=page
-status=published
-title=OpenJPA
-~~~~~~
-OpenJPA is bundled with OpenEJB as the default persistence provider.
-
-An example of working `persistence.xml` for OpenJPA:
-
- <persistence xmlns="http://java.sun.com/xml/ns/persistence" version="1.0">
-
- <persistence-unit name="movie-unit">
- <jta-data-source>movieDatabase</jta-data-source>
- <non-jta-data-source>movieDatabaseUnmanaged</non-jta-data-source>
- <class>org.superbiz.injection.jpa.Movie</class>
-
- <properties>
- <property name="openjpa.jdbc.SynchronizeMappings" value="buildSchema(ForeignKeys=true)"/>
- </properties>
- </persistence-unit>
- </persistence>
-
-
-Where the datasources above are configured in your openejb.xml as follows:
-
- <Resource id="movieDatabase" type="DataSource">
- JdbcDriver = org.hsqldb.jdbcDriver
- JdbcUrl = jdbc:hsqldb:mem:moviedb
- </Resource>
-
- <Resource id="movieDatabaseUnmanaged" type="DataSource">
- JdbcDriver = org.hsqldb.jdbcDriver
- JdbcUrl = jdbc:hsqldb:mem:moviedb
- JtaManaged = false
- </Resource>
-
-
-Or in properties as follows:
-
- p.put("movieDatabase", "new://Resource?type=DataSource");
- p.put("movieDatabase.JdbcDriver", "org.hsqldb.jdbcDriver");
- p.put("movieDatabase.JdbcUrl", "jdbc:hsqldb:mem:moviedb");
-
- p.put("movieDatabaseUnmanaged", "new://Resource?type=DataSource");
- p.put("movieDatabaseUnmanaged.JdbcDriver", "org.hsqldb.jdbcDriver");
- p.put("movieDatabaseUnmanaged.JdbcUrl", "jdbc:hsqldb:mem:moviedb");
- p.put("movieDatabaseUnmanaged.JtaManaged", "false");
-
-
-# Common exceptions
-
-## Table not found in statement
-
-Or as derby will report it "Table 'abc.xyz' doesn't exist"
-
-Someone has to create the database structure for your persistent objects.
-If you add the *openjpa.jdbc.SynchronizeMappings* property as shown below
-OpenJPA will auto-create all your tables, all your primary keys and all
-foreign keys exactly to match your objects.
-
- <persistence xmlns="http://java.sun.com/xml/ns/persistence" version="1.0">
-
- <persistence-unit name="movie-unit">
- <!-- your other stuff -->
-
- <properties>
- <property name="openjpa.jdbc.SynchronizeMappings" value="buildSchema(ForeignKeys=true)"/>
- </properties>
- </persistence-unit>
- </persistence>
-
-
-<a name="OpenJPA-Auto-commitcannotbesetwhileenrolledinatransaction"></a>
-## Auto-commit can not be set while enrolled in a transaction
-
-Pending
-
-<a name="OpenJPA-Thisbrokerisnotconfiguredtousemanagedtransactions."></a>
-## This broker is not configured to use managed transactions.
-
-<a name="OpenJPA-Setup"></a>
-### Setup
-
-Using a EXTENDED persistence context ...
-
- @PersistenceContext(unitName = "movie-unit", type = PersistenceContextType.EXTENDED)
- EntityManager entityManager;
-
-on a persistence unit setup as RESOURCE_LOCAL ...
-
- <persistence-unit name="movie-unit" transaction-type="RESOURCE_LOCAL">
- ...
- </persistence-unit>
-
-
-inside of a transaction.
-
- @TransactionAttribute(TransactionAttributeType.REQUIRED)
- public void addMovie(Movie movie) throws Exception {
- entityManager.persist(movie);
- }
-
-
-Note the default transaction attribute for any ejb method is REQUIRED
-unless explicitly set otherwise in the bean class or method in question.
-
-<a name="OpenJPA-Solutions"></a>
-### Solutions
-
-You can either:
-
-1. Change your bean or it's method to use `TransactionAttributeType.NOT_REQUIRED` or `TransactionAttributeType.NEVER` which will guarantee it will not be invoked in a JTA transaction.
-1. Change your persistence.xml so the persistence-unit uses `transaction-type="TRANSACTION"` making it capable of participating in a JTA transaction.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/orb-config.adoc
----------------------------------------------------------------------
diff --git a/docs/orb-config.adoc b/docs/orb-config.adoc
new file mode 100644
index 0000000..008c005
--- /dev/null
+++ b/docs/orb-config.adoc
@@ -0,0 +1,40 @@
+# ORB Configuration
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A ORB can be declared via xml in the `<tomee-home>/conf/tomee.xml` file
+or in a `WEB-INF/resources.xml` file using a declaration like the
+following. All properties in the element body are optional.
+
+....
+<Resource id="myORB" type="org.omg.CORBA.ORB">
+</Resource>
+....
+
+Alternatively, a ORB can be declared via properties in the
+`<tomee-home>/conf/system.properties` file or via Java VirtualMachine
+`-D` properties. The properties can also be used when embedding TomEE
+via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
+
+....
+myORB = new://Resource?type=org.omg.CORBA.ORB
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared ORB a warning will be
+logged. If a ORB is needed by the application and one is not declared,
+TomEE will create one dynamically using default settings. Multiple ORB
+declarations are allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/orb-config.md
----------------------------------------------------------------------
diff --git a/docs/orb-config.md b/docs/orb-config.md
deleted file mode 100644
index 34aa533..0000000
--- a/docs/orb-config.md
+++ /dev/null
@@ -1,26 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=ORB Configuration
-~~~~~~
-
-
-A ORB can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Resource id="myORB" type="org.omg.CORBA.ORB">
- </Resource>
-
-Alternatively, a ORB can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myORB = new://Resource?type=org.omg.CORBA.ORB
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared ORB a warning will be logged. If a ORB is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple ORB declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/persistence-context.adoc
----------------------------------------------------------------------
diff --git a/docs/persistence-context.adoc b/docs/persistence-context.adoc
new file mode 100644
index 0000000..c033d93
--- /dev/null
+++ b/docs/persistence-context.adoc
@@ -0,0 +1,59 @@
+# persistence-context
+:index-group: JPA
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Via annotation
+
+Both lookup and injection of an EntityManager can be configured via the
+`@PersistenceContext` annotation.
+
+....
+package org.superbiz;
+
+import javax.persistence.PersistenceContext;
+import javax.persistence.EntityManager;
+import javax.ejb.Stateless;
+import javax.naming.InitialContext;
+
+@Stateless
+@PersistenceContext(name = "myFooEntityManager", unitName = "foo-unit")
+public class MyBean implements MyInterface {
+
+ @PersistenceContext(unitName = "bar-unit")
+ private EntityManager myBarEntityManager;
+
+ public void someBusinessMethod() throws Exception {
+ if (myBarEntityManager == null) throw new NullPointerException("myBarEntityManager not injected");
+
+ // Both can be looked up from JNDI as well
+ InitialContext context = new InitialContext();
+ EntityManager fooEntityManager = (EntityManager) context.lookup("java:comp/env/myFooEntityManager");
+ EntityManager barEntityManager = (EntityManager) context.lookup("java:comp/env/org.superbiz.MyBean/myBarEntityManager");
+ }
+}
+....
+
+# Via xml
+
+The above @PersistenceContext annotation usage is 100% equivalent to the
+following xml.
+
+....
+<persistence-context-ref>
+ <persistence-context-ref-name>myFooEntityManager</persistence-context-ref-name>
+ <persistence-unit-name>foo-unit</persistence-unit-name>
+ <persistence-context-type>Transaction</persistence-context-type>
+</persistence-context-ref>
+
+<persistence-context-ref>
+ <persistence-context-ref-name>org.superbiz.calculator.MyBean/myBarEntityManager</persistence-context-ref-name>
+ <persistence-unit-name>bar-unit</persistence-unit-name>
+ <persistence-context-type>Transaction</persistence-context-type>
+ <injection-target>
+ <injection-target-class>org.superbiz.calculator.MyBean</injection-target-class>
+ <injection-target-name>myBarEntityManager</injection-target-name>
+ </injection-target>
+</persistence-context-ref>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/persistence-context.md
----------------------------------------------------------------------
diff --git a/docs/persistence-context.md b/docs/persistence-context.md
deleted file mode 100644
index 9b23af9..0000000
--- a/docs/persistence-context.md
+++ /dev/null
@@ -1,57 +0,0 @@
-index-group=JPA
-type=page
-status=published
-title=persistence-context
-~~~~~~
-<a name="persistence-context-Viaannotation"></a>
-# Via annotation
-
-Both lookup and injection of an EntityManager can be configured via the
-`@PersistenceContext` annotation.
-
- package org.superbiz;
-
- import javax.persistence.PersistenceContext;
- import javax.persistence.EntityManager;
- import javax.ejb.Stateless;
- import javax.naming.InitialContext;
-
- @Stateless
- @PersistenceContext(name = "myFooEntityManager", unitName = "foo-unit")
- public class MyBean implements MyInterface {
-
- @PersistenceContext(unitName = "bar-unit")
- private EntityManager myBarEntityManager;
-
- public void someBusinessMethod() throws Exception {
- if (myBarEntityManager == null) throw new NullPointerException("myBarEntityManager not injected");
-
- // Both can be looked up from JNDI as well
- InitialContext context = new InitialContext();
- EntityManager fooEntityManager = (EntityManager) context.lookup("java:comp/env/myFooEntityManager");
- EntityManager barEntityManager = (EntityManager) context.lookup("java:comp/env/org.superbiz.MyBean/myBarEntityManager");
- }
- }
-
-
-<a name="persistence-context-Viaxml"></a>
-# Via xml
-
-The above @PersistenceContext annotation usage is 100% equivalent to the
-following xml.
-
- <persistence-context-ref>
- <persistence-context-ref-name>myFooEntityManager</persistence-context-ref-name>
- <persistence-unit-name>foo-unit</persistence-unit-name>
- <persistence-context-type>Transaction</persistence-context-type>
- </persistence-context-ref>
-
- <persistence-context-ref>
- <persistence-context-ref-name>org.superbiz.calculator.MyBean/myBarEntityManager</persistence-context-ref-name>
- <persistence-unit-name>bar-unit</persistence-unit-name>
- <persistence-context-type>Transaction</persistence-context-type>
- <injection-target>
- <injection-target-class>org.superbiz.calculator.MyBean</injection-target-class>
- <injection-target-name>myBarEntityManager</injection-target-name>
- </injection-target>
- </persistence-context-ref>
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/persistence-unit-ref.adoc
----------------------------------------------------------------------
diff --git a/docs/persistence-unit-ref.adoc b/docs/persistence-unit-ref.adoc
new file mode 100644
index 0000000..447829d
--- /dev/null
+++ b/docs/persistence-unit-ref.adoc
@@ -0,0 +1,91 @@
+# persistence-unit-ref
+:index-group: JPA
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+Both lookup and injection of an
+EntityManagerFactory can be configured via the @PersistenceUnit
+annotation or in xml. Annotations and xml have equal function in both
+lookup and injection.
+
+# Injection and Lookup
+
+== Via annotation
+
+....
+package org.superbiz;
+
+import javax.persistence.PersistenceUnit;
+import javax.persistence.EntityManagerFactory;
+import javax.ejb.Stateless;
+import javax.naming.InitialUnit;
+
+@Stateless
+public class MyBean implements MyInterface {
+
+ @PersistenceUnit(unitName = "bar-unit")
+ private EntityManagerFactory myBarEntityManagerFactory;
+
+ public void someBusinessMethod() throws Exception {
+ if (myBarEntityManagerFactory == null) throw new NullPointerException("myBarEntityManagerFactory not injected");
+
+ // Both can be looked up from JNDI as well
+ InitialContext unit = new InitialContext();
+ EntityManagerFactory barEntityManagerFactory = (EntityManagerFactory) context.lookup("java:comp/env/org.superbiz.MyBean/myBarEntityManagerFactory");
+ }
+}
+....
+
+== Via xml
+
+The above @PersistenceUnit annotation usage is 100% equivalent to the
+following xml.
+
+....
+<persistence-unit-ref>
+ <persistence-unit-ref-name>org.superbiz.calculator.MyBean/myBarEntityManagerFactory</persistence-unit-ref-name>
+ <persistence-unit-name>bar-unit</persistence-unit-name>
+ <persistence-unit-type>Transaction</persistence-unit-type>
+ <injection-target>
+ <injection-target-class>org.superbiz.calculator.MyBean</injection-target-class>
+ <injection-target-name>myBarEntityManagerFactory</injection-target-name>
+ </injection-target>
+</persistence-unit-ref>
+....
+
+== Lookup only
+
+=== Via annotation
+
+....
+package org.superbiz;
+
+import javax.persistence.PersistenceUnit;
+import javax.persistence.EntityManagerFactory;
+import javax.ejb.Stateless;
+import javax.naming.InitialUnit;
+
+@Stateless
+@PersistenceUnit(name = "myFooEntityManagerFactory", unitName = "foo-unit")
+public class MyBean implements MyInterface {
+
+ public void someBusinessMethod() throws Exception {
+ InitialContext context = new InitialContext();
+ EntityManagerFactory fooEntityManagerFactory = (EntityManagerFactory) context.lookup("java:comp/env/myFooEntityManagerFactory");
+ }
+}
+....
+
+# Via xml
+
+The above @PersistenceUnit annotation usage is 100% equivalent to the
+following xml.
+
+....
+<persistence-unit-ref>
+ <persistence-unit-ref-name>myFooEntityManagerFactory</persistence-unit-ref-name>
+ <persistence-unit-name>foo-unit</persistence-unit-name>
+ <persistence-unit-type>Transaction</persistence-unit-type>
+</persistence-unit-ref>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/persistence-unit-ref.md
----------------------------------------------------------------------
diff --git a/docs/persistence-unit-ref.md b/docs/persistence-unit-ref.md
deleted file mode 100644
index d980b6b..0000000
--- a/docs/persistence-unit-ref.md
+++ /dev/null
@@ -1,91 +0,0 @@
-index-group=JPA
-type=page
-status=published
-title=persistence-unit-ref
-~~~~~~
-Both lookup and injection of an EntityManagerFactory can be configured via
-the @PersistenceUnit annotation or <persistence-unit-ref> in xml.
-Annotations and xml have equal function in both lookup and injection.
-
-<a name="persistence-unit-ref-InjectionandLookup"></a>
-# Injection and Lookup
-
-<a name="persistence-unit-ref-Viaannotation"></a>
-## Via annotation
-
- package org.superbiz;
-
- import javax.persistence.PersistenceUnit;
- import javax.persistence.EntityManagerFactory;
- import javax.ejb.Stateless;
- import javax.naming.InitialUnit;
-
- @Stateless
- public class MyBean implements MyInterface {
-
- @PersistenceUnit(unitName = "bar-unit")
- private EntityManagerFactory myBarEntityManagerFactory;
-
- public void someBusinessMethod() throws Exception {
- if (myBarEntityManagerFactory == null) throw new NullPointerException("myBarEntityManagerFactory not injected");
-
- // Both can be looked up from JNDI as well
- InitialContext unit = new InitialContext();
- EntityManagerFactory barEntityManagerFactory = (EntityManagerFactory) context.lookup("java:comp/env/org.superbiz.MyBean/myBarEntityManagerFactory");
- }
- }
-
-
-<a name="persistence-unit-ref-Viaxml"></a>
-## Via xml
-
-The above @PersistenceUnit annotation usage is 100% equivalent to the
-following xml.
-
- <persistence-unit-ref>
- <persistence-unit-ref-name>org.superbiz.calculator.MyBean/myBarEntityManagerFactory</persistence-unit-ref-name>
- <persistence-unit-name>bar-unit</persistence-unit-name>
- <persistence-unit-type>Transaction</persistence-unit-type>
- <injection-target>
- <injection-target-class>org.superbiz.calculator.MyBean</injection-target-class>
- <injection-target-name>myBarEntityManagerFactory</injection-target-name>
- </injection-target>
- </persistence-unit-ref>
-
-
-
-# Lookup only
-
-## Via annotation
-
- package org.superbiz;
-
- import javax.persistence.PersistenceUnit;
- import javax.persistence.EntityManagerFactory;
- import javax.ejb.Stateless;
- import javax.naming.InitialUnit;
-
- @Stateless
- @PersistenceUnit(name = "myFooEntityManagerFactory", unitName = "foo-unit")
- public class MyBean implements MyInterface {
-
- public void someBusinessMethod() throws Exception {
- InitialContext context = new InitialContext();
- EntityManagerFactory fooEntityManagerFactory = (EntityManagerFactory) context.lookup("java:comp/env/myFooEntityManagerFactory");
- }
- }
-
-
-<a name="persistence-unit-ref-Viaxml"></a>
-# Via xml
-
-The above @PersistenceUnit annotation usage is 100% equivalent to the
-following xml.
-
- <persistence-unit-ref>
- <persistence-unit-ref-name>myFooEntityManagerFactory</persistence-unit-ref-name>
- <persistence-unit-name>foo-unit</persistence-unit-name>
- <persistence-unit-type>Transaction</persistence-unit-type>
- </persistence-unit-ref>
-
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/properties-listing.adoc
----------------------------------------------------------------------
diff --git a/docs/properties-listing.adoc b/docs/properties-listing.adoc
new file mode 100644
index 0000000..27738b3
--- /dev/null
+++ b/docs/properties-listing.adoc
@@ -0,0 +1,729 @@
+# System Properties Listing
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+== OpenEJB system properties
+
+Name
+
+Value
+
+Description
+
+openejb.embedded.remotable
+
+bool
+
+activate or not the remote services when available
+
+.bind, <service prefix>.port, <service prefix>.disabled, <service
+prefix>.threads
+
+host or IP, port, bool
+
+override the host. Available for ejbd and httpejbd services (used by
+jaxws and jaxrs), number of thread to maneg requests
+
+openejb.embedded.initialcontext.close
+
+LOGOUT or DESTROY
+
+configure the hook called when closing the initial context. Useful when
+starting OpenEJB from a new InitialContext([properties]) instantiation.
+By default it simply logs out the logged user if it exists. DESTROY
+means clean the container.
+
+javax.persistence.provider
+
+string
+
+override the JPA provider value
+
+javax.persistence.transactionType
+
+string
+
+override the transaction type for persistence contexts
+
+javax.persistence.jtaDataSource
+
+string
+
+override the JTA datasource value for persistence contexts
+
+javax.persistence.nonJtaDataSource
+
+string
+
+override the non JTA datasource value for persistence contexts
+
+openejb.descriptors.output
+
+bool
+
+dump memory deployment descriptors. Can be used to set complete metadata
+to true and avoid scanning when starting the container or to check the
+used configuration.
+
+openejb.deployments.classpath.require.descriptor
+
+CLIENT or EJB
+
+can allow to filter what you want to scan (client modules or ejb
+modules)
+
+openejb.descriptors.output.folder
+
+path
+
+where to dump deployement descriptors if activated.
+
+openejb.strict.interface.declaration
+
+bool
+
+add some validations on session beans (spec validations in particular).
+false by default.
+
+openejb.conf.file or openejb.configuration
+
+string
+
+OpenEJB configuration file path
+
+openejb.debuggable-vm-hackery
+
+bool
+
+remove JMS informations from deployment
+
+openejb.validation.skip
+
+bool
+
+skip the validations done when OpenEJB deploys beans
+
+openejb.deployments.classpath.ear
+
+bool
+
+deploy the classpath as an ear
+
+openejb.webservices.enabled
+
+bool
+
+activate or not webservices
+
+openejb.validation.output.level
+
+TERSE or MEDIUM or VERBOSE
+
+level of the logs used to report validation errors
+
+openejb.user.mbeans.list
+
+* or a list of classes separated by ,
++
++
++
+list of mbeans to deploy automatically
++
++
++
++
++
+openejb.deploymentId.format
++
++
++
+composition (+string) of \{ejbName} \{ejbType} \{ejbClass} and
+\{ejbClass.simpleName}
++
++
++
+default \{ejbName}. The format to use to deploy ejbs.
++
++
++
++
++
+openejb.deployments.classpath
++
++
++
+bool
++
++
++
+whether or not deploy from classpath
++
++
++
++
++
+openejb.deployments.classpath.include and
+openejb.deployments.classpath.exclude
++
++
++
+regex
++
++
++
+regex to filter the scanned classpath (when you are in this case)
++
++
++
++
++
+openejb.deployments.package.include and
+openejb.deployments.package.exclude
++
++
++
+regex
++
++
++
+regex to filter scanned packages
++
++
++
++
++
+openejb.autocreate.jta-datasource-from-non-jta-one
++
++
++
+bool
++
++
++
+whether or not auto create the jta datasource if it doesn't exist but a
+non jta datasource exists. Useful when using hibernate to be able to get
+a real non jta datasource.
++
++
++
++
++
+openejb.altdd.prefix
++
++
++
+string
++
++
++
+prefix use for altDD (example test to use a test.ejb-jar.xml).
++
++
++
++
++
+org.apache.openejb.default.system.interceptors
++
++
++
+list of interceptor (qualified names) separated by a comma or a space
++
++
++
+add these interceptor on all beans
++
++
++
++
++
+openejb.jndiname.strategy.class
++
++
++
+class name
++
++
++
+an implementation of
+org.apache.openejb.assembler.classic.JndiBuilder.JndiNameStrategy
++
++
++
++
++
+openejb.jndiname.failoncollision
++
++
++
+bool
++
++
++
+if a NameAlreadyBoundException is thrown or not when 2 EJBs have the
+same name
++
++
++
++
++
+openejb.jndiname.format
++
++
++
+composition (+string) of these properties: ejbType, ejbClass,
+ejbClass.simpleName, ejbClass.packageName, ejbName, deploymentId,
+interfaceType, interfaceType.annotationName,
+interfaceType.annotationNameLC, interfaceType.xmlName,
+interfaceType.xmlNameCc, interfaceType.openejbLegacyName,
+interfaceClass, interfaceClass.simpleName, interfaceClass.packageName
++
++
++
+default \{deploymentId}\{interfaceType.annotationName}. Change the name
+used for the ejb.
++
++
++
++
++
+openejb.org.quartz.threadPool.class
++
++
++
+class qualified name which implements org.quartz.spi.ThreadPool
++
++
++
+the thread pool used by quartz (used to manage ejb timers)
++
++
++
++
++
+openejb.localcopy
++
++
++
+bool
++
++
++
+default true. whether or not copy EJB arguments[/method/interface] for
+remote invocations.
++
++
++
++
++
+openejb.cxf.jax-rs.providers
++
++
++
+the list of the qualified name of the JAX-RS providers separated by
+comma or space. Note: to specify a provider for a specific service
+suffix its class qualified name by ".providers", the value follow the
+same rules. Note 2: default is a shortcut for jaxb and json providers.
++
++
++
++
++
++
++
+openejb.wsAddress.format
++
++
++
+composition (+string) of \{ejbJarId}, ejbDeploymentId, ejbType,
+ejbClass, ejbClass.simpleName, ejbName, portComponentName, wsdlPort,
+wsdlService
++
++
++
+default /\{ejbDeploymentId}. The WS name format.
++
++
++
++
++
+org.apache.openejb.server.webservices.saaj.provider
++
++
++
+axis2, sun or null
++
++
++
+specified the saaj configuration
++
++
++
++
++
+[<uppercase service name>.]<service id>.<name> or [<uppercase service
+name>.]<service id>
++
++
++
+whatever is supported (generally string, int ...)
++
++
++
+set this value to the corresponding service. example:
+[EnterpriseBean.]<ejb-name>.activation.<property>,
+[PERSISTENCEUNIT.]<persistence unit name>.<property>, [RESOURCE.]<name>
++
++
++
++
++
+log4j.category.OpenEJB.options
++
++
++
+DEBUG, INFO, ...
++
++
++
+active one OpenEJB log level. need log4j in the classpath
++
++
++
++
++
+openejb.jmx.active
++
++
++
+bool
++
++
++
+activate (by default) or not the OpenEJB JMX MBeans
++
++
++
++
++
+openejb.nobanner
++
++
++
+bool
++
++
++
+activate or not the OpenEJB banner (activated by default)
++
++
++
+openejb.check.classloader
++
++
++
+bool
++
++
++
+if true print some information about duplicated classes
++
++
++
++
++
+openejb.check.classloader.verbose
++
++
++
+bool
++
++
++
+if true print classes intersections
++
++
++
++
++
+openejb.additional.exclude
++
++
++
+string separated by comma
++
++
++
+list of prefixes you want to exclude and are not in the default list of
+exclusion
++
++
++
++
++
+openejb.additional.include
++
++
++
+string separated by comma
++
++
++
+list of prefixes you want to remove from thedefault list of exclusion
++
++
++
++
++
+openejb.offline
++
++
++
+bool
++
++
++
+if true can create datasources and containers automatically
++
++
++
++
++
+openejb.exclude-include.order
++
++
++
+include-exclude or exclude-include
++
++
++
+if the inclusion/exclusion should win on conflicts (intersection)
++
++
++
++
++
+openejb.log.color
++
++
++
+bool
++
++
++
+activate or not the color in the console in embedded mode
++
++
++
++
++
+openejb.log.color.<level in lowercase>
++
++
++
+color in uppercase
++
++
++
+set a color for a particular level. Color are BLACK, RED, GREEN, YELLOW,
+BLUE, MAGENTA, CYAN, WHITE, DEFAULT.
++
++
++
++
++
+tomee.serialization.class.blacklist
++
++
++
+string
++
++
++
+default list of packages/classnames excluded for EJBd deserialization
+(needs to be set on server and client sides). Please see the description
+of Ejbd Transport for details.
++
++
++
++
++
+tomee.serialization.class.whitelist
++
++
++
+string
++
++
++
+default list of packages/classnames allowed for EJBd deserialization
+(blacklist wins over whitelist, needs to be set on server and client
+sides). Please see the description of Ejbd Transport for details.
++
++
++
++
++
+tomee.remote.support
++
++
++
+boolean
++
++
++
+if true /tomee webapp is auto-deployed and EJBd is active (true by
+default for 1.x, false for 7.x excepted for tomee maven plugin and
+arquillian)
++
++
++
+
+Note: all resources can be configured by properties, see
+http://tomee.apache.org/embedded-configuration.html and
+http://tomee.apache.org/properties-tool.html
+
+== OpenEJB client
+
+Name
+
+Value
+
+Description
+
+openejb.client.identityResolver
+
+implementation of org.apache.openejb.client.IdentityResolver
+
+default org.apache.openejb.client.JaasIdentityResolver. The class to get
+the client identity.
+
+openejb.client.connection.pool.timeout or
+openejb.client.connectionpool.timeout
+
+int (ms)
+
+the timeout of the client
+
+openejb.client.connection.pool.size or
+openejb.client.connectionpool.size
+
+int
+
+size of the socket pool
+
+openejb.client.keepalive
+
+int (ms)
+
+the keepalive duration
+
+openejb.client.protocol.version
+
+string
+
+Optional legacy server protocol compatibility level. Allows 4.6.x
+clients to potentially communicate with older servers. OpenEJB 4.5.2 and
+older use version "3.1", and 4.6.x currently uses version "4.6"
+(Default). This does not allow old clients to communicate with new
+servers prior to 4.6.0
+
+== TomEE specific system properties
+
+Name
+
+Value
+
+Description
+
+openejb.crosscontext
+
+bool
+
+set the cross context property on tomcat context (can be done in the
+traditionnal way if the deployment is don through the webapp discovery
+and not the OpenEJB Deployer EJB)
+
+openejb.jsessionid-support
+
+bool
+
+remove URL from session tracking modes for this context (see
+javax.servlet.SessionTrackingMode)
+
+openejb.myfaces.disable-default-values
+
+bool
+
+by default TomEE will initialize myfaces with some its default values to
+avoid useless logging
+
+openejb.web.xml.major
+
+int
+
+major version of web.xml. Can be useful to force tomcat to scan servlet
+3 annotatino when deploying with a servlet 2.x web.xml
+
+tomee.jaxws.subcontext
+
+string
+
+sub context used to bind jaxws web services, default is webservices
+
+openejb.servicemanager.enabled
+
+bool
+
+run all services detected or only known available services (WS and RS
+
+tomee.jaxws.oldsubcontext
+
+bool
+
+wether or not activate old way to bind jaxws webservices directly on
+root context
+
+openejb.modulename.useHash
+
+bool
+
+add a hash after the module name of the webmodule if it is generated
+from the webmodule location, it avoids conflicts between multiple
+deployment (through ear) of the same webapp. Note: it disactivated by
+default since names are less nice this way.
+
+openejb.session.manager
+
+qualified name (string)
+
+configure a session managaer to use for all contexts
+
+== TomEE Arquillian adaptor
+
+Name
+
+Value
+
+Description
+
+tomee.ejbcontainer.http.port
+
+int
+
+tomee port, -1 means random. When using a random port you can retreive
+it getting this property too.
+
+tomee.arquillian.http
+
+int
+
+http port used by the embedded arquillian adaptor
+
+tomee.arquillian.stop
+
+int
+
+shutdown port used by the embedded arquillian adaptor
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/properties-listing.md
----------------------------------------------------------------------
diff --git a/docs/properties-listing.md b/docs/properties-listing.md
deleted file mode 100644
index a207bd0..0000000
--- a/docs/properties-listing.md
+++ /dev/null
@@ -1,94 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=System Properties Listing
-~~~~~~
-
-# OpenEJB system properties
-<table class="mdtable">
-<tr><td><b>Name</b></td><td><b>Value</b></td><td><b>Description</b></td></tr>
-<tr><td>openejb.embedded.remotable</td><td> bool </td><td> activate or not the remote services when available </td></tr>
-<tr><td><service prefix>.bind, <service prefix>.port, <service prefix>.disabled, <service prefix>.threads</td><td> host or IP, port, bool</td><td> override the host. Available for ejbd and httpejbd services (used by jaxws and jaxrs), number of thread to maneg requests </td><tr>
-<tr><td>openejb.embedded.initialcontext.close </td><td> LOGOUT or DESTROY </td><td> configure the hook called when closing the initial context. Useful when starting OpenEJB from a new InitialContext([properties]) instantiation. By default it simply logs out the logged user if it exists. DESTROY means clean the container.</td></tr>
-<tr><td>javax.persistence.provider </td><td> string </td><td> override the JPA provider value</td></tr>
-<tr><td>javax.persistence.transactionType </td><td> string </td><td> override the transaction type for persistence contexts</td></tr>
-<tr><td>javax.persistence.jtaDataSource </td><td> string </td><td> override the JTA datasource value for persistence contexts</td></tr>
-<tr><td>javax.persistence.nonJtaDataSource </td><td> string </td><td> override the non JTA datasource value for persistence contexts</td></tr>
-<tr><td>openejb.descriptors.output </td><td>bool</td><td> dump memory deployment descriptors. Can be used to set complete metadata to true and avoid scanning when starting the container or to check the used configuration.</td></tr>
-<tr><td>openejb.deployments.classpath.require.descriptor </td><td> CLIENT or EJB </td><td> can allow to filter what you want to scan (client modules or ejb modules)</td></tr>
-<tr><td>openejb.descriptors.output.folder </td><td> path </td><td> where to dump deployement descriptors if activated. </td></tr>
-<tr><td>openejb.strict.interface.declaration </td><td> bool </td><td> add some validations on session beans (spec validations in particular). false by default.</td></tr>
-<tr><td>openejb.conf.file or openejb.configuration </td><td> string </td><td> OpenEJB configuration file path</td></tr>
-<tr><td>openejb.debuggable-vm-hackery </td><td> bool </td><td> remove JMS informations from deployment</td></tr>
-<tr><td>openejb.validation.skip </td><td> bool </td><td> skip the validations done when OpenEJB deploys beans</td></tr>
-<tr><td>openejb.deployments.classpath.ear </td><td> bool </td><td> deploy the classpath as an ear</td></tr>
-<tr><td>openejb.webservices.enabled </td><td> bool </td><td> activate or not webservices</td></tr>
-<tr><td>openejb.validation.output.level </td><td> TERSE or MEDIUM or VERBOSE </td><td> level of the logs used to report validation errors</td></tr>
-<tr><td>openejb.user.mbeans.list </td><td> * or a list of classes separated by , </td><td> list of mbeans to deploy automatically</td></tr>
-<tr><td>openejb.deploymentId.format </td><td> composition (+string) of {ejbName} {ejbType} {ejbClass} and {ejbClass.simpleName} </td><td> default {ejbName}. The format to use to deploy ejbs.</td></tr>
-<tr><td>openejb.deployments.classpath </td><td> bool </td><td> whether or not deploy from classpath</td></tr>
-<tr><td>openejb.deployments.classpath.include and openejb.deployments.classpath.exclude </td><td> regex </td><td> regex to filter the scanned classpath (when you are in this case)</td></tr>
-<tr><td>openejb.deployments.package.include and openejb.deployments.package.exclude </td><td> regex </td><td> regex to filter scanned packages</td></tr>
-<tr><td>openejb.autocreate.jta-datasource-from-non-jta-one </td><td> bool </td><td> whether or not auto create the jta datasource if it doesn't exist but a non jta datasource exists. Useful when using hibernate to be able to get a real non jta datasource.</td></tr>
-<tr><td>openejb.altdd.prefix </td><td> string </td><td> prefix use for altDD (example test to use a test.ejb-jar.xml).</td></tr>
-<tr><td>org.apache.openejb.default.system.interceptors </td><td> list of interceptor (qualified names) separated by a comma or a space </td><td> add these interceptor on all beans</td></tr>
-<tr><td>openejb.jndiname.strategy.class </td><td> class name </td><td> an implementation of org.apache.openejb.assembler.classic.JndiBuilder.JndiNameStrategy</td></tr>
-<tr><td>openejb.jndiname.failoncollision </td><td> bool </td><td> if a NameAlreadyBoundException is thrown or not when 2 EJBs have the same name</td></tr>
-<tr><td>openejb.jndiname.format </td><td> composition (+string) of these properties: ejbType, ejbClass, ejbClass.simpleName, ejbClass.packageName, ejbName, deploymentId, interfaceType, interfaceType.annotationName, interfaceType.annotationNameLC, interfaceType.xmlName, interfaceType.xmlNameCc, interfaceType.openejbLegacyName, interfaceClass, interfaceClass.simpleName, interfaceClass.packageName </td><td> default {deploymentId}{interfaceType.annotationName}. Change the name used for the ejb.</td></tr>
-<tr><td>openejb.org.quartz.threadPool.class </td><td> class qualified name which implements org.quartz.spi.ThreadPool </td><td> the thread pool used by quartz (used to manage ejb timers)</td></tr>
-<tr><td>openejb.localcopy </td><td> bool </td><td> default true. whether or not copy EJB arguments[/method/interface] for remote invocations.</td></tr>
-<tr><td>openejb.cxf.jax-rs.providers </td><td> the list of the qualified name of the JAX-RS providers separated by comma or space. Note: to specify a provider for a specific service suffix its class qualified name by ".providers", the value follow the same rules. Note 2: default is a shortcut for jaxb and json providers.</td><td></td></tr>
-<tr><td>openejb.wsAddress.format </td><td> composition (+string) of {ejbJarId}, ejbDeploymentId, ejbType, ejbClass, ejbClass.simpleName, ejbName, portComponentName, wsdlPort, wsdlService </td><td> default /{ejbDeploymentId}. The WS name format.</td></tr>
-<tr><td>org.apache.openejb.server.webservices.saaj.provider </td><td> axis2, sun or null </td><td> specified the saaj configuration</td></tr>
-<tr><td>[<uppercase service name>.]<service id>.<name> or [<uppercase service name>.]<service id></td><td> whatever is supported (generally string, int ...) </td><td> set this value to the corresponding service. example: [EnterpriseBean.]<ejb-name>.activation.<property>, [PERSISTENCEUNIT.]<persistence unit name>.<property>, [RESOURCE.]<name></td></tr>
-<tr><td> log4j.category.OpenEJB.options </td><td> DEBUG, INFO, ... </td><td> active one OpenEJB log level. need log4j in the classpath</td></tr>
-<tr><td> openejb.jmx.active </td><td> bool </td><td> activate (by default) or not the OpenEJB JMX MBeans </td></tr>
-<tr><td> openejb.nobanner </td><td> bool </td><td> activate or not the OpenEJB banner (activated by default)
-<tr><td> openejb.check.classloader </td><td> bool </td><td> if true print some information about duplicated classes </td><tr>
-<tr><td> openejb.check.classloader.verbose </td><td> bool </td><td> if true print classes intersections </td><tr>
-<tr><td> openejb.additional.exclude </td><td> string separated by comma </td><td> list of prefixes you want to exclude and are not in the default list of exclusion</td></tr>
-<tr><td> openejb.additional.include </td><td> string separated by comma </td><td> list of prefixes you want to remove from thedefault list of exclusion</td></tr>
-<tr><td> openejb.offline </td><td> bool </td><td> if true can create datasources and containers automatically </td></tr>
-<tr><td> openejb.exclude-include.order </td><td> include-exclude or exclude-include </td><td> if the inclusion/exclusion should win on conflicts (intersection) </td><tr>
-<tr><td>openejb.log.color</td><td> bool </td><td> activate or not the color in the console in embedded mode </td></tr>
-<tr><td>openejb.log.color.<level in lowercase></td><td> color in uppercase </td><td> set a color
-for a particular level. Color are BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, DEFAULT. </td></tr>
-<tr><td>tomee.serialization.class.blacklist</td><td> string </td><td> default list of packages/classnames excluded for EJBd deserialization (needs to be set on server and client sides). Please see the description of <a href="http://tomee.apache.org/ejbd-transport.html">Ejbd Transport</a> for details.</td></tr>
-<tr><td>tomee.serialization.class.whitelist</td><td> string </td><td> default list of packages/classnames allowed for EJBd deserialization (blacklist wins over whitelist, needs to be set on server and client sides). Please see the description of <a href="http://tomee.apache.org/ejbd-transport.html">Ejbd Transport</a> for details.</td></tr>
-<tr><td>tomee.remote.support</td><td> boolean </td><td> if true /tomee webapp is auto-deployed and EJBd is active (true by default for 1.x, false for 7.x excepted for tomee maven plugin and arquillian)</td></tr>
-</table>
-
-Note: all resources can be configured by properties, see http://tomee.apache.org/embedded-configuration.html and http://tomee.apache.org/properties-tool.html
-
-
-# OpenEJB client
-<table class="mdtable">
-<tr><td><b>Name</b></td><td><b>Value</b></td><td><b>Description</b></td></tr>
-<tr><td>openejb.client.identityResolver </td><td> implementation of org.apache.openejb.client.IdentityResolver </td><td> default org.apache.openejb.client.JaasIdentityResolver. The class to get the client identity.</td></tr>
-<tr><td>openejb.client.connection.pool.timeout or openejb.client.connectionpool.timeout </td><td> int (ms) </td><td> the timeout of the client</td></tr>
-<tr><td>openejb.client.connection.pool.size or openejb.client.connectionpool.size </td><td> int </td><td> size of the socket pool</td></tr>
-<tr><td>openejb.client.keepalive </td><td> int (ms) </td><td> the keepalive duration</td><tr>
-<tr><td>openejb.client.protocol.version </td><td> string </td><td> Optional legacy server protocol compatibility level. Allows 4.6.x clients to potentially communicate with older servers. OpenEJB 4.5.2 and older use version "3.1", and 4.6.x currently uses version "4.6" (Default). This does not allow old clients to communicate with new servers prior to 4.6.0</td><tr>
-</table>
-
-# TomEE specific system properties
-<table class="mdtable">
-<tr><td><b>Name</b></td><td><b>Value</b></td><td><b>Description</b></td></tr>
-<tr><td>openejb.crosscontext </td><td> bool </td><td> set the cross context property on tomcat context (can be done in the traditionnal way if the deployment is don through the webapp discovery and not the OpenEJB Deployer EJB)</td></tr>
-<tr><td>openejb.jsessionid-support </td><td> bool </td><td> remove URL from session tracking modes for this context (see javax.servlet.SessionTrackingMode)</td></tr>
-<tr><td>openejb.myfaces.disable-default-values </td><td> bool </td><td> by default TomEE will initialize myfaces with some its default values to avoid useless logging</td></tr>
-<tr><td>openejb.web.xml.major </td><td> int </td><td> major version of web.xml. Can be useful to force tomcat to scan servlet 3 annotatino when deploying with a servlet 2.x web.xml</td></tr>
-<tr><td>tomee.jaxws.subcontext </td><td> string </td><td> sub context used to bind jaxws web services, default is webservices</td></tr>
-<tr><td>openejb.servicemanager.enabled</td><td> bool </td><td> run all services detected or only known available services (WS and RS</td></tr>
-<tr><td>tomee.jaxws.oldsubcontext</td><td> bool </td><td> wether or not activate old way to bind jaxws webservices directly on root context</td><tr>
-<tr><td>openejb.modulename.useHash</td><td> bool </td><td> add a hash after the module name of the webmodule if it is generated from the webmodule location, it avoids conflicts between multiple deployment (through ear) of the same webapp. Note: it disactivated by default since names are less nice this way.</td><tr>
-<tr><td>openejb.session.manager</td><td> qualified name (string) </td><td> configure a session managaer to use for all contexts</td><tr>
-</table>
-
-# TomEE Arquillian adaptor
-<table class="mdtable">
-<tr><td><b>Name</b></td><td><b>Value</b></td><td><b>Description</b></td></tr>
-<tr><td>tomee.ejbcontainer.http.port </td><td> int </td><td> tomee port, -1 means random. When using a random port you can retreive it getting this property too.</td></tr>
-<tr><td>tomee.arquillian.http </td><td> int </td><td> http port used by the embedded arquillian adaptor</td></tr>
-<tr><td>tomee.arquillian.stop </td><td> int </td><td> shutdown port used by the embedded arquillian adaptor</td><tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/properties-tool.adoc
----------------------------------------------------------------------
diff --git a/docs/properties-tool.adoc b/docs/properties-tool.adoc
new file mode 100644
index 0000000..aa37683
--- /dev/null
+++ b/docs/properties-tool.adoc
@@ -0,0 +1,219 @@
+:index-group: OpenEJB
+Standalone Server
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+:jbake-title: Properties Tool
+
+# Properties Command line Tool
+
+To see all configurable properties in use by OpenEJB, using the
+following tool against a running server:
+
+________________________
+./bin/openejb properties
+________________________
+
+The output of this tool takes all overrideable components OpenEJB sees
+and outputs their properties along with the current value. This allows
+you to easily see what is running in your system, what properties are
+available for overriding, and what exact values are for each component.
+OpenEJB has a number of flags that can be passed to it not associated
+with any particular component, these are output as well.
+
+Content from this file can be safely copied as-is into the
+conf/system.properties file or sent to the users list with bug reports.
+These properties may also be applied back into the openejb.xml file by
+pasting the properties without the "." prefix into the respective
+component declarations. The only warning is that any properties of type
+".password" will have their values masked, so make sure you edit them if
+you reapply them back into conf/openejb.xml or conf/system.properties.
+
+# Property Overriding
+
+Any component configured in OpenEJB via the openejb.xml (and some that
+aren't) can be overridden using system properties. The format is:
+
+`<id>.<property-name>=<property-value>`
+
+And this can be done on the command line as follows:
+
+`./bin/openejb -D<id>.<property-name>=<property-value> ...`
+
+Or by adding the property to the conf/system.properties file. Note that
+command line overrides win over overrides in the conf/system.properties
+file.
+
+In an embedded environment, the properties can be added to the Hashtable
+passed into the javax.naming.InitialContext when using the
+LocalInitialContextFactory or also to the System.getProperties() object
+before OpenEJB is embedded (which will be when the first InitialContext
+is created).
+
+At startup, OpenEJB will find the component with the given id and apply
+the new property value before constructing the individual component.
+
+# Example output
+
+....
+# Container(id=Default CMP Container)
+# className: org.apache.openejb.core.cmp.CmpContainer
+#
+Default\ CMP\ Container.CmpEngineFactory=org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory
+Default\ CMP\ Container.Engine=instantdb
+Default\ CMP\ Container.ConnectorName=Default JDBC Database
+
+# Container(id=Default BMP Container)
+# className: org.apache.openejb.core.entity.EntityContainer
+#
+Default\ BMP\ Container.PoolSize=10
+
+# Container(id=Default Stateful Container)
+# className: org.apache.openejb.core.stateful.StatefulContainer
+#
+Default\ Stateful\ Container.BulkPassivate=50
+Default\ Stateful\ Container.Passivator=org.apache.openejb.core.stateful.SimplePassivater
+Default\ Stateful\ Container.TimeOut=20
+Default\ Stateful\ Container.PoolSize=500
+
+# Container(id=Default Stateless Container)
+# className: org.apache.openejb.core.stateless.StatelessContainer
+#
+Default\ Stateless\ Container.PoolSize=10
+Default\ Stateless\ Container.StrictPooling=true
+Default\ Stateless\ Container.TimeOut=0
+
+# Container(id=Default MDB Container)
+# className: org.apache.openejb.core.mdb.MdbContainer
+#
+Default\ MDB\ Container.ResourceAdapter=Default JMS Resource Adapter
+Default\ MDB\ Container.InstanceLimit=10
+Default\ MDB\ Container.MessageListenerInterface=javax.jms.MessageListener
+Default\ MDB\ Container.ActivationSpecClass=org.apache.activemq.ra.ActiveMQActivationSpec
+
+# ConnectionManager(id=Default Local TX ConnectionManager)
+# className: org.apache.openejb.resource.SharedLocalConnectionManager
+#
+
+# Resource(id=Default JMS Resource Adapter)
+# className: org.apache.activemq.ra.ActiveMQResourceAdapter
+#
+Default\ JMS\ Resource\ Adapter.ServerUrl=vm\://localhost?async\=true
+Default\ JMS\ Resource\ Adapter.BrokerXmlConfig=broker\:(tcp\://localhost\:61616)
+Default\ JMS\ Resource\ Adapter.ThreadPoolSize=30
+
+# Resource(id=Default JDBC Database)
+# className: org.apache.openejb.resource.jdbc.BasicManagedDataSource
+#
+Default\ JDBC\ Database.MinIdle=0
+Default\ JDBC\ Database.Password=xxxx
+Default\ JDBC\ Database.JdbcUrl=jdbc\:hsqldb\:file\:hsqldb
+Default\ JDBC\ Database.MaxIdle=20
+Default\ JDBC\ Database.ConnectionProperties=
+Default\ JDBC\ Database.MaxWait=-1
+Default\ JDBC\ Database.TimeBetweenEvictionRunsMillis=-1
+Default\ JDBC\ Database.MaxActive=20
+Default\ JDBC\ Database.DefaultAutoCommit=true
+Default\ JDBC\ Database.AccessToUnderlyingConnectionAllowed=false
+Default\ JDBC\ Database.JdbcDriver=org.hsqldb.jdbcDriver
+Default\ JDBC\ Database.TestWhileIdle=false
+Default\ JDBC\ Database.UserName=sa
+Default\ JDBC\ Database.MaxOpenPreparedStatements=0
+Default\ JDBC\ Database.TestOnBorrow=true
+Default\ JDBC\ Database.PoolPreparedStatements=false
+Default\ JDBC\ Database.ConnectionInterface=javax.sql.DataSource
+Default\ JDBC\ Database.TestOnReturn=false
+Default\ JDBC\ Database.MinEvictableIdleTimeMillis=1800000
+Default\ JDBC\ Database.NumTestsPerEvictionRun=3
+Default\ JDBC\ Database.InitialSize=0
+
+# Resource(id=Default Unmanaged JDBC Database)
+# className: org.apache.openejb.resource.jdbc.BasicDataSource
+#
+Default\ Unmanaged\ JDBC\ Database.MaxWait=-1
+Default\ Unmanaged\ JDBC\ Database.InitialSize=0
+Default\ Unmanaged\ JDBC\ Database.DefaultAutoCommit=true
+Default\ Unmanaged\ JDBC\ Database.ConnectionProperties=
+Default\ Unmanaged\ JDBC\ Database.MaxActive=10
+Default\ Unmanaged\ JDBC\ Database.TestOnBorrow=true
+Default\ Unmanaged\ JDBC\ Database.JdbcUrl=jdbc\:hsqldb\:file\:hsqldb
+Default\ Unmanaged\ JDBC\ Database.TestOnReturn=false
+Default\ Unmanaged\ JDBC\ Database.AccessToUnderlyingConnectionAllowed=false
+Default\ Unmanaged\ JDBC\ Database.Password=xxxx
+Default\ Unmanaged\ JDBC\ Database.MinEvictableIdleTimeMillis=1800000
+Default\ Unmanaged\ JDBC\ Database.PoolPreparedStatements=false
+Default\ Unmanaged\ JDBC\ Database.MaxOpenPreparedStatements=0
+Default\ Unmanaged\ JDBC\ Database.ConnectionInterface=javax.sql.DataSource
+Default\ Unmanaged\ JDBC\ Database.MinIdle=0
+Default\ Unmanaged\ JDBC\ Database.NumTestsPerEvictionRun=3
+Default\ Unmanaged\ JDBC\ Database.TimeBetweenEvictionRunsMillis=-1
+Default\ Unmanaged\ JDBC\ Database.JdbcDriver=org.hsqldb.jdbcDriver
+Default\ Unmanaged\ JDBC\ Database.UserName=sa
+Default\ Unmanaged\ JDBC\ Database.MaxIdle=10
+Default\ Unmanaged\ JDBC\ Database.TestWhileIdle=false
+
+# Resource(id=Default JMS Connection Factory)
+# className: org.apache.activemq.ra.ActiveMQManagedConnectionFactory
+#
+Default\ JMS\ Connection\ Factory.ConnectionInterface=javax.jms.ConnectionFactory, \
+javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory
+Default\ JMS\ Connection\ Factory.ResourceAdapter=Default JMS Resource Adapter
+
+# SecurityService(id=Default Security Service)
+# className: org.apache.openejb.core.security.SecurityServiceImpl
+#
+
+# TransactionManager(id=Default Transaction Manager)
+# className: org.apache.geronimo.transaction.manager.GeronimoTransactionManager
+#
+
+# ServerService(id=httpejbd)
+# className: org.apache.openejb.server.httpd.HttpEjbServer
+#
+httpejbd.port=4204
+httpejbd.name=httpejbd
+httpejbd.disabled=false
+httpejbd.server=org.apache.openejb.server.httpd.HttpEjbServer
+httpejbd.threads=200
+httpejbd.bind=127.0.0.1
+
+# ServerService(id=telnet)
+# className: org.apache.openejb.server.telnet.TelnetServer
+#
+telnet.port=4202
+telnet.name=telnet
+telnet.disabled=false
+telnet.bind=127.0.0.1
+telnet.threads=5
+telnet.server=org.apache.openejb.server.telnet.TelnetServer
+
+# ServerService(id=ejbd)
+# className: org.apache.openejb.server.ejbd.EjbServer
+#
+ejbd.disabled=false
+ejbd.bind=127.0.0.1
+ejbd.server=org.apache.openejb.server.ejbd.EjbServer
+ejbd.port=4201
+ejbd.name=ejbd
+ejbd.threads=200
+
+# ServerService(id=hsql)
+# className: org.apache.openejb.server.hsql.HsqlService
+#
+hsql.port=9001
+hsql.name=hsql
+hsql.disabled=false
+hsql.server=org.apache.openejb.server.hsql.HsqlService
+hsql.bind=127.0.0.1
+
+# ServerService(id=admin)
+# className: org.apache.openejb.server.admin.AdminDaemon
+#
+admin.disabled=false
+admin.bind=127.0.0.1
+admin.only_from=localhost
+admin.port=4200
+admin.threads=1
+admin.name=admin
+admin.server=org.apache.openejb.server.admin.AdminDaemon
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/properties-tool.md
----------------------------------------------------------------------
diff --git a/docs/properties-tool.md b/docs/properties-tool.md
deleted file mode 100644
index 07531ef..0000000
--- a/docs/properties-tool.md
+++ /dev/null
@@ -1,216 +0,0 @@
-index-group=OpenEJB Standalone Server
-type=page
-status=published
-title=Properties Tool
-~~~~~~
-<a name="PropertiesTool-PropertiesCommandlineTool"></a>
-# Properties Command line Tool
-
-To see all configurable properties in use by OpenEJB, using the following
-tool against a running server:
-
-> ./bin/openejb properties
-
-The output of this tool takes all overrideable components OpenEJB sees and
-outputs their properties along with the current value. This allows you to
-easily see what is running in your system, what properties are available
-for overriding, and what exact values are for each component. OpenEJB has
-a number of flags that can be passed to it not associated with any
-particular component, these are output as well.
-
-Content from this file can be safely copied as-is into the
-conf/system.properties file or sent to the users list with bug reports.
-These properties may also be applied back into the openejb.xml file by
-pasting the properties without the "<id>." prefix into the respective
-component declarations. The only warning is that any properties of type
-"<id>.password" will have their values masked, so make sure you edit them
-if you reapply them back into conf/openejb.xml or conf/system.properties.
-
-<a name="PropertiesTool-PropertyOverriding"></a>
-# Property Overriding
-
-Any component configured in OpenEJB via the openejb.xml (and some that
-aren't) can be overridden using system properties. The format is:
-
-`<id>.<property-name>=<property-value>`
-
-And this can be done on the command line as follows:
-
-`./bin/openejb -D<id>.<property-name>=<property-value> ...`
-
-Or by adding the property to the conf/system.properties file. Note that
-command line overrides win over overrides in the
-conf/system.properties file.
-
-In an embedded environment, the properties can be added to the Hashtable
-passed into the javax.naming.InitialContext when using the
-LocalInitialContextFactory or also to the System.getProperties() object
-before OpenEJB is embedded (which will be when the first InitialContext is
-created).
-
-At startup, OpenEJB will find the component with the given id and apply the
-new property value before constructing the individual component.
-
-<a name="PropertiesTool-Exampleoutput"></a>
-# Example output
-
- # Container(id=Default CMP Container)
- # className: org.apache.openejb.core.cmp.CmpContainer
- #
- Default\ CMP\ Container.CmpEngineFactory=org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory
- Default\ CMP\ Container.Engine=instantdb
- Default\ CMP\ Container.ConnectorName=Default JDBC Database
-
- # Container(id=Default BMP Container)
- # className: org.apache.openejb.core.entity.EntityContainer
- #
- Default\ BMP\ Container.PoolSize=10
-
- # Container(id=Default Stateful Container)
- # className: org.apache.openejb.core.stateful.StatefulContainer
- #
- Default\ Stateful\ Container.BulkPassivate=50
- Default\ Stateful\ Container.Passivator=org.apache.openejb.core.stateful.SimplePassivater
- Default\ Stateful\ Container.TimeOut=20
- Default\ Stateful\ Container.PoolSize=500
-
- # Container(id=Default Stateless Container)
- # className: org.apache.openejb.core.stateless.StatelessContainer
- #
- Default\ Stateless\ Container.PoolSize=10
- Default\ Stateless\ Container.StrictPooling=true
- Default\ Stateless\ Container.TimeOut=0
-
- # Container(id=Default MDB Container)
- # className: org.apache.openejb.core.mdb.MdbContainer
- #
- Default\ MDB\ Container.ResourceAdapter=Default JMS Resource Adapter
- Default\ MDB\ Container.InstanceLimit=10
- Default\ MDB\ Container.MessageListenerInterface=javax.jms.MessageListener
- Default\ MDB\ Container.ActivationSpecClass=org.apache.activemq.ra.ActiveMQActivationSpec
-
- # ConnectionManager(id=Default Local TX ConnectionManager)
- # className: org.apache.openejb.resource.SharedLocalConnectionManager
- #
-
- # Resource(id=Default JMS Resource Adapter)
- # className: org.apache.activemq.ra.ActiveMQResourceAdapter
- #
- Default\ JMS\ Resource\ Adapter.ServerUrl=vm\://localhost?async\=true
- Default\ JMS\ Resource\ Adapter.BrokerXmlConfig=broker\:(tcp\://localhost\:61616)
- Default\ JMS\ Resource\ Adapter.ThreadPoolSize=30
-
- # Resource(id=Default JDBC Database)
- # className: org.apache.openejb.resource.jdbc.BasicManagedDataSource
- #
- Default\ JDBC\ Database.MinIdle=0
- Default\ JDBC\ Database.Password=xxxx
- Default\ JDBC\ Database.JdbcUrl=jdbc\:hsqldb\:file\:hsqldb
- Default\ JDBC\ Database.MaxIdle=20
- Default\ JDBC\ Database.ConnectionProperties=
- Default\ JDBC\ Database.MaxWait=-1
- Default\ JDBC\ Database.TimeBetweenEvictionRunsMillis=-1
- Default\ JDBC\ Database.MaxActive=20
- Default\ JDBC\ Database.DefaultAutoCommit=true
- Default\ JDBC\ Database.AccessToUnderlyingConnectionAllowed=false
- Default\ JDBC\ Database.JdbcDriver=org.hsqldb.jdbcDriver
- Default\ JDBC\ Database.TestWhileIdle=false
- Default\ JDBC\ Database.UserName=sa
- Default\ JDBC\ Database.MaxOpenPreparedStatements=0
- Default\ JDBC\ Database.TestOnBorrow=true
- Default\ JDBC\ Database.PoolPreparedStatements=false
- Default\ JDBC\ Database.ConnectionInterface=javax.sql.DataSource
- Default\ JDBC\ Database.TestOnReturn=false
- Default\ JDBC\ Database.MinEvictableIdleTimeMillis=1800000
- Default\ JDBC\ Database.NumTestsPerEvictionRun=3
- Default\ JDBC\ Database.InitialSize=0
-
- # Resource(id=Default Unmanaged JDBC Database)
- # className: org.apache.openejb.resource.jdbc.BasicDataSource
- #
- Default\ Unmanaged\ JDBC\ Database.MaxWait=-1
- Default\ Unmanaged\ JDBC\ Database.InitialSize=0
- Default\ Unmanaged\ JDBC\ Database.DefaultAutoCommit=true
- Default\ Unmanaged\ JDBC\ Database.ConnectionProperties=
- Default\ Unmanaged\ JDBC\ Database.MaxActive=10
- Default\ Unmanaged\ JDBC\ Database.TestOnBorrow=true
- Default\ Unmanaged\ JDBC\ Database.JdbcUrl=jdbc\:hsqldb\:file\:hsqldb
- Default\ Unmanaged\ JDBC\ Database.TestOnReturn=false
- Default\ Unmanaged\ JDBC\ Database.AccessToUnderlyingConnectionAllowed=false
- Default\ Unmanaged\ JDBC\ Database.Password=xxxx
- Default\ Unmanaged\ JDBC\ Database.MinEvictableIdleTimeMillis=1800000
- Default\ Unmanaged\ JDBC\ Database.PoolPreparedStatements=false
- Default\ Unmanaged\ JDBC\ Database.MaxOpenPreparedStatements=0
- Default\ Unmanaged\ JDBC\ Database.ConnectionInterface=javax.sql.DataSource
- Default\ Unmanaged\ JDBC\ Database.MinIdle=0
- Default\ Unmanaged\ JDBC\ Database.NumTestsPerEvictionRun=3
- Default\ Unmanaged\ JDBC\ Database.TimeBetweenEvictionRunsMillis=-1
- Default\ Unmanaged\ JDBC\ Database.JdbcDriver=org.hsqldb.jdbcDriver
- Default\ Unmanaged\ JDBC\ Database.UserName=sa
- Default\ Unmanaged\ JDBC\ Database.MaxIdle=10
- Default\ Unmanaged\ JDBC\ Database.TestWhileIdle=false
-
- # Resource(id=Default JMS Connection Factory)
- # className: org.apache.activemq.ra.ActiveMQManagedConnectionFactory
- #
- Default\ JMS\ Connection\ Factory.ConnectionInterface=javax.jms.ConnectionFactory, \
- javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory
- Default\ JMS\ Connection\ Factory.ResourceAdapter=Default JMS Resource Adapter
-
- # SecurityService(id=Default Security Service)
- # className: org.apache.openejb.core.security.SecurityServiceImpl
- #
-
- # TransactionManager(id=Default Transaction Manager)
- # className: org.apache.geronimo.transaction.manager.GeronimoTransactionManager
- #
-
- # ServerService(id=httpejbd)
- # className: org.apache.openejb.server.httpd.HttpEjbServer
- #
- httpejbd.port=4204
- httpejbd.name=httpejbd
- httpejbd.disabled=false
- httpejbd.server=org.apache.openejb.server.httpd.HttpEjbServer
- httpejbd.threads=200
- httpejbd.bind=127.0.0.1
-
- # ServerService(id=telnet)
- # className: org.apache.openejb.server.telnet.TelnetServer
- #
- telnet.port=4202
- telnet.name=telnet
- telnet.disabled=false
- telnet.bind=127.0.0.1
- telnet.threads=5
- telnet.server=org.apache.openejb.server.telnet.TelnetServer
-
- # ServerService(id=ejbd)
- # className: org.apache.openejb.server.ejbd.EjbServer
- #
- ejbd.disabled=false
- ejbd.bind=127.0.0.1
- ejbd.server=org.apache.openejb.server.ejbd.EjbServer
- ejbd.port=4201
- ejbd.name=ejbd
- ejbd.threads=200
-
- # ServerService(id=hsql)
- # className: org.apache.openejb.server.hsql.HsqlService
- #
- hsql.port=9001
- hsql.name=hsql
- hsql.disabled=false
- hsql.server=org.apache.openejb.server.hsql.HsqlService
- hsql.bind=127.0.0.1
-
- # ServerService(id=admin)
- # className: org.apache.openejb.server.admin.AdminDaemon
- #
- admin.disabled=false
- admin.bind=127.0.0.1
- admin.only_from=localhost
- admin.port=4200
- admin.threads=1
- admin.name=admin
- admin.server=org.apache.openejb.server.admin.AdminDaemon
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/property-overriding.adoc
----------------------------------------------------------------------
diff --git a/docs/property-overriding.adoc b/docs/property-overriding.adoc
new file mode 100644
index 0000000..00cda34
--- /dev/null
+++ b/docs/property-overriding.adoc
@@ -0,0 +1,64 @@
+# Property Overriding
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+OpenEJB consists of several components (containers,
+resource adapters, security services, etc.) all of which are pluggable
+and have their own unique set of configurable properties. These
+components are required to specify their default property values in
+their service-jar.xml file. This means that at a minimum you as a user
+only need to specify what you'd like to be different. You specify the
+property name and the new value and the default value will be
+overwritten before the component is created.
+
+We call this overriding and there are several ways to do it.
+
+# The openejb.xml
+
+The default openejb.xml file has most of the useful properties for each
+component explicitly listed with default values for documentation
+purposes. It is safe to delete them and be assured that no behavior will
+change if a smaller config file is desired.
+
+Overriding can also be done via the command line or plain Java system
+properties. See link:system-properties.html[System Properties] for
+details.
+
+== What properties are available?
+
+To know what properties can be overriden the './bin/openejb properties'
+command is very useful: see link:properties-tool.html[Properties Tool]
+
+It's function is to connect to a running server and print a canonical
+list of all properties OpenEJB can see via the various means of
+configuration. When sending requests for help to the users list or jira,
+it is highly encouraged to send the output of this tool with your
+message.
+
+== Not configurable via openejb.xml
+
+The only thing not yet configurable via this file are ServerServices due
+to OpenEJB's embeddable nature and resulting long standing tradition of
+keeping the container system separate from the server layer. This may
+change someday, but untill then ServerServices are configurable via
+conf/.properties files such as conf/ejbd.properties to configure the
+main protocol that services EJB client requests.
+
+The format those properties files is greatly adapted from the xinet.d
+style of configuration and even shares similar functionality and
+properties such as host-based authorization (HBA) via the 'only_from'
+property.
+
+== Restoring openejb.xml to the defaults
+
+To restore this file to its original default state, you can simply
+delete it or rename it and OpenEJB will see it's missing and unpack
+another openejb.xml into the conf/ directory when it starts.
+
+This is not only handy for recovering from a non-functional config, but
+also for upgrading as OpenEJB will not overwrite your existing
+configuration file should you choose to unpack an new distro over the
+top of an old one -- this style of upgrade is safe provided you move
+your old lib/ directory first.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/property-overriding.md
----------------------------------------------------------------------
diff --git a/docs/property-overriding.md b/docs/property-overriding.md
deleted file mode 100644
index 0a45e28..0000000
--- a/docs/property-overriding.md
+++ /dev/null
@@ -1,65 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Property Overriding
-~~~~~~
-OpenEJB consists of several components (containers, resource adapters,
-security services, etc.) all of which are pluggable and have their own
-unique set of configurable properties. These components are required to
-specify their default property values in their service-jar.xml file. This
-means that at a minimum you as a user only need to specify what you'd like
-to be different. You specify the property name and the new value and the
-default value will be overwritten before the component is created.
-
-We call this overriding and there are several ways to do it.
-
-<a name="PropertyOverriding-Theopenejb.xml"></a>
-# The openejb.xml
-
-The default openejb.xml file has most of the useful properties for each
-component explicitly listed with default values for documentation purposes.
- It is safe to delete them and be assured that no behavior will change if a
-smaller config file is desired.
-
-
-Overriding can also be done via the command line or plain Java system
-properties. See [System Properties](system-properties.html)
- for details.
-
-<a name="PropertyOverriding-Whatpropertiesareavailable?"></a>
-## What properties are available?
-
-To know what properties can be overriden the './bin/openejb properties'
-command is very useful: see [Properties Tool](properties-tool.html)
-
-It's function is to connect to a running server and print a canonical list
-of all properties OpenEJB can see via the various means of configuration.
-When sending requests for help to the users list or jira, it is highly
-encouraged to send the output of this tool with your message.
-
-<a name="PropertyOverriding-Notconfigurableviaopenejb.xml"></a>
-## Not configurable via openejb.xml
-
-The only thing not yet configurable via this file are ServerServices due to
-OpenEJB's embeddable nature and resulting long standing tradition of
-keeping the container system separate from the server layer. This may
-change someday, but untill then ServerServices are configurable via
-conf/<service-id>.properties files such as conf/ejbd.properties to
-configure the main protocol that services EJB client requests.
-
-The format those properties files is greatly adapted from the xinet.d style
-of configuration and even shares similar functionality and properties such
-as host-based authorization (HBA) via the 'only_from' property.
-
-<a name="PropertyOverriding-Restoringopenejb.xmltothedefaults"></a>
-## Restoring openejb.xml to the defaults
-
-To restore this file to its original default state, you can simply delete
-it or rename it and OpenEJB will see it's missing and unpack another
-openejb.xml into the conf/ directory when it starts.
-
-This is not only handy for recovering from a non-functional config, but
-also for upgrading as OpenEJB will not overwrite your existing
-configuration file should you choose to unpack an new distro over the top
-of an old one -- this style of upgrade is safe provided you move your old
-lib/ directory first.
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/provisioning.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning.adoc b/docs/provisioning.adoc
new file mode 100644
index 0000000..306ff73
--- /dev/null
+++ b/docs/provisioning.adoc
@@ -0,0 +1,96 @@
+# TomEE/OpenEJB provisioning
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+== Summary
+
+Provioning is about the way to get binaries or information. It is the
+answer to how do i get my application, my webapp, my configuration.
+
+TomEE and OpenEJB brings some help about it allowing you to point out
+some resources instead of providing it directly.
+
+This indirection is clearly very useful to industrialize your software
+or simply to cloudify it.
+
+== A word about this page
+
+This page will not explain you how to deploy an application or how to
+enhance your container. It will simply explain you how which kind of
+urls are supported for such features.
+
+These feature are explained in other places.
+
+== Supported provionings
+
+=== file
+
+This is the default and well know provisioning. Simply give a file path
+the container is able to access through its filesystem.
+
+Example:
+
+....
+/MIDDLE/foo/bar/my-local-file.jar
+....
+
+=== Http/https
+
+Here you give an url to access the desired file. Proxies used are the
+JVM ones.
+
+Example:
+
+....
+http://atos.net/foo/bar/my-http-file.jar
+....
+
+=== Maven
+
+==== Usage
+
+Probably the most fun but very useful for cloud deployments: maven. Use
+maven informations to deploy your application.
+
+The location should follow:
+
+....
+mvn:groupId/artifactId[/[version]/[type]]
+....
+
+or
+
+....
+mvn:groupId:artifactId[:[version]:[type]]
+....
+
+Note: classifier are supported (through version field)
+
+For instance you can use:
+
+....
+mvn:net.atos.xa/my-application/1.0.0/war
+....
+
+==== Installation
+
+The maven url parsing is not included by default in OpenEJB/TomEE
+bundle. It needs to be installed.
+
+If you are using an embedded application and maven simply add
+org.apache.openejb:openejb-provisionning:VERSION dependency.
+
+If you are using TomEE you have to extract the
+org.apache.openejb:openejb-provisionning zip in the same classloader
+than tomee (webapps/tomee/lib for instance, for other places please have
+a look to other tip pages).
+
+Another way to install it with tomee is to edit or create the file
+/conf/provisioning.properties and add the line:
+
+....
+zip=http://repo1.maven.org/maven2/org/apache/openejb/openejb-provisionning/<version>/openejb-provisionning-<version>.zip
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/provisioning.md
----------------------------------------------------------------------
diff --git a/docs/provisioning.md b/docs/provisioning.md
deleted file mode 100644
index ce1fd09..0000000
--- a/docs/provisioning.md
+++ /dev/null
@@ -1,78 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=TomEE/OpenEJB provisioning
-~~~~~~
-
-# Summary
-
-Provioning is about the way to get binaries or information. It is the answer to
-how do i get my application, my webapp, my configuration.
-
-TomEE and OpenEJB brings some help about it allowing you to point out some
-resources instead of providing it directly.
-
-This indirection is clearly very useful to industrialize your software
-or simply to cloudify it.
-
-# A word about this page
-
-This page will not explain you how to deploy an application or
-how to enhance your container. It will simply explain you how which
-kind of urls are supported for such features.
-
-These feature are explained in other places.
-
-# Supported provionings
-## file
-
-This is the default and well know provisioning. Simply give a
-file path the container is able to access through its filesystem.
-
-Example:
-
- /MIDDLE/foo/bar/my-local-file.jar
-
-## Http/https
-
-Here you give an url to access the desired file. Proxies used are the JVM ones.
-
-Example:
-
- http://atos.net/foo/bar/my-http-file.jar
-
-## Maven
-### Usage
-
-Probably the most fun but very useful for cloud deployments: maven.
-Use maven informations to deploy your application.
-
-The location should follow:
-
- mvn:groupId/artifactId[/[version]/[type]]
-
-or
-
- mvn:groupId:artifactId[:[version]:[type]]
-
-Note: classifier are supported (through version field)
-
-For instance you can use:
-
- mvn:net.atos.xa/my-application/1.0.0/war
-
-### Installation
-
-The maven url parsing is not included by default in OpenEJB/TomEE bundle. It needs to be installed.
-
-If you are using an embedded application and maven simply add
-org.apache.openejb:openejb-provisionning:VERSION dependency.
-
-If you are using TomEE you have to extract the org.apache.openejb:openejb-provisionning zip
-in the same classloader than tomee (webapps/tomee/lib for instance, for other places please have
-a look to other tip pages).
-
-Another way to install it with tomee is to edit or create the file <tomee>/conf/provisioning.properties
-and add the line:
-
- zip=http://repo1.maven.org/maven2/org/apache/openejb/openejb-provisionning/<version>/openejb-provisionning-<version>.zip
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/proxyfactory-config.adoc
----------------------------------------------------------------------
diff --git a/docs/proxyfactory-config.adoc b/docs/proxyfactory-config.adoc
new file mode 100644
index 0000000..d970fa6
--- /dev/null
+++ b/docs/proxyfactory-config.adoc
@@ -0,0 +1,42 @@
+# ProxyFactory Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A ProxyFactory can be declared via xml in the
+`<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file
+using a declaration like the following. All properties in the element
+body are optional.
+
+....
+<ProxyFactory id="myProxyFactory" type="ProxyFactory">
+</ProxyFactory>
+....
+
+Alternatively, a ProxyFactory can be declared via properties in the
+`<tomee-home>/conf/system.properties` file or via Java VirtualMachine
+`-D` properties. The properties can also be used when embedding TomEE
+via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
+
+....
+myProxyFactory = new://ProxyFactory?type=ProxyFactory
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared ProxyFactory a
+warning will be logged. If a ProxyFactory is needed by the application
+and one is not declared, TomEE will create one dynamically using default
+settings. Multiple ProxyFactory declarations are allowed. # Supported
+Properties
+
+Property
+
+Type
+
+Default
+
+Description
http://git-wip-us.apache.org/repos/asf/tomee/blob/68720016/docs/proxyfactory-config.md
----------------------------------------------------------------------
diff --git a/docs/proxyfactory-config.md b/docs/proxyfactory-config.md
deleted file mode 100644
index 716a5f4..0000000
--- a/docs/proxyfactory-config.md
+++ /dev/null
@@ -1,26 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=ProxyFactory Configuration
-~~~~~~
-
-
-A ProxyFactory can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <ProxyFactory id="myProxyFactory" type="ProxyFactory">
- </ProxyFactory>
-
-Alternatively, a ProxyFactory can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myProxyFactory = new://ProxyFactory?type=ProxyFactory
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared ProxyFactory a warning will be logged. If a ProxyFactory is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple ProxyFactory declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-</table>
[22/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 9
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 9
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/9b209c98
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/9b209c98
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/9b209c98
Branch: refs/heads/master
Commit: 9b209c980a4317e9e0e9e3144759d87a9b23d04a
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:25 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:07:25 2018 -0800
----------------------------------------------------------------------
docs/queue-config.adoc | 48 ++++
docs/queue-config.md | 36 ---
docs/quickstart.adoc | 69 +++++
docs/quickstart.md | 71 -----
docs/remote-server.adoc | 69 +++++
docs/remote-server.md | 64 -----
docs/resource-injection.adoc | 201 ++++++++++++++
docs/resource-injection.md | 184 -------------
docs/resource-ref-for-datasource.adoc | 53 ++++
docs/resource-ref-for-datasource.md | 46 ----
docs/running-a-standalone-openejb-server.adoc | 77 ++++++
docs/running-a-standalone-openejb-server.md | 95 -------
docs/securing-a-web-service.adoc | 235 ++++++++++++++++
docs/securing-a-web-service.md | 242 -----------------
docs/security-annotations.adoc | 292 ++++++++++++++++++++
docs/security-annotations.md | 296 ---------------------
docs/security.adoc | 200 ++++++++++++++
docs/security.md | 148 -----------
docs/securityservice-config.adoc | 50 ++++
docs/securityservice-config.md | 36 ---
docs/service-locator.adoc | 159 +++++++++++
docs/service-locator.md | 171 ------------
docs/services.adoc | 28 ++
docs/services.md | 20 --
docs/singleton-beans.adoc | 228 ++++++++++++++++
docs/singleton-beans.md | 226 ----------------
docs/singleton-ejb.adoc | 7 +
docs/singleton-ejb.md | 6 -
docs/singletoncontainer-config.adoc | 69 +++++
docs/singletoncontainer-config.md | 56 ----
30 files changed, 1785 insertions(+), 1697 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/queue-config.adoc
----------------------------------------------------------------------
diff --git a/docs/queue-config.adoc b/docs/queue-config.adoc
new file mode 100644
index 0000000..ac7dd91
--- /dev/null
+++ b/docs/queue-config.adoc
@@ -0,0 +1,48 @@
+# Queue Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+A Queue can be declared via xml in the `<tomee-home>/conf/tomee.xml`
+file or in a `WEB-INF/resources.xml` file using a declaration like the
+following. All properties in the element body are optional.
+
+....
+<Resource id="myQueue" type="javax.jms.Queue">
+ destination =
+</Resource>
+....
+
+Alternatively, a Queue can be declared via properties in the
+`<tomee-home>/conf/system.properties` file or via Java VirtualMachine
+`-D` properties. The properties can also be used when embedding TomEE
+via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
+
+....
+myQueue = new://Resource?type=javax.jms.Queue
+myQueue.destination =
+....
+
+Properties and xml can be mixed. Properties will override the xml
+allowing for easy configuration change without the need for $\{} style
+variable substitution. Properties are not case sensitive. If a property
+is specified that is not supported by the declared Queue a warning will
+be logged. If a Queue is needed by the application and one is not
+declared, TomEE will create one dynamically using default settings.
+Multiple Queue declarations are allowed. # Supported Properties
+
+Property
+
+Type
+
+Default
+
+Description
+
+destination
+
+String
+
+Specifies the name of the queue
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/queue-config.md
----------------------------------------------------------------------
diff --git a/docs/queue-config.md b/docs/queue-config.md
deleted file mode 100644
index 51b30ed..0000000
--- a/docs/queue-config.md
+++ /dev/null
@@ -1,36 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Queue Configuration
-~~~~~~
-
-
-A Queue can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional.
-
- <Resource id="myQueue" type="javax.jms.Queue">
- destination =
- </Resource>
-
-Alternatively, a Queue can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext`
-
- myQueue = new://Resource?type=javax.jms.Queue
- myQueue.destination =
-
-Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared Queue a warning will be logged. If a Queue is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple Queue declarations are allowed.
-# Supported Properties
-<table class="mdtable">
-<tr>
-<th>Property</th>
-<th>Type</th>
-<th>Default</th>
-<th>Description</th>
-</tr>
-<tr>
- <td>destination</td>
- <td>String</td>
- <td></td>
- <td>
-Specifies the name of the queue
-</td>
-</tr>
-</table>
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/quickstart.adoc
----------------------------------------------------------------------
diff --git a/docs/quickstart.adoc b/docs/quickstart.adoc
new file mode 100644
index 0000000..f8ce3f6
--- /dev/null
+++ b/docs/quickstart.adoc
@@ -0,0 +1,69 @@
+# Quickstart
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Installation
+
+To install OpenEJB, simply link:downloads.html[download the latest
+binary] and unpack your zip or tar.gz into the directory where you want
+OpenEJB to live.
+
+Windows users can download the zip and unpack it with the WinZip
+program.
+
+Linux users can download the tar.gz and unpack it with the following
+command:
+
+_tar xzvf openejb-3.0.tar.gz_
+
+Congratulations, you've installed OpenEJB.
+
+If you've unpacked OpenEJB into the directory C:-3.0, for example, then
+this directory is your OPENEJB_HOME directory. The OPENEJB_HOME
+directory is referred to in various parts of the documentation, so it's
+good to remember where it is.
+
+# Using OpenEJB
+
+Now all you need to do is move to the bin directory in OPENEJB_HOME, the
+directory where OpenEJB was unpacked, and type:
+
+_openejb_
+
+For Windows users, that looks like this:
+
+*C:-3.0> bin
+
+For UNIX/Linux/Mac OS X users, that looks like this:
+
+`[user@host openejb-3.0](user@host-openejb-3.0.html) # ./bin/openejb`
+
+You really only need to know two commands to use OpenEJB,
+openejbx30:deploy-tool.html[deploy] and [start|OPENEJBx30:Startup] .
+Both are completely documented and have examples.
+
+For help information and command options, try this:
+
+__________________________________________
+openejb deploy --help openejb start --help
+__________________________________________
+
+For examples on using the start command and options, try this:
+
+________________________
+openejb start --examples
+________________________
+
+That's it!
+
+If you don't have any EJBs or clients to run, try the ubiquitous
+openejbx30:hello-world.html[Hello World] example.
+
+# Join the mailing list
+
+The OpenEJB User list is where the general OpenEJB community goes to ask
+questions, make suggestions, chat with other users, and keep a finger on
+the pulse of the project. More information about the user list and dev
+list can be found link:mailing-lists.html[here]
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/quickstart.md
----------------------------------------------------------------------
diff --git a/docs/quickstart.md b/docs/quickstart.md
deleted file mode 100644
index 5631362..0000000
--- a/docs/quickstart.md
+++ /dev/null
@@ -1,71 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Quickstart
-~~~~~~
-<a name="Quickstart-Installation"></a>
-# Installation
-
-
-To install OpenEJB, simply [download the latest binary](downloads.html)
- and unpack your zip or tar.gz into the directory where you want OpenEJB to
-live.
-
-Windows users can download the zip and unpack it with the WinZip program.
-
-Linux users can download the tar.gz and unpack it with the following
-command:
-
-*tar xzvf openejb-3.0.tar.gz*
-
-
-Congratulations, you've installed OpenEJB.
-
-If you've unpacked OpenEJB into the directory C:\openejb-3.0, for example,
-then this directory is your OPENEJB_HOME directory. The OPENEJB_HOME
-directory is referred to in various parts of the documentation, so it's
-good to remember where it is.
-
-<a name="Quickstart-UsingOpenEJB"></a>
-# Using OpenEJB
-
-
-Now all you need to do is move to the bin directory in OPENEJB_HOME, the
-directory where OpenEJB was unpacked, and type:
-
-*openejb*
-
-For Windows users, that looks like this:
-
-*C:\openejb-3.0> bin\openejb*
-
-For UNIX/Linux/Mac OS X users, that looks like this:
-
-`[user@host openejb-3.0](user@host-openejb-3.0.html)
-# ./bin/openejb`
-
-You really only need to know two commands to use OpenEJB, [deploy](openejbx30:deploy-tool.html)
- and [start|OPENEJBx30:Startup]
-. Both are completely documented and have examples.
-
-For help information and command options, try this:
-
-> openejb deploy --help
-> openejb start --help
-
-For examples on using the start command and options, try this:
-
-> openejb start --examples
-
-That's it!
-
-If you don't have any EJBs or clients to run, try the ubiquitous [Hello World](openejbx30:hello-world.html)
- example.
-
-<a name="Quickstart-Jointhemailinglist"></a>
-# Join the mailing list
-
-The OpenEJB User list is where the general OpenEJB community goes to ask
-questions, make suggestions, chat with other users, and keep a finger on
-the pulse of the project. More information about the user list and dev list
-can be found [here](mailing-lists.html)
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/remote-server.adoc
----------------------------------------------------------------------
diff --git a/docs/remote-server.adoc b/docs/remote-server.adoc
new file mode 100644
index 0000000..8fdb19d
--- /dev/null
+++ b/docs/remote-server.adoc
@@ -0,0 +1,69 @@
+# Remote Server
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+!http://www.openejb.org/images/diagram-remote-server.gif|valign=top,
+align=right, hspace=15! # Accessing EJBs Remotely
+
+When using OpenEJB as a stand-alone server you can connect across a
+network and access EJBs from a remote client. The client code for
+accessing an EJB's Remote Interface is the same, however to actually
+connect across a network to the server, you need to specify different
+JNDI parameters.
+
+# Short version
+
+Using OpenEJB's default remote server implementation is pretty straight
+forward. You simply need to:
+
+[arabic]
+. Deploy your bean.
+. Start the server on the IP and Port you want, 25.14.3.92 and 4201 for
+example.
+. Use that information in your client to create an initial context
+. Add the right jars to your client's classpath
+
+So, here it is in short.
+
+Deploy your bean with the Deploy Tool:
+
+....
+c:\openejb> openejb.bat deploy beans\myBean.jar
+....
+
+See the openejbx30:deploy-tool.html[OPENEJBx30:Deploy Tool]
+documentation for more details on deploying beans.
+
+Start the server:
+
+....
+c:\openejb> openejb.bat start -h 25.14.3.92 -p 4201
+....
+
+See the Remote Server command-line guide for more details on starting
+the Remote Server.
+
+Create an initial context in your client as such:
+
+....
+Properties p = new Properties();
+p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
+p.put("java.naming.provider.url", "ejbd://25.14.3.92:4201");
+p.put("java.naming.security.principal", "myuser");
+p.put("java.naming.security.credentials", "mypass");
+
+InitialContext ctx = new InitialContext(p);
+....
+
+If you don't have any EJBs or clients to run, try the ubiquitous
+openejbx30:hello-world.html[Hello World] example. Add the following
+library to your clients classpath:
+
+* openejb-client-x.x.x.jar
+* javaee-api-x.x.jar
+
+Both can be found in the lib directory where you installed OpenEJB or in
+Maven repositories.
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/remote-server.md
----------------------------------------------------------------------
diff --git a/docs/remote-server.md b/docs/remote-server.md
deleted file mode 100644
index 460dfc0..0000000
--- a/docs/remote-server.md
+++ /dev/null
@@ -1,64 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Remote Server
-~~~~~~
-
-!http://www.openejb.org/images/diagram-remote-server.gif|valign=top,
-align=right, hspace=15!
-<a name="RemoteServer-AccessingEJBsRemotely"></a>
-# Accessing EJBs Remotely
-
-When using OpenEJB as a stand-alone server you can connect across a network
-and access EJBs from a remote client. The client code for accessing an
-EJB's Remote Interface is the same, however to actually connect across a
-network to the server, you need to specify different JNDI parameters.
-
-<a name="RemoteServer-Shortversion"></a>
-# Short version
-
-Using OpenEJB's default remote server implementation is pretty straight
-forward. You simply need to:
-
-1. Deploy your bean.
-1. Start the server on the IP and Port you want, 25.14.3.92 and 4201 for
-example.
-1. Use that information in your client to create an initial context
-1. Add the right jars to your client's classpath
-
-So, here it is in short.
-
-Deploy your bean with the Deploy Tool:
-
- c:\openejb> openejb.bat deploy beans\myBean.jar
-
-See the [OPENEJBx30:Deploy Tool](openejbx30:deploy-tool.html)
- documentation for more details on deploying beans.
-
-Start the server:
-
- c:\openejb> openejb.bat start -h 25.14.3.92 -p 4201
-
-See the Remote Server command-line guide for more details on starting the
-Remote Server.
-
-Create an initial context in your client as such:
-
-
- Properties p = new Properties();
- p.put("java.naming.factory.initial", "org.apache.openejb.client.RemoteInitialContextFactory");
- p.put("java.naming.provider.url", "ejbd://25.14.3.92:4201");
- p.put("java.naming.security.principal", "myuser");
- p.put("java.naming.security.credentials", "mypass");
-
- InitialContext ctx = new InitialContext(p);
-
-
-If you don't have any EJBs or clients to run, try the ubiquitous [Hello World](openejbx30:hello-world.html)
- example.
-Add the following library to your clients classpath:
-
-* openejb-client-x.x.x.jar
-* javaee-api-x.x.jar
-
-Both can be found in the lib directory where you installed OpenEJB or in Maven repositories.
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/resource-injection.adoc
----------------------------------------------------------------------
diff --git a/docs/resource-injection.adoc b/docs/resource-injection.adoc
new file mode 100644
index 0000000..7b4824b
--- /dev/null
+++ b/docs/resource-injection.adoc
@@ -0,0 +1,201 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# @Resource
+Overview
+
+This example demonstrates the use of the injection of environment
+entries using *@Resource* annotation.
+
+The EJB 3.0 specification (_EJB Core Contracts and Requirements_)
+section 16.2.2 reads:
+
+_A field or method of a bean class may be annotated to request that an
+entry from the bean's environment be injected. Any of the types of
+resources or other environment entries described in this chapter may be
+injected. Injection may also be requested using entries in the
+deployment descriptor corresponding to each of these resource types._
+
+_Environment entries may also be injected into the bean through bean
+methods that follow the naming conventions for JavaBeans properties. The
+annotation is applied to the set method for the property, which is the
+method that is called to inject the environment entry. The JavaBeans
+property name (not the method name) is used as the default JNDI name._
+
+The _PurchaseOrderBean_ class shows use of field-level *@Resource*
+annotation.
+
+The _InvoiceBean_ class shows the use of method-level *@Resource*
+annotation.
+
+The source for this example can be checked out from svn:
+
+__________________________________________________________________________________________
+$ svn co
+http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/injection-of-env-entry
+__________________________________________________________________________________________
+
+To run it change your working directory to the directory
+_injection-of-env-entry_ and run the following maven2 commands:
+
+___________________________
+$ cd injection-of-env-entry
+___________________________
+
+___________________
+$ mvn clean install
+___________________
+
+# The Code
+
+== Injection through field (field-level injection)
+
+The _maxLineItem_ field in _PurchaseOrderBean_ class is annotated with
+*@Resource* annotation to inform the EJB container the location where in
+the code the injection of a simple environment entry should take place.
+The default value of 10 is assigned. You can modify the value of the
+environment entries at deployment time using deployment descriptor
+(*ejb-jar.xml*).
+
+==== @Resource annotation of a field
+
+....
+@Resource
+int maxLineItems = 10;
+....
+
+== Injection through a setter method (method-level injection)
+
+The _setMaxLineItem_ method in _InvoiceBean_ class is annotated with
+_@Resource_ annotation to inject the simple environment entry. Only
+setters can be used as a way to inject environment entry values.
+
+You could look up the env-entry using JNDI lookup() method and the
+following name:
+
+....
+java:comp/env/org.apache.openejb.examples.resource.InvoiceBean/maxLineItems
+....
+
+The pattern is to combine the fully-qualified class name and the name of
+a instance field (or a name of the setter method without _set_ prefix
+and the first letter lowercased).
+
+==== @Resource annotation of a setter method
+
+....
+@Resource
+public void setMaxLineItems(int maxLineItems) {
+ this.maxLineItems = maxLineItems;
+}
+....
+
+==== Using env-entry in ejb-jar.xml
+
+....
+<env-entry>
+ <description>The maximum number of line items per invoice.</description>
+ <env-entry-name>org.apache.openejb.examples.injection.InvoiceBean/maxLineItems</env-entry-name>
+ <env-entry-type>java.lang.Integer</env-entry-type>
+ <env-entry-value>15</env-entry-value>
+</env-entry>
+....
+
+==== Using @Resource annotated env-entry
+
+....
+public void addLineItem(LineItem item) throws TooManyItemsException {
+ if (item == null) {
+ throw new IllegalArgumentException("Line item must not be null");
+ }
+
+ if (itemCount <= maxLineItems) {
+ items.add(item);
+ itemCount++;
+ } else {
+ throw new TooManyItemsException("Number of items exceeded the maximum limit");
+ }
+}
+....
+
+# JUnit Test
+
+Writing an JUnit test for this example is quite simple. We need just to
+write a setup method to create and initialize the InitialContext, and
+then write our test methods.
+
+==== Test fixture
+
+....
+protected void setUp() throws Exception {
+ Properties properties = new Properties();
+ properties.setProperty(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.LocalInitialContextFactory");
+ properties.setProperty("openejb.deployments.classpath.include", ".*resource-injection.*");
+ initialContext = new InitialContext(properties);
+}
+....
+
+==== Test methods
+
+....
+public void testAddLineItem() throws Exception {
+ Invoice order = (Invoice)initialContext.lookup("InvoiceBeanBusinessRemote");
+ assertNotNull(order);
+ LineItem item = new LineItem("ABC-1", "Test Item");
+
+ try {
+ order.addLineItem(item);
+ } catch (TooManyItemsException tmie) {
+ fail("Test failed due to: " + tmie.getMessage());
+ }
+}
+....
+
+# Running
+
+Running the example is fairly simple. Just execute the following
+commands:
+
+___________________________
+$ cd injection-of-env-entry
+
+$ mvn clean test
+___________________________
+
+....
+-------------------------------------------------------
+ T E S T S
+-------------------------------------------------------
+Running org.superbiz.injection.PurchaseOrderBeanTest
+Apache OpenEJB 3.0.0-SNAPSHOT build: 20071218-01:41
+http://tomee.apache.org/
+INFO - openejb.home = c:\oss\openejb3\examples\injection-of-env-entry
+INFO - openejb.base = c:\oss\openejb3\examples\injection-of-env-entry
+WARN - Cannot find the configuration file [conf/openejb.xml]. Will attempt to create one for the beans deployed.
+INFO - Configuring Service(id=Default Security Service,type=SecurityService, provider-id=Default Security Service)
+INFO - Configuring Service(id=Default Transaction Manager, type=TransactionManager, provider-id=Default Transaction Manager)
+INFO - Configuring Service(id=Default JDK 1.3 ProxyFactory, type=ProxyFactory, provider-id=Default JDK 1.3 ProxyFactory)
+INFO - Found EjbModule in classpath: c:\oss\openejb3\examples\injection-of-env-entry\target\classes
+INFO - Configuring app: c:\oss\openejb3\examples\injection-of-env-entry\target\classes
+INFO - Configuring Service(id=Default Stateful Container, type=Container, provider-id=Default Stateful Container)
+INFO - Auto-creating a container for bean InvoiceBean: Container(type=STATEFUL, id=Default Stateful Container)
+INFO - Loaded Module: c:\oss\openejb3\examples\injection-of-env-entry\target\classes
+INFO - Assembling app: c:\oss\openejb3\examples\injection-of-env-entry\target\classes
+INFO - Jndi(name=InvoiceBeanRemote) --> Ejb(deployment-id=InvoiceBean)
+INFO - Jndi(name=PurchaseOrderBeanRemote) --> Ejb(deployment-id=PurchaseOrderBean)
+INFO - Created Ejb(deployment-id=InvoiceBean, ejb-name=InvoiceBean, container=Default Stateful Container)
+INFO - Created Ejb(deployment-id=PurchaseOrderBean, ejb-name=PurchaseOrderBean, container=Default Stateful Container)
+INFO - Deployed Application(path=c:\oss\openejb3\examples\injection-of-env-entry\target\classes)
+INFO - OpenEJB ready.
+OpenEJB ready.
+Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.859 sec
+Running org.superbiz.injection.InvoiceBeanTest
+Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.031 sec
+
+Results :
+
+Tests run: 4, Failures: 0, Errors: 0, Skipped: 0
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/resource-injection.md
----------------------------------------------------------------------
diff --git a/docs/resource-injection.md b/docs/resource-injection.md
deleted file mode 100644
index ac019ed..0000000
--- a/docs/resource-injection.md
+++ /dev/null
@@ -1,184 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<a name="ResourceInjection-Overview"></a>
-# @Resource Overview
-
-This example demonstrates the use of the injection of environment entries
-using <span style="color: #217D18;">**@Resource**</span> annotation.
-
-The EJB 3.0 specification (*EJB Core Contracts and Requirements*) section
-16.2.2 reads:
-
-*A field or method of a bean class may be annotated to request that an entry from the bean's environment be injected. Any of the types of resources or other environment entries described in this chapter may be injected. Injection may also be requested using entries in the deployment descriptor corresponding to each of these
-resource types.*
-
-*Environment entries may also be injected into the bean through bean methods that follow the naming conventions for JavaBeans properties. The annotation is applied to the set method for the property, which is the method that is called to inject the environment entry. The JavaBeans property name (not the method name) is used as the default JNDI name.*
-
-The *PurchaseOrderBean* class shows use of field-level **@Resource**
-annotation.
-
-The *InvoiceBean* class shows the use of method-level **@Resource**
-annotation.
-
-The source for this example can be checked out from svn:
-
-> $ svn co
-http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/injection-of-env-entry
-
-To run it change your working directory to the directory
-*injection-of-env-entry* and run the following maven2 commands:
-
->$ cd injection-of-env-entry
-
->$ mvn clean install
-
-<a name="ResourceInjection-TheCode"></a>
-# The Code
-
-<a name="ResourceInjection-Injectionthroughfield(field-levelinjection)"></a>
-## Injection through field (field-level injection)
-
-The *maxLineItem* field in *PurchaseOrderBean* class is annotated with **@Resource** annotation to inform the EJB container the location where in the code the injection of a simple environment entry should take place. The default value of 10 is assigned. You can modify the value of the environment entries at deployment time using deployment descriptor (**ejb-jar.xml**).
-
-<a name="ResourceInjection-@Resourceannotationofafield"></a>
-#### @Resource annotation of a field
-
-
- @Resource
- int maxLineItems = 10;
-
-
-<a name="ResourceInjection-Injectionthroughasettermethod(method-levelinjection)"></a>
-## Injection through a setter method (method-level injection)
-
-The *setMaxLineItem* method in *InvoiceBean* class is annotated with
-*@Resource* annotation to inject the simple environment entry. Only setters
-can be used as a way to inject environment entry values.
-
-You could look up the env-entry using JNDI lookup() method and the
-following name:
-
- java:comp/env/org.apache.openejb.examples.resource.InvoiceBean/maxLineItems
-
-The pattern is to combine the fully-qualified class name and the name of a
-instance field (or a name of the setter method without _set_ prefix and the
-first letter lowercased).
-
-<a name="ResourceInjection-@Resourceannotationofasettermethod"></a>
-#### @Resource annotation of a setter method
-
-
- @Resource
- public void setMaxLineItems(int maxLineItems) {
- this.maxLineItems = maxLineItems;
- }
-
-
-<a name="ResourceInjection-env-entryinejb-jar.xml"></a>
-#### Using env-entry in ejb-jar.xml
-
- <env-entry>
- <description>The maximum number of line items per invoice.</description>
- <env-entry-name>org.apache.openejb.examples.injection.InvoiceBean/maxLineItems</env-entry-name>
- <env-entry-type>java.lang.Integer</env-entry-type>
- <env-entry-value>15</env-entry-value>
- </env-entry>
-
-
-<a name="ResourceInjection-Using@Resourceannotatedenv-entry"></a>
-#### Using @Resource annotated env-entry
-
- public void addLineItem(LineItem item) throws TooManyItemsException {
- if (item == null) {
- throw new IllegalArgumentException("Line item must not be null");
- }
-
- if (itemCount <= maxLineItems) {
- items.add(item);
- itemCount++;
- } else {
- throw new TooManyItemsException("Number of items exceeded the maximum limit");
- }
- }
-
-
-<a name="ResourceInjection-JUnitTest"></a>
-# JUnit Test
-
-Writing an JUnit test for this example is quite simple. We need just to
-write a setup method to create and initialize the InitialContext, and then
-write our test methods.
-
-<a name="ResourceInjection-Testfixture"></a>
-#### Test fixture
-
-
- protected void setUp() throws Exception {
- Properties properties = new Properties();
- properties.setProperty(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.LocalInitialContextFactory");
- properties.setProperty("openejb.deployments.classpath.include", ".*resource-injection.*");
- initialContext = new InitialContext(properties);
- }
-
-
-<a name="ResourceInjection-Testmethods"></a>
-#### Test methods
-
- public void testAddLineItem() throws Exception {
- Invoice order = (Invoice)initialContext.lookup("InvoiceBeanBusinessRemote");
- assertNotNull(order);
- LineItem item = new LineItem("ABC-1", "Test Item");
-
- try {
- order.addLineItem(item);
- } catch (TooManyItemsException tmie) {
- fail("Test failed due to: " + tmie.getMessage());
- }
- }
-
-
-<a name="ResourceInjection-Running"></a>
-# Running
-
-Running the example is fairly simple. Just execute the following commands:
-
->$ cd injection-of-env-entry
->
->$ mvn clean test
-
-
- -------------------------------------------------------
- T E S T S
- -------------------------------------------------------
- Running org.superbiz.injection.PurchaseOrderBeanTest
- Apache OpenEJB 3.0.0-SNAPSHOT build: 20071218-01:41
- http://tomee.apache.org/
- INFO - openejb.home = c:\oss\openejb3\examples\injection-of-env-entry
- INFO - openejb.base = c:\oss\openejb3\examples\injection-of-env-entry
- WARN - Cannot find the configuration file [conf/openejb.xml]. Will attempt to create one for the beans deployed.
- INFO - Configuring Service(id=Default Security Service,type=SecurityService, provider-id=Default Security Service)
- INFO - Configuring Service(id=Default Transaction Manager, type=TransactionManager, provider-id=Default Transaction Manager)
- INFO - Configuring Service(id=Default JDK 1.3 ProxyFactory, type=ProxyFactory, provider-id=Default JDK 1.3 ProxyFactory)
- INFO - Found EjbModule in classpath: c:\oss\openejb3\examples\injection-of-env-entry\target\classes
- INFO - Configuring app: c:\oss\openejb3\examples\injection-of-env-entry\target\classes
- INFO - Configuring Service(id=Default Stateful Container, type=Container, provider-id=Default Stateful Container)
- INFO - Auto-creating a container for bean InvoiceBean: Container(type=STATEFUL, id=Default Stateful Container)
- INFO - Loaded Module: c:\oss\openejb3\examples\injection-of-env-entry\target\classes
- INFO - Assembling app: c:\oss\openejb3\examples\injection-of-env-entry\target\classes
- INFO - Jndi(name=InvoiceBeanRemote) --> Ejb(deployment-id=InvoiceBean)
- INFO - Jndi(name=PurchaseOrderBeanRemote) --> Ejb(deployment-id=PurchaseOrderBean)
- INFO - Created Ejb(deployment-id=InvoiceBean, ejb-name=InvoiceBean, container=Default Stateful Container)
- INFO - Created Ejb(deployment-id=PurchaseOrderBean, ejb-name=PurchaseOrderBean, container=Default Stateful Container)
- INFO - Deployed Application(path=c:\oss\openejb3\examples\injection-of-env-entry\target\classes)
- INFO - OpenEJB ready.
- OpenEJB ready.
- Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.859 sec
- Running org.superbiz.injection.InvoiceBeanTest
- Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.031 sec
-
- Results :
-
- Tests run: 4, Failures: 0, Errors: 0, Skipped: 0
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/resource-ref-for-datasource.adoc
----------------------------------------------------------------------
diff --git a/docs/resource-ref-for-datasource.adoc b/docs/resource-ref-for-datasource.adoc
new file mode 100644
index 0000000..c2e1ff9
--- /dev/null
+++ b/docs/resource-ref-for-datasource.adoc
@@ -0,0 +1,53 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# Via annotation
+
+....
+package org.superbiz.refs;
+
+import javax.annotation.Resource;
+import javax.ejb.Stateless;
+import javax.naming.InitialContext;
+import javax.sql.DataSource;
+
+@Stateless
+@Resource(name = "myFooDataSource", type = DataSource.class)
+public class MyDataSourceRefBean implements MyBeanInterface {
+
+ @Resource
+ private DataSource myBarDataSource;
+
+ public void someBusinessMethod() throws Exception {
+ if (myBarDataSource == null) throw new NullPointerException("myBarDataSource not injected");
+
+ // Both can be looked up from JNDI as well
+ InitialContext context = new InitialContext();
+ DataSource fooDataSource = (DataSource) context.lookup("java:comp/env/myFooDataSource");
+ DataSource barDataSource = (DataSource) context.lookup("java:comp/env/org.superbiz.refs.MyDataSourceRefBean/myBarDataSource");
+ }
+}
+....
+
+== Via xml
+
+The above @Resource annotation usage is 100% equivalent to the following
+xml.
+
+....
+<resource-ref>
+ <res-ref-name>myFooDataSource</res-ref-name>
+ <res-type>javax.sql.DataSource</res-type>
+</resource-ref>
+<resource-ref>
+ <res-ref-name>org.superbiz.refs.MyDataSourceRefBean/myBarDataSource</res-ref-name>
+ <res-type>javax.sql.DataSource</res-type>
+ <injection-target>
+ <injection-target-class>org.superbiz.refs.MyDataSourceRefBean</injection-target-class>
+ <injection-target-name>myBarDataSource</injection-target-name>
+ </injection-target>
+</resource-ref>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/resource-ref-for-datasource.md
----------------------------------------------------------------------
diff --git a/docs/resource-ref-for-datasource.md b/docs/resource-ref-for-datasource.md
deleted file mode 100644
index d27fb04..0000000
--- a/docs/resource-ref-for-datasource.md
+++ /dev/null
@@ -1,46 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-# Via annotation
-
- package org.superbiz.refs;
-
- import javax.annotation.Resource;
- import javax.ejb.Stateless;
- import javax.naming.InitialContext;
- import javax.sql.DataSource;
-
- @Stateless
- @Resource(name = "myFooDataSource", type = DataSource.class)
- public class MyDataSourceRefBean implements MyBeanInterface {
-
- @Resource
- private DataSource myBarDataSource;
-
- public void someBusinessMethod() throws Exception {
- if (myBarDataSource == null) throw new NullPointerException("myBarDataSource not injected");
-
- // Both can be looked up from JNDI as well
- InitialContext context = new InitialContext();
- DataSource fooDataSource = (DataSource) context.lookup("java:comp/env/myFooDataSource");
- DataSource barDataSource = (DataSource) context.lookup("java:comp/env/org.superbiz.refs.MyDataSourceRefBean/myBarDataSource");
- }
- }
-
-# Via xml
-
-The above @Resource annotation usage is 100% equivalent to the following xml.
-
- <resource-ref>
- <res-ref-name>myFooDataSource</res-ref-name>
- <res-type>javax.sql.DataSource</res-type>
- </resource-ref>
- <resource-ref>
- <res-ref-name>org.superbiz.refs.MyDataSourceRefBean/myBarDataSource</res-ref-name>
- <res-type>javax.sql.DataSource</res-type>
- <injection-target>
- <injection-target-class>org.superbiz.refs.MyDataSourceRefBean</injection-target-class>
- <injection-target-name>myBarDataSource</injection-target-name>
- </injection-target>
- </resource-ref>
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/running-a-standalone-openejb-server.adoc
----------------------------------------------------------------------
diff --git a/docs/running-a-standalone-openejb-server.adoc b/docs/running-a-standalone-openejb-server.adoc
new file mode 100644
index 0000000..acd1583
--- /dev/null
+++ b/docs/running-a-standalone-openejb-server.adoc
@@ -0,0 +1,77 @@
+# Running a standalone OpenEJB server
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+# Configuring the OpenEJB Runtime The OpenEJB Eclipse plugin provides
+support for running OpenEJB as a standalone server in Eclipse using WTP.
+
+To setup a server, first of all, you will need to have a copy of OpenEJB
+extracted on your machine. Once you have that, the next step is to set
+up a runtime.
+
+To set up a new runtime, click on Window, Preferences, and select
+Installed Runtimes under the Server category. Click the Add button.
+
+image:http://people.apache.org/~jgallimore/images/server_step_4.jpg[http://people.apache.org/~jgallimore/images/server_step_4.jpg]
+
+Select OpenEJB 3.0.0 from the Apache category, and click next. If you
+choose to 'also create a new server' on this panel, you can add a server
+straight after configuring the runtime.
+
+image:http://people.apache.org/~jgallimore/images/server_step_5.jpg[http://people.apache.org/~jgallimore/images/server_step_5.jpg]
+
+Browse to, or enter the path to your copy of OpenEJB. Click on Finish.
+
+# Configuring the OpenEJB Server Open the Servers view (if it isn't
+already), and right click and select New->Server.
+
+image:http://people.apache.org/~jgallimore/images/server_step_8.jpg[http://people.apache.org/~jgallimore/images/server_step_8.jpg]
+
+Select OpenEJB 3.0.0 from the Apache category, ensure you have the
+OpenEJB runtime selected, and click Next.
+
+image:http://people.apache.org/~jgallimore/images/server_step_9.jpg[http://people.apache.org/~jgallimore/images/server_step_9.jpg]
+
+Select the EJB port for the server, and select Finish.
+
+image:http://people.apache.org/~jgallimore/images/server_step_10.jpg[http://people.apache.org/~jgallimore/images/server_step_10.jpg]
+
+# Deploying a project In order to deploy your project to an OpenEJB
+server in Eclipse, your project must be a Java EE project, with the EJB
+facet enabled. If your project doesn't have the Faceted nature, you can
+use the OpenEJB plugin to add it. Simply select OpenEJB->Add Faceted
+Nature from the menu bar.
+
+image:http://people.apache.org/~jgallimore/images/server_step_1.jpg[http://people.apache.org/~jgallimore/images/server_step_1.jpg]
+
+To add the EJB facet, right click on the project in the navigator, and
+select Properties. Select Project Facets on the left hand side. Click on
+the Modify Project button.
+
+image:http://people.apache.org/~jgallimore/images/server_step_2.jpg[http://people.apache.org/~jgallimore/images/server_step_2.jpg]
+
+Select the EJB Module facet, and the Java Facet. Remember to select your
+OpenEJB runtime too. Click Next.
+
+image:http://people.apache.org/~jgallimore/images/server_step_6.jpg[http://people.apache.org/~jgallimore/images/server_step_6.jpg]
+
+Enter the source folder for the EJBs in your project and click Finish.
+
+image:http://people.apache.org/~jgallimore/images/server_step_6.jpg[http://people.apache.org/~jgallimore/images/server_step_7.jpg]
+
+Now right click on your OpenEJB server in the servers view, and select
+Add and Remove Projects.
+
+image:http://people.apache.org/~jgallimore/images/server_step_11.jpg[http://people.apache.org/~jgallimore/images/server_step_11.jpg]
+
+Add your project to the server, and click Finish.
+
+image:http://people.apache.org/~jgallimore/images/server_step_12.jpg[http://people.apache.org/~jgallimore/images/server_step_12.jpg]
+
+To start the server, Right click on your OpenEJB server, and select
+Start.
+
+image:http://people.apache.org/~jgallimore/images/server_step_13.jpg[http://people.apache.org/~jgallimore/images/server_step_13.jpg]
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/running-a-standalone-openejb-server.md
----------------------------------------------------------------------
diff --git a/docs/running-a-standalone-openejb-server.md b/docs/running-a-standalone-openejb-server.md
deleted file mode 100644
index ca81014..0000000
--- a/docs/running-a-standalone-openejb-server.md
+++ /dev/null
@@ -1,95 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Running a standalone OpenEJB server
-~~~~~~
-
-<a name="RunningastandaloneOpenEJBserver-ConfiguringtheOpenEJBRuntime"></a>
-# Configuring the OpenEJB Runtime
-The OpenEJB Eclipse plugin provides support for running OpenEJB as a
-standalone server in Eclipse using WTP.
-
-To setup a server, first of all, you will need to have a copy of OpenEJB
-extracted on your machine. Once you have that, the next step is to set up a
-runtime.
-
-To set up a new runtime, click on Window, Preferences, and select Installed
-Runtimes under the Server category. Click the Add button.
-
-![http://people.apache.org/~jgallimore/images/server_step_4.jpg][1]
-
-Select OpenEJB 3.0.0 from the Apache category, and click next. If you
-choose to 'also create a new server' on this panel, you can add a server
-straight after configuring the runtime.
-
-![http://people.apache.org/~jgallimore/images/server_step_5.jpg][2]
-
-Browse to, or enter the path to your copy of OpenEJB. Click on Finish.
-
-<a name="RunningastandaloneOpenEJBserver-ConfiguringtheOpenEJBServer"></a>
-# Configuring the OpenEJB Server
-Open the Servers view (if it isn't already), and right click and select
-New->Server.
-
-![http://people.apache.org/~jgallimore/images/server_step_8.jpg][3]
-
-Select OpenEJB 3.0.0 from the Apache category, ensure you have the OpenEJB
-runtime selected, and click Next.
-
-![http://people.apache.org/~jgallimore/images/server_step_9.jpg][4]
-
-Select the EJB port for the server, and select Finish.
-
-![http://people.apache.org/~jgallimore/images/server_step_10.jpg][5]
-
-<a name="RunningastandaloneOpenEJBserver-Deployingaproject"></a>
-# Deploying a project
-In order to deploy your project to an OpenEJB server in Eclipse, your
-project must be a Java EE project, with the EJB facet enabled. If your
-project doesn't have the Faceted nature, you can use the OpenEJB plugin to
-add it. Simply select OpenEJB->Add Faceted Nature from the menu bar.
-
-![http://people.apache.org/~jgallimore/images/server_step_1.jpg][6]
-
-To add the EJB facet, right click on the project in the navigator, and
-select Properties. Select Project Facets on the left hand side. Click on
-the Modify Project button.
-
-![http://people.apache.org/~jgallimore/images/server_step_2.jpg][7]
-
-Select the EJB Module facet, and the Java Facet. Remember to select your
-OpenEJB runtime too. Click Next.
-
-![http://people.apache.org/~jgallimore/images/server_step_6.jpg][8]
-
-Enter the source folder for the EJBs in your project and click Finish.
-
-![http://people.apache.org/~jgallimore/images/server_step_7.jpg][9]
-
-Now right click on your OpenEJB server in the servers view, and select Add
-and Remove Projects.
-
-![http://people.apache.org/~jgallimore/images/server_step_11.jpg][10]
-
-Add your project to the server, and click Finish.
-
-![http://people.apache.org/~jgallimore/images/server_step_12.jpg][11]
-
-To start the server, Right click on your OpenEJB server, and select Start.
-
-![http://people.apache.org/~jgallimore/images/server_step_13.jpg][12]
-
-
-
- [1]: http://people.apache.org/~jgallimore/images/server_step_4.jpg
- [2]: http://people.apache.org/~jgallimore/images/server_step_5.jpg
- [3]: http://people.apache.org/~jgallimore/images/server_step_8.jpg
- [4]: http://people.apache.org/~jgallimore/images/server_step_9.jpg
- [5]: http://people.apache.org/~jgallimore/images/server_step_10.jpg
- [6]: http://people.apache.org/~jgallimore/images/server_step_1.jpg
- [7]: http://people.apache.org/~jgallimore/images/server_step_2.jpg
- [8]: http://people.apache.org/~jgallimore/images/server_step_6.jpg
- [9]: http://people.apache.org/~jgallimore/images/server_step_6.jpg
- [10]: http://people.apache.org/~jgallimore/images/server_step_11.jpg
- [11]: http://people.apache.org/~jgallimore/images/server_step_12.jpg
- [12]: http://people.apache.org/~jgallimore/images/server_step_13.jpg
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/securing-a-web-service.adoc
----------------------------------------------------------------------
diff --git a/docs/securing-a-web-service.adoc b/docs/securing-a-web-service.adoc
new file mode 100644
index 0000000..05cfa33
--- /dev/null
+++ b/docs/securing-a-web-service.adoc
@@ -0,0 +1,235 @@
+# Securing a Web Service
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+Web Services are a very common way to implement a Service Oriented
+Architecture (SOA).
+
+There are lots of web service standards/specifications (XML, SOAP, WSDL,
+UUDI, WS-*, ...) coming from organizations like W3C, OASIS, WS-I, ...
+And there are java web service standards like JAX-WS 1.x (JSR 181),
+JAX-WS 2.0 (JSR 224).
+
+OpenEJB provides a standard way to implement web services transport
+protocol throughout the JAX-WS specification. Java basic standards for
+web services (JAX-WS) do lack some features that are required in most
+real world applications, e.g. standard ways for handling security and
+authentication (there is no java specification for Oasis's WS-Security
+specification).
+
+OpenEJB provides two mechanisms to secure webservices - HTTP
+authentication and WS-Security:
+
+HTTPS : works at the transport level, enables a point-to-point security.
+It has no impact on developments. It allows you :
+
+[arabic]
+. To secure data over the network with data encrypted during transport
+. To identify the end user with SSLv3 with client certificate required
+. OpenEJB supports BASIC authentication over HTTP(S), using the
+configured JAAS provider. This will honour any EJB security roles you
+have setup using
+
+. See the webservice-security example in the OpenEJB codebase
+http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/
+
+_Warning: Currently only BASIC is the only HTTP authentication mechanism
+available when running OpenEJB standalone or in a unit test, but we hope
+to support DIGEST in the future._
+
+WS-Security: works at the message (SOAP) level, enables a higher-level
+security, Nowadays, SOAP implementations use other protocols than just
+HTTP so we need to apply security to the message itself and not only at
+the transport layer. Moreover, HTTPS can only be used for securing
+point-to-point services which tend to decrease with Enterprise Service
+Bus for example.
+
+The Oasis organization has defined a standard (part of well-known WS-*)
+which aims at providing high level features in the context of web
+services: WS-Security. It provides a standard way to secure your
+services above and beyond transport level protocols such as HTTPS.
+WS-Security relies on other standards like XML-Encryption.
+
+Main features are:
+
+[arabic]
+. Timestamp a message,
+. Pass credentials (plain text and/or ciphered) between services,
+. Sign messages,
+. Encrypt messages or part of messages.
+
+Again, JAX-WS doesn't standardize security for web services. OpenEJB
+provides a common and highly configurable way to configure WS-Security
+in association with the JAX-WS usage without vendor dependence.
+Internally, OpenEJB integrates Apache WSS4J as the WS-Security
+implementation. To use the integration, you will need to configure WSS4J
+using the _openejb-jar.xml_.
+
+_Warning: the proposed WS-Security integration is only used at server
+side. Currently, WS-Security client configuration is not managed by
+OpenEJB. You can use the JAX-WS API to create a stub and then rely on
+the implementation to set up WS-Security properties._
+
+This configuration file lets you set up incoming and outgoing security
+parameters. Incoming and outgoing configuration is independent so that
+you can configure either one or the other or both. You can decide to
+check client credentials for incoming messages and sign outgoing
+messages (response).
+
+# Configuration principles The configuration is made in the
+_openejb-jar.xml_. Each endpoint web service can provide a set of
+properties to customize WS-Security behavior through the element. The
+content of this element is consistent with the overall structure of
+_openejb.xml_. The format for properties is the same as if you would use
+a common java property file.
+
+....
+<properties>
+ wss4j.in.action = UsernameToken
+ wss4j.in.passwordType = PasswordDigest
+ wss4j.in.passwordCallbackClass=org.superbiz.calculator.CustomPasswordHandler
+</properties>
+....
+
+In order to recover WSS4J properties both for input and output, we use
+naming conventions. Each property is made of .<in|out>.=
+
+For example : _wss4j.in.action = UsernameToken_
+
+# Username Token (Password digest) example #### Excerpt from
+_openejb-jar.xml_.
+
+....
+<openejb-jar xmlns="http://tomee.apache.org/xml/ns/openejb-jar-2.2">
+ <enterprise-beans>
+ ...
+ <session>
+ <ejb-name>CalculatorImpl</ejb-name>
+ <web-service-security>
+ <security-realm-name/>
+ <transport-guarantee>NONE</transport-guarantee>
+ <auth-method>WS-SECURITY</auth-method>
+ <properties>
+ wss4j.in.action = UsernameToken
+ wss4j.in.passwordType = PasswordDigest
+ wss4j.in.passwordCallbackClass=org.superbiz.calculator.CustomPasswordHandler
+ </properties>
+ </web-service-security>
+ </session>
+ ...
+ </enterprise-beans>
+</openejb-jar>
+....
+
+==== Request sent by the client. This request contains SOAP headers to
+manage security. You can see _UsernameToken_ tag from the WS-Security
+specification.
+
+....
+POST /CalculatorImplUsernameTokenHashedPassword HTTP/1.1
+Content-Type: text/xml; charset=UTF-8
+SOAPAction: ""
+Accept: *
+Cache-Control: no-cache
+Pragma: no-cache
+User-Agent: Java/1.5.0_05
+Host: 127.0.0.1:8204
+Connection: keep-alive
+Transfer-Encoding: chunked
+
+524
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+ <soap:Header>
+ <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
+ <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
+wsu:Id="UsernameToken-22402238"
+xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+ <wsse:Username xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">jane</wsse:Username>
+ <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"
+xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">tf7k3a4GREIt1xec/KXVmBdRNIg=</wsse:Password>
+ <wsse:Nonce xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">cKhUhmjQ1hGYPsdOLez5kA==</wsse:Nonce>
+ <wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2009-04-14T20:16:26.203Z</wsu:Created>
+ </wsse:UsernameToken>
+ </wsse:Security>
+ </soap:Header>
+ <soap:Body>
+ <ns1:sum xmlns:ns1="http://superbiz.org/wsdl">
+ <arg0>4</arg0>
+ <arg1>6</arg1>
+ </ns1:sum>
+ </soap:Body>
+</soap:Envelope>
+....
+
+==== The response returned from the server.
+
+....
+HTTP/1.1 200 OK
+Content-Length: 200
+Connection: close
+Content-Type: text/xml; charset=UTF-8
+Server: OpenEJB/??? (unknown os)
+
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+ <soap:Body>
+ <ns1:sumResponse xmlns:ns1="http://superbiz.org/wsdl">
+ <return>10</return>
+ </ns1:sumResponse>
+ </soap:Body>
+</soap:Envelope>
+....
+
+# JAAS with WS-Security
+
+1 doesn't work straight off with WS-Security, but you can add calls to
+the OpenEJB SecurityService to login to a JAAS provider to a
+CallbackHandler. Once you have done this, any permissions configured
+with 1 should be honoured.
+
+Here is a snippet from the webservice-ws-security example demonstrating
+this:
+
+....
+public class CustomPasswordHandler implements CallbackHandler {
+
+ public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException {
+ WSPasswordCallback pc = (WSPasswordCallback) callbacks[0];
+
+ if (pc.getUsage() == WSPasswordCallback.USERNAME_TOKEN) {
+ // TODO get the password from the users.properties if possible
+ pc.setPassword("waterfall");
+
+ } else if (pc.getUsage() == WSPasswordCallback.DECRYPT) {
+
+ pc.setPassword("serverPassword");
+
+ } else if (pc.getUsage() == WSPasswordCallback.SIGNATURE) {
+
+ pc.setPassword("serverPassword");
+
+ }
+
+ if ((pc.getUsage() == WSPasswordCallback.USERNAME_TOKEN) || (pc.getUsage() == WSPasswordCallback.USERNAME_TOKEN_UNKNOWN)) {
+
+ SecurityService securityService = SystemInstance.get().getComponent(SecurityService.class);
+ Object token = null;
+ try {
+ securityService.disassociate();
+
+ token = securityService.login(pc.getIdentifer(), pc.getPassword());
+ securityService.associate(token);
+
+ } catch (LoginException e) {
+ e.printStackTrace();
+ throw new SecurityException("wrong password");
+ }
+ }
+ }
+}
+....
+
+# Examples A full example (webservice-ws-security) is available with
+OpenEJB Examples.
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/securing-a-web-service.md
----------------------------------------------------------------------
diff --git a/docs/securing-a-web-service.md b/docs/securing-a-web-service.md
deleted file mode 100644
index 3c3ec18..0000000
--- a/docs/securing-a-web-service.md
+++ /dev/null
@@ -1,242 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Securing a Web Service
-~~~~~~
-
-Web Services are a very common way to implement a Service Oriented
-Architecture (SOA).
-
-There are lots of web service standards/specifications (XML, SOAP, WSDL,
-UUDI, WS-*, ...) coming from organizations like W3C, OASIS, WS-I, ...
-And there are java web service standards like JAX-WS 1.x (JSR 181), JAX-WS
-2.0 (JSR 224).
-
-OpenEJB provides a standard way to implement web services transport
-protocol throughout the JAX-WS specification.
-Java basic standards for web services (JAX-WS) do lack some features that
-are required in most real world applications, e.g. standard ways for
-handling security and authentication (there is no java specification for
-Oasis's WS-Security specification).
-
-OpenEJB provides two mechanisms to secure webservices - HTTP authentication
-and WS-Security:
-
-HTTPS : works at the transport level, enables a point-to-point security.
-It has no impact on developments. It allows you :
-
-1. To secure data over the network with data encrypted during transport
-2. To identify the end user with SSLv3 with client certificate required
-3. OpenEJB supports BASIC authentication over HTTP(S), using the configured
-JAAS provider. This will honour any EJB security roles you have setup using
-@RolesAllowed. See the webservice-security example in the OpenEJB codebase [http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/](http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/)
-
-*Warning:
-Currently only BASIC is the only HTTP authentication mechanism available
-when running OpenEJB standalone or in a unit test, but we hope to support
-DIGEST in the future.*
-
-
-WS-Security: works at the message (SOAP) level, enables a higher-level
-security,
-Nowadays, SOAP implementations use other protocols than just HTTP so we
-need to apply security to the message itself and not only at the transport
-layer. Moreover, HTTPS can only be used for securing point-to-point
-services which tend to decrease with Enterprise Service Bus for example.
-
-The Oasis organization has defined a standard (part of well-known WS-*)
-which aims at providing high level features in the context of web services:
-WS-Security. It provides a standard way to secure your services above and
-beyond transport level protocols such as HTTPS. WS-Security relies on other
-standards like XML-Encryption.
-
-Main features are:
-
-1. Timestamp a message,
-2. Pass credentials (plain text and/or ciphered) between services,
-3. Sign messages,
-4. Encrypt messages or part of messages.
-
-Again, JAX-WS doesn't standardize security for web services. OpenEJB
-provides a common and highly configurable way to configure WS-Security in
-association with the JAX-WS usage without vendor dependence. Internally,
-OpenEJB integrates Apache WSS4J as the WS-Security implementation. To use
-the integration, you will need to configure WSS4J using the
-*openejb-jar.xml*.
-
-*Warning:
-the proposed WS-Security integration is only used at server side.
-Currently, WS-Security client configuration is not managed by OpenEJB. You
-can use the JAX-WS API to create a stub and then rely on the implementation
-to set up WS-Security properties.*
-
-This configuration file lets you set up incoming and outgoing security
-parameters. Incoming and outgoing configuration is independent so that you
-can configure either one or the other or both. You can decide to check
-client credentials for incoming messages and sign outgoing messages
-(response).
-
-<a name="SecuringaWebService-Configurationprinciples"></a>
-# Configuration principles
-The configuration is made in the *openejb-jar.xml*. Each endpoint web
-service can provide a set of properties to customize WS-Security behavior
-through the <properties> element. The content of this element is consistent
-with the overall structure of *openejb.xml*. The format for properties is
-the same as if you would use a common java property file.
-
-
-
- <properties>
- wss4j.in.action = UsernameToken
- wss4j.in.passwordType = PasswordDigest
- wss4j.in.passwordCallbackClass=org.superbiz.calculator.CustomPasswordHandler
- </properties>
-
-
-
-In order to recover WSS4J properties both for input and output, we use
-naming conventions.
-Each property is made of
- <wss4j>.<in|out>.<wss4j property name>=<wss4j property value>
-
-For example : *wss4j.in.action = UsernameToken*
-
-<a name="SecuringaWebService-UsernameToken(Passworddigest)example"></a>
-# Username Token (Password digest) example
-<a name="SecuringaWebService-Excerptfrom*openejb-jar.xml*."></a>
-#### Excerpt from *openejb-jar.xml*.
-
-
- <openejb-jar xmlns="http://tomee.apache.org/xml/ns/openejb-jar-2.2">
- <enterprise-beans>
- ...
- <session>
- <ejb-name>CalculatorImpl</ejb-name>
- <web-service-security>
- <security-realm-name/>
- <transport-guarantee>NONE</transport-guarantee>
- <auth-method>WS-SECURITY</auth-method>
- <properties>
- wss4j.in.action = UsernameToken
- wss4j.in.passwordType = PasswordDigest
- wss4j.in.passwordCallbackClass=org.superbiz.calculator.CustomPasswordHandler
- </properties>
- </web-service-security>
- </session>
- ...
- </enterprise-beans>
- </openejb-jar>
-
-
-<a name="SecuringaWebService-Requestsentbytheclient."></a>
-#### Request sent by the client.
-This request contains SOAP headers to manage security. You can see
-*UsernameToken* tag from the WS-Security specification.
-
- POST /CalculatorImplUsernameTokenHashedPassword HTTP/1.1
- Content-Type: text/xml; charset=UTF-8
- SOAPAction: ""
- Accept: *
- Cache-Control: no-cache
- Pragma: no-cache
- User-Agent: Java/1.5.0_05
- Host: 127.0.0.1:8204
- Connection: keep-alive
- Transfer-Encoding: chunked
-
- 524
- <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- <soap:Header>
- <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
- <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
- wsu:Id="UsernameToken-22402238"
- xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
- <wsse:Username xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">jane</wsse:Username>
- <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"
- xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">tf7k3a4GREIt1xec/KXVmBdRNIg=</wsse:Password>
- <wsse:Nonce xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">cKhUhmjQ1hGYPsdOLez5kA==</wsse:Nonce>
- <wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2009-04-14T20:16:26.203Z</wsu:Created>
- </wsse:UsernameToken>
- </wsse:Security>
- </soap:Header>
- <soap:Body>
- <ns1:sum xmlns:ns1="http://superbiz.org/wsdl">
- <arg0>4</arg0>
- <arg1>6</arg1>
- </ns1:sum>
- </soap:Body>
- </soap:Envelope>
-
-
-<a name="SecuringaWebService-Theresponsereturnedfromtheserver."></a>
-#### The response returned from the server.
-
- HTTP/1.1 200 OK
- Content-Length: 200
- Connection: close
- Content-Type: text/xml; charset=UTF-8
- Server: OpenEJB/??? (unknown os)
-
- <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- <soap:Body>
- <ns1:sumResponse xmlns:ns1="http://superbiz.org/wsdl">
- <return>10</return>
- </ns1:sumResponse>
- </soap:Body>
- </soap:Envelope>
-
-
-<a name="SecuringaWebService-JAASwithWS-Security"></a>
-# JAAS with WS-Security
-
-@RolesAllowed doesn't work straight off with WS-Security, but you can add
-calls to the OpenEJB SecurityService to login to a JAAS provider to a
-CallbackHandler. Once you have done this, any permissions configured with
-@RolesAllowed should be honoured.
-
-Here is a snippet from the webservice-ws-security example demonstrating
-this:
-
-
- public class CustomPasswordHandler implements CallbackHandler {
-
- public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException {
- WSPasswordCallback pc = (WSPasswordCallback) callbacks[0];
-
- if (pc.getUsage() == WSPasswordCallback.USERNAME_TOKEN) {
- // TODO get the password from the users.properties if possible
- pc.setPassword("waterfall");
-
- } else if (pc.getUsage() == WSPasswordCallback.DECRYPT) {
-
- pc.setPassword("serverPassword");
-
- } else if (pc.getUsage() == WSPasswordCallback.SIGNATURE) {
-
- pc.setPassword("serverPassword");
-
- }
-
- if ((pc.getUsage() == WSPasswordCallback.USERNAME_TOKEN) || (pc.getUsage() == WSPasswordCallback.USERNAME_TOKEN_UNKNOWN)) {
-
- SecurityService securityService = SystemInstance.get().getComponent(SecurityService.class);
- Object token = null;
- try {
- securityService.disassociate();
-
- token = securityService.login(pc.getIdentifer(), pc.getPassword());
- securityService.associate(token);
-
- } catch (LoginException e) {
- e.printStackTrace();
- throw new SecurityException("wrong password");
- }
- }
- }
- }
-
-
-
-<a name="SecuringaWebService-Examples"></a>
-# Examples
-A full example (webservice-ws-security) is available with OpenEJB Examples.
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/security-annotations.adoc
----------------------------------------------------------------------
diff --git a/docs/security-annotations.adoc b/docs/security-annotations.adoc
new file mode 100644
index 0000000..11e27f1
--- /dev/null
+++ b/docs/security-annotations.adoc
@@ -0,0 +1,292 @@
+# Security Annotations
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+This page shows the correct usage of the security
+related annotations:
+
+* javax.annotation.security.RolesAllowed
+* javax.annotation.security.PermitAll
+* javax.annotation.security.DenyAll
+* javax.annotation.security.RunAs
+* javax.annotation.security.DeclareRoles
+
+== Basic idea
+
+* By default all methods of a business interface are accessible, logged
+in or not
+* The annotations go on the bean class, not the business interface
+* Security annotations can be applied to entire class and/or individual
+methods
+* The names of any security roles used must be declared via
+@DeclareRoles
+
+== No restrictions
+
+Allow anyone logged in or not to invoke 'svnCheckout'.
+
+These three examples are all equivalent.
+
+....
+@Stateless
+public class OpenSourceProjectBean implements Project {
+
+ public String svnCheckout(String s) {
+ return s;
+ }
+}
+
+
+@Stateless
+@PermitAll
+public class OpenSourceProjectBean implements Project {
+
+ public String svnCheckout(String s) {
+ return s;
+ }
+}
+
+
+@Stateless
+public class OpenSourceProjectBean implements Project {
+
+ @PermitAll
+ public String svnCheckout(String s) {
+ return s;
+ }
+}
+....
+
+* Allow anyone logged in or not to invoke 'svnCheckout'.
+
+== Restricting a Method
+
+Restrict the 'svnCommit' method to only individuals logged in and part
+of the "committer" role. Note that more than one role can be listed.
+
+....
+@Stateless
+@DeclareRoles({"committer"})
+public class OpenSourceProjectBean implements Project {
+
+ @RolesAllowed({"committer"})
+ public String svnCommit(String s) {
+ return s;
+ }
+
+ public String svnCheckout(String s) {
+ return s;
+ }
+}
+....
+
+* Allow only logged in users in the "committer" role to invoke
+'svnCommit'.
+* Allow anyone logged in or not to invoke 'svnCheckout'.
+
+== DeclareRoles
+
+You need to update the @DeclareRoles when referencing roles via
+isCallerInRole(roleName).
+
+....
+@Stateless
+@DeclareRoles({"committer", "contributor"})
+public class OpenSourceProjectBean implements Project {
+
+ @Resource SessionContext ctx;
+
+ @RolesAllowed({"committer"})
+ public String svnCommit(String s) {
+ ctx.isCallerInRole("committer"); // Referencing a Role
+ return s;
+ }
+
+ @RolesAllowed({"contributor"})
+ public String submitPatch(String s) {
+ return s;
+ }
+}
+....
+
+== Restricting all methods in a class
+
+Placing the annotation at the class level changes the default of
+PermitAll
+
+....
+@Stateless
+@DeclareRoles({"committer"})
+@RolesAllowed({"committer"})
+public class OpenSourceProjectBean implements Project {
+
+ public String svnCommit(String s) {
+ return s;
+ }
+
+ public String svnCheckout(String s) {
+ return s;
+ }
+
+ public String submitPatch(String s) {
+ return s;
+ }
+}
+....
+
+* Allow only logged in users in the "committer" role to invoke
+'svnCommit', 'svnCheckout' or 'submitPatch'.
+
+== Mixing class and method level restrictions
+
+Security annotations can be used at the class level and method level at
+the same time. These rules do not stack, so marking 'submitPatch'
+overrides the default of "committers".
+
+....
+@Stateless
+@DeclareRoles({"committer", "contributor"})
+@RolesAllowed({"committer"})
+public class OpenSourceProjectBean implements Project {
+
+ public String svnCommit(String s) {
+ return s;
+ }
+
+ public String svnCheckout(String s) {
+ return s;
+ }
+
+ @RolesAllowed({"contributor"})
+ public String submitPatch(String s) {
+ return s;
+ }
+}
+....
+
+* Allow only logged in users in the "committer" role to invoke
+'svnCommit' or 'svnCheckout'
+* Allow only logged in users in the "contributor" role to invoke
+'submitPatch'.
+
+== PermitAll
+
+When annotating a bean class with @RolesAllowed, the @PermitAll
+annotation becomes very useful on individual methods to open them back
+up again.
+
+....
+@Stateless
+@DeclareRoles({"committer", "contributor"})
+@RolesAllowed({"committer"})
+public class OpenSourceProjectBean implements Project {
+
+ public String svnCommit(String s) {
+ return s;
+ }
+
+ @PermitAll
+ public String svnCheckout(String s) {
+ return s;
+ }
+
+ @RolesAllowed({"contributor"})
+ public String submitPatch(String s) {
+ return s;
+ }
+}
+....
+
+* Allow only logged in users in the "committer" role to invoke
+'svnCommit'.
+* Allow only logged in users in the "contributor" role to invoke
+'submitPatch'.
+* Allow anyone logged in or not to invoke 'svnCheckout'.
+
+== DenyAll
+
+The @DenyAll annotation can be used to restrict business interface
+access from anyone, logged in or not. The method is still invokable from
+within the bean class itself.
+
+....
+@Stateless
+@DeclareRoles({"committer", "contributor"})
+@RolesAllowed({"committer"})
+public class OpenSourceProjectBean implements Project {
+
+ public String svnCommit(String s) {
+ return s;
+ }
+
+ @PermitAll
+ public String svnCheckout(String s) {
+ return s;
+ }
+
+ @RolesAllowed({"contributor"})
+ public String submitPatch(String s) {
+ return s;
+ }
+
+ @DenyAll
+ public String deleteProject(String s) {
+ return s;
+ }
+}
+....
+
+* Allow only logged in users in the "committer" role to invoke
+'svnCommit'.
+* Allow only logged in users in the "contributor" role to invoke
+'submitPatch'.
+* Allow anyone logged in or not to invoke 'svnCheckout'.
+* Allow _no one_ logged in or not to invoke 'deleteProject'.
+
+# Illegal Usage
+
+Generally, security restrictions cannot be made on AroundInvoke methods
+and most callbacks.
+
+The following usages of @RolesAllowed have no effect.
+
+....
+@Stateful
+@DecalredRoles({"committer"})
+public class MyStatefulBean implements MyBusinessInterface {
+
+ @PostConstruct
+ @RolesAllowed({"committer"})
+ public void constructed(){
+
+ }
+
+ @PreDestroy
+ @RolesAllowed({"committer"})
+ public void destroy(){
+
+ }
+
+ @AroundInvoke
+ @RolesAllowed({"committer"})
+ public Object invoke(InvocationContext invocationContext) throws
+....
+
+Exception \{ return invocationContext.proceed(); }
+
+....
+ @PostActivate
+ @RolesAllowed({"committer"})
+ public void activated(){
+
+ }
+
+ @PrePassivate
+ @RolesAllowed({"committer"})
+ public void passivate(){
+
+ }
+}
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/security-annotations.md
----------------------------------------------------------------------
diff --git a/docs/security-annotations.md b/docs/security-annotations.md
deleted file mode 100644
index f951cd6..0000000
--- a/docs/security-annotations.md
+++ /dev/null
@@ -1,296 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Security Annotations
-~~~~~~
-This page shows the correct usage of the security related annotations:
-
- - javax.annotation.security.RolesAllowed
- - javax.annotation.security.PermitAll
- - javax.annotation.security.DenyAll
- - javax.annotation.security.RunAs
- - javax.annotation.security.DeclareRoles
-
-<a name="SecurityAnnotations-Basicidea"></a>
-## Basic idea
-
-- By default all methods of a business interface are accessible, logged in
-or not
-- The annotations go on the bean class, not the business interface
-- Security annotations can be applied to entire class and/or individual
-methods
-- The names of any security roles used must be declared via @DeclareRoles
-
-<a name="SecurityAnnotations-Norestrictions"></a>
-## No restrictions
-
-Allow anyone logged in or not to invoke 'svnCheckout'.
-
-These three examples are all equivalent.
-
-
- @Stateless
- public class OpenSourceProjectBean implements Project {
-
- public String svnCheckout(String s) {
- return s;
- }
- }
-
-
- @Stateless
- @PermitAll
- public class OpenSourceProjectBean implements Project {
-
- public String svnCheckout(String s) {
- return s;
- }
- }
-
-
- @Stateless
- public class OpenSourceProjectBean implements Project {
-
- @PermitAll
- public String svnCheckout(String s) {
- return s;
- }
- }
-
-
- - Allow anyone logged in or not to invoke 'svnCheckout'.
-
-<a name="SecurityAnnotations-RestrictingaMethod"></a>
-## Restricting a Method
-
-Restrict the 'svnCommit' method to only individuals logged in and part of
-the "committer" role. Note that more than one role can be listed.
-
-
- @Stateless
- @DeclareRoles({"committer"})
- public class OpenSourceProjectBean implements Project {
-
- @RolesAllowed({"committer"})
- public String svnCommit(String s) {
- return s;
- }
-
- public String svnCheckout(String s) {
- return s;
- }
- }
-
-
- - Allow only logged in users in the "committer" role to invoke
-'svnCommit'.
- - Allow anyone logged in or not to invoke 'svnCheckout'.
-
-
-<a name="SecurityAnnotations-DeclareRoles"></a>
-## DeclareRoles
-
-You need to update the @DeclareRoles when referencing roles via
-isCallerInRole(roleName).
-
-
- @Stateless
- @DeclareRoles({"committer", "contributor"})
- public class OpenSourceProjectBean implements Project {
-
- @Resource SessionContext ctx;
-
- @RolesAllowed({"committer"})
- public String svnCommit(String s) {
- ctx.isCallerInRole("committer"); // Referencing a Role
- return s;
- }
-
- @RolesAllowed({"contributor"})
- public String submitPatch(String s) {
- return s;
- }
- }
-
-
-<a name="SecurityAnnotations-Restrictingallmethodsinaclass"></a>
-## Restricting all methods in a class
-
-Placing the annotation at the class level changes the default of PermitAll
-
-
- @Stateless
- @DeclareRoles({"committer"})
- @RolesAllowed({"committer"})
- public class OpenSourceProjectBean implements Project {
-
- public String svnCommit(String s) {
- return s;
- }
-
- public String svnCheckout(String s) {
- return s;
- }
-
- public String submitPatch(String s) {
- return s;
- }
- }
-
-
-- Allow only logged in users in the "committer" role to invoke 'svnCommit',
-'svnCheckout' or 'submitPatch'.
-
-<a name="SecurityAnnotations-Mixingclassandmethodlevelrestrictions"></a>
-## Mixing class and method level restrictions
-
-Security annotations can be used at the class level and method level at the
-same time. These rules do not stack, so marking 'submitPatch' overrides
-the default of "committers".
-
-
- @Stateless
- @DeclareRoles({"committer", "contributor"})
- @RolesAllowed({"committer"})
- public class OpenSourceProjectBean implements Project {
-
- public String svnCommit(String s) {
- return s;
- }
-
- public String svnCheckout(String s) {
- return s;
- }
-
- @RolesAllowed({"contributor"})
- public String submitPatch(String s) {
- return s;
- }
- }
-
-
- - Allow only logged in users in the "committer" role to invoke 'svnCommit'
-or 'svnCheckout'
- - Allow only logged in users in the "contributor" role to invoke
-'submitPatch'.
-
-<a name="SecurityAnnotations-PermitAll"></a>
-## PermitAll
-
-When annotating a bean class with @RolesAllowed, the @PermitAll annotation
-becomes very useful on individual methods to open them back up again.
-
-
- @Stateless
- @DeclareRoles({"committer", "contributor"})
- @RolesAllowed({"committer"})
- public class OpenSourceProjectBean implements Project {
-
- public String svnCommit(String s) {
- return s;
- }
-
- @PermitAll
- public String svnCheckout(String s) {
- return s;
- }
-
- @RolesAllowed({"contributor"})
- public String submitPatch(String s) {
- return s;
- }
- }
-
-
- - Allow only logged in users in the "committer" role to invoke
-'svnCommit'.
- - Allow only logged in users in the "contributor" role to invoke
-'submitPatch'.
- - Allow anyone logged in or not to invoke 'svnCheckout'.
-
-
-<a name="SecurityAnnotations-DenyAll"></a>
-## DenyAll
-
-The @DenyAll annotation can be used to restrict business interface access
-from anyone, logged in or not. The method is still invokable from within
-the bean class itself.
-
-
- @Stateless
- @DeclareRoles({"committer", "contributor"})
- @RolesAllowed({"committer"})
- public class OpenSourceProjectBean implements Project {
-
- public String svnCommit(String s) {
- return s;
- }
-
- @PermitAll
- public String svnCheckout(String s) {
- return s;
- }
-
- @RolesAllowed({"contributor"})
- public String submitPatch(String s) {
- return s;
- }
-
- @DenyAll
- public String deleteProject(String s) {
- return s;
- }
- }
-
-
- - Allow only logged in users in the "committer" role to invoke
-'svnCommit'.
- - Allow only logged in users in the "contributor" role to invoke
-'submitPatch'.
- - Allow anyone logged in or not to invoke 'svnCheckout'.
- - Allow *no one* logged in or not to invoke 'deleteProject'.
-
-<a name="SecurityAnnotations-IllegalUsage"></a>
-# Illegal Usage
-
-Generally, security restrictions cannot be made on AroundInvoke methods and
-most callbacks.
-
-The following usages of @RolesAllowed have no effect.
-
-
- @Stateful
- @DecalredRoles({"committer"})
- public class MyStatefulBean implements MyBusinessInterface {
-
- @PostConstruct
- @RolesAllowed({"committer"})
- public void constructed(){
-
- }
-
- @PreDestroy
- @RolesAllowed({"committer"})
- public void destroy(){
-
- }
-
- @AroundInvoke
- @RolesAllowed({"committer"})
- public Object invoke(InvocationContext invocationContext) throws
-Exception {
- return invocationContext.proceed();
- }
-
- @PostActivate
- @RolesAllowed({"committer"})
- public void activated(){
-
- }
-
- @PrePassivate
- @RolesAllowed({"committer"})
- public void passivate(){
-
- }
- }
http://git-wip-us.apache.org/repos/asf/tomee/blob/9b209c98/docs/security.adoc
----------------------------------------------------------------------
diff --git a/docs/security.adoc b/docs/security.adoc
new file mode 100644
index 0000000..785c8d6
--- /dev/null
+++ b/docs/security.adoc
@@ -0,0 +1,200 @@
+# Security
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Security - How To.
+
+We currently have two authentication mechanisms to choose from: *
+_PropertiesLoginModule_ (a basic text file based login that looks up
+users and groups from the specified properties files) * _SQLLoginModule_
+(database based login that looks up users and groups in a database
+through SQL queries)
+
+To make your program authenticate itself to the server, simply construct
+your InitialContext with the standard javax.naming.Context properties
+for user/pass info, which is:
+
+....
+Properties props = new Properties();
+props.setProperty(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory");
+props.setProperty(Context.PROVIDER_URL, "ejbd://localhost:4201");
+props.setProperty(Context.SECURITY_PRINCIPAL, "someuser");
+props.setProperty(Context.SECURITY_CREDENTIALS, "thepass");
+props.setProperty("openejb.authentication.realmName", "PropertiesLogin");
+// optional
+InitialContext ctx = new InitialContext(props);
+ctx.lookup(...);
+....
+
+That will get you logged in and all your calls from that context should
+execute as you.
+
+_$\{openejb.base}/conf/login.config_ is a standard JAAS config file.
+Here, you can configure any number of security realms to authenticate
+against. To specify which of the realms you want to authenticate
+against, you can set the _openejb.authentication.realmName_ property to
+any of the configured realm names in _login.config_. If you don't
+speficy a realm name, the default (currently _PropertiesLogin_) is used.
+For examples and more information on JAAS configuration, see the
+http://java.sun.com/javase/6/docs/technotes/guides/security/jaas/JAASRefGuide.html[JAAS
+Reference Guide] .
+
+== PropertiesLoginModule
+
+Supported options:
+
+Option
+
+Description
+
+Required
+
+UsersFile
+
+name of the properties file that contains the users and their passwords
+
+_yes_
+
+GroupsFile
+
+name of the properties file that contains the groups and their member
+lists
+
+_yes_
+
+_UsersFile_ and _GroupsFile_ are read in on every login, so +you can
+update them+ on a running system and those users will "show up"
+immediately +without the need for a restart+ of any kind.
+
+== SQLLoginModule
+
+You can either use a data source or configure the JDBC URL through which
+the user/group lookups will be made.
+
+If you use a _DataSource_, you must specify its JNDI name with the
+_dataSourceName_ option.
+
+If you use JDBC directly, you have to specify at least the JDBC URL of
+the database. The driver should be autodetected (provided the
+appropriate jar is on your classpath), but if that fails for some
+reason, you can force a specific driver using the _jdbcDriver_ option.
+For more information on JDBC URLs, see the
+http://java.sun.com/javase/6/docs/technotes/guides/jdbc/[JDBC Guide]
+
+The _userSelect_ query must return a two-column list of user names
+(column 1) and passwords (column 2). This query should normally return a
+single row, which can be achieved by the use of a query parameter
+placeholder "?". Any such placeholders in both queries will be filled in
+with the username that the client is trying to log in with. The
+_groupSelect_ query must return a two-column list of user names and
+their groups (or "roles" in the EJB world).
+
+Supported options:
+
+Option
+
+Description
+
+Required
+
+dataSourceName
+
+the name of a data source
+
+_yes_ (alternative 1)
+
+jdbcURL
+
+a standard JDBC URL
+
+_yes_ (alternative 2)
+
+jdbcDriver
+
+the fully qualified class name of the database driver
+
+no
+
+jdbcUser
+
+the user name for accessing the database
+
+no
+
+jdbcPassword
+
+the password for accessing the database
+
+no
+
+userSelect
+
+the SQL query that returns a list of users and their passwords
+
+_yes_
+
+groupSelect
+
+the SQL query that returns a list of users and groups (roles)
+
+_yes_
+
+digest
+
+the name of the digest algorithm (e.g. "MD5" or "SHA") for digest
+authentication
+
+no
+
+encoding
+
+the digest encoding, can be "hex" or "base64"
+
+no
+
+# PLUG POINTS
+
+There are four-five different plug points where you could customize the
+functionality. From largest to smallest: - _The SecurityService
+interface_: As before all security work (authentication and
+authorization) is behind this interface, only the methods on it have
+been updated. If you want to do something really "out there" or need
+total control, this is where you go. Plugging in your own
+SecurityService should really be a last resort. We still have our "do
+nothing" SecurityService implementation just as before, but it is no
+longer the default. +You can add a new SecurityService impl by creating
+a service-jar.xml and packing it in your jar+. You can configure OpenEJB
+to use a different SecurityService via the openejb.xml.
+
+* _JaccProvider super class_: If you want to plug in your own JACC
+implementation to perform custom authorization (maybe do some fancy
+auditing), this is one way to do it without really having to understand
+JACC too much. We will plug your provider in to all the places required
+by JACC if you simply +set the system property+
+"_org.apache.openejb.core.security.JaccProvider_" with the name of your
+JaccProvider impl.
+* _Regular JACC_. The JaccProvider is simply a wrapper around the many
+things you have to do to create and plugin a JACC provider, but you can
+still plugin a JACC provider in the standard ways. Read the JACC spec
+for that info.
+* _JAAS LoginModule_. You can setup a different JAAS LoginModule to do
+all your authentication by simply editing the conf/login.config file
+which is a plain JAAS config file. At the moment we only support
+username/password based login modules. At some point it would be nice to
+support any kind of input for a JAAS LoginModule, but username/password
+at least covers the majority. It actually _is_ possible to support any
+LoginModule, but you would have to supply your clients with your own way
+to authenticate to it and write a strategy for telling the OpenEJB
+client what data to send to the server with each invocation request. See
+the
+http://java.sun.com/javase/6/docs/technotes/guides/security/jaas/JAASLMDevGuide.html[JAAS
+LoginModule Developer's Guide] for more information.
+* _Client IdentityResolver_. This is the just mentioned interface you
+would have to implement to supply the OpenEJB client with alternate data
+to send to the server with each invocation request. If you're plugging
+in a new version of this it is likely that you may also want to plugin
+in your own SecurityService implementation. Reason being, the object
+returned from IdentiyResolve.getIdentity() is sent across the wire and
+straight in to the SecurityService.associate(Object) method.
[31/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 7
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 7
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/622ada3a
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/622ada3a
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/622ada3a
Branch: refs/heads/master
Commit: 622ada3a23f26a9e15b2e7c35d5a75da25e91550
Parents: 329eb60
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 23:06:56 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 23:06:56 2018 -0800
----------------------------------------------------------------------
docs/local-client-injection.adoc | 4 ++--
docs/maven/index.adoc | 5 ++---
2 files changed, 4 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/622ada3a/docs/local-client-injection.adoc
----------------------------------------------------------------------
diff --git a/docs/local-client-injection.adoc b/docs/local-client-injection.adoc
index d95de42..01a9516 100644
--- a/docs/local-client-injection.adoc
+++ b/docs/local-client-injection.adoc
@@ -1,10 +1,10 @@
-# Local Client Injection
+# OpenEJB 3.1.1 or later required}
:index-group: Testing Techniques
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: OpenEJB 3.1.1 or later required}
+## Local Client Injection
The _@LocalClient_ annotation (org.apache.openejb.api.LocalClient) is an
innovation that crosses concepts of an Java EE Application Client with a
http://git-wip-us.apache.org/repos/asf/tomee/blob/622ada3a/docs/maven/index.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/index.adoc b/docs/maven/index.adoc
index c83c30c..b526355 100644
--- a/docs/maven/index.adoc
+++ b/docs/maven/index.adoc
@@ -1,9 +1,8 @@
-:index-group: TomEE
-Maven Plugin
+# TomEE Maven Plugin
+:index-group: TomEE Maven Plugin
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-:jbake-title: TomEE Maven Plugin
Inspired by the Jetty Maven Plugin, the TomEE Maven Plugin is a
[34/44] tomee git commit: Fixing titles
Posted by jl...@apache.org.
Fixing titles
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/52a090b6
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/52a090b6
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/52a090b6
Branch: refs/heads/master
Commit: 52a090b6f581122b8f517b93911470947452f014
Parents: 622ada3
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 23:26:20 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 23:26:55 2018 -0800
----------------------------------------------------------------------
docs/local-client-injection.adoc | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/52a090b6/docs/local-client-injection.adoc
----------------------------------------------------------------------
diff --git a/docs/local-client-injection.adoc b/docs/local-client-injection.adoc
index 01a9516..fd14373 100644
--- a/docs/local-client-injection.adoc
+++ b/docs/local-client-injection.adoc
@@ -1,11 +1,9 @@
-# OpenEJB 3.1.1 or later required}
+# Local Client Injection
:index-group: Testing Techniques
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published
-## Local Client Injection
-
The _@LocalClient_ annotation (org.apache.openejb.api.LocalClient) is an
innovation that crosses concepts of an Java EE Application Client with a
plain Java SE client. This particular annotation is focused on clients
[25/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 1
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-resources.adoc
----------------------------------------------------------------------
diff --git a/docs/application-resources.adoc b/docs/application-resources.adoc
new file mode 100644
index 0000000..ac85da5
--- /dev/null
+++ b/docs/application-resources.adoc
@@ -0,0 +1,362 @@
+# Application Resources
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+== Resources
+
+TomEE provides a simple but powerful way to define resources that can be
+injected into managed components inside your application, or looked up
+via JNDI. To use a resource, it needs to be defined in the `tomee.xml`
+configuration file, a `resources.xml` file within an application, or as
+a system property. Defining a resource in `tomee.xml` will make it
+available server-wide, whereas defining the resource within a
+`resources.xml` file makes it available to a specific application.
+
+As a simple example, a JMS queue can be defined within `tomee.xml` with
+the following configuration.
+
+....
+<tomee>
+ <Resource id="MyQueue" type="javax.jms.Queue"/>
+</tomee>
+....
+
+Once the resource has been defined, the server will create an instance
+of the resource during startup, and it will be available to be injected
+into managed components using the `@Resource` annotation, as shown
+below. The `name` attribute on the `@Resource` annotation should match
+the `id` attribute on the `Resource` tag.
+
+....
+public class JmsClient {
+
+ @Resource(name="MyQueue")
+ private Queue queue;
+
+ public void sendMessage() {
+ // implementation here...
+ }
+
+}
+....
+
+As an alternative to defining a resource in XML, resources can also be
+defined using system properties:
+
+....
+MyQueue = new://Resource?type=javax.jms.Queue
+....
+
+Resources, or attributes for resources specified using system properties
+will override definitions specified in `tomee.xml`. Server-wide
+resources can be looked up in JNDI under the following name:
+openejb:Resources/resource id.
+
+== Defining Resources
+
+The `<Resource>` tag has a number of attributes, and a resource may also
+have a number of fields that can be configured by adding properties to
+the body of the `Resource` tag.
+
+For example, a DataSource resource needs a JDBC driver, URL, username
+and password to be able to connect to a database. That would be
+configured with the following syntax. Notice the key/value pair syntax
+for the properties within the `<Resource>` tag.
+
+....
+<Resource id="DB" type="DataSource">
+ JdbcDriver com.mysql.jdbc.Driver
+ JdbcUrl jdbc:mysql://localhost/test
+ UserName test
+ Password password
+</Resource>
+....
+
+Specifying the key/value pairs specific to a Resource can also be done
+when defining the resource via system properties. This is done be
+specifying an additional property for each key/value pair, using the
+resource ID as a prefix: `<resourceId>.<propertyName>=<value>`. The
+system properties equivalent of the resource above is:
+
+....
+p.setProperty("DB", "new://Resource?type=DataSource");
+p.setProperty("DB.JdbcDriver", "com.mysql.jdbc.Driver");
+p.setProperty("DB,JdbcUrl", "jdbc:mysql://localhost/test");
+p.setProperty("DB.UserName", "test");
+p.setProperty("DB.Password", "password");
+....
+
+The `<Resource>` tag has a number of attributes which control the way
+that the resource get created.
+
+* type
+
+A type that TomEE knows. The type is associated with a provider that
+knows how to create that type, and also any default properties that the
+resource should have if they are not specified in the resource
+definition. See service-jar.xml for an example set of service providers
+that come with TomEE.
+
+* provider
+
+Explicitly specifies a provider to create the resource, using defaults
+for any properties not specified.
+
+* class-name
+
+The fully qualified class that creates the resource. This might the
+resource class itself, which is created by calling the constructor, or a
+factory class that provides a specific factory method to create the
+resource.
+
+* factory-name
+
+The name of the method to call to create the resource. If this is not
+specified, the constructor for the class specified by class-name will be
+used.
+
+* constructor
+
+Specifies a comma separated list of constructor arguments. These can be
+other services, or attributes on the resource itself.
+
+== Custom resources
+
+TomEE allows you to define resources using your own Java classes, and
+these can also be injected into managed components in the same way as
+known resource types are.
+
+So the following simple resource
+
+....
+public class Configuration {
+
+ private String url;
+ private String username;
+ private int poolSize;
+
+ // getters and setters
+}
+....
+
+Can be defined in `tomee.xml` using the following configuration (note
+the `class-name` attribute):
+
+....
+<Resource id="config" class-name="org.superbiz.Configuration">
+ url http://localhost
+ username tomee
+ poolSize 20
+</Resource>
+....
+
+This resource must be available in TomEE's system classpath - i.e. it
+must be defined in a .jar within the `lib/` directory.
+
+== Field and properties
+
+As shown above, a resource class can define a number of fields, and
+TomEE will attempt to apply the values from the resource definition onto
+those fields.
+
+As an alternative to this, you can also add a properties field as shown
+below, and this will have any used properties from the resource
+configuration set added to it. So as an alternative to the above code,
+you could do:
+
+....
+public class Configuration {
+
+ private Properties properties;
+
+ public Properties getProperties() {
+ return properties;
+ }
+
+ public void setProperties(final Properties properties) {
+ this.properties = properties;
+ }
+
+}
+....
+
+Using the same resource definition:
+
+....
+<Resource id="config" class-name="org.superbiz.Configuration">
+ url http://localhost
+ username tomee
+ poolSize 20
+</Resource>
+....
+
+the url, username and poolSize values will now be available in the
+properties field, so for example, the username property could be
+accessed via properties.getProperty("username");
+
+== Application resources
+
+Resources can also be defined within an application, and optionally use
+classes from the application's classpath. To define resources in a .war
+file, include a `WEB-INF/resources.xml`. For an ejb-jar module, use
+`META-INF/resources.xml`.
+
+The format of `resources.xml` uses the same `<Resource>` tag as
+`tomee.xml`. One key difference is the root element of the XML is
+`<resources>` and not `<tomee>`.
+
+....
+<resources>
+ <Resource id="config" class-name="org.superbiz.Configuration">
+ url http://localhost
+ username tomee
+ poolSize 20
+ </Resource>
+</resources>
+....
+
+This mechanism allows you to package your custom resources within your
+application, alongside your application code, rather than requiring a
+.jar file in the `lib/` directory.
+
+Application resources are bound in JNDI under
+openejb:Resource/appname/resource id.
+
+== Additional resource properties
+
+Resources are typically discovered, created, and bound to JNDI very
+early on in the deployment process, as other components depend on them.
+This may lead to problems where the final classpath for the application
+has not yet been determined, and therefore TomEE is unable to load your
+custom resource.
+
+The following properties can be used to change this behavior.
+
+* Lazy
+
+This is a boolean value, which when true, creates a proxy that defers
+the actual instantiation of the resource until the first time it is
+looked up from JNDI. This can be useful if the resource's classpath
+until the application is started (see below), or to improve startup time
+by not fully initializing resources that might not be used.
+
+* UseAppClassLoader
+
+This boolean value forces a lazily instantiated resource to use the
+application classloader, instead of the classloader available when the
+resources were first processed.
+
+* InitializeAfterDeployment
+
+This boolean setting forces a resource created with the Lazy property to
+be instantiated once the application has started, as opposed to waiting
+for it to be looked up. Use this flag if you require the resource to be
+loaded, irrespective of whether it is injected into a managed component
+or manually looked up.
+
+By default, all of these settings are `false`, unless TomEE encounters a
+custom application resource that cannot be instantiated until the
+application has started. In this case, it will set these three flags to
+`true`, unless the `Lazy` flag has been explicitly set.
+
+== Initializing resources
+
+=== constructor
+
+By default, if no factory-name attribute and no constructor attribute is
+specified on the `Resource`, TomEE will instantiate the resource using
+its no-arg constructor. If you wish to pass constructor arguments,
+specify the arguments as a comma separated list:
+
+....
+<Resource id="config" class-name="org.superbiz.Configuration" constructor="id, poolSize">
+ url http://localhost
+ username tomee
+ poolSize 20
+</Resource>
+....
+
+=== factory-name method
+
+In some circumstances, it may be desirable to add some additional logic
+to the creation process, or to use a factory pattern to create
+resources. TomEE also provides this facility via the `factory-name`
+method. The `factory-name` attribute on the resource can reference any
+no argument method that returns an object on the class specified in the
+`class-name` attribute.
+
+For example:
+
+....
+public class Factory {
+
+ private Properties properties;
+
+ public Object create() {
+
+ MyResource resource = new MyResource();
+ // some custom logic here, maybe using this.properties
+
+ return resource;
+ }
+
+ public Properties getProperties() {
+ return properties;
+ }
+
+ public void setProperties(final Properties properties) {
+ this.properties = properties;
+ }
+
+}
+
+<resources>
+ <Resource id="MyResource" class-name="org.superbiz.Factory" factory-name="create">
+ UserName tomee
+ </Resource>
+</resources>
+....
+
+=== @PostConstruct / @PreDestroy
+
+As an alternative to using a factory method or a constructor, you can
+use @PostConstruct and @PreDestroy methods within your resource class
+(note that you cannot use this within a different factory class) to
+manage any additional creation or cleanup activities. TomEE will
+automatically call these methods when the application is started and
+destroyed. Using @PostConstruct will effectively force a lazily loaded
+resource to be instantiated when the application is starting - in the
+same way that the `InitializeAfterDeployment` property does.
+
+....
+public class MyClass {
+
+ private Properties properties;
+
+ public Properties getProperties() {
+ return properties;
+ }
+
+ public void setProperties(final Properties properties) {
+ this.properties = properties;
+ }
+
+ @PostConstruct
+ public void postConstruct() throws MBeanRegistrationException {
+ // some custom initialization
+ }
+ }
+
+}
+....
+
+== Examples
+
+The following examples demonstrate including custom resources within
+your application:
+
+* resources-jmx-example
+* resources-declared-in-webapp
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/application-resources.md
----------------------------------------------------------------------
diff --git a/docs/application-resources.md b/docs/application-resources.md
deleted file mode 100644
index b3ee1fa..0000000
--- a/docs/application-resources.md
+++ /dev/null
@@ -1,250 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Application Resources
-~~~~~~
-<a name="ApplicationResources"></a>
-
-# Resources
-
-TomEE provides a simple but powerful way to define resources that can be injected into managed components inside your application, or looked up via JNDI. To use a resource, it needs to be defined in the `tomee.xml` configuration file, a `resources.xml` file within an application, or as a system property. Defining a resource in `tomee.xml` will make it available server-wide, whereas defining the resource within a `resources.xml` file makes it available to a specific application.
-
-As a simple example, a JMS queue can be defined within `tomee.xml` with the following configuration.
-
- <tomee>
- <Resource id="MyQueue" type="javax.jms.Queue"/>
- </tomee>
-
-Once the resource has been defined, the server will create an instance of the resource during startup, and it will be available to be injected into managed components using the `@Resource` annotation, as shown below. The `name` attribute on the `@Resource` annotation should match the `id` attribute on the `Resource` tag.
-
- public class JmsClient {
-
- @Resource(name="MyQueue")
- private Queue queue;
-
- public void sendMessage() {
- // implementation here...
- }
-
- }
-
-As an alternative to defining a resource in XML, resources can also be defined using system properties:
-
- MyQueue = new://Resource?type=javax.jms.Queue
-
-Resources, or attributes for resources specified using system properties will override definitions specified in `tomee.xml`.
-Server-wide resources can be looked up in JNDI under the following name: openejb:Resources/resource id.
-
-# Defining Resources
-<a name="DefiningResources"></a>
-
-The `<Resource>` tag has a number of attributes, and a resource may also have a number of fields that can be configured by adding properties to the body of the `Resource` tag.
-
-For example, a DataSource resource needs a JDBC driver, URL, username and password to be able to connect to a database. That would be configured with the following syntax. Notice the key/value pair syntax for the properties within the `<Resource>` tag.
-
- <Resource id="DB" type="DataSource">
- JdbcDriver com.mysql.jdbc.Driver
- JdbcUrl jdbc:mysql://localhost/test
- UserName test
- Password password
- </Resource>
-
-Specifying the key/value pairs specific to a Resource can also be done when defining the resource via system properties. This is done be specifying an additional property for each key/value pair, using the resource ID as a prefix: `<resourceId>.<propertyName>=<value>`. The system properties equivalent of the resource above is:
-
- p.setProperty("DB", "new://Resource?type=DataSource");
- p.setProperty("DB.JdbcDriver", "com.mysql.jdbc.Driver");
- p.setProperty("DB,JdbcUrl", "jdbc:mysql://localhost/test");
- p.setProperty("DB.UserName", "test");
- p.setProperty("DB.Password", "password");
-
-The `<Resource>` tag has a number of attributes which control the way that the resource get created.
-
-* type
-
-A type that TomEE knows. The type is associated with a provider that knows how to create that type, and also any default properties that the resource should have if they are not specified in the resource definition. See <a href="https://github.com/apache/tomee/blob/tomee-1.7.x/tomee/tomee-webapp/src/main/resources/META-INF/org.apache.tomee/service-jar.xml">service-jar.xml</a> for an example set of service providers that come with TomEE.
-
-* provider
-
-Explicitly specifies a provider to create the resource, using defaults for any properties not specified.
-
-* class-name
-
-The fully qualified class that creates the resource. This might the resource class itself, which is created by calling the constructor, or a factory class that provides a specific factory method to create the resource.
-
-* factory-name
-
-The name of the method to call to create the resource. If this is not specified, the constructor for the class specified by class-name will be used.
-
-* constructor
-
-Specifies a comma separated list of constructor arguments. These can be other services, or attributes on the resource itself.
-
-# Custom resources
-
-TomEE allows you to define resources using your own Java classes, and these can also be injected into managed components in the same way as known resource types are.
-
-So the following simple resource
-
- public class Configuration {
-
- private String url;
- private String username;
- private int poolSize;
-
- // getters and setters
- }
-
-Can be defined in `tomee.xml` using the following configuration (note the `class-name` attribute):
-
- <Resource id="config" class-name="org.superbiz.Configuration">
- url http://localhost
- username tomee
- poolSize 20
- </Resource>
-
-This resource must be available in TomEE's system classpath - i.e. it must be defined in a .jar within the `lib/` directory.
-
-# Field and properties
-
-As shown above, a resource class can define a number of fields, and TomEE will attempt to apply the values from the resource definition onto those fields.
-
-As an alternative to this, you can also add a properties field as shown below, and this will have any used properties from the resource configuration set added to it. So as an alternative to the above code, you could do:
-
- public class Configuration {
-
- private Properties properties;
-
- public Properties getProperties() {
- return properties;
- }
-
- public void setProperties(final Properties properties) {
- this.properties = properties;
- }
-
- }
-
-Using the same resource definition:
-
- <Resource id="config" class-name="org.superbiz.Configuration">
- url http://localhost
- username tomee
- poolSize 20
- </Resource>
-
-the url, username and poolSize values will now be available in the properties field, so for example, the username property could be accessed via properties.getProperty("username");
-
-# Application resources
-
-Resources can also be defined within an application, and optionally use classes from the application's classpath. To define resources in a .war file, include a `WEB-INF/resources.xml`. For an ejb-jar module, use `META-INF/resources.xml`.
-
-The format of `resources.xml` uses the same `<Resource>` tag as `tomee.xml`. One key difference is the root element of the XML is `<resources>` and not `<tomee>`.
-
- <resources>
- <Resource id="config" class-name="org.superbiz.Configuration">
- url http://localhost
- username tomee
- poolSize 20
- </Resource>
- </resources>
-
-This mechanism allows you to package your custom resources within your application, alongside your application code, rather than requiring a .jar file in the `lib/` directory.
-
-Application resources are bound in JNDI under openejb:Resource/appname/resource id.
-
-# Additional resource properties
-
-Resources are typically discovered, created, and bound to JNDI very early on in the deployment process, as other components depend on them. This may lead to problems where the final classpath for the application has not yet been determined, and therefore TomEE is unable to load your custom resource.
-
-The following properties can be used to change this behavior.
-
-* Lazy
-
-This is a boolean value, which when true, creates a proxy that defers the actual instantiation of the resource until the first time it is looked up from JNDI. This can be useful if the resource's classpath until the application is started (see below), or to improve startup time by not fully initializing resources that might not be used.
-
-* UseAppClassLoader
-
-This boolean value forces a lazily instantiated resource to use the application classloader, instead of the classloader available when the resources were first processed.
-
-* InitializeAfterDeployment
-
-This boolean setting forces a resource created with the Lazy property to be instantiated once the application has started, as opposed to waiting for it to be looked up. Use this flag if you require the resource to be loaded, irrespective of whether it is injected into a managed component or manually looked up.
-
-By default, all of these settings are `false`, unless TomEE encounters a custom application resource that cannot be instantiated until the application has started. In this case, it will set these three flags to `true`, unless the `Lazy` flag has been explicitly set.
-
-# Initializing resources
-
-## constructor
-
-By default, if no factory-name attribute and no constructor attribute is specified on the `Resource`, TomEE will instantiate the resource using its no-arg constructor. If you wish to pass constructor arguments, specify the arguments as a comma separated list:
-
- <Resource id="config" class-name="org.superbiz.Configuration" constructor="id, poolSize">
- url http://localhost
- username tomee
- poolSize 20
- </Resource>
-
-## factory-name method
-
-In some circumstances, it may be desirable to add some additional logic to the creation process, or to use a factory pattern to create resources. TomEE also provides this facility via the `factory-name` method. The `factory-name` attribute on the resource can reference any no argument method that returns an object on the class specified in the `class-name` attribute.
-
-For example:
-
- public class Factory {
-
- private Properties properties;
-
- public Object create() {
-
- MyResource resource = new MyResource();
- // some custom logic here, maybe using this.properties
-
- return resource;
- }
-
- public Properties getProperties() {
- return properties;
- }
-
- public void setProperties(final Properties properties) {
- this.properties = properties;
- }
-
- }
-
- <resources>
- <Resource id="MyResource" class-name="org.superbiz.Factory" factory-name="create">
- UserName tomee
- </Resource>
- </resources>
-
-## @PostConstruct / @PreDestroy
-
-As an alternative to using a factory method or a constructor, you can use @PostConstruct and @PreDestroy methods within your resource class (note that you cannot use this within a different factory class) to manage any additional creation or cleanup activities. TomEE will automatically call these methods when the application is started and destroyed. Using @PostConstruct will effectively force a lazily loaded resource to be instantiated when the application is starting - in the same way that the `InitializeAfterDeployment` property does.
-
- public class MyClass {
-
- private Properties properties;
-
- public Properties getProperties() {
- return properties;
- }
-
- public void setProperties(final Properties properties) {
- this.properties = properties;
- }
-
- @PostConstruct
- public void postConstruct() throws MBeanRegistrationException {
- // some custom initialization
- }
- }
-
- }
-
-# Examples
-
-The following examples demonstrate including custom resources within your application:
-
-* resources-jmx-example
-* resources-declared-in-webapp
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/arquillian-available-adapters.adoc
----------------------------------------------------------------------
diff --git a/docs/arquillian-available-adapters.adoc b/docs/arquillian-available-adapters.adoc
new file mode 100644
index 0000000..dd9c074
--- /dev/null
+++ b/docs/arquillian-available-adapters.adoc
@@ -0,0 +1,311 @@
+# TomEE and Arquillian
+:index-group: Arquillian
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+Check out the link:arquillian-getting-started.html[Getting started] page
+if you are not at all familiar with Arquillian.
+
+All the Arquillian Adapters for TomEE support the following
+configuration options in the *src/test/resources/arquillian.xml*:
+
+....
+<container qualifier="tomee" default="true">
+ <configuration>
+ <property name="httpPort">-1</property>
+ <property name="stopPort">-1</property>
+ <!--Optional Container Properties-->
+ <property name="properties">
+ aproperty=something
+ </property>
+ <!--Optional Remote Adapter Deployer Properties
+ <property name="deployerProperties">
+ aproperty=something
+ </property>
+ -->
+ </configuration>
+</container>
+....
+
+The above can also be set as system properties rather than via the
+*src/test/resources/arquillian.xml* file.
+
+....
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <configuration>
+ <systemPropertyVariables>
+ <tomee.httpPort>-1</tomee.httpPort>
+ <tomee.stopPort>-1</tomee.stopPort>
+ </systemPropertyVariables>
+ </configuration>
+ </plugin>
+ </plugins>
+</build>
+....
+
+When a port is set to -1, a random port will be chosen. This is key to
+avoiding port conflicts on CI systems or for just plain clean testing.
+
+The TomEE Arquillian adapters will export the actual port chosen back as
+a system property using the same name. The test case can use the
+property to retrieve the port and contact the server.
+
+....
+URL url = new URL("http://localhost:" + System.getProperty("tomee.httpPort");
+// use the URL to connect to the server
+....
+
+If that property returns null
+
+When you are actually using a test on the client side, you can use
+instead
+
+....
+import org.jboss.arquillian.test.api.ArquillianResource;
+...
+@ArquillianResource private URL url;
+....
+
+The URL will get injected by Arquillian. Be careful, that injection only
+works if your are on the client side (it does not make sense in the
+server side). So, if for a specific need to need it, just use the system
+property.
+
+== TomEE Embedded Adapter
+
+The TomEE Embedded Adapter will boot TomEE right inside the test case
+itself resulting in one JVM running both the application and the test
+case. This is generally much faster than the TomEE Remote Adapter and
+great for development. That said, it is strongly recommended to also run
+all tests in a Continuous Integration system using the TomEE Remote
+Adapter.
+
+To use the TomEE Embedded Arquillian Adapter, simply add these Maven
+dependencies to your Maven pom.xml:
+
+....
+<dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>arquillian-tomee-embedded</artifactId>
+ <version>1.7.1</version> <!--Current version-->
+</dependency>
+<dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>tomee-embedded</artifactId>
+ <version>1.7.1</version>
+</dependency>
+<!--Required for WebServices and RESTful WebServices-->
+<dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>tomee-webservices</artifactId>
+ <version>1.7.1</version>
+</dependency>
+<dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>tomee-jaxrs</artifactId>
+ <version>1.7.1</version>
+</dependency>
+....
+
+As mentioned above the Embedded Adapter has the following properties
+which can be specified in the *src/test/resources/arquillian.xml* file:
+
+* `httpPort`
+* `stopPort`
+* `properties` (System properties for container)
+
+Or alternatively as System properties, possibly shared with other TomEE
+Arquillian Adapters:
+
+* `tomee.httpPort`
+* `tomee.stopPort`
+
+Or more specifically as a System properties only applicable to the
+Embedded Adapter:
+
+* `tomee.embedded.httpPort`
+* `tomee.embedded.stopPort`
+
+== TomEE Remote Adapter
+
+The TomEE Remote Adapter will unzip and setup a TomEE or TomEE Plus
+distribution. Once setup, the server will execute in a separate process.
+This will be slower, but with the added benefit it is 100% match with
+the production system environment.
+
+On a local machine clients can get the remote server port using the
+following System property:
+
+....
+final String port = System.getProperty("server.http.port");
+....
+
+The following shows a typical configuration for testing against TomEE
+(webprofile version). The same can be done against TomEE+ by changing
+`<tomee.classifier>webprofile</tomee.classifier>` to
+`<tomee.classifier>plus</tomee.classifier>`
+
+....
+<properties>
+ <tomee.version>1.7.1</tomee.version>
+ <tomee.classifier>webprofile</tomee.classifier>
+</properties>
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <configuration>
+ <systemPropertyVariables>
+ <tomee.classifier>${tomee.classifier}</tomee.classifier>
+ <tomee.version>${tomee.version}</tomee.version>
+ </systemPropertyVariables>
+ </configuration>
+ </plugin>
+ </plugins>
+</build>
+<dependencies>
+ <dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>arquillian-tomee-remote</artifactId>
+ <version>${tomee.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>apache-tomee</artifactId>
+ <version>${tomee.version}</version>
+ <classifier>${tomee.classifier}</classifier>
+ <type>zip</type>
+ </dependency>
+</dependencies>
+....
+
+The Remote Adapter has the following properties which can be specified
+in the *src/test/resources/arquillian.xml* file:
+
+* `httpPort`
+* `stopPort`
+* `version`
+* `classifier` (Must be either `webprofile` or `plus`)
+* `properties` (System properties for container)
+* `deployerProperties` (Sent to Deployer)
+
+Or alternatively as System properties, possibly shared with other TomEE
+Arquillian Adapters:
+
+* `tomee.httpPort`
+* `tomee.stopPort`
+* `tomee.version`
+* `tomee.classifier`
+
+Or more specifically as a System properties only applicable to the
+Remote Adapter:
+
+* `tomee.remote.httpPort`
+* `tomee.remote.stopPort`
+* `tomee.remote.version`
+* `tomee.remote.classifier`
+
+== Maven Profiles
+
+Setting up both adapters is quite easy via Maven profiles. Here the
+default adapter is the Embedded Adapter, the Remote Adapter will run
+with `-Ptomee-webprofile-remote` specified as a `mvn` command argument.
+
+....
+<profiles>
+
+ <profile>
+ <id>tomee-embedded</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>arquillian-tomee-embedded</artifactId>
+ <version>1.0.0</version>
+ </dependency>
+ </dependencies>
+ </profile>
+
+ <profile>
+ <id>tomee-webprofile-remote</id>
+ <properties>
+ <tomee.version>1.0.0</tomee.version>
+ <tomee.classifier>webprofile</tomee.classifier>
+ </properties>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <configuration>
+ <systemPropertyVariables>
+ <tomee.classifier>${tomee.classifier}</tomee.classifier>
+ <tomee.version>${tomee.version}</tomee.version>
+ </systemPropertyVariables>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>arquillian-tomee-remote</artifactId>
+ <version>${tomee.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>apache-tomee</artifactId>
+ <version>${tomee.version}</version>
+ <classifier>${tomee.classifier}</classifier>
+ <type>zip</type>
+ </dependency>
+ </dependencies>
+ </profile>
+
+ <profile>
+ <id>tomee-plus-remote</id>
+ <properties>
+ <tomee.version>1.0.0</tomee.version>
+ <tomee.classifier>plus</tomee.classifier>
+ </properties>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <configuration>
+ <systemPropertyVariables>
+ <tomee.classifier>${tomee.classifier}</tomee.classifier>
+ <tomee.version>${tomee.version}</tomee.version>
+ </systemPropertyVariables>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>arquillian-tomee-remote</artifactId>
+ <version>${tomee.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.openejb</groupId>
+ <artifactId>apache-tomee</artifactId>
+ <version>${tomee.version}</version>
+ <classifier>${tomee.classifier}</classifier>
+ <type>zip</type>
+ </dependency>
+ </dependencies>
+ </profile>
+
+</profiles>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/arquillian-available-adapters.md
----------------------------------------------------------------------
diff --git a/docs/arquillian-available-adapters.md b/docs/arquillian-available-adapters.md
deleted file mode 100644
index ac9c85e..0000000
--- a/docs/arquillian-available-adapters.md
+++ /dev/null
@@ -1,264 +0,0 @@
-index-group=Arquillian
-type=page
-status=published
-title=TomEE and Arquillian
-~~~~~~
-
-Check out the [Getting started](arquillian-getting-started.html) page if you are not at all familiar with Arquillian.
-
-All the Arquillian Adapters for TomEE support the following configuration options in the **src/test/resources/arquillian.xml**:
-
- <container qualifier="tomee" default="true">
- <configuration>
- <property name="httpPort">-1</property>
- <property name="stopPort">-1</property>
- <!--Optional Container Properties-->
- <property name="properties">
- aproperty=something
- </property>
- <!--Optional Remote Adapter Deployer Properties
- <property name="deployerProperties">
- aproperty=something
- </property>
- -->
- </configuration>
- </container>
-
-The above can also be set as system properties rather than via the **src/test/resources/arquillian.xml** file.
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- <configuration>
- <systemPropertyVariables>
- <tomee.httpPort>-1</tomee.httpPort>
- <tomee.stopPort>-1</tomee.stopPort>
- </systemPropertyVariables>
- </configuration>
- </plugin>
- </plugins>
- </build>
-
-When a port is set to -1, a random port will be chosen. This is key to avoiding port conflicts on CI systems or for just plain clean testing.
-
-The TomEE Arquillian adapters will export the actual port chosen back as a system property using the same name. The test case can use the property to retrieve the port and contact the server.
-
- URL url = new URL("http://localhost:" + System.getProperty("tomee.httpPort");
- // use the URL to connect to the server
-
-If that property returns null
-
-When you are actually using a test on the client side, you can use instead
-
- import org.jboss.arquillian.test.api.ArquillianResource;
- ...
- @ArquillianResource private URL url;
-
-The URL will get injected by Arquillian. Be careful, that injection only works if your are on the client side (it does not make sense in the server side). So, if for a specific need to need it, just use the system property.
-
-# TomEE Embedded Adapter
-
-The TomEE Embedded Adapter will boot TomEE right inside the test case itself resulting in one JVM running both the application and the test case. This is generally much faster than the TomEE Remote Adapter and great for development. That said, it is strongly recommended to also run all tests in a Continuous Integration system using the TomEE Remote Adapter.
-
-To use the TomEE Embedded Arquillian Adapter, simply add these Maven dependencies to your Maven pom.xml:
-
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>arquillian-tomee-embedded</artifactId>
- <version>1.7.1</version> <!--Current version-->
- </dependency>
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>tomee-embedded</artifactId>
- <version>1.7.1</version>
- </dependency>
- <!--Required for WebServices and RESTful WebServices-->
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>tomee-webservices</artifactId>
- <version>1.7.1</version>
- </dependency>
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>tomee-jaxrs</artifactId>
- <version>1.7.1</version>
- </dependency>
-
-As mentioned above the Embedded Adapter has the following properties which can be specified in the **src/test/resources/arquillian.xml** file:
-
- - `httpPort`
- - `stopPort`
- - `properties` (System properties for container)
-
-Or alternatively as System properties, possibly shared with other TomEE Arquillian Adapters:
-
- - `tomee.httpPort`
- - `tomee.stopPort`
-
-Or more specifically as a System properties only applicable to the Embedded Adapter:
-
- - `tomee.embedded.httpPort`
- - `tomee.embedded.stopPort`
-
-
-# TomEE Remote Adapter
-
-The TomEE Remote Adapter will unzip and setup a TomEE or TomEE Plus distribution. Once setup, the server will execute in a separate process. This will be slower, but with the added benefit it is 100% match with the production system environment.
-
-On a local machine clients can get the remote server port using the following System property:
-
- final String port = System.getProperty("server.http.port");
-
-The following shows a typical configuration for testing against TomEE (webprofile version). The same can be done against TomEE+ by changing `<tomee.classifier>webprofile</tomee.classifier>` to `<tomee.classifier>plus</tomee.classifier>`
-
- <properties>
- <tomee.version>1.7.1</tomee.version>
- <tomee.classifier>webprofile</tomee.classifier>
- </properties>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- <configuration>
- <systemPropertyVariables>
- <tomee.classifier>${tomee.classifier}</tomee.classifier>
- <tomee.version>${tomee.version}</tomee.version>
- </systemPropertyVariables>
- </configuration>
- </plugin>
- </plugins>
- </build>
- <dependencies>
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>arquillian-tomee-remote</artifactId>
- <version>${tomee.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>apache-tomee</artifactId>
- <version>${tomee.version}</version>
- <classifier>${tomee.classifier}</classifier>
- <type>zip</type>
- </dependency>
- </dependencies>
-
-The Remote Adapter has the following properties which can be specified in the **src/test/resources/arquillian.xml** file:
-
- - `httpPort`
- - `stopPort`
- - `version`
- - `classifier` (Must be either `webprofile` or `plus`)
- - `properties` (System properties for container)
- - `deployerProperties` (Sent to Deployer)
-
-Or alternatively as System properties, possibly shared with other TomEE Arquillian Adapters:
-
- - `tomee.httpPort`
- - `tomee.stopPort`
- - `tomee.version`
- - `tomee.classifier`
-
-Or more specifically as a System properties only applicable to the Remote Adapter:
-
- - `tomee.remote.httpPort`
- - `tomee.remote.stopPort`
- - `tomee.remote.version`
- - `tomee.remote.classifier`
-
-# Maven Profiles
-
-Setting up both adapters is quite easy via Maven profiles. Here the default adapter is the Embedded Adapter, the Remote Adapter will run with `-Ptomee-webprofile-remote` specified as a `mvn` command argument.
-
- <profiles>
-
- <profile>
- <id>tomee-embedded</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <dependencies>
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>arquillian-tomee-embedded</artifactId>
- <version>1.0.0</version>
- </dependency>
- </dependencies>
- </profile>
-
- <profile>
- <id>tomee-webprofile-remote</id>
- <properties>
- <tomee.version>1.0.0</tomee.version>
- <tomee.classifier>webprofile</tomee.classifier>
- </properties>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- <configuration>
- <systemPropertyVariables>
- <tomee.classifier>${tomee.classifier}</tomee.classifier>
- <tomee.version>${tomee.version}</tomee.version>
- </systemPropertyVariables>
- </configuration>
- </plugin>
- </plugins>
- </build>
- <dependencies>
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>arquillian-tomee-remote</artifactId>
- <version>${tomee.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>apache-tomee</artifactId>
- <version>${tomee.version}</version>
- <classifier>${tomee.classifier}</classifier>
- <type>zip</type>
- </dependency>
- </dependencies>
- </profile>
-
- <profile>
- <id>tomee-plus-remote</id>
- <properties>
- <tomee.version>1.0.0</tomee.version>
- <tomee.classifier>plus</tomee.classifier>
- </properties>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- <configuration>
- <systemPropertyVariables>
- <tomee.classifier>${tomee.classifier}</tomee.classifier>
- <tomee.version>${tomee.version}</tomee.version>
- </systemPropertyVariables>
- </configuration>
- </plugin>
- </plugins>
- </build>
- <dependencies>
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>arquillian-tomee-remote</artifactId>
- <version>${tomee.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.openejb</groupId>
- <artifactId>apache-tomee</artifactId>
- <version>${tomee.version}</version>
- <classifier>${tomee.classifier}</classifier>
- <type>zip</type>
- </dependency>
- </dependencies>
- </profile>
-
- </profiles>
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/arquillian-getting-started.adoc
----------------------------------------------------------------------
diff --git a/docs/arquillian-getting-started.adoc b/docs/arquillian-getting-started.adoc
new file mode 100644
index 0000000..093a19b
--- /dev/null
+++ b/docs/arquillian-getting-started.adoc
@@ -0,0 +1,41 @@
+# Getting started with Arquillian and TomEE
+:index-group: Arquillian
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+Arquillian is a testing framework on top of JUnit (or TestNG if you
+prefer). It makes it easier to do integration tests in a managed
+environment (JEE environment here after).
+
+We provide an embedded and remote adapter, see
+link:arquillian-available-adapters.html[the available adapters] for more
+details.
+
+In a managed environment it is usually quite difficult to perform unit
+tests, due to the fact that most of the time you have to mock almost the
+entire environment. It is very time consuming and requires complicated
+integration tests that must reflect the production environment as best
+as possible. Unit tests lose their true value.
+
+JEE always got seen as an heavy technology, impossible to test and to
+use in development. OpenEJB always fight against that idea and proved
+that it's really possible.
+
+As David Blevins said: > "Do not blame EJBs (ie. Java EE) because your
+server is not testable."
+
+With latest Java EE specifications (5 and especially 6), it becomes a
+reality. Arquillian typically addresses that area. It is basically a
+framework that aims at helping/managing the server/container in an
+agnostic way. Arquillian is responsible for the lifecycle of the
+container (start, deploy, undeploy, stop, etc).
+
+TomEE community heavily invested on that framework to prove it's really
+useful and can really help testing Java EE application. That's also an
+opportunity to get the most out of TomEE (lightweight, fast,
+feature-rich, etc).
+
+\{info See http://arquillian.org[Arquillian.org] for a great quick-start
+tutorial on Arquillian itself. }
http://git-wip-us.apache.org/repos/asf/tomee/blob/3e87b477/docs/arquillian-getting-started.md
----------------------------------------------------------------------
diff --git a/docs/arquillian-getting-started.md b/docs/arquillian-getting-started.md
deleted file mode 100644
index 78d635f..0000000
--- a/docs/arquillian-getting-started.md
+++ /dev/null
@@ -1,24 +0,0 @@
-index-group=Arquillian
-type=page
-status=published
-title=Getting started with Arquillian and TomEE
-~~~~~~
-
-Arquillian is a testing framework on top of JUnit (or TestNG if you prefer). It makes it easier to do integration tests in a managed environment (JEE environment here after).
-
-We provide an embedded and remote adapter, see [the available adapters](arquillian-available-adapters.html) for more details.
-
-In a managed environment it is usually quite difficult to perform unit tests, due to the fact that most of the time you have to mock almost the entire environment. It is very time consuming and requires complicated integration tests that must reflect the production environment as best as possible. Unit tests lose their true value.
-
-JEE always got seen as an heavy technology, impossible to test and to use in development. OpenEJB always fight against that idea and proved that it's really possible.
-
-As David Blevins said:
-> "Do not blame EJBs (ie. Java EE) because your server is not testable."
-
-With latest Java EE specifications (5 and especially 6), it becomes a reality. Arquillian typically addresses that area. It is basically a framework that aims at helping/managing the server/container in an agnostic way. Arquillian is responsible for the lifecycle of the container (start, deploy, undeploy, stop, etc).
-
-TomEE community heavily invested on that framework to prove it's really useful and can really help testing Java EE application. That's also an opportunity to get the most out of TomEE (lightweight, fast, feature-rich, etc).
-
-{info
-See [Arquillian.org](http://arquillian.org) for a great quick-start tutorial on Arquillian itself.
-}
[11/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 7
Posted by jl...@apache.org.
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/stop-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/stop-mojo.md b/docs/maven/stop-mojo.md
deleted file mode 100644
index e6fb3ef..0000000
--- a/docs/maven/stop-mojo.md
+++ /dev/null
@@ -1,1328 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:stop<a name="tomee:stop"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:stop</p>
-
-<p><b>Description</b>:</p>
-
-<div>Stop a TomEE started with start command.</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apacheRepos">apacheRepos</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>snapshots</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.apache-repos</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#appDir">appDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>apps</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#apps">apps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#args">args</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.args</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#bin">bin</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/bin</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.bin</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#catalinaBase">catalinaBase</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.catalina-base</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#checkStarted">checkStarted</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.check-started</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#classpaths">classpaths</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#config">config</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/conf</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.conf</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#context">context</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>rename the current artifact<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#debug">debug</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debug</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#debugPort">debugPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>5005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debugPort</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#deployOpenEjbApplication">deployOpenEjbApplication</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#docBases">docBases</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, which docBase to use for this war.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#ejbRemote">ejbRemote</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ejb-remote</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#externalRepositories">externalRepositories</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>for TomEE and wars only, add some external repositories to
-classloader.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#forceReloadable">forceReloadable</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>force webapp to be reloadable<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.force-reloadable</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#javaagents">javaagents</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#keepServerXmlAsthis">keepServerXmlAsthis</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(Removed since 7.0.0)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.keep-server-xml</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#lib">lib</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/lib</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.lib</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#libDir">libDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>lib</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#libs">libs</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#mainDir">mainDir</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#quickSession">quickSession</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use a real random instead of secure random. saves few ms at
-startup.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.quick-session</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#removeDefaultWebapps">removeDefaultWebapps</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-default-webapps</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#removeTomeeWebapp">removeTomeeWebapp</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-tomee-webapps</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#simpleLog">simpleLog</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.simple-log</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#skipCurrentProject">skipCurrentProject</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipCurrentProject</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#skipWarResources">skipWarResources</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipWarResources</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#systemVariables">systemVariables</a></b></td>
-
-<td><tt>Map</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#target">target</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeAjpPort">tomeeAjpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8009</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ajp</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeAlreadyInstalled">tomeeAlreadyInstalled</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exiting</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeArtifactId">tomeeArtifactId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.artifactId</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeClassifier">tomeeClassifier</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>webprofile</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeGroupId">tomeeGroupId</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.groupId</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHttpsPort">tomeeHttpsPort</a></b></td>
-
-<td><tt>Integer</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.https</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeShutdownCommand">tomeeShutdownCommand</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>SHUTDOWN</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown-command</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeShutdownPort">tomeeShutdownPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeVersion">tomeeVersion</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>-1</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.version</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#useConsole">useConsole</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.use-console</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#useOpenEJB">useOpenEJB</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>use openejb-standalone automatically instead of TomEE<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.openejb</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#warFile">warFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappClasses">webappClasses</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappClasses</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappDefaultConfig">webappDefaultConfig</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>forcing nice default for war development (WEB-INF/classes and web
-resources)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappDefaultConfig</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webappDir">webappDir</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>webapps</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#webappResources">webappResources</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/webapp</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappResources</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#webapps">webapps</a></b></td>
-
-<td><tt>List</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /></td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="apacheRepos">apacheRepos</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.apache-repos</tt></li>
-
-<li><b>Default</b>: <tt>snapshots</tt></li>
- </ul><hr />
-<p><b><a name="appDir">appDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>apps</tt></li>
- </ul><hr />
-<p><b><a name="apps">apps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="args">args</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.args</tt></li>
- </ul><hr />
-<p><b><a name="bin">bin</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.bin</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/bin</tt></li>
- </ul><hr />
-<p><b><a name="catalinaBase">catalinaBase</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.catalina-base</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="checkStarted">checkStarted</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.check-started</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="classpaths">classpaths</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="config">config</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.conf</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/conf</tt></li>
- </ul><hr />
-<p><b><a name="context">context</a>:</b></p>
-
-<div>rename the current artifact</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="debug">debug</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debug</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="debugPort">debugPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.debugPort</tt></li>
-
-<li><b>Default</b>: <tt>5005</tt></li>
- </ul><hr />
-<p><b><a name="deployOpenEjbApplication">deployOpenEjbApplication</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="docBases">docBases</a>:</b></p>
-
-<div>for TomEE and wars only, which docBase to use for this war.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="ejbRemote">ejbRemote</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ejb-remote</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="externalRepositories">externalRepositories</a>:</b></p>
-
-<div>for TomEE and wars only, add some external repositories to
-classloader.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="forceReloadable">forceReloadable</a>:</b></p>
-
-<div>force webapp to be reloadable</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.force-reloadable</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="javaagents">javaagents</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="keepServerXmlAsthis">keepServerXmlAsthis</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.keep-server-xml</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="lib">lib</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.lib</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/lib</tt></li>
- </ul><hr />
-<p><b><a name="libDir">libDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>lib</tt></li>
- </ul><hr />
-<p><b><a name="libs">libs</a>:</b></p>
-
-<div>supported formats: --> groupId:artifactId:version... -->
-unzip:groupId:artifactId:version... --> remove:prefix (often
-prefix = artifactId)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="mainDir">mainDir</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main</tt></li>
- </ul><hr />
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="quickSession">quickSession</a>:</b></p>
-
-<div>use a real random instead of secure random. saves few ms at
-startup.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.quick-session</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="removeDefaultWebapps">removeDefaultWebapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-default-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="removeTomeeWebapp">removeTomeeWebapp</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.remove-tomee-webapps</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="simpleLog">simpleLog</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.simple-log</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipCurrentProject">skipCurrentProject</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipCurrentProject</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="skipWarResources">skipWarResources</a>:</b></p>
-
-<div>when you set docBases to src/main/webapp setting it to true will
-allow hot refresh.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.skipWarResources</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="systemVariables">systemVariables</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.Map</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="target">target</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAjpPort">tomeeAjpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.ajp</tt></li>
-
-<li><b>Default</b>: <tt>8009</tt></li>
- </ul><hr />
-<p><b><a name="tomeeAlreadyInstalled">tomeeAlreadyInstalled</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.exiting</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="tomeeArtifactId">tomeeArtifactId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.artifactId</tt></li>
-
-<li><b>Default</b>: <tt>apache-tomee</tt></li>
- </ul><hr />
-<p><b><a name="tomeeClassifier">tomeeClassifier</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li>
-
-<li><b>Default</b>: <tt>webprofile</tt></li>
- </ul><hr />
-<p><b><a name="tomeeGroupId">tomeeGroupId</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.groupId</tt></li>
-
-<li><b>Default</b>: <tt>org.apache.openejb</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpsPort">tomeeHttpsPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.Integer</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.https</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownCommand">tomeeShutdownCommand</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown-command</tt></li>
-
-<li><b>Default</b>: <tt>SHUTDOWN</tt></li>
- </ul><hr />
-<p><b><a name="tomeeShutdownPort">tomeeShutdownPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.shutdown</tt></li>
-
-<li><b>Default</b>: <tt>8005</tt></li>
- </ul><hr />
-<p><b><a name="tomeeVersion">tomeeVersion</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.version</tt></li>
-
-<li><b>Default</b>: <tt>-1</tt></li>
- </ul><hr />
-<p><b><a name="useConsole">useConsole</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.use-console</tt></li>
-
-<li><b>Default</b>: <tt>true</tt></li>
- </ul><hr />
-<p><b><a name="useOpenEJB">useOpenEJB</a>:</b></p>
-
-<div>use openejb-standalone automatically instead of TomEE</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.openejb</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul><hr />
-<p><b><a name="warFile">warFile</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt></li>
- </ul><hr />
-<p><b><a name="webappClasses">webappClasses</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappClasses</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li>
- </ul><hr />
-<p><b><a name="webappDefaultConfig">webappDefaultConfig</a>:</b></p>
-
-<div>forcing nice default for war development (WEB-INF/classes and web
-resources)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>boolean</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappDefaultConfig</tt></li>
-
-<li><b>Default</b>: <tt>false</tt></li>
- </ul><hr />
-<p><b><a name="webappDir">webappDir</a>:</b></p>
-
-<div>relative to tomee.base.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>webapps</tt></li>
- </ul><hr />
-<p><b><a name="webappResources">webappResources</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.webappResources</tt></li>
-
-<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li>
- </ul><hr />
-<p><b><a name="webapps">webapps</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.util.List</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/undeploy-mojo.adoc
----------------------------------------------------------------------
diff --git a/docs/maven/undeploy-mojo.adoc b/docs/maven/undeploy-mojo.adoc
new file mode 100644
index 0000000..60e1486
--- /dev/null
+++ b/docs/maven/undeploy-mojo.adoc
@@ -0,0 +1,159 @@
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+tomee:undeploy
+
+Full name:
+
+org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:undeploy
+
+Description:
+
+Simply undeploy an application in a running TomEE
+
+Attributes:
+
+Requires a Maven project to be executed.
+
+Requires dependency resolution of artifacts in scope: runtime.
+
+Requires dependency collection of artifacts in scope: runtime.
+
+Required Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+path
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.archive.
+
+Optional Parameters
+
+Name
+
+Type
+
+Since
+
+Description
+
+password
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.pwd.
+
+realm
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.realm.
+
+tomeeHost
+
+String
+
+-
+
+(no description)Default value is: localhost.User property is:
+tomee-plugin.host.
+
+tomeeHttpPort
+
+int
+
+-
+
+(no description)Default value is: 8080.User property is:
+tomee-plugin.http.
+
+user
+
+String
+
+-
+
+(no description)User property is: tomee-plugin.user.
+
+Parameter Details
+
+password:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.pwd
+
+path:
+
+(no description)
+
+Type: java.lang.String
+
+Required: Yes
+
+User Property: tomee-plugin.archive
+
+realm:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.realm
+
+tomeeHost:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.host
+
+Default: localhost
+
+tomeeHttpPort:
+
+(no description)
+
+Type: int
+
+Required: No
+
+User Property: tomee-plugin.http
+
+Default: 8080
+
+user:
+
+(no description)
+
+Type: java.lang.String
+
+Required: No
+
+User Property: tomee-plugin.user
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/undeploy-mojo.md
----------------------------------------------------------------------
diff --git a/docs/maven/undeploy-mojo.md b/docs/maven/undeploy-mojo.md
deleted file mode 100644
index 54edb7e..0000000
--- a/docs/maven/undeploy-mojo.md
+++ /dev/null
@@ -1,209 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-~~~~~~
-<div class="section">
-<h2>tomee:undeploy<a name="tomee:undeploy"></a></h2>
-
-<p><b>Full name</b>:</p>
-
-<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:undeploy</p>
-
-<p><b>Description</b>:</p>
-
-<div>Simply undeploy an application in a running TomEE</div>
-
-<p><b>Attributes</b>:</p>
-
-<ul>
-
-<li>Requires a Maven project to be executed.</li>
-
-<li>Requires dependency resolution of artifacts in scope: <tt>runtime</tt>.</li>
-
-<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li>
- </ul>
-
-<div class="section">
-<h3>Required Parameters<a name="Required_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#path">path</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.archive</tt>.</td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
-
-<table class="mdtable">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#realm">realm</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#tomeeHost">tomeeHost</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td>
-
-<td><tt>int</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#user">user</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td>
- </tr>
- </table>
- </div>
-
-<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
-
-<p><b><a name="password">password</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li>
- </ul><hr />
-<p><b><a name="path">path</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>Yes</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.archive</tt></li>
- </ul><hr />
-<p><b><a name="realm">realm</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHost">tomeeHost</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li>
-
-<li><b>Default</b>: <tt>localhost</tt></li>
- </ul><hr />
-<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>int</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li>
-
-<li><b>Default</b>: <tt>8080</tt></li>
- </ul><hr />
-<p><b><a name="user">user</a>:</b></p>
-
-<div>(no description)</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li>
- </ul>
- </div>
- </div>
\ No newline at end of file
[04/44] tomee git commit: TOMEE-2316 Convert Markdown files to
Asciidoc in the docs folder - 3
Posted by jl...@apache.org.
TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 3
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/6972efbb
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/6972efbb
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/6972efbb
Branch: refs/heads/master
Commit: 6972efbb7428fe10c30e6f271226f902186055bd
Parents: 388460f
Author: Carlos Chacin <cc...@gmail.com>
Authored: Wed Dec 5 22:07:19 2018 -0800
Committer: Carlos Chacin <cc...@gmail.com>
Committed: Wed Dec 5 22:07:19 2018 -0800
----------------------------------------------------------------------
docs/configuration.adoc | 147 ++++++
docs/configuration.md | 144 ------
docs/configuring-containers-in-tests.adoc | 29 ++
docs/configuring-containers-in-tests.md | 27 --
docs/configuring-datasources-in-tests.adoc | 65 +++
docs/configuring-datasources-in-tests.md | 60 ---
docs/configuring-datasources.adoc | 190 ++++++++
docs/configuring-datasources.md | 170 -------
docs/configuring-durations.adoc | 69 +++
docs/configuring-durations.md | 67 ---
docs/configuring-javamail.adoc | 42 ++
docs/configuring-javamail.md | 41 --
docs/configuring-logging-in-tests.adoc | 119 +++++
docs/configuring-logging-in-tests.md | 118 -----
docs/configuring-persistenceunits-in-tests.adoc | 157 ++++++
docs/configuring-persistenceunits-in-tests.md | 144 ------
docs/constructor-injection.adoc | 100 ++++
docs/constructor-injection.md | 98 ----
docs/containers-and-resources.adoc | 473 ++++++++++++++++++
docs/containers-and-resources.md | 483 -------------------
docs/contrib/debug/debug-intellij.adoc | 182 +++++++
docs/contrib/debug/debug-intellij.md | 133 -----
docs/custom-injection.adoc | 203 ++++++++
docs/custom-injection.md | 193 --------
24 files changed, 1776 insertions(+), 1678 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuration.adoc
----------------------------------------------------------------------
diff --git a/docs/configuration.adoc b/docs/configuration.adoc
new file mode 100644
index 0000000..2e8bd5a
--- /dev/null
+++ b/docs/configuration.adoc
@@ -0,0 +1,147 @@
+# Configuration
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Short Overview
+
+== Configuration Properties
+
+* _openejb.home_ - OpenEJB home (installation) directory path. All
+relative paths are resolved against the property unless openejb.base is
+set. Unless set, the value is assigned to the _user.dir_ Java property.
+* _openejb.base_ - OpenEJB base directory path. If set, the directory
+pointed by the property is searched for resources before openejb.home.
+* _openejb.configuration_ - OpenEJB configuration file path.
+* _openejb.loader_ - OpenEJB loader that's responsible for loading EJBs.
+There are 3 different loader types: +
+** _tomcat-webapp_ - set it when inside of Tomcat scoped at just the
+webapp, aka. link:collapsed-ear.html[Collapsed EAR] ** _tomcat_ - set it
+when inside of Tomcat scoped for all webapps to share ** _system_ (also:
+bootstrap) ** _embedded_ (also: noload)
+* _openejb.configurator_ (default:
+_org.openejb.alt.config.ConfigurationFactory_ ) - a class that builds
+org.openejb.alt.assembler.classic.OpenEjbConfiguration object;
+implements the
+org.openejb.alt.assembler.classic.OpenEjbConfigurationFactory interface
+* _openejb.descriptors.output_ - possible values: true|false - When set
+OpenEJB saves deployment descriptors - ejb-jar.xml and openejb-jar.xml
+
+== Configuration File
+
+Show a config file with the elements hyperlinked.
+
+....
+<?xml version="1.0"?>
+<openejb>
+ <Container id="Default CMP Container" ctype="CMP_ENTITY">
+ Global_TX_Database c:/my/app/conf/postgresql.cmp_global_database.xml
+ Local_TX_Database c:/my/app/conf/postgresql.cmp_local_database.xml
+ </Container>
+ <Connector id="Default JDBC Database">
+ JdbcDriver org.postgresql.Driver
+ JdbcUrl jdbc:postgresql://localhost/mydb
+ UserName username
+ Password password
+ </Connector>
+ <SecurityService id="Default Security Service"/>
+ <TransactionService id="Default Transaction Manager"/>
+ <Deployments jar="c:/my/app/employee.jar"/>
+ <Deployments dir="beans/" />
+</openejb>
+....
+
+== Basic Layout
+
+Basically, openejb.base is the source for 100% of all configuration
+information and third party config files (log4j, castor, instantdb,
+whatever). This includes finding where the, possibly many, entries in
+the openejb.conf point. The openejb.home is where the code loading
+OpenEJB will look for all the OpenEJB libraries. Usually openejb.base is
+not explicitly set and defaults to the value of openejb.home, so many
+people are used to only dealing with openejb.home.
+
+The point of having and openejb.base and openejb.home was basically to
+allow several independently configured instances of OpenEJB running on a
+system (perhaps embedded in Swing apps, in Tomcat, running as a
+standalone Server, or even in Groovy as Mr. Strachan did!) but without
+the need to copy all the OpenEJB system libraries everywhere.
+
+_openejb.home_ * can be set explicitly via a system property. * if not
+set it default's to user.dir, which is the current working directory.
+
+_openejb.base_ * can be set explicitly via a system property. * If not
+set it default's to openejb.home.
+
+_openejb.configuration_ * can be set to explicitly point to the file
+containing your configuration. * If set to a relative path, we first
+look in user.dir/your-conf-file, then in openejb.base/your-conf-file *
+If not set we check in openejb.base/conf/openejb.conf * If no conf file
+is found, we create one in openejb.base/conf/openejb.conf
+
+_relative paths in openejb.conf_ * Deployment entries are resolved
+relative to openejb.base. * Containers use openejb.base to resolve their
+own config files. For example, Castor JDO to loads the database.xml and
+all other files from the openejb.base directory. * Resource adapters
+that are embedded usually have config files of their own and are also
+loaded from the openeb.base.
+
+_log files_ * The log4.configuration file is resolved relative to
+openejb.base. * The properties in the config file that point to files
+are also resolved relative to openejb.base.
+
+_OpenEJB libraries_ * The jars in the lib and dist directories under
+openejb.home are added to the classpath.
+
+=== Summary
+
+A summary of the above in a different notation:
+
+....
+openejb.home = user.dir (can be set explicitly)
+openejb.base = openejb.home (can be set explicitly)
+openejb.conf = openejb.base/conf/openejb.conf (can be set explicitly)
+logging.conf = openejb.base/conf/logging.conf (can be set explicitly)
+deployments = paths listed in openejb.conf (relative paths resolved from openejb.base)
+Classpath includes openejb.home/lib and openejb.home/dist
+....
+
+=== Example layout
+
+In this one the openejb.home and openejb.base are set, everything else
+is defaulted. The openejb.conf file as been updated to point to the ejb
+jars by name (abc-ejbs.jar and xyz-ejbs.jar).
+
+An example layout:
+
+....
+/usr/local/openejb (openejb.home)
+/usr/local/openejb/lib (in classpath)
+/usr/local/openejb/dist (in classpath)
+/home/jsmith/foo_app (openejb.base)
+/home/jsmith/foo_app/conf/openejb.conf
+/home/jsmith/foo_app/conf/logging.conf
+/home/jsmith/foo_app/abc-ejbs.jar (Deployment entry in openejb.conf)
+/home/jsmith/foo_app/xyz-ejbs.jar (Deployment entry in openejb.conf)
+/home/jsmith/foo_app/logs/
+....
+
+=== Another Example layout
+
+In this example openejb.home and openejb.base are setup as well as the
+explicit paths for the openejb and log4j configuration files.
+
+An example layout:
+
+....
+/usr/local/openejb (openejb.home)
+/usr/local/openejb/lib (in classpath)
+/usr/local/openejb/dist (in classpath)
+/home/jsmith/foo_app (openejb.base)
+/home/jsmith/foo_app/openejb.xml (openejb.configuration)
+/home/jsmith/foo_app/abc-ejbs.jar (Deployment entry in openejb.xml)
+/home/jsmith/foo_app/xyz-ejbs.jar (Deployment entry in openejb.xml)
+/home/jsmith/foo_app/log4j.conf (log4j.configuration)
+/home/jsmith/foo_app/mylogs/ (logging dir as defined in log4j.conf)
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuration.md
----------------------------------------------------------------------
diff --git a/docs/configuration.md b/docs/configuration.md
deleted file mode 100644
index ff78f5f..0000000
--- a/docs/configuration.md
+++ /dev/null
@@ -1,144 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Configuration
-~~~~~~
-<a name="Configuration-ShortOverview"></a>
-# Short Overview
-
-<a name="Configuration-ConfigurationProperties"></a>
-## Configuration Properties
-
-* _openejb.home_ - OpenEJB home (installation) directory path. All relative paths are resolved against the property unless openejb.base is set. Unless set, the value is assigned to the _user.dir_ Java property.
-* _openejb.base_ - OpenEJB base directory path. If set, the directory pointed by the property is searched for resources before openejb.home.
-* _openejb.configuration_ - OpenEJB configuration file path.
-* _openejb.loader_ - OpenEJB loader that's responsible for loading EJBs. There are 3 different loader types:
-** _tomcat-webapp_ - set it when inside of Tomcat scoped at just the webapp, aka. [Collapsed EAR](collapsed-ear.html)
-** _tomcat_ - set it when inside of Tomcat scoped for all webapps to share
-** _system_ (also: bootstrap)
-** _embedded_ (also: noload)
-* _openejb.configurator_ (default: _org.openejb.alt.config.ConfigurationFactory_ ) - a class that builds org.openejb.alt.assembler.classic.OpenEjbConfiguration object; implements the org.openejb.alt.assembler.classic.OpenEjbConfigurationFactory interface
-* _openejb.descriptors.output_ - possible values: true|false - When set OpenEJB saves deployment descriptors - ejb-jar.xml and openejb-jar.xml
-
-<a name="Configuration-ConfigurationFile"></a>
-## Configuration File
-
-Show a config file with the elements hyperlinked.
-
- <?xml version="1.0"?>
- <openejb>
- <Container id="Default CMP Container" ctype="CMP_ENTITY">
- Global_TX_Database c:/my/app/conf/postgresql.cmp_global_database.xml
- Local_TX_Database c:/my/app/conf/postgresql.cmp_local_database.xml
- </Container>
- <Connector id="Default JDBC Database">
- JdbcDriver org.postgresql.Driver
- JdbcUrl jdbc:postgresql://localhost/mydb
- UserName username
- Password password
- </Connector>
- <SecurityService id="Default Security Service"/>
- <TransactionService id="Default Transaction Manager"/>
- <Deployments jar="c:/my/app/employee.jar"/>
- <Deployments dir="beans/" />
- </openejb>
-
-
-# Basic Layout
-
-Basically, openejb.base is the source for 100% of all configuration
-information and third party config files (log4j, castor, instantdb,
-whatever). This includes finding where the, possibly many, <Deployment>
-entries in the openejb.conf point. The openejb.home is where the code
-loading OpenEJB will look for all the OpenEJB libraries. Usually
-openejb.base is not explicitly set and defaults to the value of
-openejb.home, so many people are used to only dealing with openejb.home.
-
-The point of having and openejb.base and openejb.home was basically to
-allow several independently configured instances of OpenEJB running on a
-system (perhaps embedded in Swing apps, in Tomcat, running as a standalone
-Server, or even in Groovy as Mr. Strachan did!) but without the need to
-copy all the OpenEJB system libraries everywhere.
-
- *openejb.home*
- * can be set explicitly via a system property.
- * if not set it default's to user.dir, which is the current working
- directory.
-
- *openejb.base*
- * can be set explicitly via a system property.
- * If not set it default's to openejb.home.
-
- *openejb.configuration*
- * can be set to explicitly point to the file containing your
- configuration.
- * If set to a relative path, we first look in user.dir/your-conf-file,
- then in openejb.base/your-conf-file
- * If not set we check in openejb.base/conf/openejb.conf
- * If no conf file is found, we create one in
- openejb.base/conf/openejb.conf
-
-
- *relative paths in openejb.conf*
- * Deployment entries are resolved relative to openejb.base.
- * Containers use openejb.base to resolve their own config files. For
- example, Castor JDO to loads the database.xml and all other files from the
- openejb.base directory.
- * Resource adapters that are embedded usually have config files of their
- own and are also loaded from the openeb.base.
-
- *log files*
- * The log4.configuration file is resolved relative to openejb.base.
- * The properties in the config file that point to files are also resolved
- relative to openejb.base.
-
- *OpenEJB libraries*
- * The jars in the lib and dist directories under openejb.home are added
-to the classpath.
-
-## Summary
-
-A summary of the above in a different notation:
-
- openejb.home = user.dir (can be set explicitly)
- openejb.base = openejb.home (can be set explicitly)
- openejb.conf = openejb.base/conf/openejb.conf (can be set explicitly)
- logging.conf = openejb.base/conf/logging.conf (can be set explicitly)
- deployments = paths listed in openejb.conf (relative paths resolved from openejb.base)
- Classpath includes openejb.home/lib and openejb.home/dist
-
-## Example layout
-
-In this one the openejb.home and openejb.base are set, everything else is
-defaulted. The openejb.conf file as been updated to point to the ejb jars
-by name (abc-ejbs.jar and xyz-ejbs.jar).
-
-An example layout:
-
- /usr/local/openejb (openejb.home)
- /usr/local/openejb/lib (in classpath)
- /usr/local/openejb/dist (in classpath)
- /home/jsmith/foo_app (openejb.base)
- /home/jsmith/foo_app/conf/openejb.conf
- /home/jsmith/foo_app/conf/logging.conf
- /home/jsmith/foo_app/abc-ejbs.jar (Deployment entry in openejb.conf)
- /home/jsmith/foo_app/xyz-ejbs.jar (Deployment entry in openejb.conf)
- /home/jsmith/foo_app/logs/
-
-
-## Another Example layout
-
-In this example openejb.home and openejb.base are setup as well as the
-explicit paths for the openejb and log4j configuration files.
-
-An example layout:
-
- /usr/local/openejb (openejb.home)
- /usr/local/openejb/lib (in classpath)
- /usr/local/openejb/dist (in classpath)
- /home/jsmith/foo_app (openejb.base)
- /home/jsmith/foo_app/openejb.xml (openejb.configuration)
- /home/jsmith/foo_app/abc-ejbs.jar (Deployment entry in openejb.xml)
- /home/jsmith/foo_app/xyz-ejbs.jar (Deployment entry in openejb.xml)
- /home/jsmith/foo_app/log4j.conf (log4j.configuration)
- /home/jsmith/foo_app/mylogs/ (logging dir as defined in log4j.conf)
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-containers-in-tests.adoc
----------------------------------------------------------------------
diff --git a/docs/configuring-containers-in-tests.adoc b/docs/configuring-containers-in-tests.adoc
new file mode 100644
index 0000000..b288c81
--- /dev/null
+++ b/docs/configuring-containers-in-tests.adoc
@@ -0,0 +1,29 @@
+# Configuring Containers in Tests
+:index-group: Testing Techniques
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+Like Resources, Containers
+can also be declared via InitialContext properties as well. The most
+useful is to declare a Stateful SessionBean container so that it's
+guaranteed to passivate and activate on each call to the bean, allowing
+you to test your callbacks behave as you need them to.
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.core.LocalInitialContextFactory");
+
+p.put("myStatefulContainer", "new://Container?type=STATEFUL");
+p.put("myStatefulContainer.PoolSize", "0");
+p.put("myStatefulContainer.BulkPassivate", "1");
+
+Context context = new InitialContext(p);
+....
+
+Note, this only works when using the LocalInitialContextFactory to embed
+OpenEJB into the vm. Once embedded, further configuration properties are
+ignored.
+
+See link:containers-and-resources.html[Containers and Resources] for a
+full list of supported Resource types and their properties.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-containers-in-tests.md
----------------------------------------------------------------------
diff --git a/docs/configuring-containers-in-tests.md b/docs/configuring-containers-in-tests.md
deleted file mode 100644
index dc1c56c..0000000
--- a/docs/configuring-containers-in-tests.md
+++ /dev/null
@@ -1,27 +0,0 @@
-index-group=Testing Techniques
-type=page
-status=published
-title=Configuring Containers in Tests
-~~~~~~
-Like Resources, Containers can also be declared via InitialContext
-properties as well. The most useful is to declare a Stateful SessionBean
-container so that it's guaranteed to passivate and activate on each call to
-the bean, allowing you to test your callbacks behave as you need them to.
-
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.core.LocalInitialContextFactory");
-
- p.put("myStatefulContainer", "new://Container?type=STATEFUL");
- p.put("myStatefulContainer.PoolSize", "0");
- p.put("myStatefulContainer.BulkPassivate", "1");
-
- Context context = new InitialContext(p);
-
-
-Note, this only works when using the LocalInitialContextFactory to embed
-OpenEJB into the vm. Once embedded, further configuration properties are
-ignored.
-
-See [Containers and Resources](containers-and-resources.html)
- for a full list of supported Resource types and their properties.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-datasources-in-tests.adoc
----------------------------------------------------------------------
diff --git a/docs/configuring-datasources-in-tests.adoc b/docs/configuring-datasources-in-tests.adoc
new file mode 100644
index 0000000..45210e4
--- /dev/null
+++ b/docs/configuring-datasources-in-tests.adoc
@@ -0,0 +1,65 @@
+# Configuring DataSources in Tests
+:index-group: Testing Techniques
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# InitialContext
+properties
+
+You can configure data sources from within your test case (avoiding the
+need for an `openejb.xml` entirely) like so:
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.core.LocalInitialContextFactory");
+
+p.put("myDataSource", "new://Resource?type=DataSource");
+p.put("myDataSource.JdbcDriver", "org.apache.derby.jdbc.EmbeddedDriver");
+p.put("myDataSource.JdbcUrl", "jdbc:derby:derbyDB;create=true");
+p.put("myDataSource.JtaManaged", "true");
+
+Context context = new InitialContext(p);
+....
+
+Under certain circumstances it may be necessary to load two versions of
+the same driver. This is possible by definition of a classpath for the
+resource which points to the specific driver files required for the
+DataSource:
+
+....
+p.put("myDataSourceOne", "new://Resource?type=DataSource&classpath=/path/to/driverVersionOne.jar");
+p.put("myDataSourceOne.JdbcDriver", "org.apache.derby.jdbc.EmbeddedDriver");
+p.put("myDataSource.JdbcUrl", "jdbc:derby:myDatabaseOne;create=true");
+....
+p.put("myDataSourceTwo", "new://Resource?type=DataSource&classpath=/path/to/driverVersionTwo.jar");
+p.put("myDataSourceTwo.JdbcDriver", "org.apache.derby.jdbc.EmbeddedDriver");
+p.put("myDataSource.JdbcUrl", "jdbc:derby:myDatabaseTwo;create=true");
+....
+
+This will allow an application to communicate through legacy drivers to
+the same JDBC provider.
+
+See link:embedded-configuration.html[Embedded Configuration] for further
+details on properties and overrides.
+
+See link:containers-and-resources.html[Containers and Resources] for a
+full list of supported Resource types and their properties.
+
+== Note on <jta-data-source> and <non-jta-data-source>
+
+When configuring DataSources to be used by persistence.xml files, the
+DataSource supplied for `<jta-data-source>` is typically identical to
+the `<non-jta-data-source>`, but with the `JtaManaged` property set
+differently. Keeping with our philosophy to free you up from redundant
+configuration, we will happily auto-create a missing jta-data-source or
+non-jta-data-source based upon the supplied DataSource.
+
+In the example above, a new DataSource would be generated as an exact
+copy but with the name "myDataSourceUnmanaged" and its `JtaManaged` flag
+set to `false`. If the supplied DataSource was not `JtaManaged`, then
+the generated DataSource would be called "myDataSourceJta" and have its
+`JtaManaged` flag set to `true`.
+
+When relying on this functionality it is not necessary to specify the
+name of the generated DataSource in the `persistence.xml` file.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-datasources-in-tests.md
----------------------------------------------------------------------
diff --git a/docs/configuring-datasources-in-tests.md b/docs/configuring-datasources-in-tests.md
deleted file mode 100644
index 0a45c54..0000000
--- a/docs/configuring-datasources-in-tests.md
+++ /dev/null
@@ -1,60 +0,0 @@
-index-group=Testing Techniques
-type=page
-status=published
-title=Configuring DataSources in Tests
-~~~~~~
-<a name="ConfiguringDataSourcesinTests-InitialContextproperties"></a>
-# InitialContext properties
-
-You can configure data sources from within your test case (avoiding the
-need for an `openejb.xml` entirely) like so:
-
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.core.LocalInitialContextFactory");
-
- p.put("myDataSource", "new://Resource?type=DataSource");
- p.put("myDataSource.JdbcDriver", "org.apache.derby.jdbc.EmbeddedDriver");
- p.put("myDataSource.JdbcUrl", "jdbc:derby:derbyDB;create=true");
- p.put("myDataSource.JtaManaged", "true");
-
- Context context = new InitialContext(p);
-
-Under certain circumstances it may be necessary to load two versions of the same driver.
-This is possible by definition of a classpath for the resource which points to the
-specific driver files required for the DataSource:
-
- p.put("myDataSourceOne", "new://Resource?type=DataSource&classpath=/path/to/driverVersionOne.jar");
- p.put("myDataSourceOne.JdbcDriver", "org.apache.derby.jdbc.EmbeddedDriver");
- p.put("myDataSource.JdbcUrl", "jdbc:derby:myDatabaseOne;create=true");
- ....
- p.put("myDataSourceTwo", "new://Resource?type=DataSource&classpath=/path/to/driverVersionTwo.jar");
- p.put("myDataSourceTwo.JdbcDriver", "org.apache.derby.jdbc.EmbeddedDriver");
- p.put("myDataSource.JdbcUrl", "jdbc:derby:myDatabaseTwo;create=true");
-
-This will allow an application to communicate through legacy drivers to the same JDBC provider.
-
-See [Embedded Configuration](embedded-configuration.html)
- for further details on properties and overrides.
-
-See [Containers and Resources](containers-and-resources.html)
- for a full list of supported Resource types and their properties.
-
-<a name="ConfiguringDataSourcesinTests-Noteon<jta-data-source>and<non-jta-data-source>"></a>
-## Note on <jta-data-source> and <non-jta-data-source>
-
-When configuring DataSources to be used by persistence.xml files, the
-DataSource supplied for `<jta-data-source>` is typically identical to the
-`<non-jta-data-source>`, but with the `JtaManaged` property set differently.
-Keeping with our philosophy to free you up from redundant configuration, we
-will happily auto-create a missing jta-data-source or non-jta-data-source
-based upon the supplied DataSource.
-
-In the example above, a new DataSource would be generated as an exact copy
-but with the name "myDataSourceUnmanaged" and its `JtaManaged` flag set to
-`false`. If the supplied DataSource was not `JtaManaged`, then the generated
-DataSource would be called "myDataSourceJta" and have its `JtaManaged` flag
-set to `true`.
-
-When relying on this functionality it is not necessary to specify the name
-of the generated DataSource in the `persistence.xml` file.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-datasources.adoc
----------------------------------------------------------------------
diff --git a/docs/configuring-datasources.adoc b/docs/configuring-datasources.adoc
new file mode 100644
index 0000000..d490067
--- /dev/null
+++ b/docs/configuring-datasources.adoc
@@ -0,0 +1,190 @@
+# Configuring DataSources in tomee.xml
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+The __ element is used to configure a _javax.sql.DataSource_. It is also
+used to configure other resources like Timers, Topics, Queues. We will
+see some examples of using to configure a DataSource.
+
+The element is designed after @Resource annotation and has similar
+attributes.
+
+For example, this annotation in your bean:
+
+....
+@Resource(name = "myDerbyDatasource", type = javax.sql.DataSource.class)
+....
+
+Would map to a Resource declared in your openejb.xml as follows:
+
+....
+<Resource id="myDerbyDatasource" type="javax.sql.DataSource">
+ . . . .
+<Resource>
+....
+
+Note that in the xml element, the _type_ value of _javax.sql.DataSource_
+can abbreviated to just _DataSource_ as follows:
+
+....
+<Resource id="myDerbyDatasource" type="DataSource">
+ . . . .
+<Resource>
+....
+
+It is also possible to specify the path to the driver jar file using a
+classpath attribute like so:
+
+....
+<Resource id="myDerbyDatasource" type="DataSource" classpath="/path/to/driver.jar">
+ . . . .
+<Resource>
+....
+
+...Or in a http://maven.apache.org/[Maven] environment like so:
+
+....
+<Resource id="myDerbyDatasource" type="DataSource" classpath="mvn:org.apache.derby:derby:10.10.1.1">
+ . . . .
+<Resource>
+....
+
+See link:containers-and-resources.html[Containers and Resources] for a
+complete list of supported DataSource properties.
+
+See link:datasource-password-encryption.html[DataSource Password
+Encryption] for information on specifying non-plain-text database
+passwords in your openejb.xml file.
+
+See link:common-datasource-configurations.html[Common DataSource
+Configurations] for a list of the commonly used databases and their
+driver configurations.
+
+See link:datasource-configuration-by-creator.html[DataSource
+Configuration by Creator] for a list of the different properties
+supported for each data source creator.
+
+You may also need data partitioning per customer or depending on any
+other business criteria. That's also an available feature. See
+link:dynamic-datasource.html[Dynamic Datasource] for more details.
+
+== JNDI names for configured DataSources
+
+=== Example 1
+
+....
+<Resource id="Default JDBC Database" type="DataSource">
+ . . . . .
+</Resource>
+....
+
+The global jndi name would be _java:openejb/Resource/Default JDBC
+Database_
+
+=== Example 2
+
+....
+<Resource id="Derby Database" type="DataSource">
+ . . . . .
+</Resource>
+....
+
+The global jndi name would be _java:openejb/Resource/Derby Database_
+
+== Obtaining a DataSource
+
+DataSource references in your ejb should get automatically mapped to the
+Resource you declare. The shortest and easiest rule is that _if your
+reference name matches a Resource in your openejb.xml, that's the one
+you get_. Essentially, the rules for mapping are as follows.
+
+[arabic]
+. Name Attribute Match - @Resource with a name attribute matching the
+resource name gets that resource injected
+. Injected Name Match - variable name matching the resource name gets
+that resource injected
+. No Match - nothing matches a resource name, so the first resource
+available gets injected
+
+There are various ways one could obtain a DataSource now. Lets take an
+example of Derby.
+
+With a Resource declaration in your openejb.xml like this:
+
+....
+<Resource id="myDerbyDatabase" type="DataSource">
+ . . . . .
+</Resource>
+....
+
+There are several possible ways to refer to it, as follows.
+
+_BY matching variable name to resource name_
+
+....
+@Stateless
+public class FooBean {
+ @Resource DataSource myDerbyDatabase;
+}
+....
+
+_OR BY matching name_
+
+....
+@Stateless
+public class FooBean {
+ @Resource(name="myDerbyDatabase")
+ DataSource dataSource;
+}
+....
+
+_OR BY JNDI lookup_
+
+....
+@Resource(name="myDerbyDatabase", type=javax.sql.DataSource.class)
+@Stateless
+public class FooBean {
+
+ public void setSessionContext(SessionContext sessionContext) {
+ DataSource dataSource = (DataSource)
+ sessionContext.lookup("myDerbyDatabase");
+ }
+
+ public void someOtherMethod() throws Exception {
+ InitialContext initialContext = new InitialContext();
+ DataSource dataSource = (DataSource)
+ initialContext.lookup("java:comp/env/myDerbyDatabase");
+ }
+}
+....
+
+_OR_
+
+....
+<resource-ref>
+ <res-ref-name>myDerbyDatabase</res-ref-name>
+ <res-type>javax.sql.DataSource</res-type>
+</resource-ref>
+....
+
+_OR_
+
+....
+<resource-ref>
+ <res-ref-name>jdbc/myDerbyDatabase</res-ref-name>
+ <res-type>javax.sql.DataSource</res-type>
+</resource-ref>
+....
+
+_OR_
+
+....
+<resource-ref>
+ <res-ref-name>someOtherName</res-ref-name>
+ <res-type>javax.sql.DataSource</res-type>
+ <mapped-name>myDerbyDatabase</mapped-name>
+</resource-ref>
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-datasources.md
----------------------------------------------------------------------
diff --git a/docs/configuring-datasources.md b/docs/configuring-datasources.md
deleted file mode 100644
index a63ab85..0000000
--- a/docs/configuring-datasources.md
+++ /dev/null
@@ -1,170 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=Configuring DataSources in tomee.xml
-~~~~~~
-
-<a name="ConfiguringDataSources-ConfiguringDataSourcesinopenejb.xml"></a>
-
-
-The *<Resource>* element is used to configure a *javax.sql.DataSource*. It
-is also used to configure other resources like Timers, Topics, Queues. We
-will see some examples of using <Resource> to configure a DataSource.
-
-The <Resource> element is designed after @Resource annotation and has
-similar attributes.
-
-For example, this annotation in your bean:
-
- @Resource(name = "myDerbyDatasource", type = javax.sql.DataSource.class)
-
-
-Would map to a Resource declared in your openejb.xml as follows:
-
- <Resource id="myDerbyDatasource" type="javax.sql.DataSource">
- . . . .
- <Resource>
-
-
-Note that in the xml element, the _type_ value of _javax.sql.DataSource_
-can abbreviated to just _DataSource_ as follows:
-
- <Resource id="myDerbyDatasource" type="DataSource">
- . . . .
- <Resource>
-
-It is also possible to specify the path to the driver jar file using a classpath attribute like so:
-
- <Resource id="myDerbyDatasource" type="DataSource" classpath="/path/to/driver.jar">
- . . . .
- <Resource>
-
-...Or in a [Maven](http://maven.apache.org/) environment like so:
-
- <Resource id="myDerbyDatasource" type="DataSource" classpath="mvn:org.apache.derby:derby:10.10.1.1">
- . . . .
- <Resource>
-
-See [Containers and Resources](containers-and-resources.html)
- for a complete list of supported DataSource properties.
-
-See [DataSource Password Encryption](datasource-password-encryption.html)
- for information on specifying non-plain-text database passwords in your openejb.xml file.
-
-See [Common DataSource Configurations](common-datasource-configurations.html)
- for a list of the commonly used databases and their driver configurations.
-
-See [DataSource Configuration by Creator](datasource-configuration-by-creator.html)
- for a list of the different properties supported for each data source creator.
-
-You may also need data partitioning per customer or depending on any other
-business criteria. That's also an available feature. See [Dynamic Datasource](dynamic-datasource.html) for more details.
-
-<a name="ConfiguringDataSources-JNDInamesforconfiguredDataSources"></a>
-## JNDI names for configured DataSources
-
-<a name="ConfiguringDataSources-Example1"></a>
-### Example 1
-
-
- <Resource id="Default JDBC Database" type="DataSource">
- . . . . .
- </Resource>
-
-The global jndi name would be *java:openejb/Resource/Default JDBC Database*
-
-<a name="ConfiguringDataSources-Example2"></a>
-### Example 2
-
-
- <Resource id="Derby Database" type="DataSource">
- . . . . .
- </Resource>
-
-The global jndi name would be *java:openejb/Resource/Derby Database*
-
-<a name="ConfiguringDataSources-ObtainingaDataSource"></a>
-## Obtaining a DataSource
-
-DataSource references in your ejb should get automatically mapped to the
-Resource you declare. The shortest and easiest rule is that *if your
-reference name matches a Resource in your openejb.xml, that's the one you
-get*. Essentially, the rules for mapping are as follows.
-
-1. Name Attribute Match - @Resource with a name attribute matching the
-resource name gets that resource injected
-1. Injected Name Match - variable name matching the resource name gets that
-resource injected
-1. No Match - nothing matches a resource name, so the first resource
-available gets injected
-
-
-There are various ways one could obtain a DataSource now. Lets take an
-example of Derby.
-
-With a Resource declaration in your openejb.xml like this:
-
-
- <Resource id="myDerbyDatabase" type="DataSource">
- . . . . .
- </Resource>
-
-There are several possible ways to refer to it, as follows.
-
-
-*BY matching variable name to resource name*
-
- @Stateless
- public class FooBean {
- @Resource DataSource myDerbyDatabase;
- }
-
-
-*OR BY matching name*
-
- @Stateless
- public class FooBean {
- @Resource(name="myDerbyDatabase")
- DataSource dataSource;
- }
-
-
-*OR BY JNDI lookup*
-
- @Resource(name="myDerbyDatabase", type=javax.sql.DataSource.class)
- @Stateless
- public class FooBean {
-
- public void setSessionContext(SessionContext sessionContext) {
- DataSource dataSource = (DataSource)
- sessionContext.lookup("myDerbyDatabase");
- }
-
- public void someOtherMethod() throws Exception {
- InitialContext initialContext = new InitialContext();
- DataSource dataSource = (DataSource)
- initialContext.lookup("java:comp/env/myDerbyDatabase");
- }
- }
-
-*OR*
-
- <resource-ref>
- <res-ref-name>myDerbyDatabase</res-ref-name>
- <res-type>javax.sql.DataSource</res-type>
- </resource-ref>
-
-*OR*
-
- <resource-ref>
- <res-ref-name>jdbc/myDerbyDatabase</res-ref-name>
- <res-type>javax.sql.DataSource</res-type>
- </resource-ref>
-
-*OR*
-
- <resource-ref>
- <res-ref-name>someOtherName</res-ref-name>
- <res-type>javax.sql.DataSource</res-type>
- <mapped-name>myDerbyDatabase</mapped-name>
- </resource-ref>
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-durations.adoc
----------------------------------------------------------------------
diff --git a/docs/configuring-durations.adoc b/docs/configuring-durations.adoc
new file mode 100644
index 0000000..cacfb7a
--- /dev/null
+++ b/docs/configuring-durations.adoc
@@ -0,0 +1,69 @@
+# Configuring Durations
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+The time based configuration properties of containers
+and beans support plain english, such as:
+
+* "1 hour"
+* "27 minutes"
+* "10 seconds"
+
+For convenience it is possible to specify a _compound_ form, such as:
+
+* "3 days and 2 hours"
+* "1 hour, 45 minutes"
+* "15 minutes, 23 seconds, and 10 milliseconds"
+
+Spaces are also optional between the number and the time unit, which can
+be nice when using the abbreviated forms:
+
+* "1hr"
+* "27m"
+* "10s"
+* "3d and 2hr"
+* "1hr, 45min"
+* "15m, 23s, and 10ms"
+
+Abbreviations are accepted as follows:
+
+....
+ if (u.equalsIgnoreCase("NANOSECONDS")) return TimeUnit.NANOSECONDS;
+ if (u.equalsIgnoreCase("NANOSECOND")) return TimeUnit.NANOSECONDS;
+ if (u.equalsIgnoreCase("NANOS")) return TimeUnit.NANOSECONDS;
+ if (u.equalsIgnoreCase("NANO")) return TimeUnit.NANOSECONDS;
+ if (u.equalsIgnoreCase("NS")) return TimeUnit.NANOSECONDS;
+
+ if (u.equalsIgnoreCase("MICROSECONDS")) return TimeUnit.MICROSECONDS;
+ if (u.equalsIgnoreCase("MICROSECOND")) return TimeUnit.MICROSECONDS;
+ if (u.equalsIgnoreCase("MICROS")) return TimeUnit.MICROSECONDS;
+ if (u.equalsIgnoreCase("MICRO")) return TimeUnit.MICROSECONDS;
+
+ if (u.equalsIgnoreCase("MILLISECONDS")) return TimeUnit.MILLISECONDS;
+ if (u.equalsIgnoreCase("MILLISECOND")) return TimeUnit.MILLISECONDS;
+ if (u.equalsIgnoreCase("MILLIS")) return TimeUnit.MILLISECONDS;
+ if (u.equalsIgnoreCase("MILLI")) return TimeUnit.MILLISECONDS;
+ if (u.equalsIgnoreCase("MS")) return TimeUnit.MILLISECONDS;
+
+ if (u.equalsIgnoreCase("SECONDS")) return TimeUnit.SECONDS;
+ if (u.equalsIgnoreCase("SECOND")) return TimeUnit.SECONDS;
+ if (u.equalsIgnoreCase("SEC")) return TimeUnit.SECONDS;
+ if (u.equalsIgnoreCase("S")) return TimeUnit.SECONDS;
+
+ if (u.equalsIgnoreCase("MINUTES")) return TimeUnit.MINUTES;
+ if (u.equalsIgnoreCase("MINUTE")) return TimeUnit.MINUTES;
+ if (u.equalsIgnoreCase("MIN")) return TimeUnit.MINUTES;
+ if (u.equalsIgnoreCase("M")) return TimeUnit.MINUTES;
+
+ if (u.equalsIgnoreCase("HOURS")) return TimeUnit.HOURS;
+ if (u.equalsIgnoreCase("HOUR")) return TimeUnit.HOURS;
+ if (u.equalsIgnoreCase("HRS")) return TimeUnit.HOURS;
+ if (u.equalsIgnoreCase("HR")) return TimeUnit.HOURS;
+ if (u.equalsIgnoreCase("H")) return TimeUnit.HOURS;
+
+ if (u.equalsIgnoreCase("DAYS")) return TimeUnit.DAYS;
+ if (u.equalsIgnoreCase("DAY")) return TimeUnit.DAYS;
+ if (u.equalsIgnoreCase("D")) return TimeUnit.DAYS;
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-durations.md
----------------------------------------------------------------------
diff --git a/docs/configuring-durations.md b/docs/configuring-durations.md
deleted file mode 100644
index 8c93e66..0000000
--- a/docs/configuring-durations.md
+++ /dev/null
@@ -1,67 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Configuring Durations
-~~~~~~
-The time based configuration properties of containers and beans support
-plain english, such as:
-
- - "1 hour"
- - "27 minutes"
- - "10 seconds"
-
-For convenience it is possible to specify a _compound_ form, such as:
-
- - "3 days and 2 hours"
- - "1 hour, 45 minutes"
- - "15 minutes, 23 seconds, and 10 milliseconds"
-
-Spaces are also optional between the number and the time unit, which can be nice when using the abbreviated forms:
-
- - "1hr"
- - "27m"
- - "10s"
- - "3d and 2hr"
- - "1hr, 45min"
- - "15m, 23s, and 10ms"
-
-
-Abbreviations are accepted as follows:
-
-
- if (u.equalsIgnoreCase("NANOSECONDS")) return TimeUnit.NANOSECONDS;
- if (u.equalsIgnoreCase("NANOSECOND")) return TimeUnit.NANOSECONDS;
- if (u.equalsIgnoreCase("NANOS")) return TimeUnit.NANOSECONDS;
- if (u.equalsIgnoreCase("NANO")) return TimeUnit.NANOSECONDS;
- if (u.equalsIgnoreCase("NS")) return TimeUnit.NANOSECONDS;
-
- if (u.equalsIgnoreCase("MICROSECONDS")) return TimeUnit.MICROSECONDS;
- if (u.equalsIgnoreCase("MICROSECOND")) return TimeUnit.MICROSECONDS;
- if (u.equalsIgnoreCase("MICROS")) return TimeUnit.MICROSECONDS;
- if (u.equalsIgnoreCase("MICRO")) return TimeUnit.MICROSECONDS;
-
- if (u.equalsIgnoreCase("MILLISECONDS")) return TimeUnit.MILLISECONDS;
- if (u.equalsIgnoreCase("MILLISECOND")) return TimeUnit.MILLISECONDS;
- if (u.equalsIgnoreCase("MILLIS")) return TimeUnit.MILLISECONDS;
- if (u.equalsIgnoreCase("MILLI")) return TimeUnit.MILLISECONDS;
- if (u.equalsIgnoreCase("MS")) return TimeUnit.MILLISECONDS;
-
- if (u.equalsIgnoreCase("SECONDS")) return TimeUnit.SECONDS;
- if (u.equalsIgnoreCase("SECOND")) return TimeUnit.SECONDS;
- if (u.equalsIgnoreCase("SEC")) return TimeUnit.SECONDS;
- if (u.equalsIgnoreCase("S")) return TimeUnit.SECONDS;
-
- if (u.equalsIgnoreCase("MINUTES")) return TimeUnit.MINUTES;
- if (u.equalsIgnoreCase("MINUTE")) return TimeUnit.MINUTES;
- if (u.equalsIgnoreCase("MIN")) return TimeUnit.MINUTES;
- if (u.equalsIgnoreCase("M")) return TimeUnit.MINUTES;
-
- if (u.equalsIgnoreCase("HOURS")) return TimeUnit.HOURS;
- if (u.equalsIgnoreCase("HOUR")) return TimeUnit.HOURS;
- if (u.equalsIgnoreCase("HRS")) return TimeUnit.HOURS;
- if (u.equalsIgnoreCase("HR")) return TimeUnit.HOURS;
- if (u.equalsIgnoreCase("H")) return TimeUnit.HOURS;
-
- if (u.equalsIgnoreCase("DAYS")) return TimeUnit.DAYS;
- if (u.equalsIgnoreCase("DAY")) return TimeUnit.DAYS;
- if (u.equalsIgnoreCase("D")) return TimeUnit.DAYS;
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-javamail.adoc
----------------------------------------------------------------------
diff --git a/docs/configuring-javamail.adoc b/docs/configuring-javamail.adoc
new file mode 100644
index 0000000..c924b2c
--- /dev/null
+++ b/docs/configuring-javamail.adoc
@@ -0,0 +1,42 @@
+# Configuring JavaMail
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Declaring a JavaMail Resource
+
+The basics are that any properties listed in the element are given
+directly to the javamail provider via
+javax.mail.Session.getDefaultInstance(Properties props).
+
+Here might be some example properties.
+
+....
+<Resource id="SuperbizMail" type="javax.mail.Session">
+ mail.smtp.host=mail.superbiz.org
+ mail.smtp.port=25
+ mail.transport.protocol=smtp
+ mail.smtp.auth=true
+ mail.smtp.user=someuser
+ password=mypassword
+</Resource>
+....
+
+You can create as many entries like this as you wish, they just have to
+have a unique 'id'.
+
+Careful not to add whitespace at the end of your property values. A
+java.util.Properties object will leave those in the property values and
+they will be passed to the JavaMail provider with the whitespace on the
+end which may cause issues if the provider does not actively trim the
+values before attempting to use them.
+
+== Overriding
+
+If you wanted to do a System property or InitialContext property
+override of the above example mail session, you could do so like this:
+
+....
+java ... -DSuperbizMail.mail.smtp.host=localhost
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-javamail.md
----------------------------------------------------------------------
diff --git a/docs/configuring-javamail.md b/docs/configuring-javamail.md
deleted file mode 100644
index e0de1f5..0000000
--- a/docs/configuring-javamail.md
+++ /dev/null
@@ -1,41 +0,0 @@
-index-group=Configuration
-type=page
-status=published
-title=Configuring JavaMail
-~~~~~~
-<a name="ConfiguringJavaMail-DeclaringaJavaMailResource"></a>
-# Declaring a JavaMail Resource
-
-The basics are that any properties listed in the <Resource> element are
-given directly to the javamail provider via
-javax.mail.Session.getDefaultInstance(Properties props).
-
-Here might be some example properties.
-
- <Resource id="SuperbizMail" type="javax.mail.Session">
- mail.smtp.host=mail.superbiz.org
- mail.smtp.port=25
- mail.transport.protocol=smtp
- mail.smtp.auth=true
- mail.smtp.user=someuser
- password=mypassword
- </Resource>
-
-
-You can create as many <Resource> entries like this as you wish, they just
-have to have a unique 'id'.
-
-Careful not to add whitespace at the end of your property values. A
-java.util.Properties object will leave those in the property values and
-they will be passed to the JavaMail provider with the whitespace on the end
-which may cause issues if the provider does not actively trim the values
-before attempting to use them.
-
-# Overriding
-
-If you wanted to do a System property or InitialContext property override
-of the above example mail session, you could do so like this:
-
- java ... -DSuperbizMail.mail.smtp.host=localhost
-
-
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-logging-in-tests.adoc
----------------------------------------------------------------------
diff --git a/docs/configuring-logging-in-tests.adoc b/docs/configuring-logging-in-tests.adoc
new file mode 100644
index 0000000..6a3461a
--- /dev/null
+++ b/docs/configuring-logging-in-tests.adoc
@@ -0,0 +1,119 @@
+# Configuring Logging in Tests
+:index-group: Testing Techniques
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# embedded.logging.properties
+
+When in embedded mode OpenEJB uses an embedded.logging.properties file
+packed in our openejb-core jar which use to configure the logging. This
+logging configuration is a bit lighter than the conf/logging.properties
+file created in a full standalone OpenEJB setup.
+
+When searching for any config file in the classpath, multiple files with
+the same name may exist. OpenEJB will always attempt to favor the one
+closest to the openejb.base variable. This variable is set by default to
+the current directory where your vm is executing, which is more than
+likely the directory of your current module. So simply adding a file
+named embedded.logging.properties to your module may be all that you
+need to specify a new logging configuration for your tests.
+
+Alternatively, you can set "openejb.logger.external" to "true" as a
+system property (will not work as an InitialContext property). Then
+OpenEJB will not attempt to configure logging at all and you can
+configure logging with Log4j directly using any of its APIs; xml,
+properties, or code.
+
+There are a couple good reasons for _not_ replacing the
+embedded.logging.properties file.
+
+[arabic]
+. If you want to just change 5% of the logging settings, why take
+control over the other 95% as well.
+. We do occasionally add new logging categories. If you are not
+replacing the embedded.logging.properties you will pick these up
+automatically when you upgrade.
+
+# Overriding (recommended)
+
+As mentioned in link:embedded-configuration.html[Embedded Configuration]
+much can be done with simple overriding. The default
+embedded.logging.properties is quite good and there is really no need to
+replace it completely if all you want to do is tweak a few values.
+
+You can also put logging tweaks right in your InitialContext properties
+like so:
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.core.LocalInitialContextFactory");
+
+p.put("log4j.rootLogger", "fatal,C");
+p.put("log4j.category.OpenEJB", "warn");
+p.put("log4j.category.OpenEJB.options", "info");
+p.put("log4j.category.OpenEJB.server", "info");
+p.put("log4j.category.OpenEJB.startup", "info");
+p.put("log4j.category.OpenEJB.startup.service", "warn");
+p.put("log4j.category.OpenEJB.startup.config", "info");
+p.put("log4j.category.OpenEJB.hsql", "info");
+p.put("log4j.category.CORBA-Adapter", "info");
+p.put("log4j.category.Transaction", "warn");
+p.put("log4j.category.org.apache.activemq", "error");
+p.put("log4j.category.org.apache.geronimo", "error");
+p.put("log4j.category.openjpa", "error");
+p.put("log4j.appender.C", "org.apache.log4j.ConsoleAppender");
+p.put("log4j.appender.C.layout", "org.apache.log4j.SimpleLayout");
+
+Context context = new InitialContext(p);
+....
+
+Essentially, everything starting with "log4j." gets applied as overrides
+on top of the embedded.logging.properties we find in the classpath. This
+makes it possible to easily tweak the log levels while debugging a
+particular test.
+
+Note, that InitialContext properties can also be supplied in a
+jndi.properties file in the classpath or via system properties. The
+overriding order is as follows: 1 = highest, 4 = lowest.
+
+[arabic]
+. InitialContext properties
+. jndi.properties in classpath
+. system propertes
+. embedded.logging.properties in classpath
+
+By default there are no logging settings in 1-3, so #4 is the only
+source of logging information.
+
+# Default embedded.logging.properties contents
+
+For your purposes, here are the contents of the default
+embedded.logging.properties file contained in OpenEJB 3.1.1
+
+....
+log4j.rootLogger = fatal,C
+log4j.category.OpenEJB = warn
+log4j.category.OpenEJB.server = info
+log4j.category.OpenEJB.startup = info
+log4j.category.OpenEJB.startup.service = warn
+log4j.category.OpenEJB.startup.config = info
+log4j.category.OpenEJB.hsql = info
+log4j.category.CORBA-Adapter = info
+log4j.category.Transaction = warn
+log4j.category.org.apache.activemq = error
+log4j.category.org.apache.geronimo = error
+log4j.category.openjpa = error
+
+log4j.appender.C = org.apache.log4j.ConsoleAppender
+log4j.appender.C.layout = org.apache.log4j.SimpleLayout
+....
+
+Here is that file's location in svn as well as all of the previous
+versions. Future versions will follow the same pattern.
+
+* http://svn.apache.org/repos/asf/openejb/tags/openejb-3.1.1/container/openejb-core/src/main/resources/embedded.logging.properties
+* http://svn.apache.org/repos/asf/openejb/tags/openejb-3.1/container/openejb-core/src/main/resources/embedded.logging.properties
+* http://svn.apache.org/repos/asf/openejb/tags/openejb-3.0/container/openejb-core/src/main/resources/embedded.logging.properties
+* http://svn.apache.org/repos/asf/openejb/tags/openejb-3.0-beta-2/container/openejb-core/src/main/resources/embedded.logging.properties
+* http://svn.apache.org/repos/asf/openejb/tags/openejb-3.0-beta-1/container/openejb-core/src/main/resources/embedded.logging.properties
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-logging-in-tests.md
----------------------------------------------------------------------
diff --git a/docs/configuring-logging-in-tests.md b/docs/configuring-logging-in-tests.md
deleted file mode 100644
index 3ae519f..0000000
--- a/docs/configuring-logging-in-tests.md
+++ /dev/null
@@ -1,118 +0,0 @@
-index-group=Testing Techniques
-type=page
-status=published
-title=Configuring Logging in Tests
-~~~~~~
-<a name="ConfiguringLogginginTests-embedded.logging.properties"></a>
-# embedded.logging.properties
-
-When in embedded mode OpenEJB uses an embedded.logging.properties file
-packed in our openejb-core jar which use to configure the logging. This
-logging configuration is a bit lighter than the conf/logging.properties
-file created in a full standalone OpenEJB setup.
-
-When searching for any config file in the classpath, multiple files with
-the same name may exist. OpenEJB will always attempt to favor the one
-closest to the openejb.base variable. This variable is set by default to
-the current directory where your vm is executing, which is more than likely
-the directory of your current module. So simply adding a file named
-embedded.logging.properties to your module may be all that you need to
-specify a new logging configuration for your tests.
-
-Alternatively, you can set "openejb.logger.external" to "true" as a system
-property (will not work as an InitialContext property). Then OpenEJB will
-not attempt to configure logging at all and you can configure logging with
-Log4j directly using any of its APIs; xml, properties, or code.
-
-There are a couple good reasons for *not* replacing the
-embedded.logging.properties file.
-
-1. If you want to just change 5% of the logging settings, why take control
-over the other 95% as well.
-1. We do occasionally add new logging categories. If you are not replacing
-the embedded.logging.properties you will pick these up automatically when
-you upgrade.
-
-<a name="ConfiguringLogginginTests-Overriding(recommended)"></a>
-# Overriding (recommended)
-
-As mentioned in [Embedded Configuration](embedded-configuration.html)
- much can be done with simple overriding. The default
-embedded.logging.properties is quite good and there is really no need to
-replace it completely if all you want to do is tweak a few values.
-
-You can also put logging tweaks right in your InitialContext properties
-like so:
-
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.core.LocalInitialContextFactory");
-
- p.put("log4j.rootLogger", "fatal,C");
- p.put("log4j.category.OpenEJB", "warn");
- p.put("log4j.category.OpenEJB.options", "info");
- p.put("log4j.category.OpenEJB.server", "info");
- p.put("log4j.category.OpenEJB.startup", "info");
- p.put("log4j.category.OpenEJB.startup.service", "warn");
- p.put("log4j.category.OpenEJB.startup.config", "info");
- p.put("log4j.category.OpenEJB.hsql", "info");
- p.put("log4j.category.CORBA-Adapter", "info");
- p.put("log4j.category.Transaction", "warn");
- p.put("log4j.category.org.apache.activemq", "error");
- p.put("log4j.category.org.apache.geronimo", "error");
- p.put("log4j.category.openjpa", "error");
- p.put("log4j.appender.C", "org.apache.log4j.ConsoleAppender");
- p.put("log4j.appender.C.layout", "org.apache.log4j.SimpleLayout");
-
- Context context = new InitialContext(p);
-
-
-Essentially, everything starting with "log4j." gets applied as overrides on
-top of the embedded.logging.properties we find in the classpath. This
-makes it possible to easily tweak the log levels while debugging a
-particular test.
-
-Note, that InitialContext properties can also be supplied in a
-jndi.properties file in the classpath or via system properties. The
-overriding order is as follows: 1 = highest, 4 = lowest.
-
-1. InitialContext properties
-1. jndi.properties in classpath
-1. system propertes
-1. embedded.logging.properties in classpath
-
-By default there are no logging settings in 1-3, so #4 is the only source
-of logging information.
-
-<a name="ConfiguringLogginginTests-Defaultembedded.logging.propertiescontents"></a>
-# Default embedded.logging.properties contents
-
-For your purposes, here are the contents of the default
-embedded.logging.properties file contained in OpenEJB 3.1.1
-
-
- log4j.rootLogger = fatal,C
- log4j.category.OpenEJB = warn
- log4j.category.OpenEJB.server = info
- log4j.category.OpenEJB.startup = info
- log4j.category.OpenEJB.startup.service = warn
- log4j.category.OpenEJB.startup.config = info
- log4j.category.OpenEJB.hsql = info
- log4j.category.CORBA-Adapter = info
- log4j.category.Transaction = warn
- log4j.category.org.apache.activemq = error
- log4j.category.org.apache.geronimo = error
- log4j.category.openjpa = error
-
- log4j.appender.C = org.apache.log4j.ConsoleAppender
- log4j.appender.C.layout = org.apache.log4j.SimpleLayout
-
-
-Here is that file's location in svn as well as all of the previous
-versions. Future versions will follow the same pattern.
-
-- [http://svn.apache.org/repos/asf/openejb/tags/openejb-3.1.1/container/openejb-core/src/main/resources/embedded.logging.properties](http://svn.apache.org/repos/asf/openejb/tags/openejb-3.1.1/container/openejb-core/src/main/resources/embedded.logging.properties)
-- [http://svn.apache.org/repos/asf/openejb/tags/openejb-3.1/container/openejb-core/src/main/resources/embedded.logging.properties](http://svn.apache.org/repos/asf/openejb/tags/openejb-3.1/container/openejb-core/src/main/resources/embedded.logging.properties)
-- [http://svn.apache.org/repos/asf/openejb/tags/openejb-3.0/container/openejb-core/src/main/resources/embedded.logging.properties](http://svn.apache.org/repos/asf/openejb/tags/openejb-3.0/container/openejb-core/src/main/resources/embedded.logging.properties)
-- [http://svn.apache.org/repos/asf/openejb/tags/openejb-3.0-beta-2/container/openejb-core/src/main/resources/embedded.logging.properties](http://svn.apache.org/repos/asf/openejb/tags/openejb-3.0-beta-2/container/openejb-core/src/main/resources/embedded.logging.properties)
-- [http://svn.apache.org/repos/asf/openejb/tags/openejb-3.0-beta-1/container/openejb-core/src/main/resources/embedded.logging.properties](http://svn.apache.org/repos/asf/openejb/tags/openejb-3.0-beta-1/container/openejb-core/src/main/resources/embedded.logging.properties)
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-persistenceunits-in-tests.adoc
----------------------------------------------------------------------
diff --git a/docs/configuring-persistenceunits-in-tests.adoc b/docs/configuring-persistenceunits-in-tests.adoc
new file mode 100644
index 0000000..f499814
--- /dev/null
+++ b/docs/configuring-persistenceunits-in-tests.adoc
@@ -0,0 +1,157 @@
+# Configuring PersistenceUnits in Tests
+:index-group: Testing Techniques
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+# Overriding the
+persistence.xml
+
+The most common situation in EJB related testing by far is the need to
+alter your persistence.xml for a test environment.
+
+== Overriding the jta-data-source and non-jta-data-source
+
+OpenEJB will automatically use the DataSources you have setup in your
+test environment, we're pretty good at guessing the right DataSources
+you intend even if the names don't match exactly -- or in some cases at
+all. If there is only one DataSource configured, it's very easy for us
+to guess the DataSource to use.
+
+This allows you to keep your persistence.xml configured for your
+production environment and helps eliminate the need for a "test"
+persistence.xml (though we do have that functionality). A log line will
+be printed saying if we had to adjust the DataSources of your
+persistence.xml.
+
+== Overriding the persistence-unit properties
+
+You can override any property in your test setup via either system
+properties or the initial context properties. The format is:
+
+`<unit-name>.<property>=<value>`
+
+So for example with the following persistence.xml:
+
+....
+<persistence>
+ <persistence-unit name="movie-unit">
+ <provider>org.hibernate.ejb.HibernatePersistence</provider>
+ <jta-data-source>movieDatabase</jta-data-source>
+ <non-jta-data-source>movieDatabaseUnmanaged</non-jta-data-source>
+ <properties>
+ <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
+ <property name="hibernate.max_fetch_depth" value="3"/>
+ </properties>
+ </persistence-unit>
+</persistence>
+....
+
+You can override and add persistence unit properties in your test case.
+There are currently no facilities for removing them (if you have a need
+for that let us know -- it hasn't really come up so far).
+
+....
+Properties p = new Properties();
+p.put(Context.INITIAL_CONTEXT_FACTORY,"org.apache.openejb.client.LocalInitialContextFactory");
+
+p.put("movie-unit.hibernate.hbm2ddl.auto", "update");
+p.put("movie-unit.hibernate.dialect", "org.hibernate.dialect.HSQLDialect");
+
+context = new InitialContext(p);
+....
+
+The overriding order is as follows: 1 = highest, 4 = lowest.
+
+[arabic]
+. InitialContext properties
+. jndi.properties from the classpath
+. System properties
+. persistence.xml properties
+
+By default there are no overrides in 1-3, so #4 is the only source of
+information.
+
+In the above example there would be exactly three properties for the
+"movie-unit" persistence unit:
+
+* hibernate.hbm2ddl.auto = update
+* hibernate.max_fetch_depth = 3
+* hibernate.dialect = org.hibernate.dialect.HSQLDialect
+
+These properties would be passed by OpenEJB directly to the persistence
+provider (in this case Hibernate). With one exception OpenEJB does not
+understand or modify these properties. Details on that one exception
+below.
+
+== Common mistakes
+
+Note that you *must* use the *unit name* as the prefix. This will not
+work:
+
+....
+ Properties p = new Properties();
+ p.put(Context.INITIAL_CONTEXT_FACTORY,"org.apache.openejb.client.LocalInitialContextFactory");
+
+ p.put("hibernate.hbm2ddl.auto", "update");
+ p.put("hibernate.dialect", "org.hibernate.dialect.HSQLDialect");
+
+ context = new InitialContext(p);
+....
+
+Currently, only properties that start with the unit name are search and
+applied.
+
+== No need to specify a "transaction lookup" property
+
+All vendors have such a property for getting a reference to the
+container's TransactionManager and nothing works if this is not set
+correctly to the OpenEJB specific class. To make the lives of users
+easier, OpenEJB will take the liberty of setting it for you.
+
+Here are the persistence provider classes we understand and the defaults
+we will set for you:
+
+=== Provider org.hibernate.ejb.HibernatePersistence
+
+When using this provider, the
+_hibernate.transaction.manager_lookup_class_ will be automatically set
+by OpenEJB to _org.apache.openejb.hibernate.TransactionManagerLookup_.
+If the property is already set in the persistence unit it will be
+overwritten if it starts with the standard "org.hibernate.transaction."
+prefix.
+
+Custom lookup implementations will never be overwritten automatically.
+
+=== Provider oracle.toplink.essentials.PersistenceProvider
+
+Or _oracle.toplink.essentials.ejb.cmp3.EntityManagerFactoryProvider_.
+
+When using this provider, the _toplink.target-server_ will be
+automatically set by OpenEJB to
+_org.apache.openejb.toplink.JTATransactionController_. If the property
+is already set in the persistence unit it will be overwritten if it
+starts with the standard "oracle.toplink.transaction." prefix.
+
+Custom transaction controller implementations will never be overwritten
+automatically.
+
+=== Provider org.eclipse.persistence.jpa.PersistenceProvider
+
+Or _org.eclipse.persistence.jpa.osgi.PersistenceProvider_.
+
+When using this provider, the _eclipselink.target-server_ will be
+automatically set by OpenEJB to
+_org.apache.openejb.eclipselink.JTATransactionController_. If the
+property is already set in the persistence unit it will be overwritten
+if it starts with the standard "org.eclipse.persistence.transaction."
+prefix.
+
+Custom transaction controller implementations will never be overwritten
+automatically.
+
+=== Provider org.apache.openjpa.persistence.PersistenceProviderImpl
+
+OpenJPA is capable of discovering the correct method for locating the
+TransactionManager without the need for users to specify the specific
+strategy. Therefore no specific "magic" is required.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/configuring-persistenceunits-in-tests.md
----------------------------------------------------------------------
diff --git a/docs/configuring-persistenceunits-in-tests.md b/docs/configuring-persistenceunits-in-tests.md
deleted file mode 100644
index a8e9777..0000000
--- a/docs/configuring-persistenceunits-in-tests.md
+++ /dev/null
@@ -1,144 +0,0 @@
-index-group=Testing Techniques
-type=page
-status=published
-title=Configuring PersistenceUnits in Tests
-~~~~~~
-<a name="ConfiguringPersistenceUnitsinTests-Overridingthepersistence.xml"></a>
-# Overriding the persistence.xml
-
-The most common situation in EJB related testing by far is the need to
-alter your persistence.xml for a test environment.
-
-<a name="ConfiguringPersistenceUnitsinTests-Overridingthe<jta-data-source>and<non-jta-data-source>"></a>
-## Overriding the jta-data-source and non-jta-data-source
-
-OpenEJB will automatically use the DataSources you have setup in your test
-environment, we're pretty good at guessing the right DataSources you intend
-even if the names don't match exactly -- or in some cases at all. If there
-is only one DataSource configured, it's very easy for us to guess the
-DataSource to use.
-
-This allows you to keep your persistence.xml configured for your production
-environment and helps eliminate the need for a "test" persistence.xml
-(though we do have that functionality). A log line will be printed saying
-if we had to adjust the DataSources of your persistence.xml.
-
-<a name="ConfiguringPersistenceUnitsinTests-Overridingthepersistence-unit<properties>"></a>
-## Overriding the persistence-unit properties
-
-You can override any property in your test setup via either system
-properties or the initial context properties. The format is:
-
-`<unit-name>.<property>=<value>`
-
-So for example with the following persistence.xml:
-
- <persistence>
- <persistence-unit name="movie-unit">
- <provider>org.hibernate.ejb.HibernatePersistence</provider>
- <jta-data-source>movieDatabase</jta-data-source>
- <non-jta-data-source>movieDatabaseUnmanaged</non-jta-data-source>
- <properties>
- <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
- <property name="hibernate.max_fetch_depth" value="3"/>
- </properties>
- </persistence-unit>
- </persistence>
-
-
-You can override and add persistence unit properties in your test case.
-There are currently no facilities for removing them (if you have a need for
-that let us know -- it hasn't really come up so far).
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY,"org.apache.openejb.client.LocalInitialContextFactory");
-
- p.put("movie-unit.hibernate.hbm2ddl.auto", "update");
- p.put("movie-unit.hibernate.dialect", "org.hibernate.dialect.HSQLDialect");
-
- context = new InitialContext(p);
-
-The overriding order is as follows: 1 = highest, 4 = lowest.
-
-1. InitialContext properties
-1. jndi.properties from the classpath
-1. System properties
-1. persistence.xml properties
-
-By default there are no overrides in 1-3, so #4 is the only source of
-information.
-
-In the above example there would be exactly three properties for the "movie-unit" persistence unit:
-
- - hibernate.hbm2ddl.auto = update
- - hibernate.max_fetch_depth = 3
- - hibernate.dialect = org.hibernate.dialect.HSQLDialect
-
-These properties would be passed by OpenEJB directly to the persistence
-provider (in this case Hibernate). With one exception OpenEJB does not
-understand or modify these properties. Details on that one exception
-below.
-
-### Common mistakes
-
-Note that you **must** use the **unit name** as the prefix. This will not work:
-
- Properties p = new Properties();
- p.put(Context.INITIAL_CONTEXT_FACTORY,"org.apache.openejb.client.LocalInitialContextFactory");
-
- p.put("hibernate.hbm2ddl.auto", "update");
- p.put("hibernate.dialect", "org.hibernate.dialect.HSQLDialect");
-
- context = new InitialContext(p);
-
-Currently, only properties that start with the unit name are search and applied.
-
-### No need to specify a "transaction lookup" property
-
-All vendors have such a property for getting a reference to the container's
-TransactionManager and nothing works if this is not set correctly to the
-OpenEJB specific class. To make the lives of users easier, OpenEJB will
-take the liberty of setting it for you.
-
-Here are the persistence provider classes we understand and the defaults we
-will set for you:
-
-#### Provider org.hibernate.ejb.HibernatePersistence
-
-When using this provider, the *hibernate.transaction.manager_lookup_class*
-will be automatically set by OpenEJB to
-_org.apache.openejb.hibernate.TransactionManagerLookup_. If the property
-is already set in the persistence unit it will be overwritten if it starts
-with the standard "org.hibernate.transaction." prefix.
-
-Custom lookup implementations will never be overwritten automatically.
-
-#### Provider oracle.toplink.essentials.PersistenceProvider
-
-Or _oracle.toplink.essentials.ejb.cmp3.EntityManagerFactoryProvider_.
-
-When using this provider, the *toplink.target-server* will be automatically
-set by OpenEJB to _org.apache.openejb.toplink.JTATransactionController_.
-If the property is already set in the persistence unit it will be
-overwritten if it starts with the standard "oracle.toplink.transaction."
-prefix.
-
-Custom transaction controller implementations will never be overwritten automatically.
-
-#### Provider org.eclipse.persistence.jpa.PersistenceProvider
-
-Or _org.eclipse.persistence.jpa.osgi.PersistenceProvider_.
-
-When using this provider, the *eclipselink.target-server* will be
-automatically set by OpenEJB to
-_org.apache.openejb.eclipselink.JTATransactionController_. If the property
-is already set in the persistence unit it will be overwritten if it starts
-with the standard "org.eclipse.persistence.transaction." prefix.
-
-Custom transaction controller implementations will never be overwritten automatically.
-
-#### Provider org.apache.openjpa.persistence.PersistenceProviderImpl
-
-OpenJPA is capable of discovering the correct method for locating the
-TransactionManager without the need for users to specify the specific
-strategy. Therefore no specific "magic" is required.
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/constructor-injection.adoc
----------------------------------------------------------------------
diff --git a/docs/constructor-injection.adoc b/docs/constructor-injection.adoc
new file mode 100644
index 0000000..abe0531
--- /dev/null
+++ b/docs/constructor-injection.adoc
@@ -0,0 +1,100 @@
+# Constructor Injection
+:index-group: Unrevised
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+For those of you who would like to use final fields,
+wish to avoid numerous setters, or dislike private field injection and
+would like nothing more than to just use plan old java constructors,
+your wish has come true. This is a feature we intended to add to OpenEJB
+3.0 but didn't have time for. We're happy to bring it to the OpenEJB 3.1
+release and with a bit of luck and support from people like yourself,
+we'll see this as an EJB 3.1 feature as well.
+
+....
+@Stateless
+public class WidgetBean implements Widget {
+
+ @EJB(beanName = "FooBean")
+ private final Foo foo;
+
+ @Resource(name = "count")
+ private final int count;
+
+ @Resource
+ private final DataSource ds;
+
+ public WidgetBean(Integer count, Foo foo, DataSource ds) {
+ this.count = count;
+ this.foo = foo;
+ this.ds = ds;
+ }
+
+ public int getCount() {
+ return count;
+ }
+
+ public Foo getFoo() {
+ return foo;
+ }
+}
+....
+
+The @EJB, @Resource, @PersistenceUnit, and @PersistenceContext
+annotations can be placed at the class-level instead such as:
+
+....
+@Stateless
+@EJB(name = "foo", beanInterface = Foo.class, beanName = "FooBean")
+@Resource(name = "count", type = int.class)
+@Resource(name = "ds", type = DataSource.class)
+public class WidgetBean implements Widget {
+
+ public WidgetBean(Integer count, Foo foo, DataSource ds) {
+ // do something
+ }
+
+ public int getCount() {
+ return count;
+ }
+
+ public Foo getFoo() {
+ return foo;
+ }
+}
+....
+
+Currently this functionality relies on classes being compiled with debug
+symbols (the default compile setting for javac) as we use the debug
+table in the byte code to discover the constructor arg names.
+Additionally, you must not have a no-arg constructor. If a no-arg
+constructor is present, that constructor will be used instead.
+
+Ideally, we would like the annotations to be used on the parameters
+directly as shown below. Unfortunately, this does not work as the Java
+EE annotation classes do not permit usage on parameters. If you'd like
+to see that change as much as we do, definitely voice your support by
+sending note to
+mailto:jsr-316-comments@jcp.org.html[jsr-316-comments@jcp.org]
+
+Not yet possible
+
+....
+@Stateless
+
+public class WidgetBean implements Widget {
+
+ public WidgetBean(@Resource(name = "count") Integer count, @EJB Foo foo, @Resource DataSource ds) {
+ // do something
+ }
+
+ public int getCount() {
+ return count;
+ }
+
+ public Foo getFoo() {
+ return foo;
+ }
+}
+....
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/constructor-injection.md
----------------------------------------------------------------------
diff --git a/docs/constructor-injection.md b/docs/constructor-injection.md
deleted file mode 100644
index c0a5b4c..0000000
--- a/docs/constructor-injection.md
+++ /dev/null
@@ -1,98 +0,0 @@
-index-group=Unrevised
-type=page
-status=published
-title=Constructor Injection
-~~~~~~
-For those of you who would like to use final fields, wish to avoid numerous
-setters, or dislike private field injection and would like nothing more
-than to just use plan old java constructors, your wish has come true. This
-is a feature we intended to add to OpenEJB 3.0 but didn't have time for.
-We're happy to bring it to the OpenEJB 3.1 release and with a bit of luck
-and support from people like yourself, we'll see this as an EJB 3.1 feature
-as well.
-
-
- @Stateless
- public class WidgetBean implements Widget {
-
- @EJB(beanName = "FooBean")
- private final Foo foo;
-
- @Resource(name = "count")
- private final int count;
-
- @Resource
- private final DataSource ds;
-
- public WidgetBean(Integer count, Foo foo, DataSource ds) {
- this.count = count;
- this.foo = foo;
- this.ds = ds;
- }
-
- public int getCount() {
- return count;
- }
-
- public Foo getFoo() {
- return foo;
- }
- }
-
-
-The @EJB, @Resource, @PersistenceUnit, and @PersistenceContext annotations
-can be placed at the class-level instead such as:
-
-
- @Stateless
- @EJB(name = "foo", beanInterface = Foo.class, beanName = "FooBean")
- @Resource(name = "count", type = int.class)
- @Resource(name = "ds", type = DataSource.class)
- public class WidgetBean implements Widget {
-
- public WidgetBean(Integer count, Foo foo, DataSource ds) {
- // do something
- }
-
- public int getCount() {
- return count;
- }
-
- public Foo getFoo() {
- return foo;
- }
- }
-
-
-
-Currently this functionality relies on classes being compiled with debug
-symbols (the default compile setting for javac) as we use the debug table
-in the byte code to discover the constructor arg names. Additionally, you
-must not have a no-arg constructor. If a no-arg constructor is present,
-that constructor will be used instead.
-
-Ideally, we would like the annotations to be used on the parameters
-directly as shown below. Unfortunately, this does not work as the Java EE
-annotation classes do not permit usage on parameters. If you'd like to see
-that change as much as we do, definitely voice your support by sending note
-to [jsr-316-comments@jcp.org](mailto:jsr-316-comments@jcp.org.html)
-
-
-Not yet possible
-
- @Stateless
-
- public class WidgetBean implements Widget {
-
- public WidgetBean(@Resource(name = "count") Integer count, @EJB Foo foo, @Resource DataSource ds) {
- // do something
- }
-
- public int getCount() {
- return count;
- }
-
- public Foo getFoo() {
- return foo;
- }
- }
http://git-wip-us.apache.org/repos/asf/tomee/blob/6972efbb/docs/containers-and-resources.adoc
----------------------------------------------------------------------
diff --git a/docs/containers-and-resources.adoc b/docs/containers-and-resources.adoc
new file mode 100644
index 0000000..1bb00d7
--- /dev/null
+++ b/docs/containers-and-resources.adoc
@@ -0,0 +1,473 @@
+# Containers and Resources
+:index-group: Configuration
+:jbake-date: 2018-12-05
+:jbake-type: page
+:jbake-status: published
+
+
+....
+ <p><a name="ContainersandResources-containers"></a></p>
+....
+
+CMP_ENTITY
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Container?type=CMP_ENTITY
+
+Supports the following properties
+
+Property Name
+
+Description
+
+CmpEngineFactory
+
+Default value is org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory.
+
+TransactionManager
+
+Declarable in tomee.xml via
+
+Supports the following properties
+
+Property Name
+
+Description
+
+defaultTransactionTimeoutSeconds
+
+Default value is 10 minutes.
+
+BMP_ENTITY
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Container?type=BMP_ENTITY
+
+Supports the following properties
+
+Property Name
+
+Description
+
+PoolSize
+
+Specifies the size of the bean pools for this bmp entity container.
+Default value is 10.
+
+STATELESS
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Container?type=STATELESS
+
+Supports the following properties
+
+Property Name
+
+Description
+
+TimeOut
+
+Specifies the time to wait between invocations. This value is measured
+in milliseconds. A value of 5 would result in a time-out of 5
+milliseconds between invocations. A value of zero would mean no timeout.
+Default value is 0.
+
+PoolSize
+
+Specifies the size of the bean pools for this stateless SessionBean
+container. Default value is 10.
+
+StrictPooling
+
+StrictPooling tells the container what to do when the pool reaches it's
+maximum size and there are incoming requests that need instances. With
+strict pooling, requests will have to wait for instances to become
+available. The pool size will never grow beyond the the set PoolSize
+value. Without strict pooling, the container will create temporary
+instances to meet demand. The instances will last for just one method
+invocation and then are removed. Default value is true.
+
+STATEFUL
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Container?type=STATEFUL
+
+Supports the following properties
+
+Property Name
+
+Description
+
+Passivator
+
+The passivator is responsible for writing beans to disk at passivation
+time. Different passivators can be used by setting this property to the
+fully qualified class name of the PassivationStrategy implementation.
+The passivator is not responsible for invoking any callbacks or other
+processing, its only responsibly is to write the bean state to disk.
+Known implementations: org.apache.openejb.core.stateful.RAFPassivater
+org.apache.openejb.core.stateful.SimplePassivater Default value is
+org.apache.openejb.core.stateful.SimplePassivater.
+
+TimeOut
+
+Specifies the time to wait between invocations. This value is measured
+in minutes. A value of 5 would result in a time-out of 5 minutes between
+invocations. A value of zero would mean no timeout. Default value is 20.
+
+PoolSize
+
+Specifies the size of the bean pools for this stateful SessionBean
+container. Default value is 1000.
+
+BulkPassivate
+
+Property name that specifies the number of instances to passivate at one
+time when doing bulk passivation. Default value is 100.
+
+MESSAGE
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Container?type=MESSAGE
+
+Supports the following properties
+
+Property Name
+
+Description
+
+ResourceAdapter
+
+The resource adapter delivers messages to the container Default value is
+Default JMS Resource Adapter.
+
+MessageListenerInterface
+
+Specifies the message listener interface handled by this container
+Default value is javax.jms.MessageListener.
+
+ActivationSpecClass
+
+Specifies the activation spec class Default value is
+org.apache.activemq.ra.ActiveMQActivationSpec.
+
+InstanceLimit
+
+Specifies the maximum number of bean instances that are allowed to exist
+for each MDB deployment. Default value is 10.
+
+Resources
+
+javax.sql.DataSource
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Resource?type=javax.sql.DataSource
+
+Supports the following properties
+
+Property Name
+
+Description
+
+JtaManaged
+
+Determines wether or not this data source should be JTA managed or user
+managed. If set to 'true' it will automatically be enrolled in any
+ongoing transactions. Calling begin/commit/rollback or setAutoCommit on
+the datasource or connection will not be allowed. If you need to
+perform these functions yourself, set JtaManaged to 'false' In terms of
+JPA persistence.xml: "JtaManaged=true" can be used as a
+'jta-data-source' "JtaManaged=false" can be used as a
+'non-jta-data-source' Default value is true.
+
+JdbcDriver
+
+Driver class name Default value is org.hsqldb.jdbcDriver.
+
+JdbcUrl
+
+Url for creating connections Default value is
+jdbc:hsqldb:file:data/hsqldb/hsqldb.
+
+UserName
+
+Default user name Default value is sa.
+
+Password
+
+Default password
+
+ConnectionProperties
+
+The connection properties that will be sent to the JDBC driver when
+establishing new connections Format of the string must be
+[propertyName=property;]* NOTE - The "user" and "password" properties
+will be passed explicitly, so they do not need to be included here.
+
+DefaultAutoCommit
+
+The default auto-commit state of new connections Default value is true.
+
+DefaultReadOnly
+
+The default read-only state of new connections If not set then the
+setReadOnly method will not be called. (Some drivers don't support read
+only mode, ex: Informix)
+
+DefaultTransactionIsolation
+
+The default TransactionIsolation state of new connections If not set
+then the setTransactionIsolation method will not be called. The allowed
+values for this property are: NONE READ_COMMITTED
+READ_UNCOMMITTED REPEATABLE_READ SERIALIZABLE Note: Most JDBC
+drivers do not support all isolation levels
+
+InitialSize
+
+The initial number of connections that are created when the pool is
+started Default value is 0.
+
+MaxActive
+
+The maximum number of active connections that can be allocated from this
+pool at the same time, or a negative number for no limit. Default value
+is 20.
+
+MaxIdle
+
+The maximum number of connections that can remain idle in the pool,
+without extra ones being released, or a negative number for no limit.
+Default value is 20.
+
+MinIdle
+
+The minimum number of connections that can remain idle in the pool,
+without extra ones being created, or zero to create none. Default value
+is 0.
+
+MaxWait
+
+The maximum number of milliseconds that the pool will wait (when there
+are no available connections) for a connection to be returned before
+throwing an exception, or -1 to wait indefinitely. Default value is -1.
+
+ValidationQuery
+
+The SQL query that will be used to validate connections from this pool
+before returning them to the caller. If specified, this query MUST be an
+SQL SELECT statement that returns at least one row.
+
+TestOnBorrow
+
+If true connections will be validated before being borrowed from the
+pool. If the validation fails, the connection is destroyed, and a new
+conection will be retrieved from the pool (and validated). NOTE - for a
+true value to have any effect, the ValidationQuery parameter must be
+set. Default value is true.
+
+TestOnReturn
+
+If true connections will be validated before being returned to the
+pool. If the validation fails, the connection is destroyed instead of
+being returned to the pool. NOTE - for a true value to have any effect,
+the ValidationQuery parameter must be set. Default value is false.
+
+TestWhileIdle
+
+If true connections will be validated by the idle connection evictor (if
+any). If the validation fails, the connection is destroyed and removed
+from the pool NOTE - for a true value to have any effect, the
+timeBetweenEvictionRunsMillis property must be a positive number and the
+ValidationQuery parameter must be set. Default value is false.
+
+TimeBetweenEvictionRunsMillis
+
+The number of milliseconds to sleep between runs of the idle connection
+evictor thread. When set to a negative number, no idle connection
+evictor thread will be run. Default value is -1.
+
+NumTestsPerEvictionRun
+
+The number of connectionss to examine during each run of the idle
+connection evictor thread (if any). Default value is 3.
+
+MinEvictableIdleTimeMillis
+
+The minimum amount of time a connection may sit idle in the pool before
+it is eligable for eviction by the idle connection evictor (if any).
+Default value is 1800000.
+
+PoolPreparedStatements
+
+If true, a statement pool is created for each Connection and
+PreparedStatements created by one of the following methods are
+pooled: public PreparedStatement prepareStatement(String
+sql); public PreparedStatement prepareStatement(String
+sql, int resultSetType, int resultSetConcurrency)
+Default value is false.
+
+MaxOpenPreparedStatements
+
+The maximum number of open statements that can be allocated from the
+statement pool at the same time, or zero for no limit. NOTE - Some
+drivers have limits on the number of open statements, so make sure there
+are some resources left for the other (non-prepared) statements. Default
+value is 0.
+
+AccessToUnderlyingConnectionAllowed
+
+If true the raw physical connection to the database can be accessed
+using the following construct: Connection conn =
+ds.getConnection(); Connection rawConn = ((DelegatingConnection)
+conn).getInnermostDelegate(); ... conn.close() Default is false,
+because misbehaving programs can do harmfull things to the raw
+connection shuch as closing the raw connection or continuing to use the
+raw connection after it has been assigned to another logical
+connection. Be carefull and only use when you need direct access to
+driver specific extentions. NOTE: Do NOT close the underlying
+connection, only the original logical connection wrapper. Default value
+is false.
+
+ActiveMQResourceAdapter
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Resource?type=ActiveMQResourceAdapter
+
+Supports the following properties
+
+Property Name
+
+Description
+
+BrokerXmlConfig
+
+Broker configuration Default value is
+broker:(tcp://localhost:61616)?useJmx=false.
+
+ServerUrl
+
+Broker address Default value is vm://localhost?async=true.
+
+DataSource
+
+DataSource for persistence messages Default value is Default Unmanaged
+JDBC Database.
+
+javax.jms.ConnectionFactory
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Resource?type=javax.jms.ConnectionFactory
+
+Supports the following properties
+
+Property Name
+
+Description
+
+ResourceAdapter
+
+Default value is Default JMS Resource Adapter.
+
+TransactionSupport
+
+Specifies if the connection is enrolled in global transaction allowed
+values: xa, local or none Default value is xa.
+
+PoolMaxSize
+
+Maximum number of physical connection to the ActiveMQ broker Default
+value is 10.
+
+PoolMinSize
+
+Minimum number of physical connection to the ActiveMQ broker Default
+value is 0.
+
+ConnectionMaxWaitMilliseconds
+
+Maximum amount of time to wait for a connection Default value is 5000.
+
+ConnectionMaxIdleMinutes
+
+Maximum amount of time a connection can be idle before being reclaimed
+Default value is 15.
+
+javax.jms.Queue
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Resource?type=javax.jms.Queue
+
+Supports the following properties
+
+Property Name
+
+Description
+
+destination
+
+Specifies the name of the queue
+
+javax.jms.Topic
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Resource?type=javax.jms.Topic
+
+Supports the following properties
+
+Property Name
+
+Description
+
+destination
+
+Specifies the name of the topic
+
+org.omg.CORBA.ORB
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Resource?type=org.omg.CORBA.ORB
+
+No properties.
+
+javax.mail.Session
+
+Declarable in tomee.xml via
+
+Declarable in properties via
+
+Foo = new://Resource?type=javax.mail.Session
+
+No properties.