mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-03-18 07:14:09 +01:00
418 lines
22 KiB
HTML
418 lines
22 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_92) on Tue Sep 06 06:51:25 EDT 2016 -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>CheckMojo (Dependency-Check Maven Plugin 1.4.3 API)</title>
|
|
<meta name="date" content="2016-09-06">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="CheckMojo (Dependency-Check Maven Plugin 1.4.3 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/CheckMojo.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/owasp/dependencycheck/maven/HelpMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/owasp/dependencycheck/maven/CheckMojo.html" target="_top">Frames</a></li>
|
|
<li><a href="CheckMojo.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">org.owasp.dependencycheck.maven</div>
|
|
<h2 title="Class CheckMojo" class="title">Class CheckMojo</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.apache.maven.plugin.AbstractMojo</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">org.owasp.dependencycheck.maven.BaseDependencyCheckMojo</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.owasp.dependencycheck.maven.CheckMojo</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport</dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>@Mojo(name="check",
|
|
defaultPhase=VERIFY,
|
|
threadSafe=false,
|
|
requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
|
|
requiresOnline=true)
|
|
public class <span class="typeNameLabel">CheckMojo</span>
|
|
extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></pre>
|
|
<div class="block">Maven Plugin that checks the project dependencies to see if they have any
|
|
known published vulnerabilities.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
|
<dd>Jeremy Long</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.reporting.MavenReport">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from interface org.apache.maven.reporting.MavenReport</h3>
|
|
<code>CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugin.Mojo">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3>
|
|
<code>ROLE</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.html#CheckMojo--">CheckMojo</a></span>()</code> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.html#canGenerateReport--">canGenerateReport</a></span>()</code>
|
|
<div class="block">Returns whether or not a the report can be generated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.html#getDescription-java.util.Locale-">getDescription</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code>
|
|
<div class="block">Gets the description of the Dependency-Check report to be displayed in
|
|
the Maven Generated Reports page.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.html#getName-java.util.Locale-">getName</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code>
|
|
<div class="block">Returns the report name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.html#runCheck--">runCheck</a></span>()</code>
|
|
<div class="block">Executes the dependency-check engine on the project's dependencies and
|
|
generates the report.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.org.owasp.dependencycheck.maven.BaseDependencyCheckMojo">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class org.owasp.dependencycheck.maven.<a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></h3>
|
|
<code><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#checkForFailure-java.util.List-">checkForFailure</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#excludeFromScan-java.lang.String-">excludeFromScan</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#execute--">execute</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.codehaus.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.apache.maven.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCategoryName--">getCategoryName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getConnectionString--">getConnectionString</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory--">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory-org.apache.maven.project.MavenProject-">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFile-org.apache.maven.project.MavenProject-">getDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFileContextKey--">getDataFileContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getFormat--">getFormat</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectory--">getOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectoryContextKey--">getOutputDirectoryContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputName--">getOutputName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getProject--">getProject</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReactorProjects--">getReactorProjects</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReportOutputDirectory--">getReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#initializeEngine--">initializeEngine</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isExternalReport--">isExternalReport</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isFailOnError--">isFailOnError</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isGeneratingSite--">isGeneratingSite</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#populateSettings--">populateSettings</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#readDataFile-org.apache.maven.project.MavenProject-">readDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.MavenEngine-">scanArtifacts</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#setReportOutputDirectory-java.io.File-">setReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#showSummary-org.apache.maven.project.MavenProject-java.util.List-">showSummary</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeDataFile-org.apache.maven.project.MavenProject-java.io.File-java.util.List-">writeDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeReports-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-java.io.File-">writeReports</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3>
|
|
<code>getLog, getPluginContext, setLog, setPluginContext</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="CheckMojo--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>CheckMojo</h4>
|
|
<pre>public CheckMojo()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="canGenerateReport--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>canGenerateReport</h4>
|
|
<pre>public boolean canGenerateReport()</pre>
|
|
<div class="block">Returns whether or not a the report can be generated.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><code>true</code> if the report can be generated; otherwise
|
|
<code>false</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="runCheck--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>runCheck</h4>
|
|
<pre>public void runCheck()
|
|
throws org.apache.maven.plugin.MojoExecutionException,
|
|
org.apache.maven.plugin.MojoFailureException</pre>
|
|
<div class="block">Executes the dependency-check engine on the project's dependencies and
|
|
generates the report.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#runCheck--">runCheck</a></code> in class <code><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></code></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an exception executing
|
|
the goal</dd>
|
|
<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to
|
|
fail the build</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getName-java.util.Locale-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getName</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</pre>
|
|
<div class="block">Returns the report name.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>locale</code> - the location</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the report name</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDescription-java.util.Locale-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getDescription</h4>
|
|
<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDescription(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</pre>
|
|
<div class="block">Gets the description of the Dependency-Check report to be displayed in
|
|
the Maven Generated Reports page.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>locale</code> - The Locale to get the description for</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the description</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/CheckMojo.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../org/owasp/dependencycheck/maven/HelpMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/owasp/dependencycheck/maven/CheckMojo.html" target="_top">Frames</a></li>
|
|
<li><a href="CheckMojo.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small>Copyright? 2012-15 Jeremy Long. All Rights Reserved.</small></p>
|
|
</body>
|
|
</html>
|