DELTASPIKE-690: Addng reorganised and rewritten content
Project: http://git-wip-us.apache.org/repos/asf/deltaspike/repo Commit: http://git-wip-us.apache.org/repos/asf/deltaspike/commit/548383b7 Tree: http://git-wip-us.apache.org/repos/asf/deltaspike/tree/548383b7 Diff: http://git-wip-us.apache.org/repos/asf/deltaspike/diff/548383b7 Branch: refs/heads/master Commit: 548383b7b7f3dc72c534d59c9160eed944e27190 Parents: 1596f17 Author: michellemurray <[email protected]> Authored: Tue Sep 16 22:22:33 2014 +1000 Committer: Rafael Benevides <[email protected]> Committed: Mon Dec 15 20:24:45 2014 -0200 ---------------------------------------------------------------------- documentation/src/main/asciidoc/addons.adoc | 35 + documentation/src/main/asciidoc/articles.adoc | 29 + .../src/main/asciidoc/bean-validation.adoc | 2 +- documentation/src/main/asciidoc/build.adoc | 247 +++--- documentation/src/main/asciidoc/cdiimp.adoc | 196 +++++ .../src/main/asciidoc/configuration.adoc | 3 +- documentation/src/main/asciidoc/configure.adoc | 85 +++ .../src/main/asciidoc/container-control.adoc | 2 +- documentation/src/main/asciidoc/core.adoc | 2 +- documentation/src/main/asciidoc/data.adoc | 2 +- documentation/src/main/asciidoc/examples.adoc | 53 ++ documentation/src/main/asciidoc/external.adoc | 63 ++ documentation/src/main/asciidoc/index.adoc | 751 +------------------ documentation/src/main/asciidoc/jpa.adoc | 3 +- documentation/src/main/asciidoc/jsf.adoc | 3 +- documentation/src/main/asciidoc/overview.adoc | 71 ++ .../src/main/asciidoc/partial-bean.adoc | 2 +- .../src/main/asciidoc/projectstage.adoc | 4 +- documentation/src/main/asciidoc/scheduler.adoc | 2 +- documentation/src/main/asciidoc/security.adoc | 2 +- documentation/src/main/asciidoc/servlet.adoc | 2 +- documentation/src/main/asciidoc/snapshots.adoc | 50 ++ documentation/src/main/asciidoc/source.adoc | 2 +- documentation/src/main/asciidoc/spi.adoc | 4 +- .../src/main/asciidoc/test-control.adoc | 2 +- 25 files changed, 734 insertions(+), 883 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/addons.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/addons.adoc b/documentation/src/main/asciidoc/addons.adoc new file mode 100644 index 0000000..94d0716 --- /dev/null +++ b/documentation/src/main/asciidoc/addons.adoc @@ -0,0 +1,35 @@ += Add-ons + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + +:toc: + +Add-ons extend the functionality of DeltaSpike and several have been developed external to the DeltaSpike project. Brief information is given here about each of the add-ons, with details of where they can be obtained from. + +== Monitoring +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the add-on (e.g., A two-way cdi-spring bridge that allows spring-beans to be injected into cdi-beans and vice versa provided the concepts, for example qualifiers, are compatible.)? +* When would the user use this add-on? +* Where can the user get the add-on from (https://github.com/os890/ds-monitoring-addon )? +* Any special instructions for using the add-on correctly? + +== Spring Bridge +`ds-spring-bridge-addon` is a two-way cdi-spring bridge that allows spring-beans to be injected into cdi-beans and vice versa provided the concepts, for example qualifiers, are compatible. You can obtain this add-on from https://github.com/os890/ds-spring-bridge-addon. + +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the add-on (e.g., A two-way cdi-spring bridge that allows spring-beans to be injected into cdi-beans and vice versa provided the concepts, for example qualifiers, are compatible.)? +* When would the user use this add-on? +* Where can the user get the add-on from (https://github.com/os890/ds-spring-bridge-addon )? +* Any special instructions for using the add-on correctly? + +== Disruptor +This add-on creates a disruptor process for every observer method. It currently works with Apache TomEE and JBoss AS 7. + +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the add-on (e.g., A two-way cdi-spring bridge that allows spring-beans to be injected into cdi-beans and vice versa provided the concepts, for example qualifiers, are compatible.)? +* When would the user use this add-on? +* Where can the user get the add-on from (https://github.com/os890/ds-disruptor-addon )? +* Any special instructions for using the add-on correctly? http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/articles.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/articles.adoc b/documentation/src/main/asciidoc/articles.adoc new file mode 100644 index 0000000..f16fdfa --- /dev/null +++ b/documentation/src/main/asciidoc/articles.adoc @@ -0,0 +1,29 @@ += Articles and Blogs + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + +:toc: + +You can find lots of content related to DeltaSpike with a quick internet search. But here is a list of some useful articles and blogs to get you started. + +If you know of useful DeltaSpike articles or blogs that are not listed, link:https://deltaspike.apache.org/community.html[let us know]. + +== Ongoing + +* https://twitter.com/DeltaSpikeTeam[@DeltaSpikeTeam on Twitter] +* https://twitter.com/hashtag/deltaspike[#deltaspike on Twitter] +* http://os890.blogspot.com.au/search/label/deltaspike[os890 DeltaSpike posts] +* http://rafabene.com/?s=deltaspike&submit=Search[Rafael Benevides DeltaSpike posts] +* http://rmannibucau.wordpress.com/?s=deltaspike[RManiiBucau DeltaSpike posts] +* https://struberg.wordpress.com/?s=deltaspike[Struberg DeltaSpike posts] + + +== One-offs + +* https://blogs.oracle.com/theaquarium/entry/introducing_deltaspike_1_0[The Aquarium: Introducing DeltaSpike 1.0] +* http://blog.arungupta.me/2014/06/deltaspike-1-0-extend-javaee-techtip32/[DeltaSpike 1.0 â Extend #JavaEE beyond #JavaEE] +* http://www.tearsofaunicorn.com/articles/2014/06/10/configuring-deltaspike-through-environment-variables.html[Configuring Apache Deltaspike through environment variables] +* http://blog.ctp.com/2013/11/27/bye-bye-cdi-query-hello-deltaspike-data/[Bye Bye CDI Query, Hello DeltaSpike Data] +* http://rmannibucau.wordpress.com/2013/11/20/deltaspike-data-repositories-with-dtos/[DeltaSpike Data: repositories with DTOs!] +* http://jaxenter.com/introducing-apache-deltaspike-42925.html[Closing the Gaps: Introducing Apache Deltaspike] +* http://jsfcorner.blogspot.com.au/2013/01/deltaspike-jsf-message-system.html[DeltaSpike JSF message system] http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/bean-validation.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/bean-validation.adoc b/documentation/src/main/asciidoc/bean-validation.adoc index fe26187..298c832 100644 --- a/documentation/src/main/asciidoc/bean-validation.adoc +++ b/documentation/src/main/asciidoc/bean-validation.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] +:toc: == Introduction http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/build.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/build.adoc b/documentation/src/main/asciidoc/build.adoc index 48fb04b..9ebca70 100644 --- a/documentation/src/main/asciidoc/build.adoc +++ b/documentation/src/main/asciidoc/build.adoc @@ -1,155 +1,130 @@ -= Building DeltaSpike from source += Build and Test DeltaSpike from Source :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] - -== Introduction - -Deltaspike uses http://maven.apache.org/[maven] build tool to automate the compilation, testing and packaging of the project - -=== Full build - ------------------ -mvn clean install ------------------ - -=== Build with test - - ------------------------------------------------------------------- -mvn clean install -POWB //execute the unit tests with OpenWebBeans -or -mvn clean install -PWeld //execute the unit tests with Weld ------------------------------------------------------------------- - - -=== Integration Tests - - -With the unpack Maven-Plugin all Arquillian-Tests get copied to the -integration-test module. Together with the special integration-tests -they get executed via a remote container. Currently we have -configurations for the following containers. - - -==== TomEE - - -*Executing the Arquillian tests with Apache TomEE* - ---------------------------------------- -mvn clean install -Ptomee-build-managed ---------------------------------------- - - -==== JBoss AS7 - - -===== Without existing AS7 - - -*Executing the Arquillian tests with JBoss AS7 (without AS7 installation)* - -------------------------------------------- -mvn clean install -Pjbossas-build-managed-7 -------------------------------------------- - -===== With existing AS7 - - -Set JBoss_HOME - -*Executing the Arquillian tests with JBoss AS7 (AS7 installation -required)* - -------------------------------------- -mvn clean install -Pjbossas-managed-7 -------------------------------------- - - -==== WildFly 8 - - -===== Without existing WF8 - - -*Executing the Arquillian tests with JBoss-WF8 (without WF8 installation)* - ------------------------------------------ +:toc: + +The DeltaSpike source (modules and examples) is provided for inspection, contribution and testing purposes. The source must be built with Maven, which has been used to automate the compilation, testing and packaging processes. Arquillian tests are automatically conducted when DeltaSpike is built and CDI implementations or containers with which to carry out the tests can be specified. + +In all cases, to obtain the DeltaSpike source, link:https://deltaspike.apache.org/download.html[download `deltaspike-project-<version>-source-release.zip`] and extract the contents. + +**Note:** You can also obtain the DeltaSpike source from the project Git repository. The repository is subject to change and it can be used for contributing but should not be used in production environments. For more information, see <<source#,Get Source and compile it>>. + +== Build without CDI Implementation Tests +DeltaSpike can be built without executing tests against a CDI implementation, with the following commands: + +[source,shell] +---- +$ cd /path/to/deltaspike-project-<version>/ +$ mvn clean install +---- + +== Build and Test with a CDI Implementation +Tests can be executed with both the JBoss Weld and Apache OpenWebBeans CDI implementations. + +[cols="1,2a", options="header"] +.Build Tests +|=== +|Container |Command to Execute Arquillian Tests + +|JBoss Weld +| +[source,shell] +---- +$ mvn clean install -PWeld +---- + +|Apache OpenWebBeans +| +[source,shell] +---- +$ mvn clean install -POWB +---- +|=== + + +== Build and Test with CDI Containers +Tests can be executed with JBoss Weld and Apache OpenWebBeans through Java EE 6+ application servers and containers. Configurations are currently provided as details in the table here. + +[cols="2,3a", options="header"] +.Integration Tests +|=== +|Container |Command to Execute Arquillian Tests + +|Apache TomEE +| +[source,shell] +---- +$ mvn clean install -Ptomee-build-managed +---- + +|JBoss AS7 (without AS7 installation) +| +[source,shell] +---- +$ mvn clean install -Pjbossas-build-managed-7 +---- + +|JBoss AS7 (AS7 installation required) +|Set `JBoss_HOME` + +[source,shell] +---- +$ mvn clean install -Pjbossas-managed-7 +---- + +|JBoss WildFly 8 (without WildFly 8 installation) +| +[source,shell] +---- mvn clean install -Pwildfly-build-managed ------------------------------------------ - - -===== With existing WF8 - - -Set WILDFLY_HOME - -*Executing the Arquillian tests with JBoss-WF8 (WF8 installation -required)* - ------------------------------------ -mvn clean install -Pwildfly-managed ------------------------------------ - - -==== GlassFish 3.1 - - +---- -===== Without existing GF3 +|JBoss WildFly 8 (WildFly 8 installation required) +|Set `WILDFLY_HOME` -*Executing the Arquillian tests with GF3 (without GF3 installation)* +[source,shell] +---- +$ mvn clean install -Pwildfly-managed +---- ---------------------------------------------- +|Oracle GlassFish 3 (without GlassFish 3 installation) +| +[source,shell] +---- mvn clean install -Pglassfish-build-managed-3 ---------------------------------------------- +---- +|Oracle GlassFish 3.1 (GlassFish 3.1 installation required) +|Install GlassFish (default setup without admin-password) and start +GlassFish with `asadmin start-domain` and `asadmin start-database`. -===== With existing GF3 +[source,shell] +---- +$ mvn clean install -Pglassfish-remote-3.1 +---- -Install GlassFish (default setup without admin-password) and start -GlassFish with asadmin start-domain *and* asadmin start-database - -*Executing the Arquillian tests with Oracle Glassfish 3.1+* - ----------------------------------------- -mvn clean install -Pglassfish-remote-3.1 ----------------------------------------- - - -==== GlassFish 4 - -===== Without existing GF4 - -*Executing the Arquillian tests with GF4 (without GF4 installation)* - ---------------------------------------------- +|Oracle GlassFish 4 (without Oracle GlassFish 4 installation) +| +[source,shell] +---- mvn clean install -Pglassfish-build-managed-4 ---------------------------------------------- +---- - -==== WebLogic 12c - - -Install WebLogic 12c. Start Confiuration Wizard to create a new basic +|Oracle WebLogic 12c +|Install WebLogic 12c. Start Configuration Wizard to create a new basic WebLogic Domain. Default options and domain name = base_domain, administrator user name = weblogic1, administrator password = weblogic1. -Set WLS_HOME so that %WLS_HOME%.jar exists. Start the domain. - -*Executing the Arquillian tests with Oracle WebLogic 12c* - ----------------------------------- -mvn clean install -Pwls-remote-12c ----------------------------------- - - -=== Jenkins Builds +Set `WLS_HOME` so that `%WLS_HOME%.jar` exists. Start the domain. -https://builds.apache.org/view/A-D/view/DeltaSpike/ +[source,shell] +---- +$ mvn clean install -Pwls-remote-12c +---- +|=== -=== Sonar +== Next +* For analysis of the DeltaSpike source, see https://analysis.apache.org/dashboard/index/org.apache.deltaspike:deltaspike-project +* For information about DeltaSpike automated Jenkins builds, see https://builds.apache.org/view/A-D/view/DeltaSpike/ -https://analysis.apache.org/dashboard/index/org.apache.deltaspike:deltaspike-project http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/cdiimp.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/cdiimp.adoc b/documentation/src/main/asciidoc/cdiimp.adoc new file mode 100644 index 0000000..6d6acbd --- /dev/null +++ b/documentation/src/main/asciidoc/cdiimp.adoc @@ -0,0 +1,196 @@ += Enable CDI For Your Java Environment + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + +:toc: + +DeltaSpike requires a CDI implementation to be available in the Java environment that your projects are deployed to. The implementation provides the CDI essentials, managing dependency injection and contextual lifecycles. link:http://weld.cdi-spec.org/[JBoss Weld] and link:http://openwebbeans.apache.org/[Apache OpenWebBeans (OWB)] are two widely used CDI implementations. Dependent on the Java environment you choose, some setup may be necessary as detailed here. + +== Java EE6+ Containers +CDI is part of Java EE6 and later so CDI implementations are included as standard in Java EE6+ compliant environments. There is no additional CDI configuration needed besides including the CDI-obligatory `beans.xml` file in your project. + +JBoss Weld is integrated in Java EE application servers including WildFly, JBoss Enterprise Application Platform, GlassFish, and Oracle WebLogic. + +Apache OpenWebBeans (OWB) is integrated in Java EE containers including Apache TomEE, Apache Geronimo, IBM WebSphere Application Server, and SiwPas. + +== Java EE5 and Servlet Containers +CDI implementations are not distributed with Java EE5 application servers or Servlet-only environments such as Apache TomCat and Eclipse Jetty. You can use CDI in these environments by embedding a standalone CDI implementation. Both JBoss Weld and Apache OpenWebBeans can be used for this task; for more information, see the corresponding CDI implementation documentation. + +== Java SE6+ +CDI is not part of Java SE but it can still be used. JBoss Weld and Apache OpenWebBeans implementations can be used to act as dependency injection bean managers but the respective containers must be booted manually. + +DeltaSpike provides a dedicated Container Control module to enable applications deployed in Java SE environments to boot a CDI container. The Container Control module consists of the API component and components specific to the JBoss Weld, Apache OpenWebBeans and Apache OpenEJB CDI containers. The DeltaSpike module provides a layer of abstraction from the specific CDI containers, enabling you to write container-independent code in your project. + +Instructions are provided here for adding the required resources to both Maven-based and Maven-independent projects and subsequently booting the CDI container from your project source code. + +=== Declare Dependencies for Maven-based Projects +For Maven-based projects, the Container Control module is available in Maven Central together with the other DeltaSpike modules. You must configure your project to use the DeltaSpike Container Control API and one of the CDI container-specific modules. + +. Open the project `pom.xml` file for editing +. Add the DeltaSpike Container Control API to the list of dependencies ++ +[source,xml] +---- +<dependency> + <groupId>org.apache.deltaspike.cdictrl</groupId> + <artifactId>deltaspike-cdictrl-api</artifactId> + <version>${deltaspike.version}</version> + <scope>compile</scope> +</dependency> +---- ++ +. Add CDI container dependencies for one of the container options listed here + +==== Option A: For JBoss Weld + +. Open the project `pom.xml` file for editing +. Add the JBoss Weld version to the list of properties, replacing the version as desired ++ +[source,xml] +---- +<properties> + <weld.version>1.1.9.Final</weld.version> +</properties> +---- ++ +. Add the JBoss Weld dependency to the list of dependencies ++ +[source,xml] +---- +<dependency> + <groupId>org.jboss.weld.se</groupId> + <artifactId>weld-se</artifactId> + <version>${weld.version}</version> + <scope>runtime</scope> +</dependency> +---- ++ +. Add the DeltaSpike Weld-specific Container Control module to the list of dependencies ++ +[source,xml] +---- +<dependency> + <groupId>org.apache.deltaspike.cdictrl</groupId> + <artifactId>deltaspike-cdictrl-weld</artifactId> + <version>${deltaspike.version}</version> + <scope>runtime</scope> +</dependency> +---- ++ +. Save the `pom.xml` file changes +. Download all required dependencies ++ +---- +mvn clean install +---- + +==== Option B: For Apache OpenWebBeans + +. Open the project `pom.xml` file for editing +. Add the Apache OpenWebBeans version to the list of properties, replacing the version as desired ++ +[source,xml] +---- +<properties> + <owb.version>1.2.0</owb.version> +</properties> +---- ++ +. Add the Apache OpenWebBeans dependencies to the list of dependencies ++ +[source,xml] +---- +<dependency> + <groupId>org.apache.openwebbeans</groupId> + <artifactId>openwebbeans-impl</artifactId> + <version>${owb.version}</version> + <scope>runtime</scope> +</dependency> + +<dependency> + <groupId>org.apache.openwebbeans</groupId> + <artifactId>openwebbeans-spi</artifactId> + <version>${owb.version}</version> + <scope>compile</scope> +</dependency> +---- ++ +. Add the DeltaSpike Apache OpenWebBeans-specific Container Control module to the list of dependencies ++ +[source,xml] +---- +<dependency> + <groupId>org.apache.deltaspike.cdictrl</groupId> + <artifactId>deltaspike-cdictrl-owb</artifactId> + <version>${deltaspike.version}</version> + <scope>runtime</scope> +</dependency> +---- ++ +. Save the `pom.xml` file changes +. Download all required dependencies ++ +---- +mvn clean install +---- + +=== Declare Dependencies for Maven-independent Projects +For Maven-independent projects, the Container Control module is distributed together with the other DeltaSpike modules in `distribution-fill-<version>.zip`. You must add two of the files from the `cdictrl` directory to your project, namely `deltaspike-cdictrl-api.jar` and the .jar file that corresponds to the CDI container you have chosen. Add these files to the project `WEB-INF/lib` or `EAR/lib` directory for .war and .ear projects respectively. + +=== Start the CDI Container from Your Project +To start a CDI container in your application, you must instantiate a `CdiContainer` object and call the `#boot` method. When `#boot` is called, the `CdiContainer` scans CDI-enabled +archives for beans and CDI extensions. An example is given in the code snippet here. Before the application exits, `#shutdown` must be called to correctly destroy all beans. + +[source,java] +---- +import org.apache.deltaspike.cdise.api.CdiContainer; +import org.apache.deltaspike.cdise.api.CdiContainerLoader; + +public class MainApp { + public static void main(String[] args) { + + CdiContainer cdiContainer = CdiContainerLoader.getCdiContainer(); + cdiContainer.boot(); + + // You can use CDI here + + cdiContainer.shutdown(); + } +} +---- + +Starting the container does not automatically start all CDI Contexts. Contexts must be started independently using the provided `ContextControl` class. An example of starting the Context for `@ApplicationScoped` beans is added to the code snippet here. + +[source,java] +---- +import org.apache.deltaspike.cdise.api.CdiContainer; +import org.apache.deltaspike.cdise.api.CdiContainerLoader; +import org.apache.deltaspike.cdise.api.ContextControl; +import javax.enterprise.context.ApplicationScoped; + +public class MainApp { + public static void main(String[] args) { + + CdiContainer cdiContainer = CdiContainerLoader.getCdiContainer(); + cdiContainer.boot(); + + // Starting the application-context allows to use @ApplicationScoped beans + ContextControl contextControl = cdiContainer.getContextControl(); + contextControl.startContext(ApplicationScoped.class); + + // You can use CDI here + + cdiContainer.shutdown(); + } +} +---- + +To resolve project beans, you can use the DeltaSpike `BeanProvider` class. Whether `EchoService` is a concrete implementation or just an interface depends on the application. In the case that it is an interface, the corresponding implementation is resolved. The resolved bean is a standard CDI bean and it can be used for all CDI concepts, such as @Inject, in the class without further uses of `BeanProvider`. An example of resolving the bean without qualifiers is given in the code snippet here. + +[source,java] +---- +EchoService echoService = BeanProvider.getContextualReference(EchoService.class, false); +---- + +== Next +* For more information about the Container Control module, see <<container-control#,Container Control Module>>. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/configuration.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/configuration.adoc b/documentation/src/main/asciidoc/configuration.adoc index 7f3e114..2e2107b 100644 --- a/documentation/src/main/asciidoc/configuration.adoc +++ b/documentation/src/main/asciidoc/configuration.adoc @@ -2,8 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - -[TOC] +:toc: == Configuration Basics http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/configure.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/configure.adoc b/documentation/src/main/asciidoc/configure.adoc new file mode 100644 index 0000000..df99230 --- /dev/null +++ b/documentation/src/main/asciidoc/configure.adoc @@ -0,0 +1,85 @@ += Configure DeltaSpike in Your Projects + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + +:toc: + +DeltaSpike is available for use in Maven-based and Maven-independent projects. Instructions are given here for obtaining released final versions of DeltaSpike for both approaches. + +**Note:** You can also opt to use the lastest DeltaSpike snapshots; for more information, see <<snapshots#,Test Snapshots>>. + +== Configure DeltaSpike in Maven-based Projects +DeltaSpike released versions are available from the Maven Central repository for use in Maven-based projects. This means that you do not need to modify your Maven configuration `settings.xml` file; when building projects, Maven automatically searches the online Maven Central repository for project dependencies and downloads sources to your local Maven repository. + +To begin use the DeltaSpike releases from Maven Central, you simply need to configure the project `pom.xml` file for each project with information about the release version and modules you want to use. At a minimum, you must add the DeltaSpike Core module, which provides the DeltaSpike API and utility classes. + +. Open the project `pom.xml` file for editing +. Add the DeltaSpike version to the list of properties ++ +[source,xml] +---- +<properties> + <deltaspike.version>1.0.2</deltaspike.version> +</properties> +---- ++ +. Add the DeltaSpike Core module to the list of dependencies ++ +[source,xml] +---- +<dependency> + <groupId>org.apache.deltaspike.core</groupId> + <artifactId>deltaspike-core-api</artifactId> + <version>${deltaspike.version}</version> + <scope>compile</scope> +</dependency> + +<dependency> + <groupId>org.apache.deltaspike.core</groupId> + <artifactId>deltaspike-core-impl</artifactId> + <version>${deltaspike.version}</version> + <scope>runtime</scope> +</dependency> +---- ++ +. Save the `pom.xml` file changes + +For instructions on adding the optional DeltaSpike modules, see the relevant module page: + +* <<bean-validation#,Bean Validation>> +* <<container-control#,Container Control>> +* <<data#,Data>> +* <<jpa#,JPA>> +* <<jsf#,JSF>> +* <<partial-bean#,Partial-Bean>> +* <<scheduler#,Scheduler>> +* <<security#,Security>> +* <<servlet#,Servlet>> +* <<test-control#,Test-Control>> + +== Configure DeltaSpike in Maven-independent Projects +Deltaspike is provided as a set of downloadable .jar files for projects not utilizing the Maven build system. Alternatively, you can build the DeltaSpike .jar files from source; for instructions, see <<build#,Build DeltaSpike from Source>>. In both cases, you must add the DeltaSpike .jar files directly to your projects. + +To use DeltaSpike without Maven from the downloadable .jar files, complete the following steps: + +. Download the latest `distribution-full-<version>.zip` from https://deltaspike.apache.org/download.html +. Extract the archive contents ++ +[source,shell] +---- +$ unzip distribution-full-<version>.zip +---- ++ +. Add the source to your project + .. For .war projects, copy the .jar files to `WEB-INF/lib` directory + .. For .ear projects, copy the .jar files to `EAR/lib directory` and add the following to `META-INF/application.xml`: ++ +[source,xml] +---- +<library-directory>lib</library-directory> +---- + +== Next +* To check whether your Java envrionment needs any additional CDI-specific configuration, see <<cdiimp#,Enable CDI For Your Java Environment>>. +* To see ready-to-deploy example DeltaSpike applications, see <<examples#,See DeltaSpike in Action>>. +* To understand how the various DeltaSpike modules can enhance and extend your applications, see the individual module pages. http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/container-control.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/container-control.adoc b/documentation/src/main/asciidoc/container-control.adoc index 0298553..0fdc767 100644 --- a/documentation/src/main/asciidoc/container-control.adoc +++ b/documentation/src/main/asciidoc/container-control.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] +:toc: == Introduction http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/core.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/core.adoc b/documentation/src/main/asciidoc/core.adoc index 149dca6..e3d8270 100644 --- a/documentation/src/main/asciidoc/core.adoc +++ b/documentation/src/main/asciidoc/core.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] +:toc: == Core - API http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/data.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/data.adoc b/documentation/src/main/asciidoc/data.adoc index 8be71d7..506bc10 100644 --- a/documentation/src/main/asciidoc/data.adoc +++ b/documentation/src/main/asciidoc/data.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] +:toc: == Introduction http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/examples.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/examples.adoc b/documentation/src/main/asciidoc/examples.adoc new file mode 100644 index 0000000..2ba01eb --- /dev/null +++ b/documentation/src/main/asciidoc/examples.adoc @@ -0,0 +1,53 @@ += See DeltaSpike in Action + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + +:toc: + +A collection of ready-to-build Maven-based projects are provided to demonstrate the inclusion of DeltaSpike in applications. Each example showcases a different DeltaSpike feature and explores the mechanics of DeltaSpike implementation. You can use these examples to see DeltaSpike in action and learn how to add these capabilities to your own projects. The Maven-based project examples are available in `deltaspike-project-<version>-source-release.zip` and each is briefly outlined here. + +To begin using the projects, complete the following steps: + +. link:https://deltaspike.apache.org/download.html[Download `deltaspike-project-<version>-source-release.zip`] +. Extract the archive contents ++ +[source,shell] +---- +$ unzip deltaspike-project-<version>-source-release.zip +---- ++ +. Build the projects ++ +[source,shell] +---- +$ cd /path/to/deltaspike-project-<version>/examples +$ mvn clean package +---- + +== jse-examples +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the example (e.g., This quickstart demonstrates the use of a partial bean to provide dynamic implementations of an interface, and how this might be used to provide a generic query service.)? +* When would the user use this example (e.g., The PersonQueryService provides an example of the end user API that might be available from such a framework. Extensive code comments document the example implementation.)? +* Any special instructions for how to build and deploy (e.g., It does not contain any user interface; the tests must be run to verify everything is working correctly.)? + +== jsf-examples +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the example (e.g., This quickstart demonstrates the use of a partial bean to provide dynamic implementations of an interface, and how this might be used to provide a generic query service.)? +* When would the user use this example (e.g., The PersonQueryService provides an example of the end user API that might be available from such a framework. Extensive code comments document the example implementation.)? +* Any special instructions for how to build and deploy (e.g., It does not contain any user interface; the tests must be run to verify everything is working correctly.)? + +== jsf-playground +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the example (e.g., This quickstart demonstrates the use of a partial bean to provide dynamic implementations of an interface, and how this might be used to provide a generic query service.)? +* When would the user use this example (e.g., The PersonQueryService provides an example of the end user API that might be available from such a framework. Extensive code comments document the example implementation.)? +* Any special instructions for how to build and deploy (e.g., It does not contain any user interface; the tests must be run to verify everything is working correctly.)? + +== scheduler-playground +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the example (e.g., This quickstart demonstrates the use of a partial bean to provide dynamic implementations of an interface, and how this might be used to provide a generic query service.)? +* When would the user use this example (e.g., The PersonQueryService provides an example of the end user API that might be available from such a framework. Extensive code comments document the example implementation.)? +* Any special instructions for how to build and deploy (e.g., It does not contain any user interface; the tests must be run to verify everything is working correctly.)? \ No newline at end of file http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/external.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/external.adoc b/documentation/src/main/asciidoc/external.adoc new file mode 100644 index 0000000..8a2a1f8 --- /dev/null +++ b/documentation/src/main/asciidoc/external.adoc @@ -0,0 +1,63 @@ += External Examples and Templates + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + +:toc: + +A number of DeltaSpike examples and templates have been developed external to the DeltaSpike project. These extend the DeltaSpike resources from which you can see DeltaSpike in action. Brief information is given here about each of the examples and templates, with details of where they can be obtained from. + +== Example: Confess 2012 Workshop Demo +This example was prepared for the Confess workshop and demonstrates how to use DeltaSpike instead of and side-by-side with MyFaces CODI. The secured web application demonstrates presenting users with differentiating content based on their account status. + +**Source code:** https://github.com/confess/confess2012_deltaspike + +== Example: Fullstack EE6+ with DeltaSpike +Simple example based on Java EE6+ and DeltaSpike (tested with EE6 and EE7). + +**Source code:** https://github.com/os890/ee6-ds-demo + +== Example: Fullstack CODI to DeltaSpike +This pair of examples show how to achieve the most important MyFaces CODI features with DeltaSpike and also how to migrate a CODI project to DeltaSpike. The examples are basic, compacting core CODI features into just a few JSF pages, and are intended for deployment with TomEE. + +**Source code:** https://github.com/os890/tomee_mf_stack_001 + +* CODI version in master branch +* Migrated DeltaSpike version in codi2ds branch + +== Examples: JBoss Web Framework Kit Quickstarts +The JBoss quickstarts are small working examples that demonstrate recommended practices for specific Java EE technology use cases. A subset of these quickstarts are dedicated to demonstrating DeltaSpike, including custom authorization restrictions using annotations, constructing and modifying beans, extending the influence of CDI using BeanManager, and deactivating DeltaSpike features. + +**Source code:** https://github.com/jboss-developer/jboss-wfk-quickstarts + +== Template: Java SE + CDI + DS +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the template (e.g., This quickstart demonstrates the use of a partial bean to provide dynamic implementations of an interface, and how this might be used to provide a generic query service.)? +* When would the user use this template (e.g., The PersonQueryService provides an example of the end user API that might be available from such a framework. Extensive code comments document the example implementation.)? +* Where can the user get the template from (https://github.com/os890/javase-cdi-ds-project-template )? +* Any special instructions for how to build and deploy (e.g., It does not contain any user interface; the tests must be run to verify everything is working correctly.)? + +== Template: JSF + CDI + DS (Servlet-Container) +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the template (e.g., This quickstart demonstrates the use of a partial bean to provide dynamic implementations of an interface, and how this might be used to provide a generic query service.)? +* When would the user use this template (e.g., The PersonQueryService provides an example of the end user API that might be available from such a framework. Extensive code comments document the example implementation.)? +* Where can the user get the template from (https://github.com/os890/javaweb-cdi-ds-project-template )? +* Any special instructions for how to build and deploy (e.g., It does not contain any user interface; the tests must be run to verify everything is working correctly.)? + +== Template: EJB + CDI + DS (Module) +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the template (e.g., This quickstart demonstrates the use of a partial bean to provide dynamic implementations of an interface, and how this might be used to provide a generic query service.)? +* When would the user use this template (e.g., The PersonQueryService provides an example of the end user API that might be available from such a framework. Extensive code comments document the example implementation.)? +* Where can the user get the template from (https://github.com/os890/javaee_cdi_ejb_ds_project_template )? +* Any special instructions for how to build and deploy (e.g., It does not contain any user interface; the tests must be run to verify everything is working correctly.)? + +== Template: JSF + EJB + CDI + DS (EE-Server) +**Replace this text!** Write 2-3 sentences in plain language making sure you answer every question: + +* What is the purpose of the template (e.g., This quickstart demonstrates the use of a partial bean to provide dynamic implementations of an interface, and how this might be used to provide a generic query service.)? +* When would the user use this template (e.g., The PersonQueryService provides an example of the end user API that might be available from such a framework. Extensive code comments document the example implementation.)? +* Where can the user get the template from (https://github.com/os890/javaee_jsf_cdi_ejb_ds_project_template )? +* Any special instructions for how to build and deploy (e.g., It does not contain any user interface; the tests must be run to verify everything is working correctly.)? + http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/index.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/index.adoc b/documentation/src/main/asciidoc/index.adoc index 4d6505f..eec24a1 100644 --- a/documentation/src/main/asciidoc/index.adoc +++ b/documentation/src/main/asciidoc/index.adoc @@ -2,728 +2,29 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] - -== Introduction - - -Apache DeltaSpike project has been created to support the development of -portable CDI extensions that provide useful features for Java -applications not provided out of the box by the CDI spec (Security, JPA, -...). CDI extensions created by the DeltaSpike community are packaged as -modules. - -Therefore, Apache DeltaSpike is a great toolbox for CDI. More than a set -of powerful extension and tools to ease extension development, -DeltaSpike also proves that CDI allows Java EE to evolve between each -release. - -The goal of the project is also to provide useful classes to : - -* Boot CDI Container (Weld, OpenWebbeans, OpenEJB) for Java SE, -* Stage a project, -* Provide new scopes (Window Scope, ...), -* Manage messages and configurations - -The project is currently tested on different CDI implementations like -Apache OpenWebBeans and JBoss Weld, and also on different Java Web -containers like Apache TomEE or JavaEE, JBoss AS7, Oracle GlassFish -3.1+, Oracle WebLogic Server 12c. - - -=== What is a portable CDI extension ? - -A portable CDI extension means that CDI itself can be extended. Such -extensions can be used with any spec. compliant CDI implementation. From -the user perspective, it means that you can simply drop in CDI extension -jars into your runtime e.g. to integrate third-party APIs with CDI or to -improve existing JavaEE-APIs. - -The CDI Portable extensions SPI (Service Provider Interface) allows to -define additional beans, scopes, stereotypes, interceptors and -decorators. The SPI of CDI is a powerful vehicle for innovation and -DeltaSpike is an example of it. - - -=== DeltaSpike in a nutshell - - -==== Java EE 7 without Java EE 7! - -*Transactional support for non-EJB beans:* The Transactional Interceptor -in DeltaSpike paved the way for @Transactional in Java EE 7. - -*Injectable Servlet objects:* Allows the developer to inject CDI beans -on Servlets on Java EE 6/CDI 1.0 environments - -*Injectable resources:* Configuration, resource bundles,... are easy to -inject when using CDI and Apache DeltaSpike. - -*@Exclude annotation:* it's possible to annotate beans which should be -ignored by CDI even if they are in a CDI enabled archive on Java EE -6/CDI 1.0 environment where you can't use @Vetoed or a veto based on -project-stages or expressions is needed. - -**Scheduling tasks**: Async processes in a non Java EE 7 environment. - -*Bean Validation integration:* Allows to inject CDI beans and EJB in to -Constraint-Validators. - -*BeanProvider:* Access the BeanManager and CDI beans even in non managed -classes like JPA-2.0 EntityListeners or Spring Beans. - - -==== JSF Improvements - -*Multi-window handling:* Allows to manage logical windows for -batches,... or in case of JSF it offers proper separation of -browser-tabs. - -*Type-safe view-config:* It allows to bind meta-data (e.g. for security) -to views with a type-safe, but flexible approach. It provides a more -solid navigation in case of JSF and helps a lot in the maintenance -phase. - -*View-Controller:* Based on type-safe view-configs view-controller -annotations provide a type-safe alternative to standard-tags. - -*Injection on Converters and Validators:* Allows to inject CDI beans and -EJB in to JSF Converters and Validators. - -*JSF event broadcasting to CDI:* Allows CDI to be notified about JSF -events - - -==== Productivity Improvements - -*Security based on annotations:* The foundation for building a robust, -capable and non invasive security solution. - -*New CDI scopes:* TransactionScoped, WindowScoped, ViewScoped, -ViewAccess scope, Grouped conversion scope - -*Container Control & Test Control:* Java SE with CDI, all with a -unifying API. Start, stop, add classes to a running CDI container. - -*Data Module:* An out of the box entity framework solution complete with -support for container or application managed persistence contexts, as -well as JDBC. - -*Decoupled Exception handling:* Allows to do exception handling in one -location similar to CDI Observers. - -*JMX integration:* Any CDI bean can be exposed via JMX easily with one -annotation. - -*Type-safe i18n messages:* Localized messages are easy to use with an -interface and a resource bundle, no more boilerplate and your messages -now have context within the code. - -*Type-safe Project-Stages:* Compared to project-stages in JSF, -DeltaSpike provides a type-safe, but still extensible approach which can -be used in CDI based applications. - - -== Getting Started - -A DeltaSpike project can be designed using or not Apache Maven and -consists in a collection of jar files. Depending on your needs, you will -package DeltaSpike core jar (api and impl) files or extend the list with -DeltaSpike modules. DeltaSpike Api and Impl are mandatory and provide -code required to benefits of portable CDI extensions or useful features -created. - -Remark : For Java SE, an additional step is required as you have to -select the CDI implementation of your choice to boot a CDI container. - -[TODO] Add a section or remark to explain how to package & deploy -DeltaSpike in an OSGI environment (Apache Felix, Apache Karaf, Apache -ServiceMix) - - -=== Project Configuration without Maven - - -You can manually download all JARs described above or you get <<source.adoc#,the source-code>> and <<build.adoc#,build>> DeltaSpike -manually. - -=== Project Configuration with Maven - -*Hint:* In the listings below replace the placeholders for the version with the version of your choice or use: - -[source,xml] --------------------------------------------------- -<properties> - <deltaspike.version>1.0.3</deltaspike.version> -</properties> --------------------------------------------------- - -Or if you want to very bleeding edge, point to our current snapshot. - -[source,xml] ------------------------------------------------------------ -<properties> - <deltaspike.version>1.0.4-SNAPSHOT</deltaspike.version> -</properties> ------------------------------------------------------------ - -==== Configuration of DeltaSpike Core - -[source,xml] -------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.core</groupId> - <artifactId>deltaspike-core-api</artifactId> - <version>${deltaspike.version}</version> - <scope>compile</scope> -</dependency> - -<dependency> - <groupId>org.apache.deltaspike.core</groupId> - <artifactId>deltaspike-core-impl</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> -------------------------------------------------- - -==== Configuration of DeltaSpike Modules - -Security Module -+++++++++++++++ - -[source,xml] ------------------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-security-module-api</artifactId> - <version>${deltaspike.version}</version> - <scope>compile</scope> -</dependency> - -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-security-module-impl</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> ------------------------------------------------------------- - -===== JPA Module - -[source,xml] -------------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-jpa-module-api</artifactId> - <version>${deltaspike.version}</version> - <scope>compile</scope> -</dependency> - -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-jpa-module-impl</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> -------------------------------------------------------- - -===== JSF Module - -[source,xml] -------------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-jsf-module-api</artifactId> - <version>${deltaspike.version}</version> - <scope>compile</scope> -</dependency> - -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-jsf-module-impl</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> -------------------------------------------------------- - -Some EE6 servers can't handle optional classes. If you don't like the -corresponding log entries during the startup or the deployment fails, -you can use an alternative impl-module (instead of -deltaspike-jsf-module-impl) since v1.0.1: - -[source,xml] ------------------------------------------------------------ -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-jsf-module-impl-ee6</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> ------------------------------------------------------------ - -===== Bean Validation Module - -[source,xml] -------------------------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-bean-validation-module-impl</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> -------------------------------------------------------------------- - -===== Servlet Module - -[source,xml] ------------------------------------------------------------ -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-servlet-module-api</artifactId> - <version>${deltaspike.version}</version> - <scope>compile</scope> -</dependency> - -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-servlet-module-impl</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> ------------------------------------------------------------ - -===== Data Module - -[source,xml] --------------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-data-module-api</artifactId> - <version>${deltaspike.version}</version> - <scope>compile</scope> -</dependency> - -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-data-module-impl</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> --------------------------------------------------------- - -===== Test-Control Module - -[source,xml] ----------------------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-test-control-module-api</artifactId> - <version>${deltaspike.version}</version> - <scope>test</scope> -</dependency> - -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-test-control-module-impl</artifactId> - <version>${deltaspike.version}</version> - <scope>test</scope> -</dependency> ----------------------------------------------------------------- - -===== Scheduler Module - -[source,xml] -------------------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-scheduler-module-api</artifactId> - <version>${deltaspike.version}</version> - <scope>compile</scope> -</dependency> - -<dependency> - <groupId>org.apache.deltaspike.modules</groupId> - <artifactId>deltaspike-scheduler-module-impl</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> -------------------------------------------------------------- - -==== With Java SE - - -To use DeltaSpike with Java SE, we must provide additional jars file -corresponding to the DeltaSpike CDI Controller API and its -implementation. The Controller uses Java Services to resolve the CDI -container -(http://docs.jboss.org/weld/reference/1.1.5.Final/en-US/html/[JBoss -Weld], http://openwebbeans.apache.org[Apache OpenWebbeans] (and -http://openejb.apache.org[Apache OpenEJB])) and implementation contains -the code to manage the link:#_container_control_optional[CDI container and contexts]. - -*Hint:* In the listings below replace the placeholders for the version -with the version of your choice or use: - -[source,xml] --------------------------------------------------- -<properties> - <deltaspike.version>1.0.0</deltaspike.version> - <owb.version>1.2.0</owb.version> - <weld.version>1.1.9.Final</weld.version> -</properties> --------------------------------------------------- - -===== Add the DeltaSpike Container Ctrl API - -[source,xml] ----------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.cdictrl</groupId> - <artifactId>deltaspike-cdictrl-api</artifactId> - <version>${deltaspike.version}</version> - <scope>compile</scope> -</dependency> ----------------------------------------------------- - -===== Add a CDI container + Container Ctrl Impl - - -==== ... for Apache OpenWebBeans - - -[source,xml] ----------------------------------------------------- -<dependency> - <groupId>org.apache.openwebbeans</groupId> - <artifactId>openwebbeans-impl</artifactId> - <version>${owb.version}</version> - <scope>runtime</scope> -</dependency> - -<dependency> - <groupId>org.apache.openwebbeans</groupId> - <artifactId>openwebbeans-spi</artifactId> - <version>${owb.version}</version> - <scope>compile</scope> -</dependency> - -<dependency> - <groupId>org.apache.deltaspike.cdictrl</groupId> - <artifactId>deltaspike-cdictrl-owb</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> ----------------------------------------------------- - -==== ... for JBoss Weld (RI) - - -[source,xml] ----------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.cdictrl</groupId> - <artifactId>deltaspike-cdictrl-weld</artifactId> - <version>${deltaspike.version}</version> - <scope>runtime</scope> -</dependency> - -<dependency> - <groupId>org.jboss.weld.se</groupId> - <artifactId>weld-se-core</artifactId> - <version>${weld.version}</version> - <scope>runtime</scope> -</dependency> ----------------------------------------------------- - -==== For Embedded Servlet Runtimes, you can add - - -[source,xml] -------------------------------------------------------- -<dependency> - <groupId>org.apache.deltaspike.cdictrl</groupId> - <artifactId>deltaspike-cdictrl-servlet</artifactId> - <version>${deltaspike.version}</version> - <scope>compile</scope> -</dependency> -------------------------------------------------------- - -==== Testing Snapshots - - -If you would like to test the latest Snapshot, you can <<build.adoc#,build>> DeltaSpike locally or you -get it from the Apache Snapshot-Repository: - -[source,xml] ----------------------------------------------------------- -<repositories> - <repository> - <id>apache-snapshot-repository</id> - <url>http://repository.apache.org/snapshots/</url> - <releases> - <enabled>false</enabled> - </releases> - <snapshots> - <enabled>true</enabled> - </snapshots> - </repository> -</repositories> ----------------------------------------------------------- - -== Deployment mode - -DeltaSpike can be deployed in different Java environments. Depending -which Java container and release you are using, the procedure which is -different is explained here after. - -=== With Java EE6+ - -If you are using DeltaSpike in a Java EE6 environment, you don't need to -configure a CDI implementation explicitly because it's shipped with the -container. - -=== With Java EE5 or Servlet Containers - -Java EE5 application servers as well as pure servlet containers like -Apache Tomcat / Eclipse Jetty don't provide a CDI implementation -out-of-the-box. So don't forget to setup the CDI implementation of your -choice. - -=== Standard Java SE6+ - -If you are only using a JDK and runs Java in a standalone or standard -mode (Java SE), then DeltaSpike will allow you to boot a CDI -implementation where you can use Dependency Injection with a Bean -Manager. Such an example will be presented at the next section. - -== Start a CDI container using Java SE - -This code snippet show you how with a Java MainApplication a CDI -container can be started (= boot) by DeltaSpike using Java SE and how -you define a CDI scope and resolve beans injected. - -**Hint**: To bootstrap a CDI container in your Java application, you -just need to instantiate the `CdiContainer` and call the `#boot` method. - -[source,java] -------------------------------------------------------------------------- -import org.apache.deltaspike.cdise.api.CdiContainer; -import org.apache.deltaspike.cdise.api.CdiContainerLoader; - -public class MainApp { - public static void main(String[] args) { - - CdiContainer cdiContainer = CdiContainerLoader.getCdiContainer(); - cdiContainer.boot(); - - // You can use CDI here - - cdiContainer.shutdown(); - } -} -------------------------------------------------------------------------- - -When `#boot` is called, the `CdiContainer` will scan CDI enabled -archives for beans and CDI extensions. - -**Note**: Booting the container does not automatically start all CDI -Contexts! - -Example for starting the application-context: - -[source,java] ----------------------------------------------------------------------------------- -import org.apache.deltaspike.cdise.api.CdiContainer; -import org.apache.deltaspike.cdise.api.CdiContainerLoader; -import org.apache.deltaspike.cdise.api.ContextControl; -import javax.enterprise.context.ApplicationScoped; - -public class MainApp { - public static void main(String[] args) { - - CdiContainer cdiContainer = CdiContainerLoader.getCdiContainer(); - cdiContainer.boot(); - - // Starting the application-context allows to use @ApplicationScoped beans - ContextControl contextControl = cdiContainer.getContextControl(); - contextControl.startContext(ApplicationScoped.class); - - // You can use CDI here - - cdiContainer.shutdown(); - } -} ----------------------------------------------------------------------------------- - -To resolve a bean of this project, you can use the `BeanProvider` -provided by DeltaSpike. The following example shows how to resolve the a -bean without qualifiers. It depends on the application if `EchoService` -is a concrete implementation or just an interface. In case of an -interface the corresponding implementation will be resolved. The -resolved bean is a normal CDI bean which means you can use all CDI -concepts like `@Inject` in the class (and you don't need further usages -of `BeanProvider`). - -[source,java] ----------------------------------------------------------------------------------------- -EchoService echoService = BeanProvider.getContextualReference(EchoService.class, false); ----------------------------------------------------------------------------------------- - -Before the application exits, you have to call `#shutdown` to destroy -beans,... in a well-ordered fashion. - -== Module Overview - -The core features of DeltaSpike project are packaged under the following -different modules. Some of them are mandatory while others are optional. - -=== Core (required) - -Definition : Contain the API and util classes of DeltaSpike project - -++++++++++++++++ -<a class="btn" href="core.html">View details »</a> -++++++++++++++++ - -=== Security (optional) - -Definition : Intercept and check security - -++++++++++++++++ -<a class="btn" href="security.html">View details »</a> -++++++++++++++++ - -=== JPA (optional) - - -Definition : - -++++++++++++++++ -<a class="btn" href="jpa.html">View details »</a> -++++++++++++++++ - - -=== JSF (optional) - -Definition : - -++++++++++++++++ -<a class="btn" href="jsf.html">View details »</a> -++++++++++++++++ - - -=== Container Control (optional) - -Definition : - -++++++++++++++++ -<a class="btn" href="container-control.html">View details »</a> -++++++++++++++++ - - -=== Bean Validation (optional) - -Definition : A module for adding CDI support in Bean Validation. - -Features : Allows a developer to create CDI aware `ConstraintValidator`s -that can use business objects (EJBs, ManagedBeans) to support validation -needs. - -++++++++++++++++ -<a class="btn" href="bean-validation.html">View details »</a> -++++++++++++++++ - - -=== Servlet (optional) - -Definition : The DeltaSpike Servlet module provides integration with the -Java Servlet API. - -Features : - -* Injection of common servlet objects. -* Propagation of servlet events to the CDI event bus. - -++++++++++++++++ -<a class="btn" href="servlet.html">View details »</a> -++++++++++++++++ - - -=== Partial-Bean (optional) - -++++++++++++++++ -<a class="btn" href="partial-bean.html">View details »</a> -++++++++++++++++ - - -=== Data (optional) - -Definition : The DeltaSpike Data module provides enhanced JPA experience -with declarative queries, reducing boilerplate to a minimum. - -Features : - -* Derive queries by simple method names or by method annotations -defining JPQL, named queries or plain SQL -* Result pagination and sorting -* Auditing of entities -* A simplified alternative to the Criteria API -* Mapping of entities from and to DTOs - -++++++++++++++++ -<a class="btn" href="data.html">View details »</a> -++++++++++++++++ - - -=== Test-Control (optional) - -Definition : This module allows to write CDI based tests easily. - -++++++++++++++++ -<a class="btn" href="test-control.html">View details »</a> -++++++++++++++++ - - -=== Scheduler (optional) - -Definition : This module provides a simple integration with Quartz v2 -(per default) or any other scheduler which supports cron-expressions for -job-classes. - -++++++++++++++++ -<a class="btn" href="scheduler.html">View details »</a> -++++++++++++++++ - - -== DeltaSpike SPI - -DeltaSpike Service Provider Interface (SPI) - -++++++++++++++++ -<a class="btn" href="spi.html">View details »</a> -++++++++++++++++ - - -== External - -=== Blogs - -* http://os890.blogspot.com/search/label/deltaspike - - -=== Add-ons - -* https://github.com/os890/ds-monitoring-addon[Monitoring- and Auditing] -* https://github.com/os890/ds-spring-bridge-addon[CDI/Spring Bridge] -* https://github.com/os890/ds-disruptor-addon[Fast events via Disruptor] - -=== Project Templates - -* https://github.com/os890/javase-cdi-ds-project-template[Java SE + CDI + DS] -* https://github.com/os890/javaweb-cdi-ds-project-template[JSF + CDI + DS (Servlet-Container)] -* https://github.com/os890/javaee_cdi_ejb_ds_project_template[EJB + CDI + DS (Module)] -* https://github.com/os890/javaee_jsf_cdi_ejb_ds_project_template[JSF + EJB + CDI + DS (EE-Server)] - -=== Examples - -See link:../examples.html#External[External Examples] +* Getting Started +** <<overview#,Overview of DeltaSpike>> +** <<configure#,Configure DeltaSpike in Your Projects>> +** <<cdiimp#,Enable CDI For Your Java Environment>> +** <<examples#,See DeltaSpike in Action>> +* Using Individual Modules +** <<core#,Core>> +** <<bean-validation#,Bean Validation>> +** <<container-control#,Container Control>> +** <<data#,Data>> +** <<jpa#,JPA>> +** <<jsf#,JSF>> +** <<partial-bean#,Partial-Bean>> +** <<scheduler#,Scheduler>> +** <<security#,Security>> +** <<servlet#,Servlet>> +** <<test-control#,Test-Control>> +* Advanced Information +** <<build#,Build DeltaSpike from Source>> +** <<snapshots#,Use DeltaSpike Snapshots>> +** link:https://deltaspike.apache.org/migration-guide.html[Migrate to DeltaSpike] +** <<spi#,DeltaSpike Service Provider Interface (SPI)>> +* More Resources +** <<articles#,Articles and Blogs>> +** <<addons#,Add-ons>> +** <<external#,External Examples>> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/jpa.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/jpa.adoc b/documentation/src/main/asciidoc/jpa.adoc index 76eccad..8143a67 100644 --- a/documentation/src/main/asciidoc/jpa.adoc +++ b/documentation/src/main/asciidoc/jpa.adoc @@ -2,8 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] - +:toc: == @Transactional http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/jsf.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/jsf.adoc b/documentation/src/main/asciidoc/jsf.adoc index e4044ac..e261a9b 100644 --- a/documentation/src/main/asciidoc/jsf.adoc +++ b/documentation/src/main/asciidoc/jsf.adoc @@ -2,8 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] - +:toc: == Multi-Window Handling http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/overview.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/overview.adoc b/documentation/src/main/asciidoc/overview.adoc new file mode 100644 index 0000000..09163b6 --- /dev/null +++ b/documentation/src/main/asciidoc/overview.adoc @@ -0,0 +1,71 @@ += Overview of DeltaSpike + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + +:toc: + +== Background: Portable CDI Extensions +Contexts and Dependency Injection (CDI) for Java EE (link:https://jcp.org/en/jsr/detail?id=299[JSR 299]) was introduced as part of Java EE6. It defines a collection of Java services that provides the foundation for frameworks, extensions, and integration with other technologies. + +Portable CDI extensions extend CDI implementations and improve existing Java EE APIs by enabling integration of different technologies. They can be used with any spec-compliant CDI implementation, such as JBoss Weld or Apache OpenWebBeans. The CDI container manages start and stop procedures, web beans, lifecycles, and injections. This means portable CDI extension injections can be handled by the container instead of the user. + +== About DeltaSpike +DeltaSpike is a collection of portable CDI extensions. These ready-to-use modules are created by the community and provide a method of integrating tested API extensions into your Java projects. + +DeltaSpike consists of a core module and a number of optional modules for providing additional enterprise functionality to your applications. The modules include features for enhanced security with type-safe control over method invocations, integration with schedulers, injection of CDI objects into validators, and a transactional context and scope. DeltaSpike also provides boot and shutdown control over CDI containers in Java SE applications. + +As portable CDI extensions, DeltaSpike requires a CDI implementation and supports both JBoss Weld and Apache OpenWebBeans. DeltaSpike has also been tested on a range of application servers and containers that provide these CDI implementations, such as Apache TomEE, JBoss AS, WildFly, Oracle GlassFish, and Jetty. + +In addition to the portable CDI extension modules, DeltaSpike provides a number of examples to assist you in understanding how to use and get the most from this technology. + +== Features of DeltaSpike + +=== Java EE 7 without Java EE 7! + +*Transactional support for non-EJB beans:* The Transactional Interceptor in DeltaSpike paved the way for @Transactional in Java EE 7. + +*Injectable Servlet objects:* Allows the developer to inject CDI beans on Servlets on Java EE 6/CDI 1.0 environments + +*Injectable resources:* Configuration, resource bundles,... are easy to inject when using CDI and Apache DeltaSpike. + +*@Exclude annotation:* it's possible to annotate beans which should be ignored by CDI even if they are in a CDI enabled archive on Java EE 6/CDI 1.0 environment where you can't use @Vetoed or a veto based on project-stages or expressions is needed. + +**Scheduling tasks**: Async processes in a non Java EE 7 environment. + +*Bean Validation integration:* Allows to inject CDI beans and EJB in to Constraint-Validators. + +*BeanProvider:* Access the BeanManager and CDI beans even in non managed classes like JPA-2.0 EntityListeners or Spring Beans. + + +=== JSF Improvements + +*Multi-window handling:* Allows to manage logical windows for batches,... or in case of JSF it offers proper separation of browser-tabs. + +*Type-safe view-config:* It allows to bind meta-data (e.g. for security) to views with a type-safe, but flexible approach. It provides a more solid navigation in case of JSF and helps a lot in the maintenance phase. + +*View-Controller:* Based on type-safe view-configs view-controller annotations provide a type-safe alternative to standard-tags. + +*Injection on Converters and Validators:* Allows to inject CDI beans and EJB in to JSF Converters and Validators. + +*JSF event broadcasting to CDI:* Allows CDI to be notified about JSF events + +=== Productivity Improvements + +*Security based on annotations:* The foundation for building a robust, capable and non invasive security solution. + +*New CDI scopes:* TransactionScoped, WindowScoped, ViewScoped, ViewAccess scope, Grouped conversion scope + +*Container Control & Test Control:* Java SE with CDI, all with a unifying API. Start, stop, add classes to a running CDI container. + +*Data Module:* An out of the box entity framework solution complete with support for container or application managed persistence contexts, as well as JDBC. + +*Decoupled Exception handling:* Allows to do exception handling in one location similar to CDI Observers. + +*JMX integration:* Any CDI bean can be exposed via JMX easily with one annotation. + +*Type-safe i18n messages:* Localized messages are easy to use with an interface and a resource bundle, no more boilerplate and your messages now have context within the code. + +*Type-safe Project-Stages:* Compared to project-stages in JSF, DeltaSpike provides a type-safe, but still extensible approach which can be used in CDI based applications. + +== Next +For instructions on how to start using DeltaSpike, see <<configure#,Configure DeltaSpike in Your Projects>>. http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/partial-bean.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/partial-bean.adoc b/documentation/src/main/asciidoc/partial-bean.adoc index e15b270..e89ab00 100644 --- a/documentation/src/main/asciidoc/partial-bean.adoc +++ b/documentation/src/main/asciidoc/partial-bean.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] +:toc: == Usage http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/projectstage.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/projectstage.adoc b/documentation/src/main/asciidoc/projectstage.adoc index 8419c77..224521c 100644 --- a/documentation/src/main/asciidoc/projectstage.adoc +++ b/documentation/src/main/asciidoc/projectstage.adoc @@ -2,9 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - -[TOC] - +:toc: == Introduction http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/scheduler.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/scheduler.adoc b/documentation/src/main/asciidoc/scheduler.adoc index 586357b..bf097e3 100644 --- a/documentation/src/main/asciidoc/scheduler.adoc +++ b/documentation/src/main/asciidoc/scheduler.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] +:toc: == Intro http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/security.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/security.adoc b/documentation/src/main/asciidoc/security.adoc index 200b7c6..db96701 100644 --- a/documentation/src/main/asciidoc/security.adoc +++ b/documentation/src/main/asciidoc/security.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] +:toc: == Hint http://git-wip-us.apache.org/repos/asf/deltaspike/blob/548383b7/documentation/src/main/asciidoc/servlet.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/servlet.adoc b/documentation/src/main/asciidoc/servlet.adoc index 7fe2d76..61e530f 100644 --- a/documentation/src/main/asciidoc/servlet.adoc +++ b/documentation/src/main/asciidoc/servlet.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -[TOC] +:toc: == Configuration
