Modified: deltaspike/site/trunk/content/documentation/configure.html URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/configure.html?rev=1756698&r1=1756697&r2=1756698&view=diff ============================================================================== --- deltaspike/site/trunk/content/documentation/configure.html (original) +++ deltaspike/site/trunk/content/documentation/configure.html Thu Aug 18 00:36:56 2016 @@ -1,546 +1,546 @@ -<!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"> - <!-- No caching headers --> - <meta http-equiv="cache-control" content="no-cache"/> - <meta http-equiv="pragma" content="no-cache"/> - <meta http-equiv="expires" content="-1"/> - - <title>Configure DeltaSpike in Your Projects</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"> - <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/3.1.0/css/font-awesome.min.css" rel="stylesheet"> - - - - - <!-- Tocify - nice dynamic autoscrolling TOC --> - <link href="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/stylesheets/jquery.tocify.min.css" rel="stylesheet"> - <script src="https://code.jquery.com/jquery-1.11.3.min.js"></script> - <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.11.4/jquery-ui.min.js"></script> - <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/javascripts/jquery.tocify.min.js"></script> - - - <script type="text/javascript"> - $(function () { - $("#toc").tocify({ - scrollTo: 50, - extendPage: true, - context: "#doc-content", - selectors: "h2,h3,h4,h5" - }); - $(".fallback-toc").hide(); - }); - </script> - - - <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; - } - - .toc-like { - border-radius: 6px; - border: 1px solid #ccc; - } - - .toc-like li { - line-height: 30px; - text-indent: 10px; - } - - .toc-like li.custom-toc-header { - font-weight: bold; - background: #666; - color: white; - cursor: initial !important; - padding: 5px; - } - - .toc-like li.custom-toc-header a { - color: white; - font-style: normal; - text-shadow: none; - padding: 0; - } - - .toc-like li.custom-toc-header:hover a { - background: #666; - } - - .page-title { - text-align: left; - } - - #doc-content h2, - #doc-content h3, - #doc-content h4, - #doc-content h5, - #doc-content h6 { - padding-top: 0; - margin-top: 25px; - margin-bottom: 10px; - line-height: 1.4em; - } - - #doc-content h2 { - border-bottom: 1px solid lightgrey; - } - - - </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="../index.html">Apache DeltaSpike</a> - - <div class="nav-collapse"> - - - <ul class="nav"> - <li><a href="../index.html">Home</a></li> - <li class="active"><a href="../documentation">Documentation</a></li> - <li ><a href="../javadoc.html">Javadoc</a></li> - <li ><a href="../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> - </ul> - </div> - <!--/.nav-collapse --> - <form id="search-form" action="https://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-fluid"> - - - - <div class="span8"> - <div class="page-title"> - <h1>Configure DeltaSpike in Your Projects</h1> - </div> - - <div id="doc-content"> - <div id="preamble"> -<div class="sectionbody"> -<div class="paragraph"> -<p>DeltaSpike is available for use in projects of many build tools. Instructions are given here for obtaining released final versions of DeltaSpike for both approaches.</p> -</div> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<i class="fa icon-note" title="Note"></i> -</td> -<td class="content"> -You can also opt to use the lastest DeltaSpike snapshots; for more information, see <a href="snapshots.html">Use DeltaSpike Snapshots</a>. -</td> -</tr> -</table> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_maven_projects">Maven Projects</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>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 <code>settings.xml</code> file; when building projects, Maven automatically searches the online Maven Central repository for project dependencies and downloads sources to your local Maven repository.</p> -</div> -<div class="paragraph"> -<p>To begin use the DeltaSpike releases from Maven Central, you simply need to configure the project <code>pom.xml</code> 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.</p> -</div> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Open the project <code>pom.xml</code> file for editing</p> -</li> -<li> -<p>Add the DeltaSpike version to the list of properties</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><properties></span> - <span class="tag"><deltaspike.version></span>1.7.1<span class="tag"></deltaspike.version></span> -<span class="tag"></properties></span></code></pre> -</div> -</div> -</li> -<li> -<p>Add the DeltaSpike Core module to the list of dependencies</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependencyManagement></span> - <span class="tag"><dependencies></span> - <span class="tag"><dependency></span> - <span class="tag"><groupId></span>org.apache.deltaspike.distribution<span class="tag"></groupId></span> - <span class="tag"><artifactId></span>distributions-bom<span class="tag"></artifactId></span> - <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> - <span class="tag"><type></span>pom<span class="tag"></type></span> - <span class="tag"><scope></span>import<span class="tag"></scope></span> - <span class="tag"></dependency></span> - <span class="tag"></dependencies></span> -<span class="tag"></dependencyManagement></span> - -<span class="tag"><dependency></span> - <span class="tag"><groupId></span>org.apache.deltaspike.core<span class="tag"></groupId></span> - <span class="tag"><artifactId></span>deltaspike-core-api<span class="tag"></artifactId></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.core<span class="tag"></groupId></span> - <span class="tag"><artifactId></span>deltaspike-core-impl<span class="tag"></artifactId></span> - <span class="tag"><scope></span>runtime<span class="tag"></scope></span> -<span class="tag"></dependency></span></code></pre> -</div> -</div> -</li> -<li> -<p>Save the <code>pom.xml</code> file changes</p> -</li> -</ol> -</div> -<div class="admonitionblock tip"> -<table> -<tr> -<td class="icon"> -<i class="fa icon-tip" title="Tip"></i> -</td> -<td class="content"> -The API is scoped for compile time and implementation only included for runtime, assisting to prevent you from inadvertently depending on an implementation class. -</td> -</tr> -</table> -</div> -<div class="paragraph"> -<p>For instructions on adding the optional DeltaSpike modules, see the relevant module page:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p><a href="bean-validation.html">Bean Validation</a></p> -</li> -<li> -<p><a href="container-control.html">Container Control</a></p> -</li> -<li> -<p><a href="data.html">Data</a></p> -</li> -<li> -<p><a href="jpa.html">JPA</a></p> -</li> -<li> -<p><a href="jsf.html">JSF</a></p> -</li> -<li> -<p><a href="partial-bean.html">Partial-Bean</a></p> -</li> -<li> -<p><a href="scheduler.html">Scheduler</a></p> -</li> -<li> -<p><a href="security.html">Security</a></p> -</li> -<li> -<p><a href="servlet.html">Servlet</a></p> -</li> -<li> -<p><a href="test-control.html">Test-Control</a></p> -</li> -</ul> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="config-gradle">Gradle Projects</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Setting up DeltaSpike in a Gradle based project is just as easy as Maven.</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code>// setup the Spring Dependency Management Plugin for Gradle, to import BOMs. -plugins { - id "io.spring.dependency-management" version "0.5.6.RELEASE" - id "java" // you'll likely also want the WAR plugin -} -repositories { - mavenCentral() -} -dependencyManagement { - imports { - mavenBom 'org.apache.deltaspike.distribution:distributions-bom:1.7.1' - } -} -dependencies { - compile 'org.apache.deltaspike.core:deltaspike-core-api' - runtime 'org.apache.deltaspike.core:deltaspike-core-impl' -} -sourceSets { - main { - //To use standard bean discovery mechanisms, CDI expects beans.xml to be in your classes directory - output.resourcesDir = output.classesDir - } - test { - output.resourcesDir = output.classesDir - } // and any other sourceSet you might have. - }</code></pre> -</div> -</div> -<div class="paragraph"> -<p>This will give you a Gradle build setup to run DeltaSpike.</p> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="config-maven-indep">Other Projects</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>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 <a href="build.html">Build DeltaSpike from Source</a>. In both cases, you must add the DeltaSpike .jar files directly to your projects.</p> -</div> -<div class="paragraph"> -<p>To use DeltaSpike without Maven from the downloadable .jar files, complete the following steps:</p> -</div> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Download the latest <code>distribution-full-<version>.zip</code> from <a href="https://deltaspike.apache.org/download.html" class="bare">https://deltaspike.apache.org/download.html</a></p> -</li> -<li> -<p>Extract the archive contents</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="shell">$ unzip distribution-full-<version>.zip</code></pre> -</div> -</div> -</li> -<li> -<p>Add the source to your project</p> -<div class="olist loweralpha"> -<ol class="loweralpha" type="a"> -<li> -<p>For .war projects, copy the .jar files to the <code>WEB-INF/lib</code> directory</p> -</li> -<li> -<p>For .ear projects, copy the .jar files to the <code>EAR/lib directory</code> and add the following to <code>META-INF/application.xml</code>:</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><library-directory></span>lib<span class="tag"></library-directory></span></code></pre> -</div> -</div> -</li> -</ol> -</div> -</li> -</ol> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_next">Next</h2> -<div class="sectionbody"> -<div class="ulist"> -<ul> -<li> -<p>To check whether your Java environment needs any additional CDI-specific configuration, see <a href="cdiimp.html">Enable CDI For Your Java Environment</a>.</p> -</li> -<li> -<p>To see ready-to-deploy example DeltaSpike applications, see <a href="http://deltaspike.apache.org/examples.html">See DeltaSpike in Action</a>.</p> -</li> -<li> -<p>To understand how the various DeltaSpike modules can enhance and extend your applications, see <a href="modules.html">Overview of DeltaSpike Modules</a> and the individual module pages.</p> -</li> -</ul> -</div> -</div> -</div> - </div> - </div> - - - <div class="span4"> - <div id="toc"> - <div class="moduledeps"> - <ul class="toc-like nav nav-list"> - - - - </ul> - </div> - </div> - - <div class="fallback-toc"> - <ul class="sectlevel1"> -<li><a href="#_maven_projects">Maven Projects</a></li> -<li><a href="#config-gradle">Gradle Projects</a></li> -<li><a href="#config-maven-indep">Other Projects</a></li> -<li><a href="#_next">Next</a></li> -</ul> - </div> - - </div> - - - </div> - <div class="row"> - <hr> - <footer> - <p>Copyright © 2011-2016 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> -</div> - -</body> +<!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"> + <!-- No caching headers --> + <meta http-equiv="cache-control" content="no-cache"/> + <meta http-equiv="pragma" content="no-cache"/> + <meta http-equiv="expires" content="-1"/> + + <title>Configure DeltaSpike in Your Projects</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"> + <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/3.1.0/css/font-awesome.min.css" rel="stylesheet"> + + + + + <!-- Tocify - nice dynamic autoscrolling TOC --> + <link href="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/stylesheets/jquery.tocify.min.css" rel="stylesheet"> + <script src="https://code.jquery.com/jquery-1.11.3.min.js"></script> + <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.11.4/jquery-ui.min.js"></script> + <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/javascripts/jquery.tocify.min.js"></script> + + + <script type="text/javascript"> + $(function () { + $("#toc").tocify({ + scrollTo: 50, + extendPage: true, + context: "#doc-content", + selectors: "h2,h3,h4,h5" + }); + $(".fallback-toc").hide(); + }); + </script> + + + <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; + } + + .toc-like { + border-radius: 6px; + border: 1px solid #ccc; + } + + .toc-like li { + line-height: 30px; + text-indent: 10px; + } + + .toc-like li.custom-toc-header { + font-weight: bold; + background: #666; + color: white; + cursor: initial !important; + padding: 5px; + } + + .toc-like li.custom-toc-header a { + color: white; + font-style: normal; + text-shadow: none; + padding: 0; + } + + .toc-like li.custom-toc-header:hover a { + background: #666; + } + + .page-title { + text-align: left; + } + + #doc-content h2, + #doc-content h3, + #doc-content h4, + #doc-content h5, + #doc-content h6 { + padding-top: 0; + margin-top: 25px; + margin-bottom: 10px; + line-height: 1.4em; + } + + #doc-content h2 { + border-bottom: 1px solid lightgrey; + } + + + </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="../index.html">Apache DeltaSpike</a> + + <div class="nav-collapse"> + + + <ul class="nav"> + <li><a href="../index.html">Home</a></li> + <li class="active"><a href="../documentation">Documentation</a></li> + <li ><a href="../javadoc.html">Javadoc</a></li> + <li ><a href="../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> + </ul> + </div> + <!--/.nav-collapse --> + <form id="search-form" action="https://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-fluid"> + + + + <div class="span8"> + <div class="page-title"> + <h1>Configure DeltaSpike in Your Projects</h1> + </div> + + <div id="doc-content"> + <div id="preamble"> +<div class="sectionbody"> +<div class="paragraph"> +<p>DeltaSpike is available for use in projects of many build tools. Instructions are given here for obtaining released final versions of DeltaSpike for both approaches.</p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +You can also opt to use the lastest DeltaSpike snapshots; for more information, see <a href="snapshots.html">Use DeltaSpike Snapshots</a>. +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_maven_projects">Maven Projects</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>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 <code>settings.xml</code> file; when building projects, Maven automatically searches the online Maven Central repository for project dependencies and downloads sources to your local Maven repository.</p> +</div> +<div class="paragraph"> +<p>To begin use the DeltaSpike releases from Maven Central, you simply need to configure the project <code>pom.xml</code> 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.</p> +</div> +<div class="olist arabic"> +<ol class="arabic"> +<li> +<p>Open the project <code>pom.xml</code> file for editing</p> +</li> +<li> +<p>Add the DeltaSpike version to the list of properties</p> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><properties></span> + <span class="tag"><deltaspike.version></span>1.7.1<span class="tag"></deltaspike.version></span> +<span class="tag"></properties></span></code></pre> +</div> +</div> +</li> +<li> +<p>Add the DeltaSpike Core module to the list of dependencies</p> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependencyManagement></span> + <span class="tag"><dependencies></span> + <span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.distribution<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>distributions-bom<span class="tag"></artifactId></span> + <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span> + <span class="tag"><type></span>pom<span class="tag"></type></span> + <span class="tag"><scope></span>import<span class="tag"></scope></span> + <span class="tag"></dependency></span> + <span class="tag"></dependencies></span> +<span class="tag"></dependencyManagement></span> + +<span class="tag"><dependency></span> + <span class="tag"><groupId></span>org.apache.deltaspike.core<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-core-api<span class="tag"></artifactId></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.core<span class="tag"></groupId></span> + <span class="tag"><artifactId></span>deltaspike-core-impl<span class="tag"></artifactId></span> + <span class="tag"><scope></span>runtime<span class="tag"></scope></span> +<span class="tag"></dependency></span></code></pre> +</div> +</div> +</li> +<li> +<p>Save the <code>pom.xml</code> file changes</p> +</li> +</ol> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<td class="content"> +The API is scoped for compile time and implementation only included for runtime, assisting to prevent you from inadvertently depending on an implementation class. +</td> +</tr> +</table> +</div> +<div class="paragraph"> +<p>For instructions on adding the optional DeltaSpike modules, see the relevant module page:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p><a href="bean-validation.html">Bean Validation</a></p> +</li> +<li> +<p><a href="container-control.html">Container Control</a></p> +</li> +<li> +<p><a href="data.html">Data</a></p> +</li> +<li> +<p><a href="jpa.html">JPA</a></p> +</li> +<li> +<p><a href="jsf.html">JSF</a></p> +</li> +<li> +<p><a href="partial-bean.html">Partial-Bean</a></p> +</li> +<li> +<p><a href="scheduler.html">Scheduler</a></p> +</li> +<li> +<p><a href="security.html">Security</a></p> +</li> +<li> +<p><a href="servlet.html">Servlet</a></p> +</li> +<li> +<p><a href="test-control.html">Test-Control</a></p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="config-gradle">Gradle Projects</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Setting up DeltaSpike in a Gradle based project is just as easy as Maven.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code>// setup the Spring Dependency Management Plugin for Gradle, to import BOMs. +plugins { + id "io.spring.dependency-management" version "0.5.6.RELEASE" + id "java" // you'll likely also want the WAR plugin +} +repositories { + mavenCentral() +} +dependencyManagement { + imports { + mavenBom 'org.apache.deltaspike.distribution:distributions-bom:1.7.1' + } +} +dependencies { + compile 'org.apache.deltaspike.core:deltaspike-core-api' + runtime 'org.apache.deltaspike.core:deltaspike-core-impl' +} +sourceSets { + main { + //To use standard bean discovery mechanisms, CDI expects beans.xml to be in your classes directory + output.resourcesDir = output.classesDir + } + test { + output.resourcesDir = output.classesDir + } // and any other sourceSet you might have. + }</code></pre> +</div> +</div> +<div class="paragraph"> +<p>This will give you a Gradle build setup to run DeltaSpike.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="config-maven-indep">Other Projects</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>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 <a href="build.html">Build DeltaSpike from Source</a>. In both cases, you must add the DeltaSpike .jar files directly to your projects.</p> +</div> +<div class="paragraph"> +<p>To use DeltaSpike without Maven from the downloadable .jar files, complete the following steps:</p> +</div> +<div class="olist arabic"> +<ol class="arabic"> +<li> +<p>Download the latest <code>distribution-full-<version>.zip</code> from <a href="https://deltaspike.apache.org/download.html" class="bare">https://deltaspike.apache.org/download.html</a></p> +</li> +<li> +<p>Extract the archive contents</p> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="shell">$ unzip distribution-full-<version>.zip</code></pre> +</div> +</div> +</li> +<li> +<p>Add the source to your project</p> +<div class="olist loweralpha"> +<ol class="loweralpha" type="a"> +<li> +<p>For .war projects, copy the .jar files to the <code>WEB-INF/lib</code> directory</p> +</li> +<li> +<p>For .ear projects, copy the .jar files to the <code>EAR/lib directory</code> and add the following to <code>META-INF/application.xml</code>:</p> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><library-directory></span>lib<span class="tag"></library-directory></span></code></pre> +</div> +</div> +</li> +</ol> +</div> +</li> +</ol> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_next">Next</h2> +<div class="sectionbody"> +<div class="ulist"> +<ul> +<li> +<p>To check whether your Java environment needs any additional CDI-specific configuration, see <a href="cdiimp.html">Enable CDI For Your Java Environment</a>.</p> +</li> +<li> +<p>To see ready-to-deploy example DeltaSpike applications, see <a href="http://deltaspike.apache.org/examples.html">See DeltaSpike in Action</a>.</p> +</li> +<li> +<p>To understand how the various DeltaSpike modules can enhance and extend your applications, see <a href="modules.html">Overview of DeltaSpike Modules</a> and the individual module pages.</p> +</li> +</ul> +</div> +</div> +</div> + </div> + </div> + + + <div class="span4"> + <div id="toc"> + <div class="moduledeps"> + <ul class="toc-like nav nav-list"> + + + + </ul> + </div> + </div> + + <div class="fallback-toc"> + <ul class="sectlevel1"> +<li><a href="#_maven_projects">Maven Projects</a></li> +<li><a href="#config-gradle">Gradle Projects</a></li> +<li><a href="#config-maven-indep">Other Projects</a></li> +<li><a href="#_next">Next</a></li> +</ul> + </div> + + </div> + + + </div> + <div class="row"> + <hr> + <footer> + <p>Copyright © 2011-2016 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> +</div> + +</body> </html> \ No newline at end of file