Added: websites/staging/deltaspike/trunk/content/documentation/modules.html ============================================================================== --- websites/staging/deltaspike/trunk/content/documentation/modules.html (added) +++ websites/staging/deltaspike/trunk/content/documentation/modules.html Mon Dec 15 22:31:42 2014 @@ -0,0 +1,277 @@ +<!DOCTYPE html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta charset="utf-8"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="description" content="deltaspike-generate-pages"> +<meta name="author" content="chm"> + +<title>Overview of DeltaSpike Modules</title> + +<!-- 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. --> + +<!-- Styles --> + +<link href="https://deltaspike.apache.org/resources/css/bootstrap.css"; rel="stylesheet"> +<link href="https://deltaspike.apache.org/resources/css/bootstrap-responsive.css"; rel="stylesheet"> + +<style type="text/css"> +/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */ +/*pre.CodeRay {background-color:#f7f7f8;}*/ +.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em} +.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)} +.CodeRay .line-numbers strong{font-weight: normal} +table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none} +table.CodeRay td{vertical-align: top} +table.CodeRay td.line-numbers{text-align:right} +table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)} +table.CodeRay td.code{padding:0 0 0 .5em} +table.CodeRay td.code>pre{padding:0} +.CodeRay .debug{color:#fff !important;background:#000080 !important} +.CodeRay .annotation{color:#007} +.CodeRay .attribute-name{color:#000080} +.CodeRay .attribute-value{color:#700} +.CodeRay .binary{color:#509} +.CodeRay .comment{color:#998;font-style:italic} +.CodeRay .char{color:#04d} +.CodeRay .char .content{color:#04d} +.CodeRay .char .delimiter{color:#039} +.CodeRay .class{color:#458;font-weight:bold} +.CodeRay .complex{color:#a08} +.CodeRay .constant,.CodeRay .predefined-constant{color:#008080} +.CodeRay .color{color:#099} +.CodeRay .class-variable{color:#369} +.CodeRay .decorator{color:#b0b} +.CodeRay .definition{color:#099} +.CodeRay .delimiter{color:#000} +.CodeRay .doc{color:#970} +.CodeRay .doctype{color:#34b} +.CodeRay .doc-string{color:#d42} +.CodeRay .escape{color:#666} +.CodeRay .entity{color:#800} +.CodeRay .error{color:#808} +.CodeRay .exception{color:inherit} +.CodeRay .filename{color:#099} +.CodeRay .function{color:#900;font-weight:bold} +.CodeRay .global-variable{color:#008080} +.CodeRay .hex{color:#058} +.CodeRay .integer,.CodeRay .float{color:#099} +.CodeRay .include{color:#555} +.CodeRay .inline{color:#00} +.CodeRay .inline .inline{background:#ccc} +.CodeRay .inline .inline .inline{background:#bbb} +.CodeRay .inline .inline-delimiter{color:#d14} +.CodeRay .inline-delimiter{color:#d14} +.CodeRay .important{color:#555;font-weight:bold} +.CodeRay .interpreted{color:#b2b} +.CodeRay .instance-variable{color:#008080} +.CodeRay .label{color:#970} +.CodeRay .local-variable{color:#963} +.CodeRay .octal{color:#40e} +.CodeRay .predefined{color:#369} +.CodeRay .preprocessor{color:#579} +.CodeRay .pseudo-class{color:#555} +.CodeRay .directive{font-weight:bold} +.CodeRay .type{font-weight:bold} +.CodeRay .predefined-type{color:inherit} +.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold} +.CodeRay .key{color:#808} +.CodeRay .key .delimiter{color:#606} +.CodeRay .key .char{color:#80f} +.CodeRay .value{color:#088} +.CodeRay .regexp .delimiter{color:#808} +.CodeRay .regexp .content{color:#808} +.CodeRay .regexp .modifier{color:#808} +.CodeRay .regexp .char{color:#d14} +.CodeRay .regexp .function{color:#404;font-weight:bold} +.CodeRay .string{color:#d20} +.CodeRay .string .string .string{background:#ffd0d0} +.CodeRay .string .content{color:#d14} +.CodeRay .string .char{color:#d14} +.CodeRay .string .delimiter{color:#d14} +.CodeRay .shell{color:#d14} +.CodeRay .shell .delimiter{color:#d14} +.CodeRay .symbol{color:#990073} +.CodeRay .symbol .content{color:#a60} +.CodeRay .symbol .delimiter{color:#630} +.CodeRay .tag{color:#008080} +.CodeRay .tag-special{color:#d70} +.CodeRay .variable{color:#036} +.CodeRay .insert{background:#afa} +.CodeRay .delete{background:#faa} +.CodeRay .change{color:#aaf;background:#007} +.CodeRay .head{color:#f8f;background:#505} +.CodeRay .insert .insert{color:#080} +.CodeRay .delete .delete{color:#800} +.CodeRay .change .change{color:#66f} +.CodeRay .head .head{color:#f4f} +body { + padding-top: 60px; + padding-bottom: 40px; +} +</style> +<script type="text/javascript"> + + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-36103647-1']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + + </script> +</head> + +<body> + + <div class="navbar navbar-fixed-top"> + <div class="navbar-inner"> + <div class="container"> + <a class="btn btn-navbar" data-toggle="collapse" + data-target=".nav-collapse"> <span class="icon-bar"></span> <span + class="icon-bar"></span> <span class="icon-bar"></span> + </a> <a class="brand logocolor" + href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike []</a> + <div class="nav-collapse"> + <ul class="nav"> + <li class="active"><a + href="index.html">Home</a></li> + <li><a href="../documentation">Documentation</a></li> + <li><a href="../javadoc.html">Javadoc</a></li> + <li><a href="../documentation/source.html">Source</a></li> + <li><a href="../download.html">Download</a></li> + <li><a href="../community.html">Community</a></li> + <!-- <li><a href="./support.html">Support</a></li> --> + <li><a href="../news.html">News</a></li> + <li><a href="../migration-guide.html">Migration</a></li> + </ul> + </div> + <!--/.nav-collapse --> + <form id="search-form" action="http://www.google.com/search"; + method="get" class="navbar-search pull-right"> + <input value="deltaspike.apache.org" name="sitesearch" + type="hidden"> <input class="search-query" name="q" + id="query" type="text"> + </form> + </div> + </div> + </div> + + <div class="container"> + <div class="row"> + <div class="span12"> + <div class="page-title"> + <h1>Overview of DeltaSpike Modules</h1> + </div> + + <div id="toc" class="toc"> + + <hr> + + <div class="paragraph"> +<p>DeltaSpike consists of ready-to-use modules. These include a core module and a number of optional modules for providing additional enterprise functionality to your applications. An overview of each module is provided here and for more information see the linked individual module pages.</p> +</div> +<table class="tableblock frame-all grid-all spread"> +<caption class="title">Table 1. DeltaSpike Modules</caption> +<colgroup> +<col style="width: 25%;"> +<col style="width: 25%;"> +<col style="width: 50%;"> +</colgroup> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core.html">Core</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Required</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For fundamental and defining DeltaSpike API and utility classes</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="bean-validation.html">Bean Validation</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For adding CDI support in Bean Validation, enabling creation of CDI aware <code>ConstraintValidator</code> methods that can use business objects (EJBs, ManagedBeans) to support validation needs</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="container-control.html">Container Control</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For CDI container booting and shutdown and associated context lifecycle management</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="data.html">Data</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For an enhanced JPA experience with declarative queries, reducing boilerplate to a minimum</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="jpa.html">JPA</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For transactional context and scope</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="jsf.html">JSF</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For CDI integration with JSF, with type-safe view config, multi-window handling, new scopes (WindowScoped, ViewScope, ViewAccessScoped, GroupedConversationScoped) and integration with DeltaSpike âcoreâ messages and exception handling</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="partial-bean.html">Partial-Bean</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For implementing a generic handler to replace manual implementations of interfaces (or abstract classes)</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="scheduler.html">Scheduler</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For simple integration with Quartz v2 (default) or any other scheduler that supports cron-expressions for job-classes</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html">Security</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For intercept and security checking on method calls</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="servlet.html">Servlet</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For integration with the Java Servlet API, enabling injection of common servlet objects and propagation of servlet events to the CDI event bus</p> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="test-control.html">Test-Control</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td> +<td class="tableblock halign-left valign-top"><div><div class="paragraph"> +<p>For writing CDI-based tests easily</p> +</div></div></td> +</tr> +</tbody> +</table> + </div> + + <hr> + + <footer> + <p>Copyright © 2011-2014 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.</p> + <p>Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + </footer> + + </div> + <!-- /.container --> + +</body> +</html> \ No newline at end of file
Added: websites/staging/deltaspike/trunk/content/documentation/overview.html ============================================================================== --- websites/staging/deltaspike/trunk/content/documentation/overview.html (added) +++ websites/staging/deltaspike/trunk/content/documentation/overview.html Mon Dec 15 22:31:42 2014 @@ -0,0 +1,363 @@ +<!DOCTYPE html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta charset="utf-8"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="description" content="deltaspike-generate-pages"> +<meta name="author" content="chm"> + +<title>Overview of DeltaSpike</title> + +<!-- 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. --> + +<!-- Styles --> + +<link href="https://deltaspike.apache.org/resources/css/bootstrap.css"; rel="stylesheet"> +<link href="https://deltaspike.apache.org/resources/css/bootstrap-responsive.css"; rel="stylesheet"> + +<style type="text/css"> +/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */ +/*pre.CodeRay {background-color:#f7f7f8;}*/ +.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em} +.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)} +.CodeRay .line-numbers strong{font-weight: normal} +table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none} +table.CodeRay td{vertical-align: top} +table.CodeRay td.line-numbers{text-align:right} +table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)} +table.CodeRay td.code{padding:0 0 0 .5em} +table.CodeRay td.code>pre{padding:0} +.CodeRay .debug{color:#fff !important;background:#000080 !important} +.CodeRay .annotation{color:#007} +.CodeRay .attribute-name{color:#000080} +.CodeRay .attribute-value{color:#700} +.CodeRay .binary{color:#509} +.CodeRay .comment{color:#998;font-style:italic} +.CodeRay .char{color:#04d} +.CodeRay .char .content{color:#04d} +.CodeRay .char .delimiter{color:#039} +.CodeRay .class{color:#458;font-weight:bold} +.CodeRay .complex{color:#a08} +.CodeRay .constant,.CodeRay .predefined-constant{color:#008080} +.CodeRay .color{color:#099} +.CodeRay .class-variable{color:#369} +.CodeRay .decorator{color:#b0b} +.CodeRay .definition{color:#099} +.CodeRay .delimiter{color:#000} +.CodeRay .doc{color:#970} +.CodeRay .doctype{color:#34b} +.CodeRay .doc-string{color:#d42} +.CodeRay .escape{color:#666} +.CodeRay .entity{color:#800} +.CodeRay .error{color:#808} +.CodeRay .exception{color:inherit} +.CodeRay .filename{color:#099} +.CodeRay .function{color:#900;font-weight:bold} +.CodeRay .global-variable{color:#008080} +.CodeRay .hex{color:#058} +.CodeRay .integer,.CodeRay .float{color:#099} +.CodeRay .include{color:#555} +.CodeRay .inline{color:#00} +.CodeRay .inline .inline{background:#ccc} +.CodeRay .inline .inline .inline{background:#bbb} +.CodeRay .inline .inline-delimiter{color:#d14} +.CodeRay .inline-delimiter{color:#d14} +.CodeRay .important{color:#555;font-weight:bold} +.CodeRay .interpreted{color:#b2b} +.CodeRay .instance-variable{color:#008080} +.CodeRay .label{color:#970} +.CodeRay .local-variable{color:#963} +.CodeRay .octal{color:#40e} +.CodeRay .predefined{color:#369} +.CodeRay .preprocessor{color:#579} +.CodeRay .pseudo-class{color:#555} +.CodeRay .directive{font-weight:bold} +.CodeRay .type{font-weight:bold} +.CodeRay .predefined-type{color:inherit} +.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold} +.CodeRay .key{color:#808} +.CodeRay .key .delimiter{color:#606} +.CodeRay .key .char{color:#80f} +.CodeRay .value{color:#088} +.CodeRay .regexp .delimiter{color:#808} +.CodeRay .regexp .content{color:#808} +.CodeRay .regexp .modifier{color:#808} +.CodeRay .regexp .char{color:#d14} +.CodeRay .regexp .function{color:#404;font-weight:bold} +.CodeRay .string{color:#d20} +.CodeRay .string .string .string{background:#ffd0d0} +.CodeRay .string .content{color:#d14} +.CodeRay .string .char{color:#d14} +.CodeRay .string .delimiter{color:#d14} +.CodeRay .shell{color:#d14} +.CodeRay .shell .delimiter{color:#d14} +.CodeRay .symbol{color:#990073} +.CodeRay .symbol .content{color:#a60} +.CodeRay .symbol .delimiter{color:#630} +.CodeRay .tag{color:#008080} +.CodeRay .tag-special{color:#d70} +.CodeRay .variable{color:#036} +.CodeRay .insert{background:#afa} +.CodeRay .delete{background:#faa} +.CodeRay .change{color:#aaf;background:#007} +.CodeRay .head{color:#f8f;background:#505} +.CodeRay .insert .insert{color:#080} +.CodeRay .delete .delete{color:#800} +.CodeRay .change .change{color:#66f} +.CodeRay .head .head{color:#f4f} +body { + padding-top: 60px; + padding-bottom: 40px; +} +</style> +<script type="text/javascript"> + + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-36103647-1']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + + </script> +</head> + +<body> + + <div class="navbar navbar-fixed-top"> + <div class="navbar-inner"> + <div class="container"> + <a class="btn btn-navbar" data-toggle="collapse" + data-target=".nav-collapse"> <span class="icon-bar"></span> <span + class="icon-bar"></span> <span class="icon-bar"></span> + </a> <a class="brand logocolor" + href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike []</a> + <div class="nav-collapse"> + <ul class="nav"> + <li class="active"><a + href="index.html">Home</a></li> + <li><a href="../documentation">Documentation</a></li> + <li><a href="../javadoc.html">Javadoc</a></li> + <li><a href="../documentation/source.html">Source</a></li> + <li><a href="../download.html">Download</a></li> + <li><a href="../community.html">Community</a></li> + <!-- <li><a href="./support.html">Support</a></li> --> + <li><a href="../news.html">News</a></li> + <li><a href="../migration-guide.html">Migration</a></li> + </ul> + </div> + <!--/.nav-collapse --> + <form id="search-form" action="http://www.google.com/search"; + method="get" class="navbar-search pull-right"> + <input value="deltaspike.apache.org" name="sitesearch" + type="hidden"> <input class="search-query" name="q" + id="query" type="text"> + </form> + </div> + </div> + </div> + + <div class="container"> + <div class="row"> + <div class="span12"> + <div class="page-title"> + <h1>Overview of DeltaSpike</h1> + </div> + + <div id="toc" class="toc"> + <ul class="sectlevel1"> +<li><a href="#_background">Background</a> +<ul class="sectlevel2"> +<li><a href="#_cdi">CDI</a></li> +<li><a href="#_portable_cdi_extensions">Portable CDI Extensions</a></li> +</ul> +</li> +<li><a href="#_about_apache_deltaspike">About Apache DeltaSpike</a></li> +<li><a href="#_features_of_deltaspike">Features of DeltaSpike</a> +<ul class="sectlevel2"> +<li><a href="#_java_ee_7_without_java_ee_7">Java EE 7 without Java EE 7!</a></li> +<li><a href="#_jsf_improvements">JSF Improvements</a></li> +<li><a href="#_productivity_improvements">Productivity Improvements</a></li> +</ul> +</li> +<li><a href="#_next">Next</a></li> +</ul> + <hr> + + <div class="sect1"> +<h2 id="_background">Background</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_cdi">CDI</h3> +<div class="paragraph"> +<p>Java Contexts and Dependency Injection for the Java EE platform (<a href="https://jcp.org/en/jsr/detail?id=299";>JSR 299</a>), abbreviated to CDI, was introduced as part of Java EE6. The core features of CDI are as follows:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>improved stateful object lifecycles with an additional context named <em>Conversation</em> that encompasses a series of requests within one session and lifecycle management by the container according to well-defined contexts</p> +</li> +<li> +<p>dependency injection conducted in a type-safe manner, with type checking conducted at compilation time so errors are exposed earlier and debugging is easier</p> +</li> +<li> +<p>event notification facility for object interaction</p> +</li> +<li> +<p>a better approach for interceptors with annotations binding interceptors to objects and with a new interceptor named <em>decorator</em> that knows about individual bean attributes through inheritence and is more appropriate for use in solving business problems</p> +</li> +<li> +<p>a Service Provider Interface (SPI) for developing portable extensions to the CDI container</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>CDI is a <a href="https://jcp.org/en/home/index";>Java Community Process (JCP)</a> standard. All Java EE6 compliant application servers must provide support for CDI. <a href="http://weld.cdi-spec.org/";>JBoss Weld</a> is a reference implementation of the CDI specification and other spec-compliant implementations exist such as <a href="http://openwebbeans.apache.org/";>Apache OpenWebBeans (OWB)</a>. While CDI is a Java EE6 essential, CDI can also be used in Java SE environments with the aid of standalone CDI implementations.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_portable_cdi_extensions">Portable CDI Extensions</h3> +<div class="paragraph"> +<p>The CDI Service Provider Interface (SPI) is exposed to enable extension of the CDI feature set by third-parties. Portable CDI extensions extend CDI implementations and improve existing Java EE APIs by enabling integration of different technologies.</p> +</div> +<div class="paragraph"> +<p>As set out in the CDI specification, a portable CDI extenstion may integrate with a CDI container as follows:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>providing its own beans, interceptors and decorators to the container</p> +</li> +<li> +<p>injecting dependencies into its own objects using the dependency injection service</p> +</li> +<li> +<p>providing a context implementation for a custom scope</p> +</li> +<li> +<p>augmenting or overriding the annotation-based metadata with metadata from some other source</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>As indicated by the name, <em>portable</em> CDI extensions can be used with any spec-compliant CDI implementation.</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_about_apache_deltaspike">About Apache DeltaSpike</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Apache DeltaSpike is a collection of portable CDI extensions. These ready-to-use modules enable you to integrate tested API extensions into your Java projects.</p> +</div> +<div class="paragraph"> +<p>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.</p> +</div> +<div class="paragraph"> +<p>As a CDI extension, DeltaSpike must be used in conjunction with a CDI implementation and supports both JBoss Weld and Apache OpenWebBeans. DeltaSpike has been tested on a range of application servers and containers that utilize these CDI implementations, such as Apache TomEE, JBoss AS, WildFly, Oracle GlassFish, and Jetty.</p> +</div> +<div class="paragraph"> +<p>In addition to the portable CDI extension modules, DeltaSpike provides a number of examples to show you how to use and get the most from this technology.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_features_of_deltaspike">Features of DeltaSpike</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_java_ee_7_without_java_ee_7">Java EE 7 without Java EE 7!</h3> +<div class="paragraph"> +<p><strong>Transactional support for non-EJB beans:</strong> The Transactional Interceptor in DeltaSpike paved the way for @Transactional in Java EE 7.</p> +</div> +<div class="paragraph"> +<p><strong>Injectable Servlet objects:</strong> Allows the developer to inject CDI beans on Servlets on Java EE 6/CDI 1.0 environments</p> +</div> +<div class="paragraph"> +<p><strong>Injectable resources:</strong> Configuration, resource bundles,…​ are easy to inject when using CDI and Apache DeltaSpike.</p> +</div> +<div class="paragraph"> +<p><strong>@Exclude annotation:</strong> it is 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 cais not use @Vetoed or a veto based on ProjectStages or expressions is needed.</p> +</div> +<div class="paragraph"> +<p><strong>Scheduling tasks</strong>: Async processes in a non Java EE 7 environment.</p> +</div> +<div class="paragraph"> +<p><strong>Bean Validation integration:</strong> Allows to inject CDI beans and EJB in to Constraint-Validators.</p> +</div> +<div class="paragraph"> +<p><strong>BeanProvider:</strong> Access the BeanManager and CDI beans even in non managed classes like JPA-2.0 EntityListeners or Spring Beans.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_jsf_improvements">JSF Improvements</h3> +<div class="paragraph"> +<p><strong>Multi-window handling:</strong> Allows to manage logical windows for batches,…​ or in case of JSF it offers proper separation of browser-tabs.</p> +</div> +<div class="paragraph"> +<p><strong>Type-safe view-config:</strong> 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.</p> +</div> +<div class="paragraph"> +<p><strong>View-Controller:</strong> Based on type-safe view-configs view-controller annotations provide a type-safe alternative to standard-tags.</p> +</div> +<div class="paragraph"> +<p><strong>Injection on Converters and Validators:</strong> Allows to inject CDI beans and EJB in to JSF Converters and Validators.</p> +</div> +<div class="paragraph"> +<p><strong>JSF event broadcasting to CDI:</strong> Allows CDI to be notified about JSF events</p> +</div> +</div> +<div class="sect2"> +<h3 id="_productivity_improvements">Productivity Improvements</h3> +<div class="paragraph"> +<p><strong>Security based on annotations:</strong> The foundation for building a robust, capable and non invasive security solution.</p> +</div> +<div class="paragraph"> +<p><strong>New CDI scopes:</strong> TransactionScoped, WindowScoped, ViewScoped, ViewAccess scope, Grouped conversion scope</p> +</div> +<div class="paragraph"> +<p><strong>Container Control and Test Control:</strong> Java SE with CDI, all with a unifying API. Start, stop, add classes to a running CDI container.</p> +</div> +<div class="paragraph"> +<p><strong>Data Module:</strong> An out of the box entity framework solution complete with support for container or application managed persistence contexts, as well as JDBC.</p> +</div> +<div class="paragraph"> +<p><strong>Decoupled Exception handling:</strong> Allows to do exception handling in one location similar to CDI Observers.</p> +</div> +<div class="paragraph"> +<p><strong>JMX integration:</strong> Any CDI bean can be exposed via JMX easily with one annotation.</p> +</div> +<div class="paragraph"> +<p><strong>Type-safe i18n messages:</strong> 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.</p> +</div> +<div class="paragraph"> +<p><strong>Type-safe ProjectStages:</strong> Compared to ProjectStages in JSF, DeltaSpike provides a type-safe, but still extensible approach which can be used in CDI based applications.</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_next">Next</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>For instructions on how to start using DeltaSpike, see <a href="configure.html">Configure DeltaSpike in Your Projects</a> and <a href="cdiimp.html">Enable CDI For Your Java Environment</a>.</p> +</div> +</div> +</div> + </div> + + <hr> + + <footer> + <p>Copyright © 2011-2014 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.</p> + <p>Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + </footer> + + </div> + <!-- /.container --> + +</body> +</html> \ No newline at end of file Modified: websites/staging/deltaspike/trunk/content/documentation/partial-bean.html ============================================================================== --- websites/staging/deltaspike/trunk/content/documentation/partial-bean.html (original) +++ websites/staging/deltaspike/trunk/content/documentation/partial-bean.html Mon Dec 15 22:31:42 2014 @@ -6,7 +6,7 @@ <meta name="description" content="deltaspike-generate-pages"> <meta name="author" content="chm"> -<title>Partial-Bean</title> +<title>Partial-Bean Module</title> <!-- 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. --> @@ -134,7 +134,7 @@ body { data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a> <a class="brand logocolor" - href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike</a> + href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike []</a> <div class="nav-collapse"> <ul class="nav"> <li class="active"><a @@ -164,19 +164,82 @@ body { <div class="row"> <div class="span12"> <div class="page-title"> - <h1>Partial-Bean</h1> + <h1>Partial-Bean Module</h1> </div> <div id="toc" class="toc"> <ul class="sectlevel1"> -<li><a href="#_usage">Usage</a></li> +<li><a href="#_overview">Overview</a></li> +<li><a href="#_configure_your_projects">Configure Your Projects</a> +<ul class="sectlevel2"> +<li><a href="#_declare_partial_bean_module_dependencies">Declare Partial-Bean Module Dependencies</a></li> +</ul> +</li> +<li><a href="#_use_the_module_features">Use the Module Features</a> +<ul class="sectlevel2"> +<li><a href="#__partialbeanbinding">@PartialBeanBinding</a></li> +</ul> +</li> </ul> <hr> <div class="sect1"> -<h2 id="_usage">Usage</h2> +<h2 id="_overview">Overview</h2> <div class="sectionbody"> <div class="paragraph"> +<p>The Partial-Bean module provides means for implementing a generic handler to replace manual implementations of interfaces (or abstract classes).</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_configure_your_projects">Configure Your Projects</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The configuration information provided here is for Maven-based projects and it assumes that you have already declared the DeltaSpike version and DeltaSpike Core module for your projects, as detailed in <a href="configure.html">Configure DeltaSpike in Your Projects</a>. For Maven-independent projects, see <a href="configure.html#config-maven-indep">Configure DeltaSpike in Maven-independent Projects</a>.</p> +</div> +<div class="sect2"> +<h3 id="_declare_partial_bean_module_dependencies">Declare Partial-Bean Module Dependencies</h3> +<div class="paragraph"> +<p>Add the Partial-Bean module to the list of dependencies in the project <code>pom.xml</code> file using this code snippet:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-partial-bean-module-api<span class="tag"></artifactId></span> + <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> + <span class="tag"><scope></span>compile<span class="tag"></scope></span> +<span class="tag"></dependency></span> + +<span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-partial-bean-module-impl<span class="tag"></artifactId></span> + <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> + <span class="tag"><scope></span>runtime<span class="tag"></scope></span> +<span class="tag"></dependency></span></code></pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_use_the_module_features">Use the Module Features</h2> +<div class="sectionbody"> +<div class="admonitionblock important"> +<table> +<tr> +<td class="icon"> +<div class="title">Important</div> +</td> +<td class="content"> +Currently CDI Interceptors cannot be used for partial-beans. +</td> +</tr> +</table> +</div> +<div class="sect2"> +<h3 id="__partialbeanbinding">@PartialBeanBinding</h3> +<div class="paragraph"> <p>Partial beans allow you to implement a generic handler to replace manual implementations of interfaces (or abstract classes).</p> </div> @@ -214,8 +277,6 @@ interface (/abstract class) to generic h <p>Using an abstract class as partial-bean requires javassist as an additional dependency and allows to implement some methods manually.</p> </div> -<div class="paragraph"> -<p>Attention: Currently CDI-Interceptors can’t be used for partial-beans.</p> </div> </div> </div> Modified: websites/staging/deltaspike/trunk/content/documentation/projectstage.html ============================================================================== --- websites/staging/deltaspike/trunk/content/documentation/projectstage.html (original) +++ websites/staging/deltaspike/trunk/content/documentation/projectstage.html Mon Dec 15 22:31:42 2014 @@ -134,7 +134,7 @@ body { data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a> <a class="brand logocolor" - href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike</a> + href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike []</a> <div class="nav-collapse"> <ul class="nav"> <li class="active"><a @@ -172,9 +172,9 @@ body { <li><a href="#_introduction">Introduction</a> <ul class="sectlevel2"> <li><a href="#_custom_project_stages">Custom Project Stages</a></li> -<li><a href="#_projectstageproducer_for_3rd_party_portable_extensions">ProjectStageProducer (for 3rd party portable extensions)</a> +<li><a href="#_projectstageproducer_for_third_party_portable_extensions">ProjectStageProducer (for Third-party Portable Extensions)</a> <ul class="sectlevel3"> -<li><a href="#_setting_the_active_projectstage">Setting the active ProjectStage</a></li> +<li><a href="#_setting_the_active_projectstage">Setting the Active ProjectStage</a></li> </ul> </li> </ul> @@ -187,13 +187,13 @@ body { <div class="sectionbody"> <div class="paragraph"> <p>Project stages allow to use implementations depending on the current -environment. E.g. you can implement a bean which creates sample-data for -system tests which gets activated only in case of project-stage +environment. For example, you can implement a bean which creates sample-data for +system tests which gets activated only in case of ProjectStage <code>SystemTest</code>.</p> </div> <div class="paragraph"> -<p><em>Besides custom project-stages</em> it’s possible to use the following -pre-defined project-stages:</p> +<p><em>Besides custom ProjectStages</em> it is possible to use the following +pre-defined ProjectStages:</p> </div> <div class="ulist"> <ul> @@ -219,15 +219,15 @@ pre-defined project-stages:</p> </div> <div class="paragraph"> <p>The core provides a pluggable and type-safe approach for using project -stages in a project (it’s also used within the framework). Furthermore, -<code>@Exclude</code> allows to use e.g. i mplementations annotated with -<code>javax.enterprise.inject.Alternative</code> for specific project-stages. -Besides the out-of-the-box project-stages it’s possible to implement -<em>custom but type-safe</em> project-stages which will be exposed by +stages in a project (it is also used within the framework). Furthermore, +<code>@Exclude</code> allows use of, for example, implementations annotated with +<code>javax.enterprise.inject.Alternative</code> for specific ProjectStages. +Besides the out-of-the-box ProjectStages it is possible to implement +<em>custom but type-safe</em> ProjectStages which will be exposed by DeltaSpike.</p> </div> <div class="paragraph"> -<p>Resolving and using the Project-Stage:</p> +<p>Resolving and using the ProjectStage:</p> </div> <div class="listingblock"> <div class="content"> @@ -242,13 +242,13 @@ DeltaSpike.</p> <div class="sect2"> <h3 id="_custom_project_stages">Custom Project Stages</h3> <div class="paragraph"> -<p>It’s possible to provide custom project stage implementations. +<p>It is possible to provide custom project stage implementations. Therefore, you have to provide an implementation of the <code>ProjectStageHolder</code> interface. In this class you nest the custom -project-stage implementations which have to be -<code>public static final class</code> and it’s required to extend <code>ProjectStage</code>. -It’s required to provide a <code>public static final</code> instance even though, -you won’t use it directly.</p> +ProjectStage implementations which have to be +<code>public static final class</code> and it is required to extend <code>ProjectStage</code>. +It is required to provide a <code>public static final</code> instance even though, +you will not use it directly.</p> </div> <div class="paragraph"> <p>ProjectStageHolder for custom project stage implementations:</p> @@ -287,26 +287,27 @@ customProjectStage = CustomProjectStageH </div> </div> <div class="sect2"> -<h3 id="_projectstageproducer_for_3rd_party_portable_extensions">ProjectStageProducer (for 3rd party portable extensions)</h3> +<h3 id="_projectstageproducer_for_third_party_portable_extensions">ProjectStageProducer (for Third-party Portable Extensions)</h3> <div class="paragraph"> <p><code>ProjectStageProducer</code> provides the producer method which allows to -inject the current project-stage. However, in some cases it’s needed to -use project-stages also during the bootstrapping process of the CDI -container and you can’t use injection. In such cases you can use +inject the current ProjectStage. However, in some cases it is needed to +use ProjectStages also during the bootstrapping process of the CDI +container and you cais not use injection. In such cases you can use <code>ProjectStageProducer.getInstance().getProjectStage()</code> to resolve the -current project-stage. This helper also contains helpers for unit-tests -- e.g. <code>#setProjectStage</code>. However, those methods shouldn’t be needed -for users (we just need them for testing different project-stage +current ProjectStage. This helper also contains helpers for unit-tests +- e.g. <code>#setProjectStage</code>. However, those methods shouldis not be needed +for users (we just need them for testing different ProjectStage scenarios).</p> </div> <div class="sect3"> -<h4 id="_setting_the_active_projectstage">Setting the active ProjectStage</h4> +<h4 id="_setting_the_active_projectstage">Setting the Active ProjectStage</h4> <div class="paragraph"> <p>For setting the ProjectStage which shall get used in your application you can specify it in a few ways. The underlying mechanism used to -determine the string is the ConfigResolver. E.g.:</p> +determine the string is the ConfigResolver.</p> </div> <div class="listingblock"> +<div class="title">Example</div> <div class="content"> <pre>-Dorg.apache.deltaspike.ProjectStage=Development</pre> </div> Modified: websites/staging/deltaspike/trunk/content/documentation/scheduler.html ============================================================================== --- websites/staging/deltaspike/trunk/content/documentation/scheduler.html (original) +++ websites/staging/deltaspike/trunk/content/documentation/scheduler.html Mon Dec 15 22:31:42 2014 @@ -134,7 +134,7 @@ body { data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a> <a class="brand logocolor" - href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike</a> + href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike []</a> <div class="nav-collapse"> <ul class="nav"> <li class="active"><a @@ -169,29 +169,64 @@ body { <div id="toc" class="toc"> <ul class="sectlevel1"> -<li><a href="#_intro">Intro</a></li> -<li><a href="#_external_dependencies">External Dependencies</a></li> +<li><a href="#_overview">Overview</a></li> +<li><a href="#_configure_your_projects">Configure Your Projects</a> +<ul class="sectlevel2"> +<li><a href="#_1_declare_scheduler_module_dependencies">1. Declare Scheduler Module Dependencies</a></li> +<li><a href="#_2_declare_external_dependencies">2. Declare External Dependencies</a></li> +</ul> +</li> +<li><a href="#_use_the_module_features">Use the Module Features</a> +<ul class="sectlevel2"> <li><a href="#__scheduled">@Scheduled</a></li> <li><a href="#_manual_scheduler_control">Manual Scheduler Control</a></li> <li><a href="#_custom_scheduler">Custom Scheduler</a></li> </ul> +</li> +</ul> <hr> <div class="sect1"> -<h2 id="_intro">Intro</h2> +<h2 id="_overview">Overview</h2> <div class="sectionbody"> <div class="paragraph"> -<p>This module provides a simple integration with Quartz v2 (per default) -or any other scheduler which supports cron-expressions for job-classes.</p> +<p>The Scheduler module provides simple integration with Quartz v2 (default) or any other scheduler that supports cron-expressions for job-classes.</p> </div> </div> </div> <div class="sect1"> -<h2 id="_external_dependencies">External Dependencies</h2> +<h2 id="_configure_your_projects">Configure Your Projects</h2> <div class="sectionbody"> <div class="paragraph"> -<p>If you would like to use the default-integration with quartz (which is -optional), you have to add quartz 2.x.</p> +<p>The configuration information provided here is for Maven-based projects and it assumes that you have already declared the DeltaSpike version and DeltaSpike Core module for your projects, as detailed in <a href="configure.html">Configure DeltaSpike in Your Projects</a>. For Maven-independent projects, see <a href="configure.html#config-maven-indep">Configure DeltaSpike in Maven-independent Projects</a>.</p> +</div> +<div class="sect2"> +<h3 id="_1_declare_scheduler_module_dependencies">1. Declare Scheduler Module Dependencies</h3> +<div class="paragraph"> +<p>Add the Scheduler module to the list of dependencies in the project <code>pom.xml</code> file using this code snippet:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-scheduler-module-api<span class="tag"></artifactId></span> + <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> + <span class="tag"><scope></span>compile<span class="tag"></scope></span> +<span class="tag"></dependency></span> + +<span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-scheduler-module-impl<span class="tag"></artifactId></span> + <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> + <span class="tag"><scope></span>runtime<span class="tag"></scope></span> +<span class="tag"></dependency></span></code></pre> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_2_declare_external_dependencies">2. Declare External Dependencies</h3> +<div class="paragraph"> +<p>By default, the Scheduler module looks to integrate with Quartz. If this is the scheduler you would like to use, add Quartz 2.x to the list of project dependencies using this code snippet:</p> </div> <div class="listingblock"> <div class="content"> @@ -204,9 +239,12 @@ optional), you have to add quartz 2.x.</ </div> </div> </div> +</div> <div class="sect1"> -<h2 id="__scheduled">@Scheduled</h2> +<h2 id="_use_the_module_features">Use the Module Features</h2> <div class="sectionbody"> +<div class="sect2"> +<h3 id="__scheduled">@Scheduled</h3> <div class="paragraph"> <p>Just annotate your Quartz-Jobs with <code>@Scheduled</code> and they will get picked up and passed to the scheduler automatically (during the @@ -237,10 +275,11 @@ DeltaSpike) is required. That can be con container-control module as well as <code>{}</code> for 'no scopes').</p> </div> <div class="paragraph"> -<p>With 'false' for <code>@Scheduled#onStartup</code> it’s even possible to -schedule/install jobs dynamically - e.g.:</p> +<p>With 'false' for <code>@Scheduled#onStartup</code>, it is even possible to +schedule/install jobs dynamically.</p> </div> <div class="listingblock"> +<div class="title">Example</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span> <span class="directive">public</span> <span class="type">class</span> <span class="class">ProjectStageAwareSchedulerController</span> @@ -276,16 +315,14 @@ schedule/install jobs dynamically - e.g. </div> </div> </div> -</div> -<div class="sect1"> -<h2 id="_manual_scheduler_control">Manual Scheduler Control</h2> -<div class="sectionbody"> +<div class="sect2"> +<h3 id="_manual_scheduler_control">Manual Scheduler Control</h3> <div class="paragraph"> -<p>This SPI allows to control the scheduler (or integrate any other +<p>Th SPI allows to control the scheduler (or integrate any other compatible scheduler as an alternative to Quartz2)</p> </div> <div class="paragraph"> -<p>Via std. injection like</p> +<p>Via standard injection like</p> </div> <div class="listingblock"> <div class="content"> @@ -294,15 +331,12 @@ compatible scheduler as an alternative t </div> </div> <div class="paragraph"> -<p>it’s possible to manually start/stop the scheduler, +<p>it is possible to manually start/stop the scheduler, pause/resume/interrupt/check scheduled jobs, register jobs manually or start a job once (without registering it permanently).</p> </div> <div class="paragraph"> -<p><strong>Attention</strong>:</p> -</div> -<div class="paragraph"> -<p>With some versions of Weld you have to use</p> +<p><strong>Attention</strong>: To use a typed injection-point and avoid deployment failure with some versions of Weld, you must use</p> </div> <div class="listingblock"> <div class="content"> @@ -327,19 +361,13 @@ start a job once (without registering it <span class="tag"></alternatives></span></code></pre> </div> </div> -<div class="paragraph"> -<p>to use a typed injection-point. Otherwise the deployment will fail.</p> -</div> -</div> </div> -<div class="sect1"> -<h2 id="_custom_scheduler">Custom Scheduler</h2> -<div class="sectionbody"> +<div class="sect2"> +<h3 id="_custom_scheduler">Custom Scheduler</h3> <div class="paragraph"> -<p>It’s possible to replace the default integration with Quartz. Any other -scheduler which supports cron-expressions for job-classes can be used. -Please have a look at <code>org.apache.deltaspike.test.scheduler.custom</code> for -further details.</p> +<p>It is possible to replace the default integration with Quartz. Any scheduler that supports cron-expressions for job-classes can be used. +For more information, see <a href="http://org.apache.deltaspike.test.scheduler.custom"; class="bare">http://org.apache.deltaspike.test.scheduler.custom</a>.</p> +</div> </div> </div> </div> Modified: websites/staging/deltaspike/trunk/content/documentation/security.html ============================================================================== --- websites/staging/deltaspike/trunk/content/documentation/security.html (original) +++ websites/staging/deltaspike/trunk/content/documentation/security.html Mon Dec 15 22:31:42 2014 @@ -6,7 +6,7 @@ <meta name="description" content="deltaspike-generate-pages"> <meta name="author" content="chm"> -<title>DeltaSpike Security Module</title> +<title>Security Module</title> <!-- 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. --> @@ -134,7 +134,7 @@ body { data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a> <a class="brand logocolor" - href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike</a> + href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike []</a> <div class="nav-collapse"> <ul class="nav"> <li class="active"><a @@ -164,43 +164,90 @@ body { <div class="row"> <div class="span12"> <div class="page-title"> - <h1>DeltaSpike Security Module</h1> + <h1>Security Module</h1> </div> <div id="toc" class="toc"> <ul class="sectlevel1"> -<li><a href="#_hint">Hint</a></li> -<li><a href="#_securitybinding_for_class_and_method_invocations">SecurityBinding for class and method invocations</a></li> -<li><a href="#_integrating_3rd_party_security_frameworks">Integrating 3rd party security frameworks</a> +<li><a href="#_overview">Overview</a></li> +<li><a href="#_configure_your_projects">Configure Your Projects</a> <ul class="sectlevel2"> +<li><a href="#_1_declare_security_module_dependencies">1. Declare Security Module Dependencies</a></li> +<li><a href="#_2_enable_the_security_interceptor">2. Enable the Security Interceptor</a></li> +</ul> +</li> +<li><a href="#_use_the_module_features">Use the Module Features</a> +<ul class="sectlevel2"> +<li><a href="#_securitybinding_for_class_and_method_invocations">SecurityBinding for Class and Method Invocations</a></li> +<li><a href="#_integrating_third_party_security_frameworks">Integrating Third-party Security Frameworks</a> +<ul class="sectlevel3"> <li><a href="#__secured">@Secured</a></li> <li><a href="#_accessdecisionvoter">AccessDecisionVoter</a></li> <li><a href="#_securityviolation">SecurityViolation</a></li> -<li><a href="#_abstractaccessdecisionvoter">AbstractAccessDecisionVoter</a></li> -<li><a href="#__secured_and_stereotypes_with_custom_meta_data">@Secured and Stereotypes with custom Meta-data</a></li> </ul> </li> -<li><a href="#_making_intitially_requested_and_secured_page_available_for_redirect_after_login">Making intitially requested and secured page available for redirect after login</a> -<ul class="sectlevel2"> -<li><a href="#_cdi_implementation_to_redirect_the_login_to_the_first_denied_page">CDI Implementation to redirect the login to the first denied page</a></li> -<li><a href="#_picketlink_implementation_to_redirect_the_login_to_the_first_denied_page">PicketLink Implementation to redirect the login to the first denied page</a></li> +<li><a href="#_abstractaccessdecisionvoter">AbstractAccessDecisionVoter</a> +<ul class="sectlevel3"> +<li><a href="#__secured_and_stereotypes_with_custom_meta_data">@Secured and Stereotypes with Custom Meta-data</a></li> +</ul> +</li> +<li><a href="#_making_intitially_requested_and_secured_page_available_for_redirect_after_login">Making Intitially Requested and Secured Page available for Redirect after Login</a> +<ul class="sectlevel3"> +<li><a href="#_cdi_implementation_to_redirect_the_login_to_the_first_denied_page">CDI Implementation to Redirect the Login to the First Denied Page</a></li> +<li><a href="#_picketlink_implementation_to_redirect_the_login_to_the_first_denied_page">PicketLink Implementation to Redirect the Login to the First Denied Page</a></li> </ul> </li> <li><a href="#_accessdecisionvotercontext">AccessDecisionVoterContext</a> -<ul class="sectlevel2"> +<ul class="sectlevel3"> <li><a href="#_securitystrategy_spi">SecurityStrategy SPI</a></li> </ul> </li> </ul> +</li> +</ul> <hr> <div class="sect1"> -<h2 id="_hint">Hint</h2> +<h2 id="_overview">Overview</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The Security module provides intercept and security checking on method calls. This module also enables integration of third-party security frameworks and custom security concepts.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_configure_your_projects">Configure Your Projects</h2> <div class="sectionbody"> <div class="paragraph"> -<p><strong>Hint:</strong> If you are using features described by this page with CDI 1.0 -(or DeltaSpike up to v1.1.0 with CDI 1.1+), you have -to enable the security interceptor in your beans.xml file:</p> +<p>The configuration information provided here is for Maven-based projects and it assumes that you have already declared the DeltaSpike version and DeltaSpike Core module for your projects, as detailed in <a href="configure.html">Configure DeltaSpike in Your Projects</a>. For Maven-independent projects, see <a href="configure.html#config-maven-indep">Configure DeltaSpike in Maven-independent Projects</a>.</p> +</div> +<div class="sect2"> +<h3 id="_1_declare_security_module_dependencies">1. Declare Security Module Dependencies</h3> +<div class="paragraph"> +<p>Add the Security module to the list of dependencies in the project <code>pom.xml</code> file using this code snippet:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-security-module-api<span class="tag"></artifactId></span> + <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> + <span class="tag"><scope></span>compile<span class="tag"></scope></span> +<span class="tag"></dependency></span> + +<span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-security-module-impl<span class="tag"></artifactId></span> + <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> + <span class="tag"><scope></span>runtime<span class="tag"></scope></span> +<span class="tag"></dependency></span></code></pre> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_2_enable_the_security_interceptor">2. Enable the Security Interceptor</h3> +<div class="paragraph"> +<p>For CDI 1.0 (or DeltaSpike v1.1.0 and earlier together with CDI 1.1+), you must enable the security interceptor in the project <code>beans.xml</code> file:</p> </div> <div class="listingblock"> <div class="content"> @@ -214,25 +261,24 @@ to enable the security interceptor in yo </div> </div> </div> +</div> <div class="sect1"> -<h2 id="_securitybinding_for_class_and_method_invocations">SecurityBinding for class and method invocations</h2> +<h2 id="_use_the_module_features">Use the Module Features</h2> <div class="sectionbody"> +<div class="sect2"> +<h3 id="_securitybinding_for_class_and_method_invocations">SecurityBinding for Class and Method Invocations</h3> <div class="paragraph"> -<p>This feature of the security module functions by intercepting method -calls, and performing a security check before invocation is allowed to -proceed.</p> +<p>This feature of the Security module intercepts method calls and performs a security check before invocation is allowed to proceed.</p> </div> <div class="paragraph"> <p>In order to use the DeltaSpike security module, you must first have -installed the proper dependencies into your POM file. Once this is +installed the proper dependencies into the <code>pom.xml</code> file. Once this is complete, you may proceed to create a security parameter binding annotation. This is what we will use to add security behavior to our business classes and methods.</p> </div> -<div class="paragraph"> -<p>Create the SecurityBinding:</p> -</div> <div class="listingblock"> +<div class="title">Create the SecurityBinding</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Retention</span>(value = RUNTIME) <span class="annotation">@Target</span>({TYPE, METHOD}) @@ -254,10 +300,8 @@ if we need to access parameter arguments context. Note that we may also inject other beans into the parameter list of our @Secures method.</p> </div> -<div class="paragraph"> -<p>Create the Authorizer:</p> -</div> <div class="listingblock"> +<div class="title">Create the Authorizer</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span> <span class="directive">public</span> <span class="type">class</span> <span class="class">CustomAuthorizer</span> @@ -276,10 +320,8 @@ list of our @Secures method.</p> This binding annotation may be placed on the entire class (securing all methods,) or on individual methods that you wish to secure.</p> </div> -<div class="paragraph"> -<p>Secure a bean method:</p> -</div> <div class="listingblock"> +<div class="title">Secure a Bean Method</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span> <span class="directive">public</span> <span class="type">class</span> <span class="class">SecuredBean1</span> @@ -297,10 +339,8 @@ methods,) or on individual methods that in our authorizer bean by creating custom @SecurityParameterBinding types; this is a simple step once we have completed the work above:</p> </div> -<div class="paragraph"> -<p>Create a parameter binding annotation:</p> -</div> <div class="listingblock"> +<div class="title">Create a Parameter Binding Annotation</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Retention</span>(value = RUNTIME) <span class="annotation">@Target</span>({PARAMETER}) @@ -315,10 +355,8 @@ types; this is a simple step once we hav values as arguments into our authorizer method, providing domain-level security in our applications:</p> </div> -<div class="paragraph"> -<p>Update the Authorizer to use parameter binding:</p> -</div> <div class="listingblock"> +<div class="title">Update the Authorizer to use Parameter Binding</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span> <span class="directive">public</span> <span class="type">class</span> <span class="class">CustomAuthorizer</span> @@ -335,10 +373,8 @@ security in our applications:</p> <div class="paragraph"> <p>Note that our business method must also be annotated.</p> </div> -<div class="paragraph"> -<p>Complete the parameter binding:</p> -</div> <div class="listingblock"> +<div class="title">Complete the Parameter Binding</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span> <span class="directive">public</span> <span class="type">class</span> <span class="class">SecuredBean1</span> @@ -396,10 +432,8 @@ to use a secured return value:</p> <p>Now the authorization will take place after the method invocation using the return value of the business method.</p> </div> -<div class="paragraph"> -<p>Complete the parameter binding:</p> -</div> <div class="listingblock"> +<div class="title">Complete the Parameter Binding</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span> <span class="directive">public</span> <span class="type">class</span> <span class="class">SecuredBean1</span> @@ -417,17 +451,15 @@ the return value of the business method. as part of our security authorizer!</p> </div> </div> -</div> -<div class="sect1"> -<h2 id="_integrating_3rd_party_security_frameworks">Integrating 3rd party security frameworks</h2> -<div class="sectionbody"> <div class="sect2"> -<h3 id="__secured">@Secured</h3> +<h3 id="_integrating_third_party_security_frameworks">Integrating Third-party Security Frameworks</h3> +<div class="sect3"> +<h4 id="__secured">@Secured</h4> <div class="paragraph"> <p><code>@Secured</code> is build on <code>@SecurityBindingType</code> and a very simple -alternative to the rest of the security module. It’s a basic hook to -integrate a custom security concept, 3rd party frameworks,…​ . It -doesn’t provide a full blown security concept like the rest of the +alternative to the rest of the security module. It is a basic hook to +integrate a custom security concept, third-party frameworks, etc. It +doesis not provide a full blown security concept like the rest of the security module, but other DeltaSpike modules ensure that the security concepts are integrated properly (e.g. correct behaviour within custom scope implementations,…​). It just allows to integrate other security @@ -440,10 +472,8 @@ a bit, because between the interceptor a approach. Therefore the basic behaviour remains the same and you can think about it like an interceptor.)</p> </div> -<div class="paragraph"> -<p>Securing all intercepted methods of a CDI bean:</p> -</div> <div class="listingblock"> +<div class="title">Securing All Intercepted Methods of a CDI Bean</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="comment">//...</span> <span class="annotation">@Secured</span>(CustomAccessDecisionVoter.class) @@ -453,13 +483,8 @@ think about it like an interceptor.)</p> }</code></pre> </div> </div> -<div class="paragraph"> -<p>or</p> -</div> -<div class="paragraph"> -<p>Securing specific methods:</p> -</div> <div class="listingblock"> +<div class="title">Securing Specific Methods</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="comment">//...</span> <span class="directive">public</span> <span class="type">class</span> <span class="class">SecuredBean</span> @@ -473,8 +498,8 @@ think about it like an interceptor.)</p> </div> </div> </div> -<div class="sect2"> -<h3 id="_accessdecisionvoter">AccessDecisionVoter</h3> +<div class="sect3"> +<h4 id="_accessdecisionvoter">AccessDecisionVoter</h4> <div class="paragraph"> <p>This interface is (besides the <code>Secured</code> annotation) the most important part of the concept. Both artifact types are also the only required @@ -495,16 +520,17 @@ parts:</p> </div> </div> <div class="paragraph"> -<p>[TODO] hint about the changed parameter/s</p> +<p>[TODO] tip about the changed parameter/s</p> </div> </div> -<div class="sect2"> -<h3 id="_securityviolation">SecurityViolation</h3> +<div class="sect3"> +<h4 id="_securityviolation">SecurityViolation</h4> <div class="paragraph"> <p>In case of a detected violation a <code>SecurityViolation</code> has to be added to the result returned by the <code>AccessDecisionVoter</code>.</p> </div> </div> +</div> <div class="sect2"> <h3 id="_abstractaccessdecisionvoter">AbstractAccessDecisionVoter</h3> <div class="paragraph"> @@ -526,19 +552,16 @@ This is a convenience class which allows }</code></pre> </div> </div> -</div> -<div class="sect2"> -<h3 id="__secured_and_stereotypes_with_custom_meta_data">@Secured and Stereotypes with custom Meta-data</h3> +<div class="sect3"> +<h4 id="__secured_and_stereotypes_with_custom_meta_data">@Secured and Stereotypes with Custom Meta-data</h4> <div class="paragraph"> <p>If there are multiple <code>AccessDecisionVoter</code> and maybe in different -constellations, it’s easier to provide an expressive CDI stereotypes for +constellations, it is easier to provide an expressive CDI stereotypes for it. Later on that also allows to change the behaviour in a central place.</p> </div> -<div class="paragraph"> -<p>Stereotype support of @Secured:</p> -</div> <div class="listingblock"> +<div class="title">Stereotype Support of @Secured</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Named</span> <span class="annotation">@Admin</span> @@ -556,12 +579,10 @@ place.</p> </div> </div> <div class="paragraph"> -<p>Furthermore, it’s possible to provide custom meta-data easily.</p> -</div> -<div class="paragraph"> -<p>Stereotype of @Secured with custom meta-data:</p> +<p>Furthermore, it is possible to provide custom meta-data easily.</p> </div> <div class="listingblock"> +<div class="title">Stereotype of @Secured with Custom Meta-data</div> <div class="content"> <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Named</span> <span class="annotation">@Admin</span>(securityLevel=<span class="integer">3</span>) @@ -594,17 +615,15 @@ place.</p> </div> </div> </div> -</div> -<div class="sect1"> -<h2 id="_making_intitially_requested_and_secured_page_available_for_redirect_after_login">Making intitially requested and secured page available for redirect after login</h2> -<div class="sectionbody"> +<div class="sect2"> +<h3 id="_making_intitially_requested_and_secured_page_available_for_redirect_after_login">Making Intitially Requested and Secured Page available for Redirect after Login</h3> <div class="paragraph"> <p>DeltaSpike can be combined with pure CDI or with any other security frameworks (like PicketLink) to track the denied page and make it available after user logs in.</p> </div> -<div class="sect2"> -<h3 id="_cdi_implementation_to_redirect_the_login_to_the_first_denied_page">CDI Implementation to redirect the login to the first denied page</h3> +<div class="sect3"> +<h4 id="_cdi_implementation_to_redirect_the_login_to_the_first_denied_page">CDI Implementation to Redirect the Login to the First Denied Page</h4> <div class="paragraph"> <p>Your LoginService will fire a custom <code>UserLoggedInEvent</code></p> </div> @@ -678,8 +697,8 @@ store the denied page on your own.</p> </div> </div> </div> -<div class="sect2"> -<h3 id="_picketlink_implementation_to_redirect_the_login_to_the_first_denied_page">PicketLink Implementation to redirect the login to the first denied page</h3> +<div class="sect3"> +<h4 id="_picketlink_implementation_to_redirect_the_login_to_the_first_denied_page">PicketLink Implementation to Redirect the Login to the First Denied Page</h4> <div class="paragraph"> <p>Once that PicketLink handles the authentication for you, you only need to store the denied page and observe PicketLink <code>LoggedInEvent</code> to @@ -745,10 +764,8 @@ store the denied page on your own.</p> </div> </div> </div> -</div> -<div class="sect1"> -<h2 id="_accessdecisionvotercontext">AccessDecisionVoterContext</h2> -<div class="sectionbody"> +<div class="sect2"> +<h3 id="_accessdecisionvotercontext">AccessDecisionVoterContext</h3> <div class="paragraph"> <p>Because the <code>AccessDecisionVoter</code> can be chained, <code>AccessDecisionVoterContext</code> allows to get the current state as well as @@ -766,18 +783,18 @@ the results of the security check.</p> <p><code>getViolations()</code> - Exposes the found violations</p> </li> <li> -<p><code>getSource()</code> - Exposes e.g. the current instance of <code>javax.interceptor.InvocationContext</code> in combination with <code>@Secured</code> used as interceptor.</p> +<p><code>getSource()</code> - Exposes, for example, the current instance of <code>javax.interceptor.InvocationContext</code> in combination with <code>@Secured</code> used as interceptor.</p> </li> <li> -<p><code>getMetaData()</code> - Exposes the found meta-data e.g. the view-config-class if <code>@Secured</code> is used in combination with type-safe view-configs</p> +<p><code>getMetaData()</code> - Exposes the found meta-data, for example the view-config-class if <code>@Secured</code> is used in combination with type-safe view-configs</p> </li> <li> <p><code>getMetaDataFor(String, Class<T>)</code> - Exposes meta-data for the given key</p> </li> </ul> </div> -<div class="sect2"> -<h3 id="_securitystrategy_spi">SecurityStrategy SPI</h3> +<div class="sect3"> +<h4 id="_securitystrategy_spi">SecurityStrategy SPI</h4> <div class="paragraph"> <p>The <code>SecurityStrategy</code> interface allows to provide a custom implementation which should be used for <code>@Secured</code>. Provide a custom @@ -785,15 +802,28 @@ implementation as bean-class in combinat <code>@Specializes</code> (or as global-alternative).</p> </div> <div class="paragraph"> -<p>In case of global-alternatives an additional config needs to be added to -<code>/META-INF/apache-deltaspike.properties</code> - e.g.:</p> +<p>In case of global-alternatives an additional configuration needs to be added to +<code>/META-INF/apache-deltaspike.properties</code>.</p> </div> -<div class="paragraph"> -<p><code>globalAlternatives.org.apache.deltaspike.security.spi.authorization.SecurityStrategy=mypackage.CustomSecurityStrategy</code></p> +<div class="listingblock"> +<div class="title">Example</div> +<div class="content"> +<pre>globalAlternatives.org.apache.deltaspike.security.spi.authorization.SecurityStrategy=mypackage.CustomSecurityStrategy</pre> +</div> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<div class="title">Tip</div> +</td> +<td class="content"> +The configuration for global-alternatives is following the pattern: +globalAlternatives.<code><interface-name></code>=<code><implementation-class-name></code> +</td> +</tr> +</table> </div> -<div class="paragraph"> -<p><strong>Note</strong>: The config for global-alternatives is following the pattern: -globalAlternatives.<code><interface-name></code>=<code><implementation-class-name></code></p> </div> </div> </div> Modified: websites/staging/deltaspike/trunk/content/documentation/servlet.html ============================================================================== --- websites/staging/deltaspike/trunk/content/documentation/servlet.html (original) +++ websites/staging/deltaspike/trunk/content/documentation/servlet.html Mon Dec 15 22:31:42 2014 @@ -134,7 +134,7 @@ body { data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a> <a class="brand logocolor" - href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike</a> + href="http://deltaspike.apache.org/index.html";>Apache DeltaSpike []</a> <div class="nav-collapse"> <ul class="nav"> <li class="active"><a @@ -169,9 +169,17 @@ body { <div id="toc" class="toc"> <ul class="sectlevel1"> -<li><a href="#_configuration">Configuration</a></li> -<li><a href="#_injectable_servlet_objects">Injectable Servlet objects</a> +<li><a href="#_overview">Overview</a></li> +<li><a href="#_configure_your_projects">Configure Your Projects</a> <ul class="sectlevel2"> +<li><a href="#_1_declare_servlet_module_dependencies">1. Declare Servlet Module Dependencies</a></li> +</ul> +</li> +<li><a href="#_2_configure_listeners_and_filters">2. Configure Listeners and Filters</a></li> +<li><a href="#_use_the_module_features">Use the Module Features</a> +<ul class="sectlevel2"> +<li><a href="#_injectable_servlet_objects">Injectable Servlet Objects</a> +<ul class="sectlevel3"> <li><a href="#_servletcontext">ServletContext</a></li> <li><a href="#_servletrequest_httpservletrequest">ServletRequest / HttpServletRequest</a></li> <li><a href="#_servletresponse_httpservletresponse">ServletResponse / HttpServletResponse</a></li> @@ -179,18 +187,59 @@ body { <li><a href="#_principal">Principal</a></li> </ul> </li> -<li><a href="#_servlet_event_propagation">Servlet event propagation</a> -<ul class="sectlevel2"> -<li><a href="#_servlet_context_lifecycle_events">Servlet context lifecycle events</a></li> -<li><a href="#_request_and_response_lifecycle_events">Request and response lifecycle events</a></li> -<li><a href="#_session_lifecycle_events">Session lifecycle events</a></li> +<li><a href="#_servlet_event_propagation">Servlet Event Propagation</a> +<ul class="sectlevel3"> +<li><a href="#_servlet_context_lifecycle_events">Servlet Context Lifecycle Events</a></li> +<li><a href="#_request_and_response_lifecycle_events">Request and Response Lifecycle Events</a></li> +<li><a href="#_session_lifecycle_events">Session Lifecycle Events</a></li> +</ul> +</li> </ul> </li> </ul> <hr> <div class="sect1"> -<h2 id="_configuration">Configuration</h2> +<h2 id="_overview">Overview</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The Servlet module provides CDI integration with the Java Servlet API. It enables injection of common servlet objects and propagation of servlet events to the CDI event bus.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_configure_your_projects">Configure Your Projects</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The configuration information provided here is for Maven-based projects and it assumes that you have already declared the DeltaSpike version and DeltaSpike Core module for your projects, as detailed in <a href="configure.html">Configure DeltaSpike in Your Projects</a>. For Maven-independent projects, see <a href="configure.html#config-maven-indep">Configure DeltaSpike in Maven-independent Projects</a>.</p> +</div> +<div class="sect2"> +<h3 id="_1_declare_servlet_module_dependencies">1. Declare Servlet Module Dependencies</h3> +<div class="paragraph"> +<p>Add the Servlet module to the list of dependencies in the project <code>pom.xml</code> file using this code snippet:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-servlet-module-api<span class="tag"></artifactId></span> + <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> + <span class="tag"><scope></span>compile<span class="tag"></scope></span> +<span class="tag"></dependency></span> + +<span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-servlet-module-impl<span class="tag"></artifactId></span> + <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> + <span class="tag"><scope></span>runtime<span class="tag"></scope></span> +<span class="tag"></dependency></span></code></pre> +</div> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_2_configure_listeners_and_filters">2. Configure Listeners and Filters</h2> <div class="sectionbody"> <div class="paragraph"> <p>In most cases there is no need for any additional configuration beside @@ -204,7 +253,7 @@ register the listeners and filters in yo <div class="ulist"> <ul> <li> -<p>Your container doesn’t support Servlet 3.0 or newer.</p> +<p>Your container doesis not support Servlet 3.0 or newer.</p> </li> <li> <p>You have set <code>metadata-complete=true</code> in your <code>web.xml</code>.</p> @@ -215,8 +264,7 @@ register the listeners and filters in yo </ul> </div> <div class="paragraph"> -<p>In these cases you will have to add the following section manually to -your <code>web.xml</code>:</p> +<p>In these cases you will have to add the following section manually to the project <code>web.xml</code>:</p> </div> <div class="listingblock"> <div class="content"> @@ -264,8 +312,10 @@ your <code>web.xml</code>:</p> </div> </div> <div class="sect1"> -<h2 id="_injectable_servlet_objects">Injectable Servlet objects</h2> +<h2 id="_use_the_module_features">Use the Module Features</h2> <div class="sectionbody"> +<div class="sect2"> +<h3 id="_injectable_servlet_objects">Injectable Servlet Objects</h3> <div class="paragraph"> <p>The DeltaSpike Servlet module contains producers for many objects of a Servlet environment. All produces are using the special qualifier @@ -281,8 +331,8 @@ injection of some Servlet objects out of <span class="directive">private</span> ServletObject servletObject;</code></pre> </div> </div> -<div class="sect2"> -<h3 id="_servletcontext">ServletContext</h3> +<div class="sect3"> +<h4 id="_servletcontext">ServletContext</h4> <div class="paragraph"> <p>The <code>ServletContext</code> is made available in the application scope. It can be injected into any CDI bean like this:</p> @@ -294,8 +344,8 @@ be injected into any CDI bean like this: </div> </div> </div> -<div class="sect2"> -<h3 id="_servletrequest_httpservletrequest">ServletRequest / HttpServletRequest</h3> +<div class="sect3"> +<h4 id="_servletrequest_httpservletrequest">ServletRequest / HttpServletRequest</h4> <div class="paragraph"> <p>The <code>ServletRequest</code> is made available in the request scope. The current request can be injected into a CDI bean like this:</p> @@ -316,8 +366,8 @@ request can be injected into a CDI bean </div> </div> </div> -<div class="sect2"> -<h3 id="_servletresponse_httpservletresponse">ServletResponse / HttpServletResponse</h3> +<div class="sect3"> +<h4 id="_servletresponse_httpservletresponse">ServletResponse / HttpServletResponse</h4> <div class="paragraph"> <p>The <code>ServletResponse</code> is made available in the request scope. The current response can be injected into a CDI bean like this:</p> @@ -338,8 +388,8 @@ current response can be injected into a </div> </div> </div> -<div class="sect2"> -<h3 id="_httpsession">HttpSession</h3> +<div class="sect3"> +<h4 id="_httpsession">HttpSession</h4> <div class="paragraph"> <p>The <code>HttpSession</code> is made available in the session scope. You can inject the current session of a user into a CDI bean like this:</p> @@ -355,8 +405,8 @@ the current session of a user into a CDI of a session.</p> </div> </div> -<div class="sect2"> -<h3 id="_principal">Principal</h3> +<div class="sect3"> +<h4 id="_principal">Principal</h4> <div class="paragraph"> <p>The <code>Principal</code> is made available in the request scope. The current principal can be injected into a CDI bean like this:</p> @@ -373,12 +423,10 @@ principal can be injected into a CDI bea </div> </div> </div> -</div> -<div class="sect1"> -<h2 id="_servlet_event_propagation">Servlet event propagation</h2> -<div class="sectionbody"> +<div class="sect2"> +<h3 id="_servlet_event_propagation">Servlet Event Propagation</h3> <div class="paragraph"> -<p>The DeltaSpike Servlet module will propagate a number of Servlet object +<p>The DeltaSpike Servlet module propagates a number of Servlet object lifecycle events to the CDI event bus. This allows regular CDI beans to observe these events and react accordingly.</p> </div> @@ -388,11 +436,11 @@ To distinguish between construction and object, DeltaSpike uses the qualifiers <code>@Initialized</code> and <code>@Destroyed</code>.</p> </div> <div class="paragraph"> -<p>The following sections will show which concrete Servlet objects are +<p>The following sections shows which concrete Servlet objects are supported and how their lifecycle can be observed.</p> </div> -<div class="sect2"> -<h3 id="_servlet_context_lifecycle_events">Servlet context lifecycle events</h3> +<div class="sect3"> +<h4 id="_servlet_context_lifecycle_events">Servlet Context Lifecycle Events</h4> <div class="paragraph"> <p>The Servlet module supports initialization and destruction events for the <code>ServletContext</code>. These events can for example be used to detect @@ -417,7 +465,7 @@ events can be observed:</p> </div> <div class="listingblock"> <div class="content"> -<pre>org.apache.deltaspike.servlet.impl.event.EventBridgeContextListener</pre> +<pre class="CodeRay highlight"><code data-lang="java">org.apache.deltaspike.servlet.impl.event.EventBridgeContextListener</code></pre> </div> </div> <div class="paragraph"> @@ -426,8 +474,8 @@ also simply remove the entry for the <co your <code>web.xml</code> to disable the events.</p> </div> </div> -<div class="sect2"> -<h3 id="_request_and_response_lifecycle_events">Request and response lifecycle events</h3> +<div class="sect3"> +<h4 id="_request_and_response_lifecycle_events">Request and Response Lifecycle Events</h4> <div class="paragraph"> <p>The Servlet module also supports initialization and destruction events for the <code>HttpServletRequest</code> and <code>HttpServletResponse</code>. These events can @@ -471,7 +519,7 @@ class:</p> </div> <div class="listingblock"> <div class="content"> -<pre>org.apache.deltaspike.servlet.impl.event.EventBridgeFilter</pre> +<pre class="CodeRay highlight"><code data-lang="java">org.apache.deltaspike.servlet.impl.event.EventBridgeFilter</code></pre> </div> </div> <div class="paragraph"> @@ -480,8 +528,8 @@ also simply remove the entry for the <co <code>web.xml</code> to disable the events.</p> </div> </div> -<div class="sect2"> -<h3 id="_session_lifecycle_events">Session lifecycle events</h3> +<div class="sect3"> +<h4 id="_session_lifecycle_events">Session Lifecycle Events</h4> <div class="paragraph"> <p>The last category of events supported by the DeltaSpike Servlet module are the lifecycle events for the user’s HTTP session. The following @@ -505,7 +553,7 @@ this event category, deactivate the foll </div> <div class="listingblock"> <div class="content"> -<pre>org.apache.deltaspike.servlet.impl.event.EventBridgeSessionListener</pre> +<pre class="CodeRay highlight"><code data-lang="java">org.apache.deltaspike.servlet.impl.event.EventBridgeSessionListener</code></pre> </div> </div> <div class="paragraph"> @@ -515,6 +563,7 @@ your <code>web.xml</code> to disable the </div> </div> </div> +</div> </div> </div>
