This is an automated email from the ASF dual-hosted git repository. rzo1 pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/tomee.git
commit ef00da3d475f400f1a63961937ad0e2a3ec7b112 Author: Richard Zowalla <[email protected]> AuthorDate: Fri May 22 15:26:15 2026 +0200 docs: repair Confluence/wiki/markdown conversion artifacts These pages still contained leftover markup from the old wiki-to-AsciiDoc migration that rendered as literal garbage. Convert them to valid AsciiDoc: - markdown links [text](url) and wiki links [text|target] -> link:url[text] - openejbx30:/openejb: page references and [OPENEJB:...] markers - Confluence block macros {note}/{tip}/{warning}/{panel}/{anchor}/{include} /{color} -> AsciiDoc admonitions, anchors and plain text - {snippet:url=openejb3/examples/...} macros -> links to the live example sources on GitHub - dead !http://...! image macros removed; stray section headings and mangled inline emphasis fixed --- docs/basics---getting-things.adoc | 28 +++++++++++++--------------- docs/collapsed-ear.adoc | 6 +++--- docs/deployments.adoc | 2 +- docs/eclipse-plugin.adoc | 16 ++++++++-------- docs/embedded-and-remotable.adoc | 33 ++++++++++++++++++--------------- docs/embedding.adoc | 12 ++++-------- docs/faq.adoc | 8 +++----- docs/generating-ejb-3-annotations.adoc | 8 +------- docs/getting-started.adoc | 7 +++---- docs/hello-world.adoc | 14 +++++--------- docs/javaagent.adoc | 2 +- docs/local-client-injection.adoc | 8 +++++--- docs/local-server.adoc | 6 ++---- docs/lookup-of-other-ejbs-example.adoc | 18 +++++++++--------- docs/quickstart.adoc | 10 +++++----- docs/remote-server.adoc | 7 +++---- docs/singleton-beans.adoc | 11 +++++------ docs/singleton-ejb.adoc | 2 +- docs/startup.adoc | 7 +++---- docs/telnet-console.adoc | 2 +- docs/tomcat-object-factory.adoc | 10 ++++------ docs/validation-tool.adoc | 10 ++++------ 22 files changed, 102 insertions(+), 125 deletions(-) diff --git a/docs/basics---getting-things.adoc b/docs/basics---getting-things.adoc index 273831b485..8c360eedd7 100644 --- a/docs/basics---getting-things.adoc +++ b/docs/basics---getting-things.adoc @@ -7,28 +7,26 @@ = Getting Stuff from the Container Generally speaking the only way to get a -link:container-managed-resource.html[Container-Managed Resource] is via -_dependency injection_ or _lookup_ from within a [Container-Managed -Component] . +Container-Managed Resource is via +_dependency injection_ or _lookup_ from within a Container-Managed +Component. The _unbreakable rules_. Read these over and over again when things don't work. [arabic] . java:comp/env is the spec defined namespace for lookup of any -link:container-managed-resource.html[Container-Managed Resource] +Container-Managed Resource . java:comp/env is _empty_ by default . java:comp/env is _read-only_ at runtime . java:comp/env is populated by link:declaring-references.html[Declaring -References] to [Container-Managed Resource] via xml or annotation -. only link:container-managed-component.html[Container-Managed -Component] s, _not_ their libraries, can [Declare References|Declaring -References] via xml or annotation -. only link:container-managed-component.html[Container-Managed -Component] s, _not_ their libraries, can get dependency injection of -[Container-Managed Resource] s -. only link:container-managed-component.html[Container-Managed -Component] s, _and_ their libraries, may look up from java:comp/env +References] to a Container-Managed Resource via xml or annotation +. only Container-Managed Components, _not_ their libraries, can +link:declaring-references.html[Declare References] via xml or annotation +. only Container-Managed Components, _not_ their libraries, can get +dependency injection of Container-Managed Resources +. only Container-Managed Components, _and_ their libraries, may look up +from java:comp/env . you _must_ use the _no-arg_ 'new InitialContext()' constructor to lookup something from java:comp/env . the annotations and xml for link:declaring-references.html[Declaring @@ -74,8 +72,8 @@ offer some great new options for more global-style lookups. See rule 2 and the above. Just creating an EJB doesn't cause it to be added to java:comp/env. If a -link:container-managed-component.html[Container-Managed Component] wants -to look up the EJB they must [Declare a Reference|Declaring References] +Container-Managed Component wants +to look up the EJB they must link:declaring-references.html[Declare a Reference] to it via the `@EJB` annotation or <ejb-local-ref> or <ejb-ref> in xml. In Java EE 6, however, EJBs will be automatically bound to "java:global[/<app-name>]/<module-name>/<bean-name>[!<fully-qualified-interface-name>]" diff --git a/docs/collapsed-ear.adoc b/docs/collapsed-ear.adoc index 0728ccce11..3d93155cdb 100644 --- a/docs/collapsed-ear.adoc +++ b/docs/collapsed-ear.adoc @@ -43,7 +43,7 @@ is where J2EE "jumps the shark" for a large majority of people's needs. = Example with Tomcat If you want to try to work with Servlets/JSP and OpenEJB using Tomcat, -see the openejbx30:tomcat.html[setup page] and the +see the link:deploying-in-tomee.html[setup page] and the "/webapps/ejb-examples" section of the -link:downloads.html[openejb-examples.zip] available on the -http://tomee.apache.org/downloads.html[download page]. +openejb-examples.zip available on the +https://tomee.apache.org/download-ng.html[download page]. diff --git a/docs/deployments.adoc b/docs/deployments.adoc index a19b51ca7c..e70f094604 100644 --- a/docs/deployments.adoc +++ b/docs/deployments.adoc @@ -25,7 +25,7 @@ with a 'jar' attribute pointing to the jar file on the file system. The last element in the example uses a relative path to point to the ejb jar. This path will be resolved relative to the catalina.base property. So, for example, of the value of catalina.base was 'c:' then TomEE -would look for the jar 'c:.jar'. See the [OPENEJB:Configuration] guide +would look for the jar 'c:.jar'. See the link:configuration.html[Configuration] guide for more details. == A directory of jars diff --git a/docs/eclipse-plugin.adoc b/docs/eclipse-plugin.adoc index 4aa12dca66..b591945dd8 100644 --- a/docs/eclipse-plugin.adoc +++ b/docs/eclipse-plugin.adoc @@ -9,17 +9,17 @@ The _OpenEJB Eclipse Plugin_ will be a suite of tools made available via Eclipse to make EJB development with OpenEJB easier. The initial offering will probably provide basic functionality by taking advantage -of http://www.eclipse.org/webtools[WebTools] to allow for OpenEJB to be +of https://www.eclipse.org/webtools[WebTools] to allow for OpenEJB to be an available container/runtime within Eclipse. This means full debugging and Eclipse project integration. From there, the sky is the limit so -feel free to suggest features on the [OpenEJB Dev list|Mailing -Lists#MailingLists-DeveloperMailingList] . +feel free to suggest features on the +link:https://lists.apache.org/[email protected][TomEE Dev list]. = How to get involved? Just the same as getting involved with any part of OpenEJB -- send a mail to the -link:mailing-lists#mailinglists-developermailinglist.html[OpenEJB Dev +link:https://lists.apache.org/[email protected][TomEE Dev list] and say "Hi!" We're a very relaxed group so no need to be perfect or overly prepared. Just dive right in, we're always happy to have more. @@ -28,14 +28,14 @@ or overly prepared. Just dive right in, we're always happy to have more. The initiative is just launching, but you can grab what we have right here and start hacking. -http://svn.apache.org/repos/asf/tomee/openejb-eclipse-plugin/trunk/ +https://github.com/apache/tomee/ = What do I need to help? -http://www.eclipse.org[Eclipse] http://www.eclipse.org/webtools[Eclipse +https://www.eclipse.org[Eclipse] https://www.eclipse.org/webtools[Eclipse Web Tools] = Resources -http://eclipsezilla.eclipsecon.org/show_bug.cgi?id=3581[EclipseCon -Presentation for Extending WTP] +EclipseCon +Presentation for Extending WTP diff --git a/docs/embedded-and-remotable.adoc b/docs/embedded-and-remotable.adoc index 7dfa1e8bc8..4f87f33b76 100644 --- a/docs/embedded-and-remotable.adoc +++ b/docs/embedded-and-remotable.adoc @@ -39,17 +39,17 @@ classpath. A number of ServerServices are available currently: * openejb-hsql * openejb-activemq -_The source for this example is in the "telephone-stateful" directory -located in the openejb:download.html[openejb-examples.zip] available on -the http://tomee.apache.org/downloads.html[download page]._ +_The source for this example is in the +link:https://github.com/apache/tomee/tree/main/examples/telephone-stateful[telephone-stateful] +example directory._ -\{note} If your goal is simply to unit test beans with remote +NOTE: If your goal is simply to unit test beans with remote interfaces, this is _not_ the right example for you. The LocalInitialContextFactory completely supports remote interfaces and all spec required pass-by-value (serialization) semantics without the need for network sockets. This example shows the use of OpenEJB in an embedded environment where connection _outside_ the vm is -required.\{note} +required. = The Code @@ -60,13 +60,16 @@ you call _listen_ to get your answer. == bean -\{snippet:id=code|url=openejb3/examples/telephone-stateful/src/main/java/org/superbiz/telephone/TelephoneBean.java|lang=java} +link:https://github.com/apache/tomee/blob/main/examples/telephone-stateful/src/main/java/org/superbiz/telephone/TelephoneBean.java[TelephoneBean.java] == business interface -\{snippet:id=code|url=openejb3/examples/telephone-stateful/src/main/java/org/superbiz/telephone/Telephone.java|lang=java} +link:https://github.com/apache/tomee/blob/main/examples/telephone-stateful/src/main/java/org/superbiz/telephone/Telephone.java[Telephone.java] -{title= EJB3 Notes} The bean class uses the annotation _`@Remote_` but +[TIP] +.EJB3 Notes +==== +The bean class uses the annotation `@Remote` but does not specify a list of interfaces as is normally required. Per EJB3 rules, if the bean implements exactly _one business interface_ it may use `@Remote` with no other values and that business interface is then @@ -76,7 +79,7 @@ identical usage of `@Local`. The critical thing to know is that if you add another interface the rules change and require that you specify both interfaces in the `@Remote` annotation as in `@Remote`(\{Telephone.class, SecondInterface.class}). -\{tip} +==== = Embedding @@ -91,13 +94,13 @@ communicates to the embedded container system over the ejbd protocol. == setUp -\{snippet:id=setup|url=openejb3/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java|lang=java} +link:https://github.com/apache/tomee/blob/main/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java[TelephoneTest.java] == LocalInitialContextFactory: making in-vm calls to a remote business interface -\{snippet:id=localcontext|url=openejb3/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java|lang=java} +link:https://github.com/apache/tomee/blob/main/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java[TelephoneTest.java] == RemoteInitialContextFactory: making networked calls to a remote @@ -109,18 +112,18 @@ different VM than the one in which the ejb container is embedded. These classpath and connect to OpenEJB via the RemoteInitialContextFactory like any other remote EJB client. -\{snippet:id=remotecontext|url=openejb3/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java|lang=java} +link:https://github.com/apache/tomee/blob/main/examples/telephone-stateful/src/test/java/org/superbiz/telephone/TelephoneTest.java[TelephoneTest.java] = Maven setup -\{snippet:id=desc|url=openejb3/examples/telephone-stateful/pom.xml} +link:https://github.com/apache/tomee/blob/main/examples/telephone-stateful/pom.xml[pom.xml] -\{snippet:id=openejbdep|url=openejb3/examples/telephone-stateful/pom.xml|lang=xml} +link:https://github.com/apache/tomee/blob/main/examples/telephone-stateful/pom.xml[pom.xml] = Running Running the example is fairly simple. In the "telephone-stateful" -directory of the openejb:download.html[examples zip] , just run: +directory of the link:https://github.com/apache/tomee/tree/main/examples/telephone-stateful[telephone-stateful example], just run: $ mvn clean install diff --git a/docs/embedding.adoc b/docs/embedding.adoc index 04a2edd1ac..8bf08f3bf7 100644 --- a/docs/embedding.adoc +++ b/docs/embedding.adoc @@ -24,11 +24,7 @@ PersistenceUnits in Tests] Tests] * link:configuring-logging-in-tests.html[Configuring Logging in Tests] * link:alternate-descriptors.html[Alternate Descriptors] -* link:unit-testing-transactions.html[Unit Testing Transactions] -* link:testcase-with-testbean-inner-class.html[TestCase with TestBean -inner-class] -* [TestCase Injection (@LocalClient)](local-client-injection.html) - -== Examples - -\{include:Examples Table} +* Unit Testing Transactions +* TestCase with TestBean +inner-class +* link:local-client-injection.html[TestCase Injection (`@LocalClient`)] diff --git a/docs/faq.adoc b/docs/faq.adoc index 96f03c03a7..6c12f13bae 100644 --- a/docs/faq.adoc +++ b/docs/faq.adoc @@ -52,15 +52,13 @@ InitialContext using org.apache.openejb.client.LocalInitialContextFactory. The LocalInitialContextFactory will boot OpenEJB in your vm and all ejb applications visible in the classpath will be deployed. See -http://tomee.apache.org/embedding-openejb.html for details on how to +https://tomee.apache.org/embedding-openejb.html for details on how to embed openejb in your application and IDE. See -openejbx30:application-discovery-via-the-classpath.html[Application +link:application-discovery-via-the-classpath.html[Application discovery via the classpath] for various ways to have your applications discovered. -== During embedded testing, how can I externalize all my DataSource - -configuration? +== During embedded testing, how can I externalize all my DataSource configuration? Create an openejb.xml file in any directory that gets added to your test classpath. For maven, something that winds up directly under diff --git a/docs/generating-ejb-3-annotations.adoc b/docs/generating-ejb-3-annotations.adoc index b1681b186a..2885f92479 100644 --- a/docs/generating-ejb-3-annotations.adoc +++ b/docs/generating-ejb-3-annotations.adoc @@ -23,7 +23,7 @@ eclipse:eclipse afterwards) <dependency> <groupId>org.apache.tomee</groupId> <artifactId>jakartaee-api</artifactId> - <version>9.xxxx</version> + <version>11.0.0-SNAPSHOT</version> <scope>provided</scope> </dependency> </dependencies> @@ -35,13 +35,9 @@ your build path. Next, click the 'OpenEJB' menu on the menubar, and select 'Generate Annotations'. -!http://www.jrg.me.uk/openejb/annotations_step_1.jpg! - Select the project you would like to work with, if it isn't already selected. Click 'Next'. -!http://www.jrg.me.uk/openejb/annotations_step_2.jpg! - Select your `ejb-jar.xml` and (optionally) your `openejb-jar.xml` files. Select or deselect the other options as appropriate, and select 'Next'. @@ -59,7 +55,5 @@ extending jakarta.ejb.EJBObject. * Add `@Remote` and `@RemoteHome` annotations entity beans to POJOs - This options converts abstract CMP classes to POJOs generating simple getters and setters. -!http://www.jrg.me.uk/openejb/annotations_step_3.jpg! - Review the changes that the plugin will make to your source code. Uncheck any changes you don't want to apply, and click 'Finish'. diff --git a/docs/getting-started.adoc b/docs/getting-started.adoc index e998cb1d98..1e4821a8b7 100644 --- a/docs/getting-started.adoc +++ b/docs/getting-started.adoc @@ -15,7 +15,7 @@ environment 1. Write an EJB 1. Write an EJB client 1. Start the server == 1. Download and Install OpenEJB Follow -these http://cwiki.apache.org/confluence/display/OPENEJB/Quickstart[instructions] +these https://cwiki.apache.org/confluence/display/OPENEJB/Quickstart[instructions] == 2. Setup your development environment @@ -47,7 +47,6 @@ D:\openejb-3.0.0-SNAPSHOT>bin\openejb start Apache OpenEJB 3.0.0-SNAPSHOT build: 20070830-07:53 http://tomee.apache.org/ OpenEJB ready. -[OPENEJB:init] OpenEJB Remote Server ** Starting Services ** NAME IP PORT @@ -121,9 +120,9 @@ App(id=D:\openejb-3.0.0-SNAPSHOT\apps\greeting.jar) Jndi(name=GreetingBeanRemote) ---- -\{color:#330000}\{_}Notice the Jndi(name=GreetingBeanRemote) +_Notice the Jndi(name=GreetingBeanRemote) information. Keep this handy as this is the JNDI name of the bean which -the client will use for lookup\{_}\{color} +the client will use for lookup_ == 6. Write the Client diff --git a/docs/hello-world.adoc b/docs/hello-world.adoc index 0c42da0c6c..35cbbea06f 100644 --- a/docs/hello-world.adoc +++ b/docs/hello-world.adoc @@ -9,12 +9,9 @@ run an EJB and EJB client in its most minimum form. It does not hide steps or rely on special build tools or IDEs and is about the most stripped down you can get. -_See the link:examples.html[Examples] page for a full list of examples -that range from [`@Stateles`|Simple Stateless Example] and -[@Stateful|Simple Stateful Example] beans, to [Dependency -Injection|Injection of env-entry Example] , JDBC [DataSources|Injection -of DataSource Example] , JPA [EntityManagers|Injection of EntityManager -Example] and more._ +_See the link:https://github.com/apache/tomee/tree/main/examples[Examples] page for a full list of examples +that range from `@Stateless` and `@Stateful` beans, to Dependency +Injection, JDBC DataSources, JPA EntityManagers and more._ == A basic EJB example @@ -34,7 +31,7 @@ OpenEJB == Download and install OpenEJB This example pertains to OpenEJB 3.0 which can be -http://archive.apache.org/dist/openejb/3.0[downloaded here] . Once you +https://archive.apache.org/dist/openejb/3.0[downloaded here] . Once you have downloaded OpenEJB, you can then simply extract the contents of the downloaded file to whichever directory you want to install OpenEJB in. @@ -198,7 +195,6 @@ karan@poweredge:~/install/openejb-3.0$ bin/openejb start Apache OpenEJB 3.0 build: 20070926-12:34 http://tomee.apache.org/ OpenEJB ready. -[OPENEJB:init] ---- OpenEJB Remote Server ** Starting Services ** NAME IP PORT + @@ -260,4 +256,4 @@ the contents of logs/openejb.log file in the email. = Looking for more? More EJB 3.0 examples, sample applications, tutorials and howtos -available link:examples.html[here] . +available link:https://github.com/apache/tomee/tree/main/examples[here] . diff --git a/docs/javaagent.adoc b/docs/javaagent.adoc index 56c1dfdd54..b2f1264897 100644 --- a/docs/javaagent.adoc +++ b/docs/javaagent.adoc @@ -14,7 +14,7 @@ Adding a java agent is done via a vm parameter as follows: [source,bash] ---- -java -javaagent:openejb-javaagent-4.6.0.jar _\[other params...](other-params....html) +java -javaagent:openejb-javaagent-4.6.0.jar [other params...] ---- == Maven2 diff --git a/docs/local-client-injection.adoc b/docs/local-client-injection.adoc index 3b75d80999..701ff08ee2 100644 --- a/docs/local-client-injection.adoc +++ b/docs/local-client-injection.adoc @@ -75,10 +75,12 @@ module containing your `@LocalClient` class is being properly identified as an EJB module or a Client module, than it is possible you are seeing some classloading issues. -\{panel} javax.naming.NamingException: Unable to find injection +---- +javax.naming.NamingException: Unable to find injection meta-data for org.superbiz.MyClient. Ensure that class was annotated -with `@org`.apache.openejb.api.LocalClient and was successfully discovered -and deployed. \{panel} +with @org.apache.openejb.api.LocalClient and was successfully discovered +and deployed. +---- If you encounter this try setting this openejb-specific boot flag so that annotations will be treated specially and always loaded by the diff --git a/docs/local-server.adoc b/docs/local-server.adoc index f29db8a9ed..ee33bd55e4 100644 --- a/docs/local-server.adoc +++ b/docs/local-server.adoc @@ -4,8 +4,7 @@ :jbake-type: page :jbake-status: published -!http://www.openejb.org/images/diagram-local-server.gif|valign=top, -align=right, hspace=15! # Accessing EJBs Locally += Accessing EJBs Locally When OpenEJB embedded in your app, server, IDE, or JUnit, you can use what we call the Local Server and avoid the network overhead and enjoy @@ -52,5 +51,4 @@ easy for testing, debugging, developing, etc. = Embedding -!http://www.openejb.org/images/diagram-local-server.gif|valign=top, -align=right, hspace=15! \{include:OPENEJBx30:Embedding} +See link:embedding.html[Embedding] for details. diff --git a/docs/lookup-of-other-ejbs-example.adoc b/docs/lookup-of-other-ejbs-example.adoc index 043de21609..0a61ddfc6b 100644 --- a/docs/lookup-of-other-ejbs-example.adoc +++ b/docs/lookup-of-other-ejbs-example.adoc @@ -7,7 +7,7 @@ = Overview This example shows how to configure JNDI to lookup other EJBs using -either the _`@EJB_` annotation or the `ejb-jar.xml` deployment descriptor. +either the `@EJB` annotation or the `ejb-jar.xml` deployment descriptor. There are a couple interesting aspects in this example intended to flush out some of the more confusing, and perhaps frustrating, aspects of @@ -67,14 +67,14 @@ a namespace that is private to each bean and not visible to other beans Here we show the code for _RedBean_ and _BlueBean_ and their shared business local interface _Friend_. -\{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/RedBean.java|lang=java} -\{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/BlueBean.java|lang=java} -\{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/Friend.java|lang=java} +* link:https://github.com/apache/tomee/blob/main/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/RedBean.java[RedBean.java] +* link:https://github.com/apache/tomee/blob/main/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/BlueBean.java[BlueBean.java] +* link:https://github.com/apache/tomee/blob/main/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/Friend.java[Friend.java] -The key items in the above are the following: - _`@EJB_` has been used at +The key items in the above are the following: - `@EJB` has been used at the _class level_ to declare _myFriend_ in the _java:comp/env_ namespace of each EJB - because both beans share the _same interface_, _Friend_, -we need to add *beanName* to the _`@EJB_` usage to specify the exact EJB +we need to add *beanName* to the `@EJB` usage to specify the exact EJB we want - for _BlueBean_ the _java:comp/env/myFriend_ name has been configured to point to _RedBean_ - for _RedBean_ the _java:comp/env/myFriend_ name has been configured to point to _BlueBean_ @@ -83,7 +83,7 @@ _java:comp/env/myFriend_ name has been configured to point to _BlueBean_ If there is a desire to not use annotations, the above annotation usage is equivalent to the following `ejb-jar.xml` -\{snippet:url=openejb3/examples/lookup-of-ejbs-with-descriptor/src/main/resources/META-INF/ejb-jar.xml|lang=xml} +link:https://github.com/apache/tomee/blob/main/examples/lookup-of-ejbs-with-descriptor/src/main/resources/META-INF/ejb-jar.xml[ejb-jar.xml] = Writing a unit test for the example @@ -91,12 +91,12 @@ Writing a unit test for this example is quite simple. We need just to write a setup method to create and initialize the InitialContext, and then write our test methods -\{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/test/java/org/superbiz/ejblookup/EjbDependencyTest.java|lang=java} +link:https://github.com/apache/tomee/blob/main/examples/lookup-of-ejbs/src/test/java/org/superbiz/ejblookup/EjbDependencyTest.java[EjbDependencyTest.java] = Running Running the example is fairly simple. In the "lookup-of-ejbs" directory -of the openejb:download.html[examples zip] , just run: +of the link:https://github.com/apache/tomee/tree/main/examples/lookup-of-ejbs[lookup-of-ejbs example], just run: ___________________ $ mvn clean install diff --git a/docs/quickstart.adoc b/docs/quickstart.adoc index 19fe9f55ae..a6702bd4e2 100644 --- a/docs/quickstart.adoc +++ b/docs/quickstart.adoc @@ -6,7 +6,7 @@ = Installation -To install OpenEJB, simply link:downloads.html[download the latest +To install OpenEJB, simply https://tomee.apache.org/download-ng.html[download the latest binary] and unpack your zip or tar.gz into the directory where you want OpenEJB to live. @@ -38,10 +38,10 @@ For Windows users, that looks like this: For UNIX/Linux/Mac OS X users, that looks like this: -`[user@host openejb-3.0]([email protected]) # ./bin/openejb` +`[user@host openejb-3.0]# ./bin/openejb` You really only need to know two commands to use OpenEJB, -openejbx30:deploy-tool.html[deploy] and [start|OPENEJBx30:Startup] . +link:deploy-tool.html[deploy] and link:startup.html[start]. Both are completely documented and have examples. For help information and command options, try this: @@ -59,11 +59,11 @@ ________________________ That's it! If you don't have any EJBs or clients to run, try the ubiquitous -openejbx30:hello-world.html[Hello World] example. +link:hello-world.html[Hello World] example. = Join the mailing list The OpenEJB User list is where the general OpenEJB community goes to ask questions, make suggestions, chat with other users, and keep a finger on the pulse of the project. More information about the user list and dev -list can be found link:mailing-lists.html[here] +list can be found https://lists.apache.org/[email protected][here] diff --git a/docs/remote-server.adoc b/docs/remote-server.adoc index 8e1416635c..220f9f82a4 100644 --- a/docs/remote-server.adoc +++ b/docs/remote-server.adoc @@ -5,8 +5,7 @@ :jbake-status: published -!http://www.openejb.org/images/diagram-remote-server.gif|valign=top, -align=right, hspace=15! # Accessing EJBs Remotely +== Accessing EJBs Remotely When using OpenEJB as a stand-alone server you can connect across a network and access EJBs from a remote client. The client code for @@ -35,7 +34,7 @@ Deploy your bean with the Deploy Tool: c:\openejb> openejb.bat deploy beans\myBean.jar ---- -See the openejbx30:deploy-tool.html[OPENEJBx30:Deploy Tool] +See the link:deploy-tool.html[Deploy Tool] documentation for more details on deploying beans. Start the server: @@ -62,7 +61,7 @@ InitialContext ctx = new InitialContext(p); ---- If you don't have any EJBs or clients to run, try the ubiquitous -openejbx30:hello-world.html[Hello World] example. Add the following +link:hello-world.html[Hello World] example. Add the following library to your clients classpath: * openejb-client-x.x.x.jar diff --git a/docs/singleton-beans.adoc b/docs/singleton-beans.adoc index ae142a2dd6..d399e9ae3d 100644 --- a/docs/singleton-beans.adoc +++ b/docs/singleton-beans.adoc @@ -24,7 +24,7 @@ has an `@Startup` annotation which is similar in concept to the servlet you can use an `@DependsOn` annotation to say which other Singletons you need and the container will ensure they start before you. -See the link:singleton-example.html[Singleton Example] for sample bean +See the Singleton Example for sample bean code and client. == Concurrency @@ -66,7 +66,7 @@ easily put `@Lock`(READ) on their bean class, thus changing the default, and then `@Lock`(WRITE) on specific methods if needed. The locking modes of Container-Managed Concurrency map directly to the -_http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/ReadWriteLock.html[java.util.concurrent.ReadWriteLock] +_https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReadWriteLock.html[java.util.concurrent.ReadWriteLock] _ API which looks like this: [source,java] @@ -100,11 +100,10 @@ all the Singleton bean's methods. Essentially: The EJB container may use something other than ReadWriteLock but the semantics of a ReadWriteLock must be followed. Internally, we use an instance of -http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html[java.util.concurrent.ReentrantReadWriteLock] +https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantReadWriteLock.html[java.util.concurrent.ReentrantReadWriteLock] which supports correct memory synchronization, some reentrancy, lock downgrading, and -[more|http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html] -. +link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantReadWriteLock.html[more]. ==== Acquiring the Lock @@ -112,7 +111,7 @@ The `@AccessTimeout` annotation can configure how long a thread will wait to acquire the read or write lock. This annotation can be used on the bean class or individual methods. The annotation maps directly to the -http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/Lock.html[java.util.concurrent.locks.Lock] +https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/Lock.html[java.util.concurrent.locks.Lock] interface. [source,java] diff --git a/docs/singleton-ejb.adoc b/docs/singleton-ejb.adoc index a987d7c17c..bd748c234d 100644 --- a/docs/singleton-ejb.adoc +++ b/docs/singleton-ejb.adoc @@ -4,4 +4,4 @@ :jbake-type: page :jbake-status: published -\{include:OPENEJBx30:Singleton Beans} +See link:singleton-beans.html[Singleton Beans]. diff --git a/docs/startup.adoc b/docs/startup.adoc index fc5214938d..cace690f90 100644 --- a/docs/startup.adoc +++ b/docs/startup.adoc @@ -10,7 +10,7 @@ openejb start - OpenEJB Remote Server = SYNOPSIS -openejb start link:#options.html[#options] +openejb start [options] = NOTE @@ -31,13 +31,13 @@ _C:-3.0> binstart_ In UNIX, Linux, or Mac OS X, the deploy tool can be executed as follows: -`\[user@host openejb-3.0]([email protected]) # ./bin/openejb start` +`[user@host openejb-3.0]# ./bin/openejb start` Depending on your OpenEJB version, you may need to change execution bits to make the scripts executable. You can do this with the following command. -`\[user@host openejb-3.0]([email protected]) # chmod 755 bin/openejb` +`[user@host openejb-3.0]# chmod 755 bin/openejb` From here on out, it will be assumed that you know how to execute the right openejb script for your operating system and commands will appear @@ -264,7 +264,6 @@ output will be seen on the console Apache OpenEJB 3.0 build: 20070825-01:10 http://tomee.apache.org/ OpenEJB ready. -[OPENEJB:init] ---- OpenEJB Remote Server ** Starting Services ** NAME IP PORT httpejbd diff --git a/docs/telnet-console.adoc b/docs/telnet-console.adoc index 2ac2478758..7804c5358c 100644 --- a/docs/telnet-console.adoc +++ b/docs/telnet-console.adoc @@ -4,7 +4,7 @@ :jbake-type: page :jbake-status: published -\{note} Availability: Since OpenEJB 0.9\{note} +NOTE: Availability: Since OpenEJB 0.9 = Basic Usage diff --git a/docs/tomcat-object-factory.adoc b/docs/tomcat-object-factory.adoc index c70600fbf2..038492fbda 100644 --- a/docs/tomcat-object-factory.adoc +++ b/docs/tomcat-object-factory.adoc @@ -4,14 +4,12 @@ :jbake-type: page :jbake-status: published -_The TomcatEjbFactory as discussed in the -http://www.onjava.com/pub/a/onjava/2003/02/12/ejb_tomcat.html[OnJava -article "OpenEJB: EJB for Tomcat"] is no longer required._ +_The TomcatEjbFactory as discussed in the OnJava +article "OpenEJB: EJB for Tomcat" is no longer required._ As of OpenEJB 3.0 references from Servlets to EJBs happen automatically -with usage of the [`@EJB` -annotation](openejbx30:injection-of-other-ejbs-example.html) in the +with usage of the `@EJB` annotation in the Servlet, Filter or Listener declared in the `web.xml`. -See the openejbx30:tomcat.html[Tomcat Integration] page for the most +See the link:deploying-in-tomee.html[Deploying in TomEE] page for the most up-to-date details on using OpenEJB inside Tomcat. diff --git a/docs/validation-tool.adoc b/docs/validation-tool.adoc index 8c16e3f5fa..a4696de023 100644 --- a/docs/validation-tool.adoc +++ b/docs/validation-tool.adoc @@ -11,7 +11,7 @@ openejb validate - OpenEJB Validation Tool = SYNOPSIS -openejb validate link:options.html[options] jarfiles +openejb validate [options] jarfiles = NOTE @@ -24,22 +24,20 @@ In Windows, the validation tool can be executed as follows: _C:> openejb validate -help_ -\{warning} There is a bug in the openejb.bat script of OpenEJB 0.9.0 +WARNING: There is a bug in the openejb.bat script of OpenEJB 0.9.0 that doesn't allow you to execute the validate command as above. For that release, Windows users can execute the following command: _C:> bin.bat -help_ -\{warning} - In UNIX, Linux, or Mac OS X, the deploy tool can be executed as follows: -`[user@host openejb]([email protected]) # ./openejb.sh validate -help` +`[user@host openejb]# ./openejb.sh validate -help` Depending on your OpenEJB version, you may need to change execution bits to make the scripts executable. You can do this with the following command. -`[user@host openejb]([email protected]) # chmod 755 openejb.sh bin/*.sh` +`[user@host openejb]# chmod 755 openejb.sh bin/*.sh` From here on out, it will be assumed that you know how to execute the right openejb script for your operating system and commands will appear
