blob: eca45a7fd8e7bd7b19d9de8ea10014586d51f548 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>WikiEngine (Apache JSPWiki 2.12.2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WikiEngine (Apache JSPWiki 2.12.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":42,"i6":42,"i7":10,"i8":10,"i9":10,"i10":42,"i11":10,"i12":42,"i13":42,"i14":10,"i15":42,"i16":10,"i17":42,"i18":42,"i19":42,"i20":10,"i21":10,"i22":10,"i23":42,"i24":9,"i25":9,"i26":9,"i27":42,"i28":10,"i29":10,"i30":10,"i31":42,"i32":42,"i33":42,"i34":42,"i35":42,"i36":42,"i37":10,"i38":42,"i39":42,"i40":10,"i41":10,"i42":10,"i43":42,"i44":10,"i45":42,"i46":10,"i47":42,"i48":42,"i49":42,"i50":10,"i51":10,"i52":42,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WikiEngine.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" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.wiki</a></div>
<h2 title="Class WikiEngine" class="title">Class WikiEngine</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.wiki.WikiEngine</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
</dl>
<hr>
<object type="image/svg+xml" data="WikiEngine.svg" style="max-width:60%;float:right;"></object>
<pre style="white-space:pre-wrap;">public class <a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.97">WikiEngine</a>
extends java.lang.Object
implements <a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></pre>
<div class="block">Main implementation for <a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core"><code>Engine</code></a>.
<P>
Using this class: Always get yourself an instance from JSP page by using the <code>WikiEngine.getInstance(..)</code> method. Never create
a new WikiEngine() from scratch, unless you're writing tests.
<p>
</div>
</li>
</ul>
</div>
<div class="summary" style="clear:right;">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.Class&lt;?&gt;,&#8203;java.lang.Object&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#managers">managers</a></span></code></th>
<td class="colLast">
<div class="block">Stores WikiEngine's associated managers.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.wiki.api.core.Engine">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.wiki.api.core.<a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></h3>
<code><a href="api/core/Engine.html#DEFAULT_INLINEPATTERN">DEFAULT_INLINEPATTERN</a>, <a href="api/core/Engine.html#DEFAULT_TEMPLATE_NAME">DEFAULT_TEMPLATE_NAME</a>, <a href="api/core/Engine.html#PREFS_COOKIE_NAME">PREFS_COOKIE_NAME</a>, <a href="api/core/Engine.html#PROP_ACL_MANAGER_IMPL">PROP_ACL_MANAGER_IMPL</a>, <a href="api/core/Engine.html#PROP_ALLOW_CREATION_OF_EMPTY_PAGES">PROP_ALLOW_CREATION_OF_EMPTY_PAGES</a>, <a href="api/core/Engine.html#PROP_APPNAME">PROP_APPNAME</a>, <a href="api/core/Engine.html#PROP_ENCODING">PROP_ENCODING</a>, <a href="api/core/Engine.html#PROP_FRONTPAGE">PROP_FRONTPAGE</a>, <a href="api/core/Engine.html#PROP_INLINEIMAGEPTRN">PROP_INLINEIMAGEPTRN</a>, <a href="api/core/Engine.html#PROP_INTERWIKIREF">PROP_INTERWIKIREF</a>, <a href="api/core/Engine.html#PROP_MATCHPLURALS">PROP_MATCHPLURALS</a>, <a href="api/core/Engine.html#PROP_NO_FILTER_ENCODING">PROP_NO_FILTER_ENCODING</a>, <a href="api/core/Engine.html#PROP_REF_MANAGER_IMPL">PROP_REF_MANAGER_IMPL</a>, <a href="api/core/Engine.html#PROP_SEARCHPATH">PROP_SEARCHPATH</a>, <a href="api/core/Engine.html#PROP_STOREUSERNAME">PROP_STOREUSERNAME</a>, <a href="api/core/Engine.html#PROP_TEMPLATEDIR">PROP_TEMPLATEDIR</a>, <a href="api/core/Engine.html#PROP_URLCONSTRUCTOR">PROP_URLCONSTRUCTOR</a>, <a href="api/core/Engine.html#PROP_WORKDIR">PROP_WORKDIR</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Properties)">WikiEngine</a></span>&#8203;(java.util.Properties&nbsp;properties)</code></th>
<td class="colLast">
<div class="block">Instantiate the WikiEngine using a given set of properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(javax.servlet.ServletContext,java.lang.String)">WikiEngine</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context,
java.lang.String&nbsp;appid)</code></th>
<td class="colLast">
<div class="block">Instantiate using this method when you're running as a servlet and WikiEngine will figure out where to look for the property file.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addWikiEventListener(org.apache.wiki.event.WikiEventListener)">addWikiEventListener</a></span>&#8203;(<a href="event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Registers a WikiEventListener with this instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decodeName(java.lang.String)">decodeName</a></span>&#8203;(java.lang.String&nbsp;pagerequest)</code></th>
<td class="colLast">
<div class="block">Decodes a URL-encoded request back to regular life.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeName(java.lang.String)">encodeName</a></span>&#8203;(java.lang.String&nbsp;pagename)</code></th>
<td class="colLast">
<div class="block">Turns a WikiName into something that can be called through using an URL.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireEvent(int)">fireEvent</a></span>&#8203;(int&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Fires a WikiEngineEvent to all registered listeners.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#firePageEvent(int,java.lang.String)">firePageEvent</a></span>&#8203;(int&nbsp;type,
java.lang.String&nbsp;pageName)</code></th>
<td class="colLast">
<div class="block">Fires a WikiPageEvent to all registered listeners.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="auth/acl/AclManager.html" title="interface in org.apache.wiki.auth.acl">AclManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAclManager()">getAclManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AclManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="ui/admin/AdminBeanManager.html" title="interface in org.apache.wiki.ui.admin">AdminBeanManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAdminBeanManager()">getAdminBeanManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AdminBeanManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllInlinedImagePatterns()">getAllInlinedImagePatterns</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a collection of all image types that get inlined.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Collection&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllInterWikiLinks()">getAllInterWikiLinks</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a collection of all supported InterWiki links.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getApplicationName()">getApplicationName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the name of the application.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="attachment/AttachmentManager.html" title="interface in org.apache.wiki.attachment">AttachmentManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachmentManager()">getAttachmentManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AttachmentManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttribute(java.lang.String)">getAttribute</a></span>&#8203;(java.lang.String&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Gets an attribute from the engine.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="auth/AuthenticationManager.html" title="interface in org.apache.wiki.auth">AuthenticationManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticationManager()">getAuthenticationManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AuthenticationManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="auth/AuthorizationManager.html" title="interface in org.apache.wiki.auth">AuthorizationManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthorizationManager()">getAuthorizationManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AuthorizationManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBaseURL()">getBaseURL</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the base URL, telling where this Wiki actually lives.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="ui/CommandResolver.html" title="interface in org.apache.wiki.ui">CommandResolver</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommandResolver()">getCommandResolver</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( CommandResolver.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.nio.charset.Charset</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContentEncoding()">getContentEncoding</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the IANA name of the character set encoding we're supposed to be using right now.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="diff/DifferenceManager.html" title="interface in org.apache.wiki.diff">DifferenceManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDifferenceManager()">getDifferenceManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( DifferenceManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="ui/EditorManager.html" title="interface in org.apache.wiki.ui">EditorManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEditorManager()">getEditorManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( EditorManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="filters/FilterManager.html" title="interface in org.apache.wiki.filters">FilterManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFilterManager()">getFilterManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( FilterManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFinalPageName(java.lang.String)">getFinalPageName</a></span>&#8203;(java.lang.String&nbsp;page)</code></th>
<td class="colLast">
<div class="block">Returns the correct page name, or null, if no such page can be found.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFrontPage()">getFrontPage</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the default front page, if no page is used.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGlobalRSSURL()">getGlobalRSSURL</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the URL of the global RSS file.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="auth/authorize/GroupManager.html" title="interface in org.apache.wiki.auth.authorize">GroupManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupManager()">getGroupManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( GroupManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>static <a href="WikiEngine.html" title="class in org.apache.wiki">WikiEngine</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance(javax.servlet.ServletConfig)">getInstance</a></span>&#8203;(javax.servlet.ServletConfig&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Gets a WikiEngine related to this servlet.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>static <a href="WikiEngine.html" title="class in org.apache.wiki">WikiEngine</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance(javax.servlet.ServletConfig,java.util.Properties)">getInstance</a></span>&#8203;(javax.servlet.ServletConfig&nbsp;config,
java.util.Properties&nbsp;props)</code></th>
<td class="colLast">
<div class="block">Gets a WikiEngine related to the servlet.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>static <a href="WikiEngine.html" title="class in org.apache.wiki">WikiEngine</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance(javax.servlet.ServletContext,java.util.Properties)">getInstance</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context,
java.util.Properties&nbsp;props)</code></th>
<td class="colLast">
<div class="block">Gets a WikiEngine related to the servlet.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="i18n/InternationalizationManager.html" title="interface in org.apache.wiki.i18n">InternationalizationManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInternationalizationManager()">getInternationalizationManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( InternationalizationManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInterWikiURL(java.lang.String)">getInterWikiURL</a></span>&#8203;(java.lang.String&nbsp;wikiName)</code></th>
<td class="colLast">
<div class="block">Returns an URL to some other Wiki that we know.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getManager(java.lang.Class)">getManager</a></span>&#8203;(java.lang.Class&lt;T&gt;&nbsp;manager)</code></th>
<td class="colLast">
<div class="block">Retrieves the object instantiated by the Engine matching the requested type.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;java.util.List&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getManagers(java.lang.Class)">getManagers</a></span>&#8203;(java.lang.Class&lt;T&gt;&nbsp;manager)</code></th>
<td class="colLast">
<div class="block">Retrieves the objects instantiated by the Engine that can be assigned to the requested type.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="pages/PageManager.html" title="interface in org.apache.wiki.pages">PageManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPageManager()">getPageManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( PageManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="content/PageRenamer.html" title="interface in org.apache.wiki.content">PageRenamer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPageRenamer()">getPageRenamer</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( PageRenamer.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="plugin/PluginManager.html" title="interface in org.apache.wiki.plugin">PluginManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPluginManager()">getPluginManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( PluginManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="ui/progress/ProgressManager.html" title="interface in org.apache.wiki.ui.progress">ProgressManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProgressManager()">getProgressManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( ProgressManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="references/ReferenceManager.html" title="interface in org.apache.wiki.references">ReferenceManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReferenceManager()">getReferenceManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( ReferenceManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="render/RenderingManager.html" title="interface in org.apache.wiki.render">RenderingManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRenderingManager()">getRenderingManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( RenderingManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRootPath()">getRootPath</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the root path.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code><a href="rss/RSSGenerator.html" title="interface in org.apache.wiki.rss">RSSGenerator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRSSGenerator()">getRSSGenerator</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( RSSGenerator.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="search/SearchManager.html" title="interface in org.apache.wiki.search">SearchManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchManager()">getSearchManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( SearchManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>javax.servlet.ServletContext</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletContext()">getServletContext</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the ServletContext that this particular Engine was initialized with.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSpecialPageReference(java.lang.String)">getSpecialPageReference</a></span>&#8203;(java.lang.String&nbsp;original)</code></th>
<td class="colLast">
<div class="block">If the page is a special page, then returns a direct URL to that page.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>java.util.Date</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStartTime()">getStartTime</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the moment when this engine was started.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code><a href="tasks/TasksManager.html" title="interface in org.apache.wiki.tasks">TasksManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTasksManager()">getTasksManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( TaskManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTemplateDir()">getTemplateDir</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the current template directory.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code><a href="ui/TemplateManager.html" title="interface in org.apache.wiki.ui">TemplateManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTemplateManager()">getTemplateManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( TemplateManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getURL(java.lang.String,java.lang.String,java.lang.String)">getURL</a></span>&#8203;(java.lang.String&nbsp;context,
java.lang.String&nbsp;pageName,
java.lang.String&nbsp;params)</code></th>
<td class="colLast">
<div class="block">Returns an URL if a WikiContext is not available.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><a href="url/URLConstructor.html" title="interface in org.apache.wiki.url">URLConstructor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getURLConstructor()">getURLConstructor</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( URLConstructor.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="auth/UserManager.html" title="interface in org.apache.wiki.auth">UserManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserManager()">getUserManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( UserManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code><a href="variables/VariableManager.html" title="interface in org.apache.wiki.variables">VariableManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVariableManager()">getVariableManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( VariableManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>java.util.Properties</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWikiProperties()">getWikiProperties</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the set of properties that the Engine was initialized with.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWorkDir()">getWorkDir</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the JSPWiki working directory set with "jspwiki.workDir".</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code><a href="workflow/WorkflowManager.html" title="interface in org.apache.wiki.workflow">WorkflowManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWorkflowManager()">getWorkflowManager</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( WorkflowManager.class )</code> instead.</div>
</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(java.util.Properties)">initialize</a></span>&#8203;(java.util.Properties&nbsp;props)</code></th>
<td class="colLast">
<div class="block">Does all the real initialization.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initReferenceManager()">initReferenceManager</a></span>()</code></th>
<td class="colLast">
<div class="block">Initializes the reference manager.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isConfigured()">isConfigured</a></span>()</code></th>
<td class="colLast">
<div class="block">check if the Engine has been configured.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAttribute(java.lang.String)">removeAttribute</a></span>&#8203;(java.lang.String&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Removes an attribute.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeWikiEventListener(org.apache.wiki.event.WikiEventListener)">removeWikiEventListener</a></span>&#8203;(<a href="event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Un-registers a WikiEventListener with this instance.</div>
</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAttribute(java.lang.String,java.lang.Object)">setAttribute</a></span>&#8203;(java.lang.String&nbsp;key,
java.lang.Object&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds an attribute to the engine for the duration of this engine.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shutdown()">shutdown</a></span>()</code></th>
<td class="colLast">
<div class="block">Signals that the <code>Engine</code> will be shut down by the servlet container.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.wiki.api.core.Engine">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.wiki.api.core.<a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></h3>
<code><a href="api/core/Engine.html#adapt(java.lang.Class)">adapt</a>, <a href="api/core/Engine.html#findConfigFile(java.lang.String)">findConfigFile</a>, <a href="api/core/Engine.html#getPluginSearchPath()">getPluginSearchPath</a>, <a href="api/core/Engine.html#start(java.util.Properties)">start</a>, <a href="api/core/Engine.html#stop()">stop</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="managers">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>managers</h4>
<pre>protected final&nbsp;java.util.Map&lt;java.lang.Class&lt;?&gt;,&#8203;java.lang.Object&gt; <a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.139">managers</a></pre>
<div class="block">Stores WikiEngine's associated managers.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.util.Properties)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WikiEngine</h4>
<pre>public&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.212">WikiEngine</a>&#8203;(java.util.Properties&nbsp;properties)
throws <a href="api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</a></pre>
<div class="block">Instantiate the WikiEngine using a given set of properties. Use this constructor for testing purposes only.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - A set of properties to use to initialize this WikiEngine.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</a></code> - If the initialization fails.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(javax.servlet.ServletContext,java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WikiEngine</h4>
<pre>protected&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.224">WikiEngine</a>&#8203;(javax.servlet.ServletContext&nbsp;context,
java.lang.String&nbsp;appid)
throws <a href="api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</a></pre>
<div class="block">Instantiate using this method when you're running as a servlet and WikiEngine will figure out where to look for the property file.
Do not use this method - use WikiEngine.getInstance() instead.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - A ServletContext.</dd>
<dd><code>appid</code> - An Application ID. This application is a unique random string which is used to recognize this WikiEngine.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</a></code> - If the WikiEngine construction fails.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getInstance(javax.servlet.ServletConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre class="methodSignature">public static&nbsp;<a href="WikiEngine.html" title="class in org.apache.wiki">WikiEngine</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.149">getInstance</a>&#8203;(javax.servlet.ServletConfig&nbsp;config)
throws <a href="InternalWikiException.html" title="class in org.apache.wiki">InternalWikiException</a></pre>
<div class="block">Gets a WikiEngine related to this servlet. Since this method is only called from JSP pages (and JspInit()) to be specific,
we throw a RuntimeException if things don't work.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - The ServletConfig object for this servlet.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A WikiEngine instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="InternalWikiException.html" title="class in org.apache.wiki">InternalWikiException</a></code> - in case something fails. This is a RuntimeException, so be prepared for it.</dd>
</dl>
</li>
</ul>
<a id="getInstance(javax.servlet.ServletConfig,java.util.Properties)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre class="methodSignature">public static&nbsp;<a href="WikiEngine.html" title="class in org.apache.wiki">WikiEngine</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.163">getInstance</a>&#8203;(javax.servlet.ServletConfig&nbsp;config,
java.util.Properties&nbsp;props)</pre>
<div class="block">Gets a WikiEngine related to the servlet. Works like getInstance(ServletConfig), but does not force the Properties object.
This method is just an optional way of initializing a WikiEngine for embedded JSPWiki applications; normally, you
should use getInstance(ServletConfig).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - The ServletConfig of the webapp servlet/JSP calling this method.</dd>
<dd><code>props</code> - A set of properties, or null, if we are to load JSPWiki's default jspwiki.properties (this is the usual case).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>One well-behaving WikiEngine instance.</dd>
</dl>
</li>
</ul>
<a id="getInstance(javax.servlet.ServletContext,java.util.Properties)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre class="methodSignature">public static&nbsp;<a href="WikiEngine.html" title="class in org.apache.wiki">WikiEngine</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.175">getInstance</a>&#8203;(javax.servlet.ServletContext&nbsp;context,
java.util.Properties&nbsp;props)
throws <a href="InternalWikiException.html" title="class in org.apache.wiki">InternalWikiException</a></pre>
<div class="block">Gets a WikiEngine related to the servlet. Works just like getInstance( ServletConfig )</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - The ServletContext of the webapp servlet/JSP calling this method.</dd>
<dd><code>props</code> - A set of properties, or null, if we are to load JSPWiki's default jspwiki.properties (this is the usual case).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>One fully functional, properly behaving WikiEngine.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="InternalWikiException.html" title="class in org.apache.wiki">InternalWikiException</a></code> - If the WikiEngine instantiation fails.</dd>
</dl>
</li>
</ul>
<a id="initialize(java.util.Properties)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.238">initialize</a>&#8203;(java.util.Properties&nbsp;props)
throws <a href="api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</a></pre>
<div class="block">Does all the real initialization.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#initialize(java.util.Properties)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>props</code> - Wiki configuration properties.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</a></code> - if something happens while setting up the <code>Engine</code>.</dd>
</dl>
</li>
</ul>
<a id="getManager(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManager</h4>
<pre class="methodSignature">public&nbsp;&lt;T&gt;&nbsp;T&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.404">getManager</a>&#8203;(java.lang.Class&lt;T&gt;&nbsp;manager)</pre>
<div class="block">Retrieves the object instantiated by the Engine matching the requested type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getManager(java.lang.Class)">getManager</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - type of the requested object.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>manager</code> - requested object instantiated by the Engine.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>requested object instantiated by the Engine, <code>null</code> if not available.</dd>
</dl>
</li>
</ul>
<a id="getManagers(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManagers</h4>
<pre class="methodSignature">public&nbsp;&lt;T&gt;&nbsp;java.util.List&lt;T&gt;&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.414">getManagers</a>&#8203;(java.lang.Class&lt;T&gt;&nbsp;manager)</pre>
<div class="block">Retrieves the objects instantiated by the Engine that can be assigned to the requested type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getManagers(java.lang.Class)">getManagers</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - type of the requested object.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>manager</code> - requested objectx instantiated by the Engine.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>collection of requested objects instantiated by the Engine, <code>empty</code> list if none available.</dd>
</dl>
</li>
</ul>
<a id="isConfigured()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConfigured</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.424">isConfigured</a>()</pre>
<div class="block">check if the Engine has been configured.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#isConfigured()">isConfigured</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if it has, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a id="initReferenceManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initReferenceManager</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.463">initReferenceManager</a>()
throws <a href="api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</a></pre>
<div class="block">Initializes the reference manager. Scans all existing WikiPages for
internal links and adds them to the ReferenceManager object.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</a></code> - If the reference manager initialization fails.</dd>
</dl>
</li>
</ul>
<a id="getWikiProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWikiProperties</h4>
<pre class="methodSignature">public&nbsp;java.util.Properties&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.485">getWikiProperties</a>()</pre>
<div class="block">Returns the set of properties that the Engine was initialized with. Note that this method returns a direct reference, so it's
possible to manipulate the properties. However, this is not advised unless you really know what you're doing.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getWikiProperties()">getWikiProperties</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The wiki properties</dd>
</dl>
</li>
</ul>
<a id="getWorkDir()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkDir</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.491">getWorkDir</a>()</pre>
<div class="block">Returns the JSPWiki working directory set with "jspwiki.workDir".</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getWorkDir()">getWorkDir</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The working directory.</dd>
</dl>
</li>
</ul>
<a id="getTemplateDir()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemplateDir</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.497">getTemplateDir</a>()</pre>
<div class="block">Returns the current template directory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getTemplateDir()">getTemplateDir</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The template directory as initialized by the engine.</dd>
</dl>
</li>
</ul>
<a id="getStartTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartTime</h4>
<pre class="methodSignature">public&nbsp;java.util.Date&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.503">getStartTime</a>()</pre>
<div class="block">Returns the moment when this engine was started.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getStartTime()">getStartTime</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The start time of this wiki.</dd>
</dl>
</li>
</ul>
<a id="getBaseURL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseURL</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.509">getBaseURL</a>()</pre>
<div class="block">Returns the base URL, telling where this Wiki actually lives.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getBaseURL()">getBaseURL</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Base URL.</dd>
</dl>
</li>
</ul>
<a id="getGlobalRSSURL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGlobalRSSURL</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.515">getGlobalRSSURL</a>()</pre>
<div class="block">Returns the URL of the global RSS file. May be null, if the RSS file generation is not operational.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getGlobalRSSURL()">getGlobalRSSURL</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The global RSS url</dd>
</dl>
</li>
</ul>
<a id="getInterWikiURL(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInterWikiURL</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.526">getInterWikiURL</a>&#8203;(java.lang.String&nbsp;wikiName)</pre>
<div class="block">Returns an URL to some other Wiki that we know.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getInterWikiURL(java.lang.String)">getInterWikiURL</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wikiName</code> - The name of the other wiki.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null, if no such reference was found.</dd>
</dl>
</li>
</ul>
<a id="getURL(java.lang.String,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURL</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.532">getURL</a>&#8203;(java.lang.String&nbsp;context,
java.lang.String&nbsp;pageName,
java.lang.String&nbsp;params)</pre>
<div class="block">Returns an URL if a WikiContext is not available.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getURL(java.lang.String,java.lang.String,java.lang.String)">getURL</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - The WikiContext (VIEW, EDIT, etc...)</dd>
<dd><code>pageName</code> - Name of the page, as usual</dd>
<dd><code>params</code> - List of parameters. May be null, if no parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An URL (absolute or relative).</dd>
</dl>
</li>
</ul>
<a id="getFrontPage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrontPage</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.542">getFrontPage</a>()</pre>
<div class="block">Returns the default front page, if no page is used.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getFrontPage()">getFrontPage</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The front page name.</dd>
</dl>
</li>
</ul>
<a id="getServletContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletContext</h4>
<pre class="methodSignature">public&nbsp;javax.servlet.ServletContext&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.548">getServletContext</a>()</pre>
<div class="block">Returns the ServletContext that this particular Engine was initialized with. <strong>It may return <code>null</code></strong>,
if the Engine is not running inside a servlet container!</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getServletContext()">getServletContext</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ServletContext of the Engine, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="getAllInterWikiLinks()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllInterWikiLinks</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;java.lang.String&gt;&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.554">getAllInterWikiLinks</a>()</pre>
<div class="block">Returns a collection of all supported InterWiki links.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getAllInterWikiLinks()">getAllInterWikiLinks</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A Collection of Strings.</dd>
</dl>
</li>
</ul>
<a id="getAllInlinedImagePatterns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllInlinedImagePatterns</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;java.lang.String&gt;&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.568">getAllInlinedImagePatterns</a>()</pre>
<div class="block">Returns a collection of all image types that get inlined.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getAllInlinedImagePatterns()">getAllInlinedImagePatterns</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A Collection of Strings with a regexp pattern.</dd>
</dl>
</li>
</ul>
<a id="getSpecialPageReference(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSpecialPageReference</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.586">getSpecialPageReference</a>&#8203;(java.lang.String&nbsp;original)</pre>
<div class="block"><p>If the page is a special page, then returns a direct URL to that page. Otherwise returns <code>null</code>.
This method delegates requests to <a href="ui/CommandResolver.html#getSpecialPageReference(java.lang.String)"><code>CommandResolver.getSpecialPageReference(String)</code></a>.</p>
<p>Special pages are defined in jspwiki.properties using the jspwiki.specialPage setting. They're typically used to give Wiki page
names to e.g. custom JSP pages.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getSpecialPageReference(java.lang.String)">getSpecialPageReference</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>original</code> - The page to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A reference to the page, or null, if there's no special page.</dd>
</dl>
</li>
</ul>
<a id="getApplicationName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.592">getApplicationName</a>()</pre>
<div class="block">Returns the name of the application.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getApplicationName()">getApplicationName</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A string describing the name of this application.</dd>
</dl>
</li>
</ul>
<a id="getFinalPageName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFinalPageName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.599">getFinalPageName</a>&#8203;(java.lang.String&nbsp;page)
throws <a href="api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</a></pre>
<div class="block">Returns the correct page name, or null, if no such page can be found. Aliases are considered. This method simply delegates to
<a href="ui/CommandResolver.html#getFinalPageName(java.lang.String)"><code>CommandResolver.getFinalPageName(String)</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getFinalPageName(java.lang.String)">getFinalPageName</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>page</code> - Page name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The rewritten page name, or null, if the page does not exist.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</a></code> - If something goes wrong in the backend.</dd>
</dl>
</li>
</ul>
<a id="encodeName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.605">encodeName</a>&#8203;(java.lang.String&nbsp;pagename)</pre>
<div class="block">Turns a WikiName into something that can be called through using an URL.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#encodeName(java.lang.String)">encodeName</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pagename</code> - A name. Can be actually any string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A properly encoded name.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="api/core/Engine.html#decodeName(java.lang.String)"><code>Engine.decodeName(String)</code></a></dd>
</dl>
</li>
</ul>
<a id="decodeName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.615">decodeName</a>&#8203;(java.lang.String&nbsp;pagerequest)</pre>
<div class="block">Decodes a URL-encoded request back to regular life. This properly heeds the encoding as defined in the settings file.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#decodeName(java.lang.String)">decodeName</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pagerequest</code> - The URL-encoded string to decode</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A decoded string.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="api/core/Engine.html#encodeName(java.lang.String)"><code>Engine.encodeName(String)</code></a></dd>
</dl>
</li>
</ul>
<a id="getContentEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentEncoding</h4>
<pre class="methodSignature">public&nbsp;java.nio.charset.Charset&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.625">getContentEncoding</a>()</pre>
<div class="block">Returns the IANA name of the character set encoding we're supposed to be using right now.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getContentEncoding()">getContentEncoding</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The content encoding (either UTF-8 or ISO-8859-1).</dd>
</dl>
</li>
</ul>
<a id="shutdown()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdown</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.638">shutdown</a>()</pre>
<div class="block">Signals that the <code>Engine</code> will be shut down by the servlet container.
<p>It is called by <a href="WikiServlet.html#destroy()"><code>WikiServlet.destroy()</code></a>. When this method is called, it fires a "shutdown" WikiEngineEvent to
all registered listeners.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#shutdown()">shutdown</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
</dl>
</li>
</ul>
<a id="getTemplateManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemplateManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="ui/TemplateManager.html" title="interface in org.apache.wiki.ui">TemplateManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.652">getTemplateManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( TemplateManager.class )</code> instead.</div>
</div>
<div class="block">Returns the current TemplateManager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A TemplateManager instance.</dd>
</dl>
</li>
</ul>
<a id="getWorkflowManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkflowManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="workflow/WorkflowManager.html" title="interface in org.apache.wiki.workflow">WorkflowManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.664">getWorkflowManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( WorkflowManager.class )</code> instead.</div>
</div>
<div class="block">Returns the <a href="workflow/WorkflowManager.html" title="interface in org.apache.wiki.workflow"><code>WorkflowManager</code></a> associated with this WikiEngine. If the WikiEngine has not been
initialized, this method will return <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the task queue</dd>
</dl>
</li>
</ul>
<a id="getReferenceManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReferenceManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="references/ReferenceManager.html" title="interface in org.apache.wiki.references">ReferenceManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.676">getReferenceManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( ReferenceManager.class )</code> instead.</div>
</div>
<div class="block">Returns this object's ReferenceManager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current ReferenceManager instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.1</dd>
</dl>
</li>
</ul>
<a id="getRenderingManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRenderingManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="render/RenderingManager.html" title="interface in org.apache.wiki.render">RenderingManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.688">getRenderingManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( RenderingManager.class )</code> instead.</div>
</div>
<div class="block">Returns the current rendering manager for this wiki application.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A RenderingManager object.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.3.27</dd>
</dl>
</li>
</ul>
<a id="getPluginManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="plugin/PluginManager.html" title="interface in org.apache.wiki.plugin">PluginManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.700">getPluginManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( PluginManager.class )</code> instead.</div>
</div>
<div class="block">Returns the current plugin manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current PluginManager instance</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.1</dd>
</dl>
</li>
</ul>
<a id="getVariableManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariableManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="variables/VariableManager.html" title="interface in org.apache.wiki.variables">VariableManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.711">getVariableManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( VariableManager.class )</code> instead.</div>
</div>
<div class="block">Returns the current variable manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current VariableManager.</dd>
</dl>
</li>
</ul>
<a id="getPageManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="pages/PageManager.html" title="interface in org.apache.wiki.pages">PageManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.722">getPageManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( PageManager.class )</code> instead.</div>
</div>
<div class="block">Returns the current PageManager which is responsible for storing and managing WikiPages.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current PageManager instance.</dd>
</dl>
</li>
</ul>
<a id="getCommandResolver()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCommandResolver</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="ui/CommandResolver.html" title="interface in org.apache.wiki.ui">CommandResolver</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.733">getCommandResolver</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( CommandResolver.class )</code> instead.</div>
</div>
<div class="block">Returns the CommandResolver for this wiki engine.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resolver</dd>
</dl>
</li>
</ul>
<a id="getAttachmentManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachmentManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="attachment/AttachmentManager.html" title="interface in org.apache.wiki.attachment">AttachmentManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.745">getAttachmentManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AttachmentManager.class )</code> instead.</div>
</div>
<div class="block">Returns the current AttachmentManager, which is responsible for storing and managing attachments.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current AttachmentManager instance</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.9.31.</dd>
</dl>
</li>
</ul>
<a id="getAuthorizationManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthorizationManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="auth/AuthorizationManager.html" title="interface in org.apache.wiki.auth">AuthorizationManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.756">getAuthorizationManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AuthorizationManager.class )</code> instead.</div>
</div>
<div class="block">Returns the currently used authorization manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current AuthorizationManager instance.</dd>
</dl>
</li>
</ul>
<a id="getAuthenticationManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticationManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="auth/AuthenticationManager.html" title="interface in org.apache.wiki.auth">AuthenticationManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.767">getAuthenticationManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AuthenticationManager.class )</code> instead.</div>
</div>
<div class="block">Returns the currently used authentication manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current AuthenticationManager instance.</dd>
</dl>
</li>
</ul>
<a id="getFilterManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="filters/FilterManager.html" title="interface in org.apache.wiki.filters">FilterManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.779">getFilterManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( FilterManager.class )</code> instead.</div>
</div>
<div class="block">Returns the manager responsible for the filters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current FilterManager instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1.88</dd>
</dl>
</li>
</ul>
<a id="getSearchManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSearchManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="search/SearchManager.html" title="interface in org.apache.wiki.search">SearchManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.791">getSearchManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( SearchManager.class )</code> instead.</div>
</div>
<div class="block">Returns the manager responsible for searching the Wiki.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current SearchManager instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2.21</dd>
</dl>
</li>
</ul>
<a id="getProgressManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProgressManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="ui/progress/ProgressManager.html" title="interface in org.apache.wiki.ui.progress">ProgressManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.803">getProgressManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( ProgressManager.class )</code> instead.</div>
</div>
<div class="block">Returns the progress manager we're using</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A ProgressManager.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.6</dd>
</dl>
</li>
</ul>
<a id="getRootPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootPath</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.809">getRootPath</a>()</pre>
<div class="block">Returns the root path. The root path is where the Engine is located in the file system.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getRootPath()">getRootPath</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A path to where the Wiki is installed in the local filesystem.</dd>
</dl>
</li>
</ul>
<a id="getURLConstructor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURLConstructor</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="url/URLConstructor.html" title="interface in org.apache.wiki.url">URLConstructor</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.819">getURLConstructor</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( URLConstructor.class )</code> instead.</div>
</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URL constructor.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2.6</dd>
</dl>
</li>
</ul>
<a id="getRSSGenerator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRSSGenerator</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="rss/RSSGenerator.html" title="interface in org.apache.wiki.rss">RSSGenerator</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.832">getRSSGenerator</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( RSSGenerator.class )</code> instead.</div>
</div>
<div class="block">Returns the RSSGenerator. If the property <code>jspwiki.rss.generate</code> has not been set to <code>true</code>, this method
will return <code>null</code>, <em>and callers should check for this value.</em></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the RSS generator</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1.165</dd>
</dl>
</li>
</ul>
<a id="getPageRenamer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageRenamer</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="content/PageRenamer.html" title="interface in org.apache.wiki.content">PageRenamer</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.844">getPageRenamer</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( PageRenamer.class )</code> instead.</div>
</div>
<div class="block">Returns the PageRenamer employed by this WikiEngine.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current PageRenamer instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.5.141</dd>
</dl>
</li>
</ul>
<a id="getUserManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="auth/UserManager.html" title="interface in org.apache.wiki.auth">UserManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.856">getUserManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( UserManager.class )</code> instead.</div>
</div>
<div class="block">Returns the UserManager employed by this WikiEngine.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current UserManager instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.3</dd>
</dl>
</li>
</ul>
<a id="getTasksManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTasksManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="tasks/TasksManager.html" title="interface in org.apache.wiki.tasks">TasksManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.867">getTasksManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( TaskManager.class )</code> instead.</div>
</div>
<div class="block">Returns the TasksManager employed by this WikiEngine.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current TasksManager instance.</dd>
</dl>
</li>
</ul>
<a id="getGroupManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="auth/authorize/GroupManager.html" title="interface in org.apache.wiki.auth.authorize">GroupManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.879">getGroupManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( GroupManager.class )</code> instead.</div>
</div>
<div class="block">Returns the GroupManager employed by this WikiEngine.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current GroupManager instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.3</dd>
</dl>
</li>
</ul>
<a id="getAdminBeanManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdminBeanManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="ui/admin/AdminBeanManager.html" title="interface in org.apache.wiki.ui.admin">AdminBeanManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.891">getAdminBeanManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AdminBeanManager.class )</code> instead.</div>
</div>
<div class="block">Returns the current <a href="ui/admin/AdminBeanManager.html" title="interface in org.apache.wiki.ui.admin"><code>AdminBeanManager</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current <a href="ui/admin/AdminBeanManager.html" title="interface in org.apache.wiki.ui.admin"><code>AdminBeanManager</code></a>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.6</dd>
</dl>
</li>
</ul>
<a id="getAclManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAclManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="auth/acl/AclManager.html" title="interface in org.apache.wiki.auth.acl">AclManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.906">getAclManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( AclManager.class )</code> instead.</div>
</div>
<div class="block">Returns the AclManager employed by this WikiEngine. The AclManager is lazily initialized.
<p>
The AclManager implementing class may be set by the System property <a href="api/core/Engine.html#PROP_ACL_MANAGER_IMPL"><code>Engine.PROP_ACL_MANAGER_IMPL</code></a>.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current AclManager.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.3</dd>
</dl>
</li>
</ul>
<a id="getDifferenceManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDifferenceManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="diff/DifferenceManager.html" title="interface in org.apache.wiki.diff">DifferenceManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.917">getDifferenceManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( DifferenceManager.class )</code> instead.</div>
</div>
<div class="block">Returns the DifferenceManager so that texts can be compared.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the difference manager.</dd>
</dl>
</li>
</ul>
<a id="getEditorManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEditorManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="ui/EditorManager.html" title="interface in org.apache.wiki.ui">EditorManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.928">getEditorManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( EditorManager.class )</code> instead.</div>
</div>
<div class="block">Returns the current EditorManager instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current EditorManager.</dd>
</dl>
</li>
</ul>
<a id="getInternationalizationManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInternationalizationManager</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="i18n/InternationalizationManager.html" title="interface in org.apache.wiki.i18n">InternationalizationManager</a>&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.939">getInternationalizationManager</a>()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <code>getManager( InternationalizationManager.class )</code> instead.</div>
</div>
<div class="block">Returns the current i18n manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current Intertan... Interante... Internatatializ... Whatever.</dd>
</dl>
</li>
</ul>
<a id="addWikiEventListener(org.apache.wiki.event.WikiEventListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addWikiEventListener</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.945">addWikiEventListener</a>&#8203;(<a href="event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</a>&nbsp;listener)</pre>
<div class="block">Registers a WikiEventListener with this instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#addWikiEventListener(org.apache.wiki.event.WikiEventListener)">addWikiEventListener</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the event listener</dd>
</dl>
</li>
</ul>
<a id="removeWikiEventListener(org.apache.wiki.event.WikiEventListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeWikiEventListener</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.951">removeWikiEventListener</a>&#8203;(<a href="event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</a>&nbsp;listener)</pre>
<div class="block">Un-registers a WikiEventListener with this instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#removeWikiEventListener(org.apache.wiki.event.WikiEventListener)">removeWikiEventListener</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the event listener</dd>
</dl>
</li>
</ul>
<a id="fireEvent(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fireEvent</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.961">fireEvent</a>&#8203;(int&nbsp;type)</pre>
<div class="block">Fires a WikiEngineEvent to all registered listeners.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the event type</dd>
</dl>
</li>
</ul>
<a id="firePageEvent(int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>firePageEvent</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.972">firePageEvent</a>&#8203;(int&nbsp;type,
java.lang.String&nbsp;pageName)</pre>
<div class="block">Fires a WikiPageEvent to all registered listeners.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the event type</dd>
</dl>
</li>
</ul>
<a id="setAttribute(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.979">setAttribute</a>&#8203;(java.lang.String&nbsp;key,
java.lang.Object&nbsp;value)</pre>
<div class="block">Adds an attribute to the engine for the duration of this engine. The value is not persisted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#setAttribute(java.lang.String,java.lang.Object)">setAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the attribute name</dd>
<dd><code>value</code> - the value</dd>
</dl>
</li>
</ul>
<a id="getAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttribute</h4>
<pre class="methodSignature">public&nbsp;&lt;T&gt;&nbsp;T&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.985">getAttribute</a>&#8203;(java.lang.String&nbsp;key)</pre>
<div class="block">Gets an attribute from the engine.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#getAttribute(java.lang.String)">getAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the attribute name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value</dd>
</dl>
</li>
</ul>
<a id="removeAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeAttribute</h4>
<pre class="methodSignature">public&nbsp;&lt;T&gt;&nbsp;T&nbsp;<a href="../../../src-html/org/apache/wiki/WikiEngine.html#line.992">removeAttribute</a>&#8203;(java.lang.String&nbsp;key)</pre>
<div class="block">Removes an attribute.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="api/core/Engine.html#removeAttribute(java.lang.String)">removeAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="api/core/Engine.html" title="interface in org.apache.wiki.api.core">Engine</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The key of the attribute to remove.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The previous attribute, if it existed.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WikiEngine.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" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright (c) 2001-2023 The Apache Software Foundation. All rights reserved.</small></p>
</footer>
</body>
</html>