Google Git
Sign in
apache / sling-site / efb755e2a1343f468acc49021bd82b6982f4c904 / . / src / main / jbake / assets / components / jspc-maven-plugin / jspc-mojo.html
blob: 45405443663ff2daa3c5d2075d94b25e43b8e25c [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2017-06-12
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20170612" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Sling Maven Plugin for Compiling JSP Sources into Bundles &#x2013; jspc:jspc</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h2>Apache Sling Maven Plugin for Compiling JSP Sources into Bundles</h2>
</div>
</div>
<div class="pull-right"></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2017-06-12<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 2.1.0</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
<li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a> </li>
<li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a> </li>
<li class="nav-header">Project Documentation</li>
<li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a> </li>
<li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a> </li>
</ul>
<hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
</div>
</div>
</div>
<div id="bodyColumn" class="span10" >
<div class="section">
<h2><a name="jspc:jspc"></a>jspc:jspc</h2>
<p><b>Full name</b>:</p>
<p>org.apache.sling:jspc-maven-plugin:2.1.0:jspc</p>
<p><b>Description</b>:</p>
<div>The <tt>JspcMojo</tt> is implements the Sling Maven JspC goal
<tt>jspc</tt> compiling JSP into the target and creating a
component descriptor for Declarative Services to use the JSP with
the help of the appropriate adapter as component.</div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>Requires dependency resolution of artifacts in scope: <tt>compile</tt>.</li>
<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>compile</tt>.</li>
</ul>
<div class="section">
<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="table table-striped" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td><b><a href="#compilerSourceVM">compilerSourceVM</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>The Compiler Source Version of the Java source generated from the
JSP files before compiling into classes.<br /><b>Default value is</b>: <tt>1.5</tt>.<br /><b>User property is</b>: <tt>jspc.compilerSourceVM</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#compilerTargetVM">compilerTargetVM</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>The Target Virtual Machine Version to generate class files for.<br /><b>Default value is</b>: <tt>1.5</tt>.<br /><b>User property is</b>: <tt>jspc.compilerTargetVM</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#excludes">excludes</a></b></td>
<td><tt>String[]</tt></td>
<td><tt>-</tt></td>
<td>Excluded JSPs, empty by default<br /></td>
</tr>
<tr class="a">
<td><b><a href="#failOnError">failOnError</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>jspc.failOnError</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#includes">includes</a></b></td>
<td><tt>String[]</tt></td>
<td><tt>-</tt></td>
<td>Included JSPs, defaults to <tt>&quot;**/*.jsp&quot;</tt><br /></td>
</tr>
<tr class="a">
<td><b><a href="#jasperClassDebugInfo">jasperClassDebugInfo</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>jspc.jasper.classdebuginfo</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#jasperEnablePooling">jasperEnablePooling</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>jspc.jasper.enablePooling</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#jasperGenStringAsCharArray">jasperGenStringAsCharArray</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>jspc.jasper.genStringAsCharArray</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#jasperIeClassId">jasperIeClassId</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>clsid:8AD9C840-044E-11D1-B3E9-00805F499D93</tt>.<br /><b>User property is</b>: <tt>jspc.jasper.ieClassId</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#jasperKeepGenerated">jasperKeepGenerated</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>jspc.jasper.keepgenerated</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#jasperMappedFile">jasperMappedFile</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>jspc.jasper.mappedfile</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#jasperTrimSpaces">jasperTrimSpaces</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>jspc.jasper.trimSpaces</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#jspFileExtensions">jspFileExtensions</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td><b>Deprecated.</b> Use the <tt>includes</tt> filter instead.<br /><b>Default value is</b>: <tt>jsp,jspx</tt>.<br /><b>User property is</b>: <tt>jspc.jspFileExtensions</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#outputDirectory">outputDirectory</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Target directory for the compiled JSP classes.<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>jspc.outputDirectory</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#printCompilationReport">printCompilationReport</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Prints a compilation report by listing all the packages and
dependencies that were used during processing the JSPs.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>jspc.printCompilationReport</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#servletPackage">servletPackage</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td><b>Deprecated.</b> Due to internal refactoring, this is not longer supported.<br /><b>Default value is</b>: <tt>org.apache.jsp</tt>.<br /><b>User property is</b>: <tt>jspc.servletPackage</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#showSuccess">showSuccess</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>jspc.showSuccess</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>Location of the JSP source file.<br /><b>Default value is</b>: <tt>${project.build.scriptSourceDirectory}</tt>.<br /><b>User property is</b>: <tt>jspc.sourceDirectory</tt>.</td>
</tr>
</table>
</div>
<div class="section">
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><b><a name="compilerSourceVM">compilerSourceVM</a>:</b></p>
<div>The Compiler Source Version of the Java source generated from the
JSP files before compiling into classes.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.compilerSourceVM</tt></li>
<li><b>Default</b>: <tt>1.5</tt></li>
</ul><hr />
<p><b><a name="compilerTargetVM">compilerTargetVM</a>:</b></p>
<div>The Target Virtual Machine Version to generate class files for.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.compilerTargetVM</tt></li>
<li><b>Default</b>: <tt>1.5</tt></li>
</ul><hr />
<p><b><a name="excludes">excludes</a>:</b></p>
<div>Excluded JSPs, empty by default</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String[]</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="failOnError">failOnError</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.failOnError</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="includes">includes</a>:</b></p>
<div>Included JSPs, defaults to <tt>&quot;**/*.jsp&quot;</tt></div>
<ul>
<li><b>Type</b>: <tt>java.lang.String[]</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="jasperClassDebugInfo">jasperClassDebugInfo</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.jasper.classdebuginfo</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="jasperEnablePooling">jasperEnablePooling</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.jasper.enablePooling</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="jasperGenStringAsCharArray">jasperGenStringAsCharArray</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.jasper.genStringAsCharArray</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="jasperIeClassId">jasperIeClassId</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.jasper.ieClassId</tt></li>
<li><b>Default</b>: <tt>clsid:8AD9C840-044E-11D1-B3E9-00805F499D93</tt></li>
</ul><hr />
<p><b><a name="jasperKeepGenerated">jasperKeepGenerated</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.jasper.keepgenerated</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="jasperMappedFile">jasperMappedFile</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.jasper.mappedfile</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="jasperTrimSpaces">jasperTrimSpaces</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.jasper.trimSpaces</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="jspFileExtensions">jspFileExtensions</a>:</b></p>
<div><b>Deprecated.</b> Use the <tt>includes</tt> filter instead.</div>
<div>Comma separated list of extensions of files to be compiled by the
plugin.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.jspFileExtensions</tt></li>
<li><b>Default</b>: <tt>jsp,jspx</tt></li>
</ul><hr />
<p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
<div>Target directory for the compiled JSP classes.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.outputDirectory</tt></li>
<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li>
</ul><hr />
<p><b><a name="printCompilationReport">printCompilationReport</a>:</b></p>
<div>Prints a compilation report by listing all the packages and
dependencies that were used during processing the JSPs.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.printCompilationReport</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="servletPackage">servletPackage</a>:</b></p>
<div><b>Deprecated.</b> Due to internal refactoring, this is not longer supported.</div>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.servletPackage</tt></li>
<li><b>Default</b>: <tt>org.apache.jsp</tt></li>
</ul><hr />
<p><b><a name="showSuccess">showSuccess</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.showSuccess</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
<div>Location of the JSP source file.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>jspc.sourceDirectory</tt></li>
<li><b>Default</b>: <tt>${project.build.scriptSourceDirectory}</tt></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>Copyright &copy;2007&#x2013;2017
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All rights reserved.</p>
</div>
</div>
</footer>
</body>
</html>