TOMEE-2316 Convert Markdown files to Asciidoc in the docs folder - 12
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/4dd89bdf Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/4dd89bdf Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/4dd89bdf Branch: refs/heads/master Commit: 4dd89bdf5b7fb47025c043939ed6beadd7c24a98 Parents: 388460f Author: Carlos Chacin <[email protected]> Authored: Wed Dec 5 22:07:28 2018 -0800 Committer: Carlos Chacin <[email protected]> Committed: Wed Dec 5 22:07:28 2018 -0800 ---------------------------------------------------------------------- docs/tomee-directory-structure.adoc | 25 + docs/tomee-directory-structure.md | 61 -- docs/tomee-embedded-maven-plugin.adoc | 788 ++++++++++++++++++++++++ docs/tomee-embedded-maven-plugin.md | 959 ----------------------------- docs/tomee-jaas.adoc | 88 +++ docs/tomee-jaas.md | 73 --- docs/tomee-logging-in-eclipse.adoc | 18 + docs/tomee-logging-in-eclipse.md | 13 - docs/tomee-logging.adoc | 32 + docs/tomee-logging.md | 33 - docs/tomee-maven-plugin.adoc | 175 ++++++ docs/tomee-maven-plugin.md | 148 ----- docs/tomee-mp-getting-started.adoc | 98 +++ docs/tomee-mp-getting-started.md | 65 -- docs/tomee-version-policies.adoc | 55 ++ docs/tomee-version-policies.md | 28 - docs/tomee-webaccess.adoc | 18 + docs/tomee-webaccess.md | 21 - docs/tomee-webapp.adoc | 73 +++ docs/tomee-webapp.md | 62 -- 20 files changed, 1370 insertions(+), 1463 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-directory-structure.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-directory-structure.adoc b/docs/tomee-directory-structure.adoc new file mode 100644 index 0000000..3ba8e36 --- /dev/null +++ b/docs/tomee-directory-structure.adoc @@ -0,0 +1,25 @@ +: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. + +#TomEE Directory Layout: + +TomEE directory layout is the same as that of Tomcat, with a few changes +as described below. + +Considering this root to be the $tomee-install-dir> http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-directory-structure.md ---------------------------------------------------------------------- diff --git a/docs/tomee-directory-structure.md b/docs/tomee-directory-structure.md deleted file mode 100644 index 0232eae..0000000 --- a/docs/tomee-directory-structure.md +++ /dev/null @@ -1,61 +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. - -#TomEE Directory Layout: - -TomEE directory layout is the same as that of Tomcat, with a few changes as described below. - -Considering this root to be the $tomee-install-dir> - -<pre> -/bin - Added tomee.sh (Access all TomEE tools: cipher, deploy, properties, undeploy) - Added TomEE.*.exe (Windows service binaries) - Added service*.bat (Windows service installer - uses binaries above) - Modified catalina.(sh|bat) (Optional - add the OpenJPA javaagent to enhance JPA entities. Only necessary if you use both JPA and the OpenJPA implementation and you did not enhance bytecode at build time) - -/conf - Added system.properties (Easy way to configure whatever you want on TomEE. Check it out and look into, you will discover so many interesting properties) - Added tomee.xml (The place where you can declare/configure resources, containers, Transaction manager, etc) - Modified server.xml (As in tomcat with one extra listener - can configure ports, hosts, engines, threadpools etc) - Modified tomcat-users.xml (optional - only changed to define tomee user to secure the webapp/tomee GUI) - -/endorsed - Added annotation-api.jar (Override Tomcat default jar, because not compliant with the current JEE 6 specification) - Added jaxb-(api|impl).jar (Override JDK 1.6 default implementation cause too old for the JEE 6 specification) - -/lib - That's where all the magic is. This directory will receive a set of new jars. First, it gets all openejb-* and tomee-* jars. It also contains dependencies (Specification implementations: openjpa-*, openwebbeans-*, etc). - Removed annotation-api.jar (Non compliant with JEE 6 specification. See endorsed/) - Removed el-api.jar (Already contained in javaee-api.jar provided by TomEE in that same directory) - -/webapps - Works the same way as it does for Tomcat. Drop your directories/wars in here! - Removed examples (Just because most of people does not care) - -/apps (does not exist by default) - Can receive WARs of course, but also JAR and EAR files. Optionally add your resources.xml file here. - -/webapps/tomee (added but optional) - The TomEE graphical user interface. That's the administration interface. - ** This webapp is mandatory if you need EJBs remote invocation -</pre> http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-embedded-maven-plugin.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-embedded-maven-plugin.adoc b/docs/tomee-embedded-maven-plugin.adoc new file mode 100644 index 0000000..e9cfad5 --- /dev/null +++ b/docs/tomee-embedded-maven-plugin.adoc @@ -0,0 +1,788 @@ +:index-group: TomEE +Maven Plugin +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published +:jbake-title: TomEE Embedded Maven Plugin + + +link:tomee-maven-plugin.html[TomEE Maven Plugin] provides a nice way to +run "as in production" a server fully configured keeping the +configuration in the project (easiness of sharing between team members). +However for modern web development the fact to run the "exploded war" +prevents to develop web resources in place. TomEE embedded maven plugin +solves it directly allowing to directly deploy the war project in place +using "classpath as war" option. + +It also allows to use a flat classpath deployment which is often use +with microservices. + +tomee-embedded:run + +Full name: + +org.apache.tomee.maven:tomee-embedded-maven-plugin:7.0.0-M1:run + +Description: + +Run an Embedded 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 + +ajpPort + +int + +- + +(no description)Default value is: 8009.User property is: +tomee-embedded-plugin.ajp. + +applicationCopyFolder + +File + +- + +(no description)Default value is: +$\{project.build.directory}/tomee-embedded/applications.User property +is: tomee-plugin.application-copy. + +applicationScopes + +List + +- + +(no description) + +applications + +List + +- + +(no description) + +classpathAsWar + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-embedded-plugin.classpathAsWar. + +clientAuth + +String + +- + +(no description)User property is: tomee-embedded-plugin.clientAuth. + +containerProperties + +Map + +- + +(no description) + +context + +String + +- + +(no description)User property is: tomee-embedded-plugin.context. + +dir + +String + +- + +(no description)Default value is: +$\{project.build.directory}/apache-tomee-embedded.User property is: +tomee-embedded-plugin.lib. + +docBase + +File + +- + +(no description)Default value is: +$\{project.basedir}/src/main/webapp.User property is: +tomee-embedded-plugin.docBase. + +forceJspDevelopment + +boolean + +- + +force webapp to be reloadableDefault value is: true.User property is: +tomee-plugin.jsp-development. + +host + +String + +- + +(no description)Default value is: localhost.User property is: +tomee-embedded-plugin.host. + +httpPort + +int + +- + +(no description)Default value is: 8080.User property is: +tomee-embedded-plugin.http. + +httpsPort + +int + +- + +(no description)Default value is: 8443.User property is: +tomee-embedded-plugin.httpsPort. + +inlinedServerXml + +PlexusConfiguration + +- + +(no description) + +inlinedTomEEXml + +PlexusConfiguration + +- + +(no description) + +keepServerXmlAsThis + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-embedded-plugin.keepServerXmlAsThis. + +keyAlias + +String + +- + +(no description)User property is: tomee-embedded-plugin.keyAlias. + +keystoreFile + +String + +- + +(no description)User property is: tomee-embedded-plugin.keystoreFile. + +keystorePass + +String + +- + +(no description)User property is: tomee-embedded-plugin.keystorePass. + +keystoreType + +String + +- + +(no description)Default value is: JKS.User property is: +tomee-embedded-plugin.keystoreType. + +mavenLog + +boolean + +- + +(no description)Default value is: true.User property is: +tomee-embedded-plugin.mavenLog. + +modules + +List + +- + +(no description)Default value is: $\{project.build.outputDirectory}.User +property is: tomee-embedded-plugin.modules. + +packaging + +String + +- + +(no description)Default value is: $\{project.packaging}. + +quickSession + +boolean + +- + +(no description)Default value is: true.User property is: +tomee-embedded-plugin.quickSession. + +roles + +Map + +- + +(no description) + +serverXml + +File + +- + +(no description) + +skipCurrentProject + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-plugin.skip-current-project. + +skipHttp + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-embedded-plugin.skipHttp. + +ssl + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-embedded-plugin.ssl. + +sslProtocol + +String + +- + +(no description)User property is: tomee-embedded-plugin.sslProtocol. + +stopPort + +int + +- + +(no description)Default value is: 8005.User property is: +tomee-embedded-plugin.stop. + +useProjectClasspath + +boolean + +- + +(no description)Default value is: true.User property is: +tomee-embedded-plugin.useProjectClasspath. + +users + +Map + +- + +(no description) + +warFile + +File + +- + +(no description)Default value is: +latexmath:[${project.build.directory}/$]\{project.build.finalName}. + +webResourceCached + +boolean + +- + +(no description)Default value is: true.User property is: +tomee-embedded-plugin.webResourceCached. + +withEjbRemote + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-embedded-plugin.withEjbRemote. + +workDir + +File + +- + +(no description)Default value is: +$\{project.build.directory}/tomee-embedded-work.User property is: +tomee-plugin.work. + +Parameter Details + +ajpPort: + +(no description) + +Type: int + +Required: No + +User Property: tomee-embedded-plugin.ajp + +Default: 8009 + +applicationCopyFolder: + +(no description) + +Type: java.io.File + +Required: No + +User Property: tomee-plugin.application-copy + +Default: $\{project.build.directory}/tomee-embedded/applications + +applicationScopes: + +(no description) + +Type: java.util.List + +Required: No + +applications: + +(no description) + +Type: java.util.List + +Required: No + +classpathAsWar: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-embedded-plugin.classpathAsWar + +Default: false + +clientAuth: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-embedded-plugin.clientAuth + +containerProperties: + +(no description) + +Type: java.util.Map + +Required: No + +context: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-embedded-plugin.context + +dir: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-embedded-plugin.lib + +Default: $\{project.build.directory}/apache-tomee-embedded + +docBase: + +(no description) + +Type: java.io.File + +Required: No + +User Property: tomee-embedded-plugin.docBase + +Default: $\{project.basedir}/src/main/webapp + +forceJspDevelopment: + +force webapp to be reloadable + +Type: boolean + +Required: No + +User Property: tomee-plugin.jsp-development + +Default: true + +host: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-embedded-plugin.host + +Default: localhost + +httpPort: + +(no description) + +Type: int + +Required: No + +User Property: tomee-embedded-plugin.http + +Default: 8080 + +httpsPort: + +(no description) + +Type: int + +Required: No + +User Property: tomee-embedded-plugin.httpsPort + +Default: 8443 + +inlinedServerXml: + +(no description) + +Type: org.codehaus.plexus.configuration.PlexusConfiguration + +Required: No + +inlinedTomEEXml: + +(no description) + +Type: org.codehaus.plexus.configuration.PlexusConfiguration + +Required: No + +keepServerXmlAsThis: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-embedded-plugin.keepServerXmlAsThis + +Default: false + +keyAlias: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-embedded-plugin.keyAlias + +keystoreFile: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-embedded-plugin.keystoreFile + +keystorePass: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-embedded-plugin.keystorePass + +keystoreType: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-embedded-plugin.keystoreType + +Default: JKS + +mavenLog: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-embedded-plugin.mavenLog + +Default: true + +modules: + +(no description) + +Type: java.util.List + +Required: No + +User Property: tomee-embedded-plugin.modules + +Default: $\{project.build.outputDirectory} + +packaging: + +(no description) + +Type: java.lang.String + +Required: No + +Default: $\{project.packaging} + +quickSession: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-embedded-plugin.quickSession + +Default: true + +roles: + +(no description) + +Type: java.util.Map + +Required: No + +serverXml: + +(no description) + +Type: java.io.File + +Required: No + +skipCurrentProject: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.skip-current-project + +Default: false + +skipHttp: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-embedded-plugin.skipHttp + +Default: false + +ssl: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-embedded-plugin.ssl + +Default: false + +sslProtocol: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-embedded-plugin.sslProtocol + +stopPort: + +(no description) + +Type: int + +Required: No + +User Property: tomee-embedded-plugin.stop + +Default: 8005 + +useProjectClasspath: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-embedded-plugin.useProjectClasspath + +Default: true + +users: + +(no description) + +Type: java.util.Map + +Required: No + +warFile: + +(no description) + +Type: java.io.File + +Required: No + +Default: +latexmath:[${project.build.directory}/$]\{project.build.finalName} + +webResourceCached: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-embedded-plugin.webResourceCached + +Default: true + +withEjbRemote: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-embedded-plugin.withEjbRemote + +Default: false + +workDir: + +(no description) + +Type: java.io.File + +Required: No + +User Property: tomee-plugin.work + +Default: $\{project.build.directory}/tomee-embedded-work http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-embedded-maven-plugin.md ---------------------------------------------------------------------- diff --git a/docs/tomee-embedded-maven-plugin.md b/docs/tomee-embedded-maven-plugin.md deleted file mode 100644 index 9e1bfc5..0000000 --- a/docs/tomee-embedded-maven-plugin.md +++ /dev/null @@ -1,959 +0,0 @@ -index-group=TomEE Maven Plugin -type=page -status=published -title=TomEE Embedded Maven Plugin -~~~~~~ - -[TomEE Maven Plugin](tomee-maven-plugin.html) provides a nice way to run "as in production" a server fully configured -keeping the configuration in the project (easiness of sharing between team members). However for modern web development -the fact to run the "exploded war" prevents to develop web resources in place. TomEE embedded maven plugin -solves it directly allowing to directly deploy the war project in place using "classpath as war" option. - -It also allows to use a flat classpath deployment which is often use with microservices. - -<h2><a name="tomee-embedded:run"></a>tomee-embedded:run</h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.tomee.maven:tomee-embedded-maven-plugin:7.0.0-M1:run</p> - -<p><b>Description</b>:</p> - -<div>Run an Embedded 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><a name="Optional_Parameters"></a>Optional Parameters</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="#ajpPort">ajpPort</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-embedded-plugin.ajp</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#applicationCopyFolder">applicationCopyFolder</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}/tomee-embedded/applications</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.application-copy</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#applicationScopes">applicationScopes</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="#applications">applications</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="#classpathAsWar">classpathAsWar</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-embedded-plugin.classpathAsWar</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#clientAuth">clientAuth</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-embedded-plugin.clientAuth</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#containerProperties">containerProperties</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="#context">context</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-embedded-plugin.context</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#dir">dir</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee-embedded</tt>.<br /><b>User property is</b>: <tt>tomee-embedded-plugin.lib</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#docBase">docBase</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-embedded-plugin.docBase</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#forceJspDevelopment">forceJspDevelopment</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>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.jsp-development</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#host">host</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-embedded-plugin.host</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#httpPort">httpPort</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-embedded-plugin.http</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#httpsPort">httpsPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>8443</tt>.<br /><b>User property is</b>: <tt>tomee-embedded-plugin.httpsPort</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#inlinedServerXml">inlinedServerXml</a></b></td> - -<td><tt>PlexusConfiguration</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#inlinedTomEEXml">inlinedTomEEXml</a></b></td> - -<td><tt>PlexusConfiguration</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-embedded-plugin.keepServerXmlAsThis</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#keyAlias">keyAlias</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-embedded-plugin.keyAlias</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#keystoreFile">keystoreFile</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-embedded-plugin.keystoreFile</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#keystorePass">keystorePass</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-embedded-plugin.keystorePass</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#keystoreType">keystoreType</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>JKS</tt>.<br /><b>User property is</b>: <tt>tomee-embedded-plugin.keystoreType</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#mavenLog">mavenLog</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-embedded-plugin.mavenLog</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#modules">modules</a></b></td> - -<td><tt>List</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-embedded-plugin.modules</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#packaging">packaging</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.packaging}</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#quickSession">quickSession</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-embedded-plugin.quickSession</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#roles">roles</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="#serverXml">serverXml</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></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.skip-current-project</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#skipHttp">skipHttp</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-embedded-plugin.skipHttp</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#ssl">ssl</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-embedded-plugin.ssl</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#sslProtocol">sslProtocol</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-embedded-plugin.sslProtocol</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#stopPort">stopPort</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-embedded-plugin.stop</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#useProjectClasspath">useProjectClasspath</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-embedded-plugin.useProjectClasspath</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#users">users</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="#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}</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#webResourceCached">webResourceCached</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-embedded-plugin.webResourceCached</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#withEjbRemote">withEjbRemote</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-embedded-plugin.withEjbRemote</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#workDir">workDir</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}/tomee-embedded-work</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.work</tt>.</td> - </tr> - </table> - </div> - -<div class="section"> -<h3><a name="Parameter_Details"></a>Parameter Details</h3> - -<p><b><a name="ajpPort">ajpPort</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-embedded-plugin.ajp</tt></li> - -<li><b>Default</b>: <tt>8009</tt></li> - </ul><hr /> -<p><b><a name="applicationCopyFolder">applicationCopyFolder</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.application-copy</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/tomee-embedded/applications</tt></li> - </ul><hr /> -<p><b><a name="applicationScopes">applicationScopes</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="applications">applications</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="classpathAsWar">classpathAsWar</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-embedded-plugin.classpathAsWar</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="clientAuth">clientAuth</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-embedded-plugin.clientAuth</tt></li> - </ul><hr /> -<p><b><a name="containerProperties">containerProperties</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="context">context</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-embedded-plugin.context</tt></li> - </ul><hr /> -<p><b><a name="dir">dir</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-embedded-plugin.lib</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee-embedded</tt></li> - </ul><hr /> -<p><b><a name="docBase">docBase</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-embedded-plugin.docBase</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li> - </ul><hr /> -<p><b><a name="forceJspDevelopment">forceJspDevelopment</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.jsp-development</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="host">host</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-embedded-plugin.host</tt></li> - -<li><b>Default</b>: <tt>localhost</tt></li> - </ul><hr /> -<p><b><a name="httpPort">httpPort</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-embedded-plugin.http</tt></li> - -<li><b>Default</b>: <tt>8080</tt></li> - </ul><hr /> -<p><b><a name="httpsPort">httpsPort</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-embedded-plugin.httpsPort</tt></li> - -<li><b>Default</b>: <tt>8443</tt></li> - </ul><hr /> -<p><b><a name="inlinedServerXml">inlinedServerXml</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>org.codehaus.plexus.configuration.PlexusConfiguration</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="inlinedTomEEXml">inlinedTomEEXml</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>org.codehaus.plexus.configuration.PlexusConfiguration</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-embedded-plugin.keepServerXmlAsThis</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="keyAlias">keyAlias</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-embedded-plugin.keyAlias</tt></li> - </ul><hr /> -<p><b><a name="keystoreFile">keystoreFile</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-embedded-plugin.keystoreFile</tt></li> - </ul><hr /> -<p><b><a name="keystorePass">keystorePass</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-embedded-plugin.keystorePass</tt></li> - </ul><hr /> -<p><b><a name="keystoreType">keystoreType</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-embedded-plugin.keystoreType</tt></li> - -<li><b>Default</b>: <tt>JKS</tt></li> - </ul><hr /> -<p><b><a name="mavenLog">mavenLog</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-embedded-plugin.mavenLog</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="modules">modules</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> - -<li><b>User Property</b>: <tt>tomee-embedded-plugin.modules</tt></li> - -<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li> - </ul><hr /> -<p><b><a name="packaging">packaging</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>Default</b>: <tt>${project.packaging}</tt></li> - </ul><hr /> -<p><b><a name="quickSession">quickSession</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-embedded-plugin.quickSession</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="roles">roles</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="serverXml">serverXml</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> - </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.skip-current-project</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="skipHttp">skipHttp</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-embedded-plugin.skipHttp</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="ssl">ssl</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-embedded-plugin.ssl</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="sslProtocol">sslProtocol</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-embedded-plugin.sslProtocol</tt></li> - </ul><hr /> -<p><b><a name="stopPort">stopPort</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-embedded-plugin.stop</tt></li> - -<li><b>Default</b>: <tt>8005</tt></li> - </ul><hr /> -<p><b><a name="useProjectClasspath">useProjectClasspath</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-embedded-plugin.useProjectClasspath</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="users">users</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="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}</tt></li> - </ul><hr /> -<p><b><a name="webResourceCached">webResourceCached</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-embedded-plugin.webResourceCached</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="withEjbRemote">withEjbRemote</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-embedded-plugin.withEjbRemote</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="workDir">workDir</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.work</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/tomee-embedded-work</tt></li> - </ul> - </div> - http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-jaas.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-jaas.adoc b/docs/tomee-jaas.adoc new file mode 100644 index 0000000..40965f4 --- /dev/null +++ b/docs/tomee-jaas.adoc @@ -0,0 +1,88 @@ +# JAAS and TomEE +:index-group: Unrevised +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published + + +== Purpose + +You want to use JAAS in TomEE with custom (or OpenEJB) LoginModules. + +== Solution + +TomEE tries to keep as possible as it is Tomcat so simply configure your +JAAS LoginModule as in Tomcat. + +Note: only the first one will be used. + +== Configuration + +Add to your `CATALINA_OPTS` the `java.security.auth.login.config` system +property: + +.... +-Djava.security.auth.login.config=$CATALINA_BASE/conf/login.config +.... + +Configure your realm in server.xml file + +.... +<?xml version='1.0' encoding='utf-8'?> +<Server port="8005" shutdown="SHUTDOWN"> + <Listener className="org.apache.tomee.loader.OpenEJBListener" /> + <Listener className="org.apache.catalina.security.SecurityListener" /> + + <Service name="Catalina"> + <Connector port="8080" protocol="HTTP/1.1" + connectionTimeout="20000" + redirectPort="8443" /> + <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" /> + <Engine name="Catalina" defaultHost="localhost"> + <!-- here is the magic --> + <Realm className="org.apache.catalina.realm.JAASRealm" appName="PropertiesLogin" + userClassNames="org.apache.openejb.core.security.jaas.UserPrincipal" + roleClassNames="org.apache.openejb.core.security.jaas.GroupPrincipal"> + </Realm> + + <Host name="localhost" appBase="webapps" + unpackWARs="true" autoDeploy="true" /> + </Engine> + </Service> +</Server> +.... + +Configure your `login.config` file + +.... +PropertiesLogin { + org.apache.openejb.core.security.jaas.PropertiesLoginModule required + Debug=false + UsersFile="users.properties" + GroupsFile="groups.properties"; +}; +.... + +Configure your login module specifically (`users.properties` for +snippets of this page for instance). + +Place `users.properties` and `groups.properties` files in +`$CATALINA_BASE/conf/` folder. `users.properties` file contains user +name and associated password entries, ex.: + +.... +me=password +tomee=tomee +.... + +`groups.properties` file specifies groups and their users, ex.: + +.... +my-role=me +manager-gui=tomee,me +tomee-admin=tomee +.... + +*NOTE*: `users.properties` and `groups.properties` file names and file +location are fixed. If other names are used, the files must be placed in +`%CATALINA_BASE/lib/` folder instead. http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-jaas.md ---------------------------------------------------------------------- diff --git a/docs/tomee-jaas.md b/docs/tomee-jaas.md deleted file mode 100644 index 4653cfd..0000000 --- a/docs/tomee-jaas.md +++ /dev/null @@ -1,73 +0,0 @@ -index-group=Unrevised -type=page -status=published -title=JAAS and TomEE -~~~~~~ - -# Purpose - -You want to use JAAS in TomEE with custom (or OpenEJB) LoginModules. - -# Solution - -TomEE tries to keep as possible as it is Tomcat so simply -configure your JAAS LoginModule as in Tomcat. - -Note: only the first one will be used. - -# Configuration - -Add to your `CATALINA_OPTS` the `java.security.auth.login.config` system property: - - -Djava.security.auth.login.config=$CATALINA_BASE/conf/login.config - -Configure your realm in server.xml file - - <?xml version='1.0' encoding='utf-8'?> - <Server port="8005" shutdown="SHUTDOWN"> - <Listener className="org.apache.tomee.loader.OpenEJBListener" /> - <Listener className="org.apache.catalina.security.SecurityListener" /> - - <Service name="Catalina"> - <Connector port="8080" protocol="HTTP/1.1" - connectionTimeout="20000" - redirectPort="8443" /> - <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" /> - <Engine name="Catalina" defaultHost="localhost"> - <!-- here is the magic --> - <Realm className="org.apache.catalina.realm.JAASRealm" appName="PropertiesLogin" - userClassNames="org.apache.openejb.core.security.jaas.UserPrincipal" - roleClassNames="org.apache.openejb.core.security.jaas.GroupPrincipal"> - </Realm> - - <Host name="localhost" appBase="webapps" - unpackWARs="true" autoDeploy="true" /> - </Engine> - </Service> - </Server> - -Configure your `login.config` file - - PropertiesLogin { - org.apache.openejb.core.security.jaas.PropertiesLoginModule required - Debug=false - UsersFile="users.properties" - GroupsFile="groups.properties"; - }; - - -Configure your login module specifically (`users.properties` for snippets of this page for instance). - -Place `users.properties` and `groups.properties` files in `$CATALINA_BASE/conf/` folder. -`users.properties` file contains user name and associated password entries, ex.: - - me=password - tomee=tomee - -`groups.properties` file specifies groups and their users, ex.: - - my-role=me - manager-gui=tomee,me - tomee-admin=tomee - -**NOTE**: `users.properties` and `groups.properties` file names and file location are fixed. If other names are used, the files must be placed in `%CATALINA_BASE/lib/` folder instead. http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-logging-in-eclipse.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-logging-in-eclipse.adoc b/docs/tomee-logging-in-eclipse.adoc new file mode 100644 index 0000000..94e700d --- /dev/null +++ b/docs/tomee-logging-in-eclipse.adoc @@ -0,0 +1,18 @@ +# How to use JULI for TomEE in WTP? +:index-group: Unrevised +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published + + +It seems that WTP doesn't manage correctly Tomcat logging configuration +(which needs to be done through system properties). A quick workaround +is to add these properties manually: + +.... +-Djava.util.logging.config.file="<tomee>/conf/logging.properties" +-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager +.... + +More information on: +http://wiki.eclipse.org/WTP_Tomcat_FAQ#How_do_I_enable_the_JULI_logging_in_a_Tomcat_5.5_Server_instance.3F http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-logging-in-eclipse.md ---------------------------------------------------------------------- diff --git a/docs/tomee-logging-in-eclipse.md b/docs/tomee-logging-in-eclipse.md deleted file mode 100644 index 07fd6cb..0000000 --- a/docs/tomee-logging-in-eclipse.md +++ /dev/null @@ -1,13 +0,0 @@ -index-group=Unrevised -type=page -status=published -title=How to use JULI for TomEE in WTP? -~~~~~~ - -It seems that WTP doesn't manage correctly Tomcat logging configuration (which needs to be done through -system properties). A quick workaround is to add these properties manually: - - -Djava.util.logging.config.file="<tomee>/conf/logging.properties" - -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager - -More information on: http://wiki.eclipse.org/WTP_Tomcat_FAQ#How_do_I_enable_the_JULI_logging_in_a_Tomcat_5.5_Server_instance.3F http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-logging.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-logging.adoc b/docs/tomee-logging.adoc new file mode 100644 index 0000000..08cce00 --- /dev/null +++ b/docs/tomee-logging.adoc @@ -0,0 +1,32 @@ +: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. + +Logging in TomEE is configured using the conf/logging.properties file. +Here are some of the benefits: + +You do not have to author a logging.properties from scratch. + +You get one with sensible defaults. + +If you did modify the default file, and you wanted to revert back to the +default file generated by TomEE, all you have to do is + +Delete or rename the file e.g. rename it to logging.properties.BAK . + +Restart the server http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-logging.md ---------------------------------------------------------------------- diff --git a/docs/tomee-logging.md b/docs/tomee-logging.md deleted file mode 100644 index 1852c18..0000000 --- a/docs/tomee-logging.md +++ /dev/null @@ -1,33 +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. - -Logging in TomEE is configured using the conf/logging.properties file. Here are some of the benefits: - - You do not have to author a logging.properties from scratch. - - You get one with sensible defaults. - - If you did modify the default file, and you wanted to revert back to the default file generated by TomEE, all you have to do is - - Delete or rename the file e.g. rename it to logging.properties.BAK . - - Restart the server http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-maven-plugin.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-maven-plugin.adoc b/docs/tomee-maven-plugin.adoc new file mode 100644 index 0000000..6c53fcf --- /dev/null +++ b/docs/tomee-maven-plugin.adoc @@ -0,0 +1,175 @@ +# TomEE Maven Plugin +:index-group: Unrevised +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published + + +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 + +Creates an executable jar of the application. + +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/4dd89bdf/docs/tomee-maven-plugin.md ---------------------------------------------------------------------- diff --git a/docs/tomee-maven-plugin.md b/docs/tomee-maven-plugin.md deleted file mode 100644 index 10e7ecb..0000000 --- a/docs/tomee-maven-plugin.md +++ /dev/null @@ -1,148 +0,0 @@ -index-group=Unrevised -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="maven/build-mojo.html">tomee:build</a></td> -<td>Create TomEE, but do not run it.</td></tr> -<tr class="a"> -<td><a href="maven/configtest-mojo.html">tomee:configtest</a></td> -<td>Run the Apache Tomcat `configtest` command.</td></tr> -<tr class="b"> -<td><a href="maven/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="maven/deploy-mojo.html">tomee:deploy</a></td> -<td>Deploy an application in a running TomEE.</td></tr> -<tr class="b"> -<td><a href="maven/exec-mojo.html">tomee:exec</a></td> -<td>Creates an executable jar of the application.</td></tr> -<tr class="a"> -<td><a href="maven/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="maven/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="maven/run-mojo.html">tomee:run</a></td> -<td>Start and wait for TomEE.</td></tr> -<tr class="b"> -<td><a href="maven/start-mojo.html">tomee:start</a></td> -<td>Start TomEE and continue.</td></tr> -<tr class="a"> -<td><a href="maven/stop-mojo.html">tomee:stop</a></td> -<td>Stop a TomEE started with start command.</td></tr> -<tr class="b"> -<td><a href="maven/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/4dd89bdf/docs/tomee-mp-getting-started.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-mp-getting-started.adoc b/docs/tomee-mp-getting-started.adoc new file mode 100644 index 0000000..316ebaf --- /dev/null +++ b/docs/tomee-mp-getting-started.adoc @@ -0,0 +1,98 @@ +:index-group: TomEE +Maven Plugin +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published +:jbake-title: TomEE Maven Plugin + + +###Add The TomEE Maven Plugin To An Existing Project + +If you already have a maven project set up then just add the plugin as +described link:maven/index.html[here] + +You will likely need the full Java EE API added to your pom file: + +.... +<dependency> + <groupId>org.apache.openejb</groupId> + <artifactId>javaee-api</artifactId> + <version>6.0-6</version> + <scope>provided</scope> +</dependency> +.... + +The simplest path is to allow Maven to create an example project for +you. Even if you have an existing project you can always use the +template as a reference. + +###Generate a Basic TomEE-Project With Maven + +TomEE provides a maven-archetype for generating a template project. This +template project is preconfigured with `javaee-api` (scope provided) and +with the link:maven/index.html[`tomee-maven-plugin`] for starting the +application with TomEE. + +For example, if current version of the archetype is '1.7.1', then the +required command to generate an application would be: + +.... +mvn archetype:generate -DarchetypeGroupId=org.apache.openejb.maven -DarchetypeArtifactId=tomee-webapp-archetype -DarchetypeVersion=1.7.1 +.... + +The first time you run this command maven downloads the archetype and +some parts related to it. Afterwards you see a prompt which allows you +to specify the groupId, artifactId, version and package of your +application. If you are using 'tomee' as groupId, 'tomee-demo' as +artifactId, '1.0' as version and 'myapp' as package, your console should +show something like: + +.... +Define value for property 'groupId': : tomee +Define value for property 'artifactId': : tomee-demo +Define value for property 'version': 1.0-SNAPSHOT: : 1.0 +Define value for property 'package': tomee: : myapp +Confirm properties configuration: +groupId: tomee +artifactId: tomee-demo +version: 1.0 +package: myapp +... +[INFO] BUILD SUCCESS +... +.... + +Afterwards you see a new folder with the name you used for the +artifactId (in the previous example 'tomee-demo'). For starting the +application you have to change the current directory to the directory of +the generated application: + +.... +cd tomee-demo +.... + +###Starting a TomEE-Project with Maven + +With using the archetype everything you need is in place already. So you +just have to start TomEE with: + +.... +mvn package tomee:run +.... + +The first time you run this command takes a bit longer, because maven +has to download e.g. TomEE. Once those parts are downloaded, starting +maven, deploying and starting the generated application takes less than +10s (depending on your computer). + +###Accessing a running application + +The application gets deployed to `target/apache-tomee/webapps`. If +everything worked correctly, you should see a directory ('ROOT') as well +as a web-archive ('ROOT.war'). The context-paths of the deployed +application is ROOT. In our example the generated application contains a +servlet mapped to '/index'. So you can access it via: + +.... +http://localhost:8080/index +.... http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-mp-getting-started.md ---------------------------------------------------------------------- diff --git a/docs/tomee-mp-getting-started.md b/docs/tomee-mp-getting-started.md deleted file mode 100644 index 4e3ba0d..0000000 --- a/docs/tomee-mp-getting-started.md +++ /dev/null @@ -1,65 +0,0 @@ -index-group=TomEE Maven Plugin -type=page -status=published -title=TomEE Maven Plugin -~~~~~~ - -###Add The TomEE Maven Plugin To An Existing Project - -If you already have a maven project set up then just add the plugin as described [here](maven/index.html) - -You will likely need the full Java EE API added to your pom file: - - <dependency> - <groupId>org.apache.openejb</groupId> - <artifactId>javaee-api</artifactId> - <version>6.0-6</version> - <scope>provided</scope> - </dependency> - -The simplest path is to allow Maven to create an example project for you. Even if you have an existing project you can always use the template as a reference. - -###Generate a Basic TomEE-Project With Maven - -TomEE provides a maven-archetype for generating a template project. This template project is preconfigured with `javaee-api` (scope provided) and with the [`tomee-maven-plugin`](maven/index.html) for starting the application with TomEE. - -For example, if current version of the archetype is '1.7.1', then the required command to generate an application would be: - - mvn archetype:generate -DarchetypeGroupId=org.apache.openejb.maven -DarchetypeArtifactId=tomee-webapp-archetype -DarchetypeVersion=1.7.1 - -The first time you run this command maven downloads the archetype and some parts related to it. Afterwards you see a prompt which allows you to specify the groupId, artifactId, version and package of your application. -If you are using 'tomee' as groupId, 'tomee-demo' as artifactId, '1.0' as version and 'myapp' as package, your console should show something like: - - Define value for property 'groupId': : tomee - Define value for property 'artifactId': : tomee-demo - Define value for property 'version': 1.0-SNAPSHOT: : 1.0 - Define value for property 'package': tomee: : myapp - Confirm properties configuration: - groupId: tomee - artifactId: tomee-demo - version: 1.0 - package: myapp - ... - [INFO] BUILD SUCCESS - ... - -Afterwards you see a new folder with the name you used for the artifactId (in the previous example 'tomee-demo'). -For starting the application you have to change the current directory to the directory of the generated application: - - cd tomee-demo - -###Starting a TomEE-Project with Maven - -With using the archetype everything you need is in place already. So you just have to start TomEE with: - - mvn package tomee:run - -The first time you run this command takes a bit longer, because maven has to download e.g. TomEE. -Once those parts are downloaded, starting maven, deploying and starting the generated application takes less than 10s (depending on your computer). - -###Accessing a running application - -The application gets deployed to `target/apache-tomee/webapps`. If everything worked correctly, you should see a directory ('ROOT') as well as a web-archive ('ROOT.war'). -The context-paths of the deployed application is ROOT. In our example the generated application contains a servlet mapped to '/index'. So you can access it via: - - http://localhost:8080/index http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-version-policies.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-version-policies.adoc b/docs/tomee-version-policies.adoc new file mode 100644 index 0000000..908ed23 --- /dev/null +++ b/docs/tomee-version-policies.adoc @@ -0,0 +1,55 @@ +:index-group: Unrevised +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published + +. # TomEE +versioning policies + +TomEE version policy is made of three dot-separated numbers: x.y.z + +* x is the major version. It corresponds to the maximum Java EE +specification supported by TomEE and a codebase generation, starting +with value 1 for Java EE 6 support. Next major will be 7 targetting +JavaEE 7 etc... +* y is the minor version. It corresponds to a features level, starting +at 0. Initial TomEE release was 1.0.0, followed by 1.5.0 because of the +accumulation of features changes delivered since 1.0.0. Note that +features changes must comply with the Java EE specification level given +by TomEE's major version. +* z is the fix level. It corresponds to bug fixes changes without new +features, starting at 0. Upgrades of embedded components (Tomcat, +OpenEJB, MyFaces, etc.) are normally part of bug fixes releases. + +These policies allow an Java EE application to be certified with a given +TomEEE version x.y.z and to be compatible with TomEE versions x.y1.* +with y1>y and compatible with TomEE version x.y.z1 with z1>z. + +Important: being JavaEE certified means the server passed the Test +Compatibility Kit (TCK). To simplify/summarize it is a big test suite to +validate your are compliant with a JavaEE version. TomEE 1.x passed the +JavaEE 6 TCK which was donated to Apache Software Foundation by Oracle. +This donation hasn't been done to Apache for JavaEE 7 so TomEE is not +able for now to be validated against it and therefore TomEE versions +targetting JavaEE 7 are not yet certified. + +To make it more explicit here is a small table showing the targetted +JavaEE version and the related certification state by version: + +TomEE Version + +JavaEE Version + +Certified + +1.x + +6 + +Yes + +7.x + +7 + +No http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-version-policies.md ---------------------------------------------------------------------- diff --git a/docs/tomee-version-policies.md b/docs/tomee-version-policies.md deleted file mode 100644 index ae5c666..0000000 --- a/docs/tomee-version-policies.md +++ /dev/null @@ -1,28 +0,0 @@ -index-group=Unrevised -type=page -status=published -~~~~~~ -. -# TomEE versioning policies - -TomEE version policy is made of three dot-separated numbers: x.y.z - - - x is the major version. It corresponds to the maximum Java EE specification supported by TomEE and a codebase generation, starting with value 1 for Java EE 6 support. Next major will be 7 targetting JavaEE 7 etc... - - - y is the minor version. It corresponds to a features level, starting at 0. Initial TomEE release was 1.0.0, followed by 1.5.0 because of the accumulation of features changes delivered since 1.0.0. Note that features changes must comply with the Java EE specification level given by TomEE's major version. - - - z is the fix level. It corresponds to bug fixes changes without new features, starting at 0. Upgrades of embedded components (Tomcat, OpenEJB, MyFaces, etc.) are normally part of bug fixes releases. - -These policies allow an Java EE application to be certified with a given TomEEE version x.y.z and to be compatible with TomEE versions x.y1.* with y1>y and compatible with TomEE version x.y.z1 with z1>z. - -Important: being JavaEE certified means the server passed the Test Compatibility Kit (TCK). To simplify/summarize it is a big test suite to validate your are compliant with a JavaEE version. TomEE 1.x passed the JavaEE 6 TCK which was donated to Apache Software Foundation by Oracle. This donation hasn't been done to Apache for JavaEE 7 so TomEE is not able for now to be validated against it and therefore TomEE versions targetting JavaEE 7 are not yet certified. - -To make it more explicit here is a small table showing the targetted JavaEE version and the related certification state by version: - -<table class="mdtable"> -<tr><td>TomEE Version</td><td>JavaEE Version</td><td>Certified</td></tr> -<tr><td>1.x</td><td>6</td><td>Yes</td></tr> -<tr><td>7.x</td><td>7</td><td>No</td></tr> -</table> - - http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-webaccess.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-webaccess.adoc b/docs/tomee-webaccess.adoc new file mode 100644 index 0000000..c4ce24a --- /dev/null +++ b/docs/tomee-webaccess.adoc @@ -0,0 +1,18 @@ +: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. http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-webaccess.md ---------------------------------------------------------------------- diff --git a/docs/tomee-webaccess.md b/docs/tomee-webaccess.md deleted file mode 100644 index 1859287..0000000 --- a/docs/tomee-webaccess.md +++ /dev/null @@ -1,21 +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. http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-webapp.adoc ---------------------------------------------------------------------- diff --git a/docs/tomee-webapp.adoc b/docs/tomee-webapp.adoc new file mode 100644 index 0000000..87aad26 --- /dev/null +++ b/docs/tomee-webapp.adoc @@ -0,0 +1,73 @@ +# About the 'tomee' webapp +: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. + +There are two forms of the `tomee` webapp to consider: + +* from an *tomee-1.x.x.war* that has been downloaded and added to a +Tomcat 7 install. This `tomee` webapp will contain all the necessary +libraries to add the missing Java EE functionality to Tomcat as well as +a small console. +* from an *apache-tomee-1.x.x.zip*. The `tomee` webapp shipped inside a +TomEE zip or tar is the same webapp as above, but with the libraries +moved into the `<tomcat-home>/lib/` directory + +The only real difference between a "Tomcat with drop-in tomee.war" and a +"TomEE" install is where the additional libraries live. + +== Deleting from plain Tomcat + +Deleting the `tomee` webapp from a plain Tomcat install will effectively +uninstall TomEE from Tomcat. + +== Deleting from TomEE + +Deleting the `tomee` webapp from a TomEE install is safe as the needed +libraries have been moved into `<tomcat-home>/lib/` + +The only loss of functionality would be the ability to remotely execute +EJBs over HTTP. However this can easily be added to a different webapp +like so: + +.... +<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>/myejbs/*</url-pattern> +</servlet-mapping> +.... + +Then you can create an `InitialContext` that points to that webapp like +so: + +.... +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/mywebapp/myejbs";); +// 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"); +.... http://git-wip-us.apache.org/repos/asf/tomee/blob/4dd89bdf/docs/tomee-webapp.md ---------------------------------------------------------------------- diff --git a/docs/tomee-webapp.md b/docs/tomee-webapp.md deleted file mode 100644 index 0b57091..0000000 --- a/docs/tomee-webapp.md +++ /dev/null @@ -1,62 +0,0 @@ -index-group=General Information -type=page -status=published -title=About the 'tomee' webapp -~~~~~~ -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. - -There are two forms of the `tomee` webapp to consider: - - - from an **tomee-1.x.x.war** that has been downloaded and added to a Tomcat 7 install. This `tomee` webapp will contain all the necessary libraries to add the missing Java EE functionality to Tomcat as well as a small console. - - from an **apache-tomee-1.x.x.zip**. The `tomee` webapp shipped inside a TomEE zip or tar is the same webapp as above, but with the libraries moved into the `<tomcat-home>/lib/` directory - -The only real difference between a "Tomcat with drop-in tomee.war" and a "TomEE" install is where the additional libraries live. - -## Deleting from plain Tomcat - -Deleting the `tomee` webapp from a plain Tomcat install will effectively uninstall TomEE from Tomcat. - -## Deleting from TomEE - -Deleting the `tomee` webapp from a TomEE install is safe as the needed libraries have been moved into `<tomcat-home>/lib/` - -The only loss of functionality would be the ability to remotely execute EJBs over HTTP. However this can easily be added to a different webapp like so: - - <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>/myejbs/*</url-pattern> - </servlet-mapping> - - -Then you can create an `InitialContext` that points to that webapp like so: - - 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/mywebapp/myejbs";); - // 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");
