Google Git
Sign in
apache / tomee-site-pub / 43cf80e624a0cecf0f38bef5ef2614bfb2410f57 / . / tomee-9.0 / javadoc / org / apache / tomee / installer / Installer.html
blob: 1765e82c44bace8c457c1d27ba271bf6b1373fae [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Installer</title>
<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="Installer";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":9,"i12":9,"i13":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="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/apache/tomee/installer/Alerts.html" title="class in org.apache.tomee.installer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/tomee/installer/InstallerInterface.html" title="interface in org.apache.tomee.installer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/tomee/installer/Installer.html" target="_top">Frames</a></li>
<li><a href="Installer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.apache.tomee.installer</div>
<h2 title="Class Installer" class="title">Class Installer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.tomee.installer.Installer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/tomee/installer/InstallerInterface.html" title="interface in org.apache.tomee.installer">InstallerInterface</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Installer</span>
extends java.lang.Object
implements <a href="../../../../org/apache/tomee/installer/InstallerInterface.html" title="interface in org.apache.tomee.installer">InstallerInterface</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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/apache/tomee/installer/Installer.html#Installer-org.apache.tomee.installer.Paths-">Installer</a></span>(<a href="../../../../org/apache/tomee/installer/Paths.html" title="class in org.apache.tomee.installer">Paths</a>&nbsp;paths)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#Installer-org.apache.tomee.installer.Paths-boolean-">Installer</a></span>(<a href="../../../../org/apache/tomee/installer/Paths.html" title="class in org.apache.tomee.installer">Paths</a>&nbsp;paths,
boolean&nbsp;force)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#Installer-org.apache.tomee.installer.Paths-java.util.Map-boolean-">Installer</a></span>(<a href="../../../../org/apache/tomee/installer/Paths.html" title="class in org.apache.tomee.installer">Paths</a>&nbsp;paths,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;properties,
boolean&nbsp;force)</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#addTomEEAdminConfInTomcatUsers--">addTomEEAdminConfInTomcatUsers</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#addTomEEAdminConfInTomcatUsers-boolean-">addTomEEAdminConfInTomcatUsers</a></span>(boolean&nbsp;securityActivated)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/tomee/installer/Alerts.html" title="class in org.apache.tomee.installer">Alerts</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#getAlerts--">getAlerts</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/tomee/installer/PathsInterface.html" title="interface in org.apache.tomee.installer">PathsInterface</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#getPaths--">getPaths</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/tomee/installer/Status.html" title="enum in org.apache.tomee.installer">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#getStatus--">getStatus</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#installAll--">installAll</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#installConfigFiles-boolean-">installConfigFiles</a></span>(boolean&nbsp;builtIn)</code>
<div class="block">Installs conf/tomee.xml and conf/logging.properties files.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#installFull--">installFull</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#installJavaagent--">installJavaagent</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#installListener--">installListener</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#installListener-java.lang.String-">installListener</a></span>(java.lang.String&nbsp;listener)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#isAgentInstalled--">isAgentInstalled</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#isListenerInstalled--">isListenerInstalled</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/tomee/installer/Installer.html#reset--">reset</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="Installer-org.apache.tomee.installer.Paths-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Installer</h4>
<pre>public&nbsp;Installer(<a href="../../../../org/apache/tomee/installer/Paths.html" title="class in org.apache.tomee.installer">Paths</a>&nbsp;paths)</pre>
</li>
</ul>
<a name="Installer-org.apache.tomee.installer.Paths-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Installer</h4>
<pre>public&nbsp;Installer(<a href="../../../../org/apache/tomee/installer/Paths.html" title="class in org.apache.tomee.installer">Paths</a>&nbsp;paths,
boolean&nbsp;force)</pre>
</li>
</ul>
<a name="Installer-org.apache.tomee.installer.Paths-java.util.Map-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Installer</h4>
<pre>public&nbsp;Installer(<a href="../../../../org/apache/tomee/installer/Paths.html" title="class in org.apache.tomee.installer">Paths</a>&nbsp;paths,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;properties,
boolean&nbsp;force)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isListenerInstalled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isListenerInstalled</h4>
<pre>public static&nbsp;boolean&nbsp;isListenerInstalled()</pre>
</li>
</ul>
<a name="isAgentInstalled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAgentInstalled</h4>
<pre>public static&nbsp;boolean&nbsp;isAgentInstalled()</pre>
</li>
</ul>
<a name="getPaths--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPaths</h4>
<pre>public&nbsp;<a href="../../../../org/apache/tomee/installer/PathsInterface.html" title="interface in org.apache.tomee.installer">PathsInterface</a>&nbsp;getPaths()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html#getPaths--">getPaths</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html" title="interface in org.apache.tomee.installer">InstallerInterface</a></code></dd>
</dl>
</li>
</ul>
<a name="getAlerts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlerts</h4>
<pre>public&nbsp;<a href="../../../../org/apache/tomee/installer/Alerts.html" title="class in org.apache.tomee.installer">Alerts</a>&nbsp;getAlerts()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html#getAlerts--">getAlerts</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html" title="interface in org.apache.tomee.installer">InstallerInterface</a></code></dd>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html#reset--">reset</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html" title="interface in org.apache.tomee.installer">InstallerInterface</a></code></dd>
</dl>
</li>
</ul>
<a name="getStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatus</h4>
<pre>public&nbsp;<a href="../../../../org/apache/tomee/installer/Status.html" title="enum in org.apache.tomee.installer">Status</a>&nbsp;getStatus()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html#getStatus--">getStatus</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html" title="interface in org.apache.tomee.installer">InstallerInterface</a></code></dd>
</dl>
</li>
</ul>
<a name="installAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>installAll</h4>
<pre>public&nbsp;void&nbsp;installAll()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html#installAll--">installAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/tomee/installer/InstallerInterface.html" title="interface in org.apache.tomee.installer">InstallerInterface</a></code></dd>
</dl>
</li>
</ul>
<a name="addTomEEAdminConfInTomcatUsers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTomEEAdminConfInTomcatUsers</h4>
<pre>public&nbsp;void&nbsp;addTomEEAdminConfInTomcatUsers()</pre>
</li>
</ul>
<a name="addTomEEAdminConfInTomcatUsers-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTomEEAdminConfInTomcatUsers</h4>
<pre>public&nbsp;void&nbsp;addTomEEAdminConfInTomcatUsers(boolean&nbsp;securityActivated)</pre>
</li>
</ul>
<a name="installFull--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>installFull</h4>
<pre>public&nbsp;void&nbsp;installFull()</pre>
</li>
</ul>
<a name="installListener--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>installListener</h4>
<pre>public&nbsp;void&nbsp;installListener()</pre>
</li>
</ul>
<a name="installListener-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>installListener</h4>
<pre>public&nbsp;void&nbsp;installListener(java.lang.String&nbsp;listener)</pre>
</li>
</ul>
<a name="installJavaagent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>installJavaagent</h4>
<pre>public&nbsp;void&nbsp;installJavaagent()</pre>
</li>
</ul>
<a name="installConfigFiles-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>installConfigFiles</h4>
<pre>public&nbsp;void&nbsp;installConfigFiles(boolean&nbsp;builtIn)</pre>
<div class="block">Installs conf/tomee.xml and conf/logging.properties files.
This method retrieves the tomee.xml and logging.properties files
from openejb core jar file and installs them under the conf directory
of tomcat. if there is already a conf/logging.properties file available
then this method appends the contents of openejb logging.properties file
to the exisiting properties file.
Replace web.xml to set jasper in production mode instead of dev mode.
NOTE:- If the existing conf/logging.properties file already has some openejb specific
configuration, then this method will just leave the logging.properties file alone</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builtIn</code> - </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="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/apache/tomee/installer/Alerts.html" title="class in org.apache.tomee.installer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/tomee/installer/InstallerInterface.html" title="interface in org.apache.tomee.installer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/tomee/installer/Installer.html" target="_top">Frames</a></li>
<li><a href="Installer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>