http://git-wip-us.apache.org/repos/asf/tomee/blob/c3f8984b/docs/jpa-concepts.mdtext ---------------------------------------------------------------------- diff --git a/docs/jpa-concepts.mdtext b/docs/jpa-concepts.mdtext deleted file mode 100644 index 0afb88c..0000000 --- a/docs/jpa-concepts.mdtext +++ /dev/null @@ -1,217 +0,0 @@ -Title: JPA Concepts -<a name="JPAConcepts-JPA101"></a> -# JPA 101 - -If there's one thing you have to understand to successfully use JPA (Java -Persistence API) it's the concept of a *Cache*. Almost everything boils -down to the Cache at one point or another. Unfortunately the Cache is an -internal thing and not exposed via the JPA API classes, so it not easy to -touch or feel from a coding perspective. - -Here's a quick cheat sheet of the JPA world: - - - A **Cache** is a **copy of data**, copy meaning pulled from but living -outside the database. - - **Flushing** a Cache is the act of putting modified data back into the -database. - - A **PersistenceContext** is essentially a Cache. It also tends to have -it's own non-shared database connection. - - An **EntityManager** represents a PersistenceContext (and therefore a -Cache) - - An **EntityManagerFactory** creates an EntityManager (and therefore a -PersistenceContext/Cache) - -Comparing `RESOURCE_LOCAL` and `JTA` persistence contexts - -With <persistence-unit transaction-type="**RESOURCE_LOCAL**"> **you** are -responsible for EntityManager (PersistenceContext/Cache) creating and -tracking... - -- You **must** use the **EntityManagerFactory** to get an EntityManager -- The resulting **EntityManager** instance **is** a -PersistenceContext/Cache -- An **EntityManagerFactory** can be injected via the **@PersistenceUnit** -annotation only (not @PersistenceContext) -- You are **not** allowed to use @PersistenceContext to refer to a unit -of type RESOURCE_LOCAL -- You **must** use the **EntityTransaction** API to begin/commit around -**every** call to your EntityManger -- Calling entityManagerFactory.createEntityManager() twice results in -**two** separate EntityManager instances and therefor **two** separate -PersistenceContexts/Caches. -- It is **almost never** a good idea to have more than one **instance** of -an EntityManager in use (don't create a second one unless you've destroyed -the first) - -With <persistence-unit transaction-type="**JTA**"> the **container** -will do EntityManager (PersistenceContext/Cache) creating and tracking... - -- You **cannot** use the **EntityManagerFactory** to get an EntityManager -- You can only get an **EntityManager** supplied by the **container** -- An **EntityManager** can be injected via the **@PersistenceContext** -annotation only (not @PersistenceUnit) -- You are **not** allowed to use @PersistenceUnit to refer to a unit of -type JTA -- The **EntityManager** given by the container is a **reference** to the -PersistenceContext/Cache associated with a JTA Transaction. -- If no JTA transaction is in progress, the EntityManager **cannot be -used** because there is no PersistenceContext/Cache. -- Everyone with an EntityManager reference to the **same unit** in the -**same transaction** will automatically have a reference to the **same -PersistenceContext/Cache** -- The PersistenceContext/Cache is **flushed** and cleared at JTA -**commit** time - -<a name="JPAConcepts-Cache==PersistenceContext"></a> -# Cache == PersistenceContext - -The concept of a database cache is an extremely important concept to be -aware of. Without a copy of the data in memory (i.e. a cache) when you -call account.getBalance() the persistence provider would have to go read -the value from the database. Calling account.getBalance() several times -would cause several trips to the database. This would obviously be a big -waste of resources. The other side of having a cache is that when you call -account.setBalance(5000) it also doesn't hit the database (usually). When -the cache is "flushed" the data in it is sent to the database via as many -SQL updates, inserts and deletes as are required. That is the basics of -java persistence of any kind all wrapped in a nutshell. If you can -understand that, you're good to go in nearly any persistence technology -java has to offer. - -Complications can arise when there is more than one -PersistenceContext/Cache relating the same data in the same transaction. -In any given transaction you want exactly one PersistenceContext/Cache for -a given set of data. Using a JTA unit with an EntityManager -created by the container will always guarantee that this is the case. With -a RESOURCE_LOCAL unit and an EntityManagerFactory you should create and use -exactly one EntityManager instance in your transaction to ensure there is -only one active PersistenceContext/Cache for the given set of data active -against the current transaction. - -<a name="JPAConcepts-CachesandDetaching"></a> -# Caches and Detaching - -Detaching is the concept of a persistent object **leaving** the -PersistenceContext/Cache. Leaving means that any updates made to the -object are **not** reflected in the PersistenceContext/Cache. An object will -become Detached if it somehow **lives longer** or is **used outside** the scope -of the PersistenceContext/Cache. - -For a JTA unit, the PersistenceContext/Cache will live as long as -the transaction does. When a transaction completes (commits or rollsback) -all objects that were in the PersistenceContext/Cache are Detached. You -can still use them, but they are no longer associated with a -PersistenceContext/Cache and modifications on them will **not** be reflected -in a PersistenceContext/Cache and therefore not the database either. - -Serializing objects that are currently in a PersistenceContext/Cache will -also cause them to Detach. - -In some cases objects or collections of objects that become Detached may -not have all the data you need. This can be because of lazy loading. With -lazy loading, data isn't pulled from the database and into the -PersistenceContext/Cache until it is requested in code. In many cases the -Collections of persistent objects returned from an -javax.persistence.Query.getResultList() call are completely empty until you -iterate over them. A side effect of this is that if the Collection becomes -Detached before it's been fully read it will be permanently empty and of no -use and calling methods on the Detached Collection can cause strange errors -and exceptions to be thrown. If you wish to Detach a Collection of -persistent objects it is always a good idea to iterate over the Collection -at least once. - -You **cannot** call EntityManager.persist() or EntityManager.remove() on a -Detached object. - -Calling EntityManager.merge() will re-attach a Detached object. - -<a name="JPAConcepts-ValidRESOURCE_LOCALUnitusage"></a> -# Valid RESOURCE_LOCAL Unit usage - -Servlets and EJBs can use RESOURCE_LOCAL persistence units through the -EntityManagerFactory as follows: - - <?xml version="1.0" encoding="UTF-8" ?> - <persistence xmlns="http://java.sun.com/xml/ns/persistence"; version="1.0"> - - <!-- Tutorial "unit" --> - <persistence-unit name="Tutorial" transaction-type="RESOURCE_LOCAL"> - <non-jta-data-source>myNonJtaDataSource</non-jta-data-source> - <class>org.superbiz.jpa.Account</class> - </persistence-unit> - - </persistence> - -And referenced as follows - - import javax.persistence.EntityManagerFactory; - import javax.persistence.EntityManager; - import javax.persistence.EntityTransaction; - import javax.persistence.PersistenceUnit; - - public class MyEjbOrServlet ... { - - @PersistenceUnit(unitName="Tutorial") - private EntityManagerFactory factory; - - // Proper exception handling left out for simplicity - public void ejbMethodOrServletServiceMethod() throws Exception { - EntityManager entityManager = factory.createEntityManager(); - - EntityTransaction entityTransaction = entityManager.getTransaction(); - - entityTransaction.begin(); - - Account account = entityManager.find(Account.class, 12345); - - account.setBalance(5000); - - entityTransaction.commit(); - } - - ... - } - - -# Valid JTA Unit usage - -EJBs can use JTA persistence units through the EntityManager as -follows: - - <?xml version="1.0" encoding="UTF-8" ?> - <persistence xmlns="http://java.sun.com/xml/ns/persistence"; version="1.0"> - - <!-- Tutorial "unit" --> - <persistence-unit name="Tutorial" transaction-type="JTA"> - <jta-data-source>myJtaDataSource</jta-data-source> - <non-jta-data-source>myNonJtaDataSource</non-jta-data-source> - <class>org.superbiz.jpa.Account</class> - </persistence-unit> - - </persistence> - -And referenced as follows - - import javax.ejb.Stateless; - import javax.ejb.TransactionAttribute; - import javax.ejb.TransactionAttributeType; - import javax.persistence.EntityManager; - import javax.persistence.PersistenceContext; - - @Stateless - public class MyEjb implements MyEjbInterface { - - @PersistenceContext(unitName = "Tutorial") - private EntityManager entityManager; - - // Proper exception handling left out for simplicity - @TransactionAttribute(TransactionAttributeType.REQUIRED) - public void ejbMethod() throws Exception { - - Account account = entityManager.find(Account.class, 12345); - - account.setBalance(5000); - - } - } -
http://git-wip-us.apache.org/repos/asf/tomee/blob/c3f8984b/docs/jpa-usage.mdtext ---------------------------------------------------------------------- diff --git a/docs/jpa-usage.mdtext b/docs/jpa-usage.mdtext deleted file mode 100644 index 6a5cf39..0000000 --- a/docs/jpa-usage.mdtext +++ /dev/null @@ -1,50 +0,0 @@ -Title: JPA Usage -<a name="JPAUsage-Thingstowatchoutfor"></a> -# Things to watch out for - -<a name="JPAUsage-Critical:Alwayssetjta-data-sourceandnon-jta-data-source"></a> -## Critical: Always set jta-data-source and non-jta-data-source - -Always set the value of jta-data-source and non-jta-data-source in your -persistence.xml file. Regardless if targeting your EntityManager usage for -transaction-type="RESOURCE_LOCAL" or transaction-type="TRANSACTION", it's -very difficult to guarantee one or the other will be the only one needed. -Often times the JPA Provider itself will require both internally to do -various optimizations or other special features. - -* The *jta-data-source* should always have it's OpenEJB-specific -'*JtaManaged*' property set to '*true*' (this is the default) -* The *non-jta-data-source* should always have it's OpenEJB-specific -'*JtaManaged*' property set to '*false*'. - -See [Containers and Resources](containers-and-resources.html) - for how to configure 'JtaManaged' and a full list of <Resource> properties -for DataSources. - -<a name="JPAUsage-Bedetachaware"></a> -## Be detach aware - -A warning for any new JPA user is by default all objects will detach at the -end of a transaction. People typically discover this when the go to remove -or update an object they fetched previously and get an exception like "You -cannot perform operation delete on detached object". - -All ejb methods start a transaction unless a) you [configure them otherwise](transaction-annotations.html) -, or b) the caller already has a transaction in progress when it calls the -bean. If you're in a test case or a servlet, it's most likely B that is -biting you. You're asking an ejb for some persistent objects, it uses the -EntityManager in the scope of the transaction started around it's method -and returns some persistent objects, by the time you get them the -transaction has completed and now the objects are detached. - -<a name="JPAUsage-Solutions"></a> -### Solutions -1. Call EntityManager.merge(..) inside the bean code to reattach your -object. -1. Use PersistenceContextType.EXTENDED as in '@PersistenceContext(unitName -= "movie-unit", type = PersistenceContextType.EXTENDED)' for EntityManager -refs instead of the default of PersistenceContextType.TRANSACTION. -1. If testing, use a technique to execute transactions in your test code. -That's described here in [Unit testing transactions](unit-testing-transactions.html) - - http://git-wip-us.apache.org/repos/asf/tomee/blob/c3f8984b/docs/local-client-injection.mdtext ---------------------------------------------------------------------- diff --git a/docs/local-client-injection.mdtext b/docs/local-client-injection.mdtext deleted file mode 100644 index 4387fd9..0000000 --- a/docs/local-client-injection.mdtext +++ /dev/null @@ -1,85 +0,0 @@ -Title: Local Client Injection -{note:title=OpenEJB 3.1.1 or later required} - -The *@LocalClient* annotation (org.apache.openejb.api.LocalClient) is an -innovation that crosses concepts of an Java EE Application Client with a -plain Java SE client. This particular annotation is focused on clients of -an Embeddable EJB container, i.e. local clients. There is another -annotation in development called @RemoteClient that will be focused on -remote clients; clients running outside the vm the container runs. - -Any clients annotated with @LocalClient will be scanned at deployment time -for usage of injection-related annotations. The references in the -@LocalClient will be processed with the application just as if the class -was a Java EE Application Client module, but with a few slight differences: - -1. Declaring field/method injection points as 'static' is not required -1. References to EntityManagers via @PersistenceContext are allowed -1. References to local business interfaces via @EJB is allowed -1. References to UserTransaction via @Resource is allowed - -As well since this is not a heavyweight Java EE Application Client, you are -not required to use any special packaging or command-line parameters to run -the client. Your client can be a Unit Test or any plain java code that -needs to pull objects from the Embedded EJB container. Classes with -@LocalClient can be placed in a Client module or an EJB module. A given -module may have as many classes annotated with @LocalClient as it wishes. - -<a name="LocalClientInjection-Injection"></a> -# Injection - -The injection occurs via acquiring a LocalInitialContext via the -LocalInitialContextFactory and calling _bind("inject", instance)_ passing -in the instantiated local client object: - - - @LocalClient - public class MoviesTest extends TestCase { - - @EJB - private Movies movies; - - @Resource - private UserTransaction userTransaction; - - @PersistenceContext - private EntityManager entityManager; - - public void setUp() throws Exception { - Properties p = new Properties(); - p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.LocalInitialContextFactory"); - InitialContext initialContext = new InitialContext(p); - initialContext.bind("inject", this); - } - - //... other test methods - } - - -<a name="LocalClientInjection-Discovery"></a> -# Discovery - -All EJB modules are scanned for @LocalClient classes, even if those EJB -Modules are inside .war files as with the [Collapsed EAR](collapsed-ear.html) -. As well any modules that contain a META-INF/application-client.xml file -will be scanned for @LocalClient classes. - -If you see the following error message and are absolutely sure the module -containing your @LocalClient class is being properly identified as an EJB -module or a Client module, than it is possible you are seeing some -classloading issues. - -{panel} -javax.naming.NamingException: Unable to find injection meta-data for -org.superbiz.MyClient. Ensure that class was annotated with [email protected] and was successfully discovered and -deployed. -{panel} - -If you encounter this try setting this openejb-specific boot flag so that -annotations will be treated specially and always loaded by the parent -classloader - -`openejb.tempclassloader.skip=annotations` - - http://git-wip-us.apache.org/repos/asf/tomee/blob/c3f8984b/docs/local-server.mdtext ---------------------------------------------------------------------- diff --git a/docs/local-server.mdtext b/docs/local-server.mdtext deleted file mode 100644 index acacb2c..0000000 --- a/docs/local-server.mdtext +++ /dev/null @@ -1,57 +0,0 @@ -Title: Local Server -!http://www.openejb.org/images/diagram-local-server.gif|valign=top, -align=right, hspace=15! -<a name="LocalServer-AccessingEJBsLocally"></a> -# Accessing EJBs Locally - -When OpenEJB embedded in your app, server, IDE, or JUnit, you can use what -we call the Local Server and avoid the network overhead and enjoy an easy -way to embedd OpenEJB. Instead of putting the app in the server, put the -server in the app! - -<a name="LocalServer-Saywhat?!Alocalserver?"></a> -# Say what?! A local server? - -Yes, you read correctly. OpenEJB can be embedded and treated as your very -own personal EJB container. - -If they can have Local and Remote EJB's, why not Local and Remote EJB -Servers too? - -Haven't you ever wanted EJBs without the heavy? I mean you need the "heavy" -eventually, but not while you're developing. Well, there's the advantage of -an EJB implementation that was designed with a very clean and well defined -server-container contract, you can cut the server part out completely! - -So, if you wish to access ejbs locally and not in client/server mode, you -can do so by embedding OpenEJB as a library and accessing ejbs through -OpenEJB's built-in IntraVM (Local) Server. Why would someone want to do -this? -* Your application is a server or other middleware -* You want to write an app that can be both stand alone *and* distributed -* To test your EJBs with JUnit and don't want to start/stop servers and -other nonsense -* Imagine the power from being able to use your IDE debugger to step from -your Client all the way into your EJB and back with no remote debugging -voodoo. - -In this case, your application, test suite, IDE, or client accesses beans -as you would from any other EJB Server. The EJB Server just happens to be -running in the same virtual machine as your application. This EJB Server is -thusly called the IntraVM Server, and, for all intense purposes, your -application an IntraVM Client. - -There are some interesting differences though. The IntraVM Server isn't a -heavyweight server as one normally associates with EJB. It doesn't open -connections, launch threads for processing requests, introduce complex -classloading heirarchies, or any of those "heavy" kind of things. All it -does is dish out proxies to your app that can be used to shoot calls right -into the EJB Container. Very light, very fast, very easy for testing, -debugging, developing, etc. - -<a name="LocalServer-Embedding"></a> -# Embedding - -!http://www.openejb.org/images/diagram-local-server.gif|valign=top, -align=right, hspace=15! -{include:OPENEJBx30:Embedding} http://git-wip-us.apache.org/repos/asf/tomee/blob/c3f8984b/docs/lookup-of-other-ejbs-example.mdtext ---------------------------------------------------------------------- diff --git a/docs/lookup-of-other-ejbs-example.mdtext b/docs/lookup-of-other-ejbs-example.mdtext deleted file mode 100644 index 5681e06..0000000 --- a/docs/lookup-of-other-ejbs-example.mdtext +++ /dev/null @@ -1,147 +0,0 @@ -Title: Lookup of other EJBs Example -<a name="LookupofotherEJBsExample-Overview"></a> -# Overview - -This example shows how to configure JNDI to lookup other EJBs using either -the *@EJB* annotation or the *ejb-jar.xml* deployment descriptor. - -There are a couple interesting aspects in this example intended to flush -out some of the more confusing, and perhaps frustrating, aspects of -referring to EJBs. - - - beans themselves do not have JNDI names (this was only recently added in -Java EE 6) - -This is the most frustrating and hard to accept. Java EE 5 does not have a -global namespace and therefore there is no *singular* name for your EJB. -It does not matter what you do to your EJB, there is no standard way to -"give" the bean a name that can be used by the application globally. - - - each EJB owns its own private *java:comp/env* namespace -(*java:comp/env* is not global and cannot be treated that way) - - names do not magically appear in *java:comp/env*, they must be -explicitly added. - - to get a reference to bean *B* in the *java:comp/env* namespace of -bean *A*, bean *A* must declare a reference to bean *B*. - -You read this right. If you have 10 EJBs and all of them want to refer to -bean *B*, then you must declare bean *B* as a reference 10 times (once -for each of the 10 beans). There is no standard way in Java EE 5 to do -this just once for all beans. In Java EE 6 there is a "*java:global*" -namespace, a "*java:app*" namespace, and a "*java:module*" namespace -where names can be defined with the desired scope. Java EE 5 has only -*java:comp*. - -There are two things which make this even more confusing: - - - Servlets have always defined *java:comp/env* differently. In a -webapp, the *java:comp/env* namespace is shared by all servlets. This is -essentially equivalent to the *java:module* namespace in Java EE 6. -Understand there is a conflict in definition here and that for EJBs, -*java:comp* is scoped at the component (the EJB itself) not the module as -with webapps. - - All vendors have some proprietary concept of global JNDI. So you may be -able to lookup "*java:/MyBean*" or "*MyBeanLocal*", but these are -vendor-specific and non-portable. - -As well this example shows some other interesting aspects of referring to -EJBs: - - - Two beans may use the same business interfaces, the interface alone does -not necessarily identify the exact bean - - circular references are possible - -To illustrate all of this, we have two simple @Stateless beans, *RedBean* -and *BlueBean*. Both implement the same business local interface, -*Friend*. Both *RedBean* and *BlueBean* define -*java:comp/env/myFriend* differently which is allowed as *java:comp* is -a namespace that is private to each bean and not visible to other beans -- -so the names do not have to match. - - -<a name="LookupofotherEJBsExample-TheCode"></a> -# The Code - -Here we show the code for *RedBean* and *BlueBean* and their shared -business local interface *Friend*. -{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/RedBean.java|lang=java} -{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/BlueBean.java|lang=java} -{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/main/java/org/superbiz/ejblookup/Friend.java|lang=java} - -The key items in the above are the following: - - *@EJB* has been used at the *class level* to declare *myFriend* in -the *java:comp/env* namespace of each EJB - - because both beans share the *same interface*, *Friend*, we need to -add **beanName** to the *@EJB* usage to specify the exact EJB we want - - for *BlueBean* the *java:comp/env/myFriend* name has been configured -to point to *RedBean* - - for *RedBean* the *java:comp/env/myFriend* name has been configured -to point to *BlueBean* - -<a name="LookupofotherEJBsExample-Alternativetoannotations"></a> -## Alternative to annotations - -If there is a desire to not use annotations, the above annotation usage is -equivalent to the following ejb-jar.xml -{snippet:url=openejb3/examples/lookup-of-ejbs-with-descriptor/src/main/resources/META-INF/ejb-jar.xml|lang=xml} - -<a name="LookupofotherEJBsExample-Writingaunittestfortheexample"></a> -# Writing a unit test for the example - -Writing an unit test for this example is quite simple. We need just to -write a setup method to create and initialize the InitialContext, and then -write our test methods - -{snippet:id=code|url=openejb3/examples/lookup-of-ejbs/src/test/java/org/superbiz/ejblookup/EjbDependencyTest.java|lang=java} - -<a name="LookupofotherEJBsExample-Running"></a> -# Running - -Running the example is fairly simple. In the "lookup-of-ejbs" directory of -the [examples zip](openejb:download.html) -, just run: - -> $ mvn clean install - -Which should create output like the following. - - - ------------------------------------------------------- - T E S T S - ------------------------------------------------------- - Running org.superbiz.ejblookup.EjbDependencyTest - Apache OpenEJB 3.1.5-SNAPSHOT build: 20101129-09:51 - http://tomee.apache.org/ - INFO - openejb.home = -/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs - INFO - openejb.base = -/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs - INFO - Configuring Service(id=Default Security Service, -type=SecurityService, provider-id=Default Security Service) - INFO - Configuring Service(id=Default Transaction Manager, -type=TransactionManager, provider-id=Default Transaction Manager) - INFO - Found EjbModule in classpath: -/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs/target/classes - INFO - Beginning load: -/Users/dblevins/work/openejb-3.1.x/examples/lookup-of-ejbs/target/classes - INFO - Configuring enterprise application: classpath.ear - INFO - Configuring Service(id=Default Stateless Container, type=Container, -provider-id=Default Stateless Container) - INFO - Auto-creating a container for bean BlueBean: -Container(type=STATELESS, id=Default Stateless Container) - INFO - Enterprise application "classpath.ear" loaded. - INFO - Assembling app: classpath.ear - INFO - Jndi(name=BlueBeanLocal) --> Ejb(deployment-id=BlueBean) - INFO - Jndi(name=RedBeanLocal) --> Ejb(deployment-id=RedBean) - INFO - Created Ejb(deployment-id=RedBean, ejb-name=RedBean, -container=Default Stateless Container) - INFO - Created Ejb(deployment-id=BlueBean, ejb-name=BlueBean, -container=Default Stateless Container) - INFO - Deployed Application(path=classpath.ear) - Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.244 sec - - Results : - - Tests run: 2, Failures: 0, Errors: 0, Skipped: 0 - - http://git-wip-us.apache.org/repos/asf/tomee/blob/c3f8984b/docs/managedcontainer-config.mdtext ---------------------------------------------------------------------- diff --git a/docs/managedcontainer-config.mdtext b/docs/managedcontainer-config.mdtext deleted file mode 100644 index a41651e..0000000 --- a/docs/managedcontainer-config.mdtext +++ /dev/null @@ -1,24 +0,0 @@ -Title: ManagedContainer Configuration - - -A ManagedContainer can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional. - - <Container id="myManagedContainer" type="MANAGED"> - </Container> - -Alternatively, a ManagedContainer can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext` - - myManagedContainer = new://Container?type=MANAGED - -Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared ManagedContainer a warning will be logged. If a ManagedContainer is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple ManagedContainer declarations are allowed. -# Supported Properties -<table class="mdtable"> -<tr> -<th>Property</th> -<th>Type</th> -<th>Default</th> -<th>Description</th> -</tr> -</table> - - http://git-wip-us.apache.org/repos/asf/tomee/blob/c3f8984b/docs/manual-installation.mdtext ---------------------------------------------------------------------- diff --git a/docs/manual-installation.mdtext b/docs/manual-installation.mdtext deleted file mode 100644 index d24e01d..0000000 --- a/docs/manual-installation.mdtext +++ /dev/null @@ -1,223 +0,0 @@ -Title: Manual Installation - -# Overview - -The manual installation process is significantly harder then the [automatic installation](tomcat.html) - which we normally recommend. In this installation process you will do the -following: - -1. Install openejb.war -1. Download openejb.war from the [download page](http://tomee.apache.org/downloads.html) -1. Make webapps/openejb directory -1. Change to new webapps/openejb directory -1. Unpack the openejb.war file in the new directory -1. Add the OpenEJB listener the conf/server.xml file -1. Update the non-compliant Tomcat annotations-api.jar -1. Add the OpenEJB JavaAgent to the bin/catalina.bat or bin/catalina.bat -script - -##Install openejb.war - -Once Tomcat has been [installed](tomcat-installation.html) -, the OpenEJB plugin for Tomcat can be installed. The war can be obtained -from the [download page](http://tomee.apache.org/downloads.html) - -The commands in this example are executed from within the Tomcat -installation directory. - -<a name="ManualInstallation-UnpackOpenEJBTomcatplugininTomcatwebappsdirectory"></a> -## Unpack OpenEJB Tomcat plugin in Tomcat webapps directory - -Be careful, this is the most error prone step. A web -application does not contain a root directory, so if you unpack it in the -wrong directory, it is difficult to undo. Please, follow this step -closely, and most importantly make sure you execute the unpack command -from within the new webapps/openejb directory - -Due to the structure of war files, you must create a new directory for -OpenEJB, change to the new directory and execute the unpack command from -within the new directory. If you get this wrong, it is difficult to undo, -so follow the steps closely. - -<pre><code> - C:\apache-tomcat-6.0.14>mkdir webapps\openejb - - C:\apache-tomcat-6.0.14>cd webapps\openejb - - C:\apache-tomcat-6.0.14\webapps\openejb>jar -xvf \openejb.war - created: WEB-INF/ - created: WEB-INF/classes/ - created: WEB-INF/classes/org/ - created: WEB-INF/classes/org/apache/ - created: WEB-INF/classes/org/apache/openejb/ - ...snip... - - C:\apache-tomcat-6.0.14\webapps\openejb>dir - Volume in drive C has no label. - Volume Serial Number is 0000-0000 - - Directory of C:\apache-tomcat-6.0.14\webapps\openejb - - 09/21/2007 10:19 AM <DIR> . - 09/21/2007 10:19 AM <DIR> .. - 09/21/2007 10:19 AM 1,000 index.html - 09/21/2007 10:19 AM <DIR> lib - 09/21/2007 10:19 AM 11,358 LICENSE - 09/21/2007 10:19 AM <DIR> META-INF - 09/21/2007 10:19 AM 11,649 NOTICE - 09/21/2007 10:19 AM 1,018 openejb.xml - 09/21/2007 10:19 AM 1,886 README.txt - 09/21/2007 10:19 AM <DIR> tomcat - 09/21/2007 10:19 AM <DIR> WEB-INF - 5 File(s) 26,911 bytes - 6 Dir(s) 4,633,796,608 bytes free - - C:\apache-tomcat-6.0.14\webapps\openejb>cd ..\.. - - C:\apache-tomcat-6.0.14> - - {card:label=Unix}{noformat:nopanel=true} - apache-tomcat-6.0.14$ mkdir webapps/openejb - - apache-tomcat-6.0.14$ cd webapps/openejb/ - - apache-tomcat-6.0.14/webapps/openejb$ jar -xvf path/to/openejb.war - created: WEB-INF/ - created: WEB-INF/classes/ - created: WEB-INF/classes/org/ - created: WEB-INF/classes/org/apache/ - created: WEB-INF/classes/org/apache/openejb/ - ...snip... - - apache-tomcat-6.0.14/webapps/openejb$ ls - LICENSE META-INF/ NOTICE README.txt WEB-INF/ index.html - lib/ openejb.xml tomcat/ - - apache-tomcat-6.0.14/webapps/openejb$ cd ../.. - - apache-tomcat-6.0.14$ - -</code></pre> - -<a name="ManualInstallation-AddtheOpenEJBlistenertoTomcat"></a> -## Add the OpenEJB listener to Tomcat - -All Tomcat listener classes must be available in the Tomcat common class -loader, so the openejb-loader jar must be copied into the Tomcat lib -directory. - - - C:\apache-tomcat-6.0.14>copy webapps\openejb\lib\openejb-loader-3.0.0-SNAPSHOT.jar lib\openejb-loader.jar - 1 file(s) copied. - - apache-tomcat-6.0.14$ cp webapps/openejb/lib/openejb-loader-*.jar lib/openejb-loader.jar - - -Add the following `<Listener -className="org.apache.openejb.loader.OpenEJBListener" />` to your conf/server.xml file to load the OpenEJB listener: - -The snippet is shown below - - <!-- Note: A "Server" is not itself a "Container", so you may not - define subcomponents such as "Valves" at this - level. - Documentation at /docs/config/server.html - --> - - <Server port="8005" shutdown="SHUTDOWN"> - <!-- OpenEJB plugin for tomcat --> - <Listener - className="org.apache.openejb.loader.OpenEJBListener" /> - - <!--APR library loader. Documentation at /docs/apr.html --> - <Listener - className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" /> - -<a name="ManualInstallation-UpdatetheTomcatannotations-api.jarfile"></a> -## Update the Tomcat annotations-api.jar file - -Tomcat contains an old non-compliant version of the javax.annotation -classes and these invalid classes must be updated so OpenEJB can process -annotations. Simply, replace the annotations-api.jar in the Tomcat lib -directory with the updated annotations-api.jar in the OpenEJB war. - -<pre><code> - -C:\apache-tomcat-6.0.14>copy webapps\openejb\tomcat\annotations-api.jar -lib\annotations-api.jar -Overwrite lib\annotations-api.jar? (Yes/No/All): y - 1 file(s) copied. - -apache-tomcat-6.0.14$ cp webapps/openejb/tomcat/annotations-api.jar -lib/annotations-api.jar - -</code></pre> - -<a name="ManualInstallation-{anchor:javaagent}AddOpenEJBjavaagenttoTomcatstartup"></a> -## Add OpenEJB javaagent to Tomcat startup - -OpenJPA, the Java Persistence implementation used by OpenEJB, currently -must enhanced persistence classes to function properly, and this requires -the installation of a javaagent into the Tomcat startup process. - -First, copy the OpenEJB JavaAgent jar into the lib directory. - -<pre><code> - - C:\apache-tomcat-6.0.14>copy webapps\openejb\lib\openejb-javaagent-3.0.0-SNAPSHOT.jar lib\openejb-javaagent.jar - 1 file(s) copied. - - apache-tomcat-6.0.14$ cp webapps/openejb/lib/openejb-javaagent-*.jar lib/openejb-javaagent.jar - -</code></pre> - -Simply, add the snippet marked below in -bin/catalina.bat (Windows) or bin/catalina.sh (Unix) file to enable the -OpenEJB javaagent: - - if not exist "%CATALINA_BASE%\conf\logging.properties" goto noJuli - set JAVA_OPTS=%JAVA_OPTS% - -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager - -Djava.util.logging.config.file="%CATALINA_BASE%\conf\logging.properties" - :noJuli - - # Start of Snippet to add - rem Add OpenEJB javaagent if not exist - "%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar" goto - noOpenEJBJavaagent set - JAVA_OPTS="-javaagent:%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar" - %JAVA_OPTS% :noOpenEJBJavaagent - # End of Snippet to add - - - rem ----- Execute The Requested Command - --------------------------------------- - echo Using CATALINA_BASE: %CATALINA_BASE% - echo Using CATALINA_HOME: %CATALINA_HOME% - - - - # Set juli LogManager if it is present - if [OPENEJB: -r "$CATALINA_BASE"/conf/logging.properties ](openejb:--r-"$catalina_base"/conf/logging.properties-.html) - ; then - JAVA_OPTS="$JAVA_OPTS - "-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager" - "-Djava.util.logging.config.file="$CATALINA_BASE/conf/logging.properties" - fi - - #Start of Snippet to add - if [OPENEJB: -r "$CATALINA_BASE"/webapps/lib/openejb-javaagent.jar ](openejb:--r-"$catalina_base"/webapps/lib/openejb-javaagent.jar-.html) - ; then - JAVA_OPTS=""-javaagent:$CATALINA_BASE/lib/openejb-javaagent.jar" - $JAVA_OPTS" - fi - #End of Snippet to add - - - -##Note: - The example above is an excerpt from the middle of the -bin/catalina.sh file. Search for the this section and add the snippet shown - - - http://git-wip-us.apache.org/repos/asf/tomee/blob/c3f8984b/docs/maven.mdtext ---------------------------------------------------------------------- diff --git a/docs/maven.mdtext b/docs/maven.mdtext deleted file mode 100644 index 41eb91c..0000000 --- a/docs/maven.mdtext +++ /dev/null @@ -1,38 +0,0 @@ -# Maven Information - -This page is intended to provide an insight into basic [Maven](http://maven.apache.org/) usage for users that are not all that familiar with [Maven](http://maven.apache.org/) projects. -It is by no means a tutorial and is designed to be more of a *quickstart* to get you up and running. - -You can find a really good [Maven](http://maven.apache.org/) tutorial here: [http://books.sonatype.com/mvnex-book/reference/public-book.html](http://books.sonatype.com/mvnex-book/reference/public-book.html) - -It is assumed that: - - - You have downloaded and installed [Maven](http://maven.apache.org/) and that you can run **mvn --version** from any command prompt (or console). - - You have downloaded and installed [Subversion](http://subversion.apache.org/) and that you can run **svn --version** from any command prompt or console. - -It is also assumed you have downloaded one of the following: - - - One of the example projects from [http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples]() - - The entire project source from [http://svn.apache.org/repos/asf/tomee/tomee/trunk](http://svn.apache.org/repos/asf/tomee/tomee/trunk) - -Use [Subversion](http://subversion.apache.org/) to checkout the example sources from a console like so: - - svn co http://svn.apache.org/repos/asf/tomee/tomee/trunk/examples/[example] - -Or that you may of course also be using your own project pom.xml - -If you want to use the latest snapshot locate the *<repositories>* section in your pom.xml and ensure the following repository exists: - - <repositories> - <repository> - <id>apache-m2-snapshot</id> - <name>Apache M2 Snapshot Repository</name> - <url>http://repository.apache.org/snapshots/</url> - <releases> - <enabled>false</enabled> - </releases> - <snapshots> - <enabled>true</enabled> - </snapshots> - </repository> - </repositories> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/tomee/blob/c3f8984b/docs/maven/build-mojo.mdtext ---------------------------------------------------------------------- diff --git a/docs/maven/build-mojo.mdtext b/docs/maven/build-mojo.mdtext deleted file mode 100644 index d666cc9..0000000 --- a/docs/maven/build-mojo.mdtext +++ /dev/null @@ -1,1422 +0,0 @@ -<div class="section"> -<h2>tomee:build<a name="tomee:build"></a></h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:build</p> - -<p><b>Description</b>:</p> - -<div>Create but not run a TomEE.</div> - -<p><b>Attributes</b>:</p> - -<ul> - -<li>Requires a Maven project to be executed.</li> - -<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li> - -<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li> - </ul> - -<div class="section"> -<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> - -<table class="mdtable"> - -<tr class="a"> - -<th>Name</th> - -<th>Type</th> - -<th>Since</th> - -<th>Description</th> - </tr> - -<tr class="b"> - -<td><b><a href="#apacheRepos">apacheRepos</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>snapshots</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.apache-repos</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#appDir">appDir</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>apps</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#apps">apps</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#args">args</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.args</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#attach">attach</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.attach</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#bin">bin</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/bin</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.bin</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#catalinaBase">catalinaBase</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.catalina-base</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#checkStarted">checkStarted</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.check-started</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#classifier">classifier</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#classpaths">classpaths</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#config">config</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/conf</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.conf</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#context">context</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>rename the current artifact<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#debug">debug</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debug</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#debugPort">debugPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>5005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debugPort</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#deployOpenEjbApplication">deployOpenEjbApplication</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#docBases">docBases</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>for TomEE and wars only, which docBase to use for this war.<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#ejbRemote">ejbRemote</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ejb-remote</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#externalRepositories">externalRepositories</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>for TomEE and wars only, add some external repositories to -classloader.<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#forceReloadable">forceReloadable</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>force webapp to be reloadable<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.force-reloadable</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#javaagents">javaagents</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#keepServerXmlAsthis">keepServerXmlAsthis</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(Removed since 7.0.0)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.keep-server-xml</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#lib">lib</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/lib</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.lib</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#libDir">libDir</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>lib</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#libs">libs</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>supported formats: --> groupId:artifactId:version... --> -unzip:groupId:artifactId:version... --> remove:prefix (often -prefix = artifactId)<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#mainDir">mainDir</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#password">password</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#quickSession">quickSession</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>use a real random instead of secure random. saves few ms at -startup.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.quick-session</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#realm">realm</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#removeDefaultWebapps">removeDefaultWebapps</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-default-webapps</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#removeTomeeWebapp">removeTomeeWebapp</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-tomee-webapps</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#simpleLog">simpleLog</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.simple-log</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#skipCurrentProject">skipCurrentProject</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipCurrentProject</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#skipWarResources">skipWarResources</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>when you set docBases to src/main/webapp setting it to true will -allow hot refresh.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipWarResources</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#systemVariables">systemVariables</a></b></td> - -<td><tt>Map</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#target">target</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeAjpPort">tomeeAjpPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>8009</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ajp</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeAlreadyInstalled">tomeeAlreadyInstalled</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exiting</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeArtifactId">tomeeArtifactId</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.artifactId</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeClassifier">tomeeClassifier</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>webprofile</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeGroupId">tomeeGroupId</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.groupId</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeHost">tomeeHost</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeHttpsPort">tomeeHttpsPort</a></b></td> - -<td><tt>Integer</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.https</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeShutdownCommand">tomeeShutdownCommand</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>SHUTDOWN</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown-command</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeShutdownPort">tomeeShutdownPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>8005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeVersion">tomeeVersion</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>-1</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.version</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#useConsole">useConsole</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.use-console</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#useOpenEJB">useOpenEJB</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>use openejb-standalone automatically instead of TomEE<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.openejb</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#user">user</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#warFile">warFile</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#webappClasses">webappClasses</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappClasses</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#webappDefaultConfig">webappDefaultConfig</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>forcing nice default for war development (WEB-INF/classes and web -resources)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappDefaultConfig</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#webappDir">webappDir</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>webapps</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#webappResources">webappResources</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/webapp</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappResources</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#webapps">webapps</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#zip">zip</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.zip</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#zipFile">zipFile</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.zip</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.zip-file</tt>.</td> - </tr> - </table> - </div> - -<div class="section"> -<h3>Parameter Details<a name="Parameter_Details"></a></h3> - -<p><b><a name="apacheRepos">apacheRepos</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.apache-repos</tt></li> - -<li><b>Default</b>: <tt>snapshots</tt></li> - </ul><hr /> -<p><b><a name="appDir">appDir</a>:</b></p> - -<div>relative to tomee.base.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>apps</tt></li> - </ul><hr /> -<p><b><a name="apps">apps</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="args">args</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.args</tt></li> - </ul><hr /> -<p><b><a name="attach">attach</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.attach</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="bin">bin</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.bin</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/bin</tt></li> - </ul><hr /> -<p><b><a name="catalinaBase">catalinaBase</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.catalina-base</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee</tt></li> - </ul><hr /> -<p><b><a name="checkStarted">checkStarted</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.check-started</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="classifier">classifier</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li> - </ul><hr /> -<p><b><a name="classpaths">classpaths</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="config">config</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.conf</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/conf</tt></li> - </ul><hr /> -<p><b><a name="context">context</a>:</b></p> - -<div>rename the current artifact</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="debug">debug</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.debug</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="debugPort">debugPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.debugPort</tt></li> - -<li><b>Default</b>: <tt>5005</tt></li> - </ul><hr /> -<p><b><a name="deployOpenEjbApplication">deployOpenEjbApplication</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="docBases">docBases</a>:</b></p> - -<div>for TomEE and wars only, which docBase to use for this war.</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="ejbRemote">ejbRemote</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.ejb-remote</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="externalRepositories">externalRepositories</a>:</b></p> - -<div>for TomEE and wars only, add some external repositories to -classloader.</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="forceReloadable">forceReloadable</a>:</b></p> - -<div>force webapp to be reloadable</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.force-reloadable</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="javaagents">javaagents</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="keepServerXmlAsthis">keepServerXmlAsthis</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.keep-server-xml</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="lib">lib</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.lib</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/lib</tt></li> - </ul><hr /> -<p><b><a name="libDir">libDir</a>:</b></p> - -<div>relative to tomee.base.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>lib</tt></li> - </ul><hr /> -<p><b><a name="libs">libs</a>:</b></p> - -<div>supported formats: --> groupId:artifactId:version... --> -unzip:groupId:artifactId:version... --> remove:prefix (often -prefix = artifactId)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="mainDir">mainDir</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main</tt></li> - </ul><hr /> -<p><b><a name="password">password</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li> - </ul><hr /> -<p><b><a name="quickSession">quickSession</a>:</b></p> - -<div>use a real random instead of secure random. saves few ms at -startup.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.quick-session</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="realm">realm</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li> - </ul><hr /> -<p><b><a name="removeDefaultWebapps">removeDefaultWebapps</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.remove-default-webapps</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="removeTomeeWebapp">removeTomeeWebapp</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.remove-tomee-webapps</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="simpleLog">simpleLog</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.simple-log</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="skipCurrentProject">skipCurrentProject</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.skipCurrentProject</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="skipWarResources">skipWarResources</a>:</b></p> - -<div>when you set docBases to src/main/webapp setting it to true will -allow hot refresh.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.skipWarResources</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="systemVariables">systemVariables</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.Map</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="target">target</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}</tt></li> - </ul><hr /> -<p><b><a name="tomeeAjpPort">tomeeAjpPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.ajp</tt></li> - -<li><b>Default</b>: <tt>8009</tt></li> - </ul><hr /> -<p><b><a name="tomeeAlreadyInstalled">tomeeAlreadyInstalled</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.exiting</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="tomeeArtifactId">tomeeArtifactId</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.artifactId</tt></li> - -<li><b>Default</b>: <tt>apache-tomee</tt></li> - </ul><hr /> -<p><b><a name="tomeeClassifier">tomeeClassifier</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li> - -<li><b>Default</b>: <tt>webprofile</tt></li> - </ul><hr /> -<p><b><a name="tomeeGroupId">tomeeGroupId</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.groupId</tt></li> - -<li><b>Default</b>: <tt>org.apache.openejb</tt></li> - </ul><hr /> -<p><b><a name="tomeeHost">tomeeHost</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li> - -<li><b>Default</b>: <tt>localhost</tt></li> - </ul><hr /> -<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li> - -<li><b>Default</b>: <tt>8080</tt></li> - </ul><hr /> -<p><b><a name="tomeeHttpsPort">tomeeHttpsPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.Integer</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.https</tt></li> - </ul><hr /> -<p><b><a name="tomeeShutdownCommand">tomeeShutdownCommand</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.shutdown-command</tt></li> - -<li><b>Default</b>: <tt>SHUTDOWN</tt></li> - </ul><hr /> -<p><b><a name="tomeeShutdownPort">tomeeShutdownPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.shutdown</tt></li> - -<li><b>Default</b>: <tt>8005</tt></li> - </ul><hr /> -<p><b><a name="tomeeVersion">tomeeVersion</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.version</tt></li> - -<li><b>Default</b>: <tt>-1</tt></li> - </ul><hr /> -<p><b><a name="useConsole">useConsole</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.use-console</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="useOpenEJB">useOpenEJB</a>:</b></p> - -<div>use openejb-standalone automatically instead of TomEE</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.openejb</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="user">user</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li> - </ul><hr /> -<p><b><a name="warFile">warFile</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt></li> - </ul><hr /> -<p><b><a name="webappClasses">webappClasses</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.webappClasses</tt></li> - -<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li> - </ul><hr /> -<p><b><a name="webappDefaultConfig">webappDefaultConfig</a>:</b></p> - -<div>forcing nice default for war development (WEB-INF/classes and web -resources)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.webappDefaultConfig</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="webappDir">webappDir</a>:</b></p> - -<div>relative to tomee.base.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>webapps</tt></li> - </ul><hr /> -<p><b><a name="webappResources">webappResources</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.webappResources</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li> - </ul><hr /> -<p><b><a name="webapps">webapps</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="zip">zip</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.zip</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="zipFile">zipFile</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.zip-file</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.zip</tt></li> - </ul> - </div> - </div> \ No newline at end of file
