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>
