blob: efe3633eb074ca4cb9b5c07be0901ea6b6f19110 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Overview (Apache JSPWiki 2.12.0-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="Overview (Apache JSPWiki 2.12.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>
<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>
<div class="header">
<h1 class="title">Apache JSPWiki 2.12.0-SNAPSHOT API</h1>
</div>
<main role="main">
<div class="contentContainer">
<object type="image/svg+xml" data="package-dependencies.svg" style="display:block;margin-left:auto;margin-right:auto;max-width:95%;"></object>
<table class="overviewSummary">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor" id="i0">
<th class="colFirst" scope="row"><a href="org/apache/wiki/package-summary.html">org.apache.wiki</a></th>
<td class="colLast">
<div class="block">The chief package of JSPWiki.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<th class="colFirst" scope="row"><a href="org/apache/wiki/ajax/package-summary.html">org.apache.wiki.ajax</a></th>
<td class="colLast">
<div class="block">AJAX support classes.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<th class="colFirst" scope="row"><a href="org/apache/wiki/api/package-summary.html">org.apache.wiki.api</a></th>
<td class="colLast">
<div class="block">JSPWiki's API package.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<th class="colFirst" scope="row"><a href="org/apache/wiki/api/core/package-summary.html">org.apache.wiki.api.core</a></th>
<td class="colLast">
<div class="block">JSPWiki's central API.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<th class="colFirst" scope="row"><a href="org/apache/wiki/api/engine/package-summary.html">org.apache.wiki.api.engine</a></th>
<td class="colLast">
<div class="block">JSPWiki's Engine's component related classes.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<th class="colFirst" scope="row"><a href="org/apache/wiki/api/exceptions/package-summary.html">org.apache.wiki.api.exceptions</a></th>
<td class="colLast">
<div class="block">JSPWiki's API exceptions package.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<th class="colFirst" scope="row"><a href="org/apache/wiki/api/filters/package-summary.html">org.apache.wiki.api.filters</a></th>
<td class="colLast">
<div class="block">Filter's API package of JSPWiki.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<th class="colFirst" scope="row"><a href="org/apache/wiki/api/plugin/package-summary.html">org.apache.wiki.api.plugin</a></th>
<td class="colLast">
<div class="block">Plugin's API package of JSPWiki.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<th class="colFirst" scope="row"><a href="org/apache/wiki/api/providers/package-summary.html">org.apache.wiki.api.providers</a></th>
<td class="colLast">
<div class="block">Page Providers' API package of JSPWiki.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<th class="colFirst" scope="row"><a href="org/apache/wiki/api/search/package-summary.html">org.apache.wiki.api.search</a></th>
<td class="colLast">
<div class="block">Search's API package of JSPWiki.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<th class="colFirst" scope="row"><a href="org/apache/wiki/api/spi/package-summary.html">org.apache.wiki.api.spi</a></th>
<td class="colLast">
<div class="block">JSPWiki's SPI package.</div>
</td>
</tr>
<tr class="rowColor" id="i11">
<th class="colFirst" scope="row"><a href="org/apache/wiki/attachment/package-summary.html">org.apache.wiki.attachment</a></th>
<td class="colLast">
<div class="block">Attachment management, uploading and downloading.</div>
</td>
</tr>
<tr class="altColor" id="i12">
<th class="colFirst" scope="row"><a href="org/apache/wiki/auth/package-summary.html">org.apache.wiki.auth</a></th>
<td class="colLast">
<div class="block">Authentication, Authorization and the third A thing.</div>
</td>
</tr>
<tr class="rowColor" id="i13">
<th class="colFirst" scope="row"><a href="org/apache/wiki/auth/acl/package-summary.html">org.apache.wiki.auth.acl</a></th>
<td class="colLast">
<div class="block">Access Control List implementation.</div>
</td>
</tr>
<tr class="altColor" id="i14">
<th class="colFirst" scope="row"><a href="org/apache/wiki/auth/authorize/package-summary.html">org.apache.wiki.auth.authorize</a></th>
<td class="colLast">
<div class="block">Authorizer implementation.</div>
</td>
</tr>
<tr class="rowColor" id="i15">
<th class="colFirst" scope="row"><a href="org/apache/wiki/auth/login/package-summary.html">org.apache.wiki.auth.login</a></th>
<td class="colLast">
<div class="block">Provides the different login modules that JSPWiki uses.</div>
</td>
</tr>
<tr class="altColor" id="i16">
<th class="colFirst" scope="row"><a href="org/apache/wiki/auth/permissions/package-summary.html">org.apache.wiki.auth.permissions</a></th>
</tr>
<tr class="rowColor" id="i17">
<th class="colFirst" scope="row"><a href="org/apache/wiki/auth/user/package-summary.html">org.apache.wiki.auth.user</a></th>
</tr>
<tr class="altColor" id="i18">
<th class="colFirst" scope="row"><a href="org/apache/wiki/bootstrap/package-summary.html">org.apache.wiki.bootstrap</a></th>
<td class="colLast">
<div class="block">JSPWiki's Bootstrapping procedures package.</div>
</td>
</tr>
<tr class="rowColor" id="i19">
<th class="colFirst" scope="row"><a href="org/apache/wiki/cache/package-summary.html">org.apache.wiki.cache</a></th>
<td class="colLast">
<div class="block">Provides a cache abstraction for JSPWiki.</div>
</td>
</tr>
<tr class="altColor" id="i20">
<th class="colFirst" scope="row"><a href="org/apache/wiki/content/package-summary.html">org.apache.wiki.content</a></th>
<td class="colLast">
<div class="block">Provides content management functionality for JSPWiki.</div>
</td>
</tr>
<tr class="rowColor" id="i21">
<th class="colFirst" scope="row"><a href="org/apache/wiki/diff/package-summary.html">org.apache.wiki.diff</a></th>
</tr>
<tr class="altColor" id="i22">
<th class="colFirst" scope="row"><a href="org/apache/wiki/event/package-summary.html">org.apache.wiki.event</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i23">
<th class="colFirst" scope="row"><a href="org/apache/wiki/filters/package-summary.html">org.apache.wiki.filters</a></th>
<td class="colLast">
<div class="block">Provides page and content filtering functionality for JSPWiki.</div>
</td>
</tr>
<tr class="altColor" id="i24">
<th class="colFirst" scope="row"><a href="org/apache/wiki/forms/package-summary.html">org.apache.wiki.forms</a></th>
<td class="colLast">
<div class="block">Contains classes for doing form handling within JSPWiki.</div>
</td>
</tr>
<tr class="rowColor" id="i25">
<th class="colFirst" scope="row"><a href="org/apache/wiki/htmltowiki/package-summary.html">org.apache.wiki.htmltowiki</a></th>
<td class="colLast">
<div class="block">HTML to wiki syntax translation related classes.</div>
</td>
</tr>
<tr class="altColor" id="i26">
<th class="colFirst" scope="row"><a href="org/apache/wiki/htmltowiki/syntax/package-summary.html">org.apache.wiki.htmltowiki.syntax</a></th>
<td class="colLast">
<div class="block">Package Specification</div>
</td>
</tr>
<tr class="rowColor" id="i27">
<th class="colFirst" scope="row"><a href="org/apache/wiki/htmltowiki/syntax/jspwiki/package-summary.html">org.apache.wiki.htmltowiki.syntax.jspwiki</a></th>
<td class="colLast">
<div class="block">JSPWiki syntax decoration related classes.</div>
</td>
</tr>
<tr class="altColor" id="i28">
<th class="colFirst" scope="row"><a href="org/apache/wiki/htmltowiki/syntax/markdown/package-summary.html">org.apache.wiki.htmltowiki.syntax.markdown</a></th>
<td class="colLast">
<div class="block">Markdown syntax decoration related classes.</div>
</td>
</tr>
<tr class="rowColor" id="i29">
<th class="colFirst" scope="row"><a href="org/apache/wiki/http/filter/package-summary.html">org.apache.wiki.http.filter</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i30">
<th class="colFirst" scope="row"><a href="org/apache/wiki/i18n/package-summary.html">org.apache.wiki.i18n</a></th>
<td class="colLast">
<div class="block">I18n related classes.</div>
</td>
</tr>
<tr class="rowColor" id="i31">
<th class="colFirst" scope="row"><a href="org/apache/wiki/its/package-summary.html">org.apache.wiki.its</a></th>
<td class="colLast">
<div class="block">JSPWiki functional tests.</div>
</td>
</tr>
<tr class="altColor" id="i32">
<th class="colFirst" scope="row"><a href="org/apache/wiki/its/environment/package-summary.html">org.apache.wiki.its.environment</a></th>
<td class="colLast">
<div class="block">Tests' environment values that can be overwritten through System properties.</div>
</td>
</tr>
<tr class="rowColor" id="i33">
<th class="colFirst" scope="row"><a href="org/apache/wiki/management/package-summary.html">org.apache.wiki.management</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i34">
<th class="colFirst" scope="row"><a href="org/apache/wiki/markdown/package-summary.html">org.apache.wiki.markdown</a></th>
<td class="colLast">
<div class="block">Entry point for JSPWiki Flexmark's custom extensions.</div>
</td>
</tr>
<tr class="rowColor" id="i35">
<th class="colFirst" scope="row"><a href="org/apache/wiki/markdown/extensions/jspwikilinks/attributeprovider/package-summary.html">org.apache.wiki.markdown.extensions.jspwikilinks.attributeprovider</a></th>
<td class="colLast">
<div class="block">Wikilinks' attributes custom decoration.</div>
</td>
</tr>
<tr class="altColor" id="i36">
<th class="colFirst" scope="row"><a href="org/apache/wiki/markdown/extensions/jspwikilinks/postprocessor/package-summary.html">org.apache.wiki.markdown.extensions.jspwikilinks.postprocessor</a></th>
<td class="colLast">
<div class="block">Wikilinks' nodes custom post processing.</div>
</td>
</tr>
<tr class="rowColor" id="i37">
<th class="colFirst" scope="row"><a href="org/apache/wiki/markdown/nodes/package-summary.html">org.apache.wiki.markdown.nodes</a></th>
<td class="colLast">
<div class="block">Custom Flexmark node's to handle special JSPWiki elements.</div>
</td>
</tr>
<tr class="altColor" id="i38">
<th class="colFirst" scope="row"><a href="org/apache/wiki/markdown/renderer/package-summary.html">org.apache.wiki.markdown.renderer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i39">
<th class="colFirst" scope="row"><a href="org/apache/wiki/modules/package-summary.html">org.apache.wiki.modules</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i40">
<th class="colFirst" scope="row"><a href="org/apache/wiki/pages/package-summary.html">org.apache.wiki.pages</a></th>
<td class="colLast">
<div class="block">Entry point for JSPWiki's Page Objects.</div>
</td>
</tr>
<tr class="rowColor" id="i41">
<th class="colFirst" scope="row"><a href="org/apache/wiki/pages/haddock/package-summary.html">org.apache.wiki.pages.haddock</a></th>
<td class="colLast">
<div class="block">JSPWiki Haddock's Page Objects.</div>
</td>
</tr>
<tr class="altColor" id="i42">
<th class="colFirst" scope="row"><a href="org/apache/wiki/parser/package-summary.html">org.apache.wiki.parser</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i43">
<th class="colFirst" scope="row"><a href="org/apache/wiki/parser/markdown/package-summary.html">org.apache.wiki.parser.markdown</a></th>
<td class="colLast">
<div class="block">Markdown parsing.</div>
</td>
</tr>
<tr class="altColor" id="i44">
<th class="colFirst" scope="row"><a href="org/apache/wiki/plugin/package-summary.html">org.apache.wiki.plugin</a></th>
<td class="colLast">
<div class="block">Provides plugins to the JSPWiki.</div>
</td>
</tr>
<tr class="rowColor" id="i45">
<th class="colFirst" scope="row"><a href="org/apache/wiki/preferences/package-summary.html">org.apache.wiki.preferences</a></th>
<td class="colLast">
<div class="block">Preferences storage.</div>
</td>
</tr>
<tr class="altColor" id="i46">
<th class="colFirst" scope="row"><a href="org/apache/wiki/providers/package-summary.html">org.apache.wiki.providers</a></th>
<td class="colLast">
<div class="block">Provides storage for JSPWiki.</div>
</td>
</tr>
<tr class="rowColor" id="i47">
<th class="colFirst" scope="row"><a href="org/apache/wiki/references/package-summary.html">org.apache.wiki.references</a></th>
<td class="colLast">
<div class="block">Provides the JSPWiki track of pages' references.</div>
</td>
</tr>
<tr class="altColor" id="i48">
<th class="colFirst" scope="row"><a href="org/apache/wiki/render/package-summary.html">org.apache.wiki.render</a></th>
<td class="colLast">
<div class="block">Provides the JSPWiki rendering functionality.</div>
</td>
</tr>
<tr class="rowColor" id="i49">
<th class="colFirst" scope="row"><a href="org/apache/wiki/render/markdown/package-summary.html">org.apache.wiki.render.markdown</a></th>
<td class="colLast">
<div class="block">Markdown rendering.</div>
</td>
</tr>
<tr class="altColor" id="i50">
<th class="colFirst" scope="row"><a href="org/apache/wiki/rpc/atom/package-summary.html">org.apache.wiki.rpc.atom</a></th>
<td class="colLast">
<div class="block">Provides the JSPWiki ATOM API functionality.</div>
</td>
</tr>
<tr class="rowColor" id="i51">
<th class="colFirst" scope="row"><a href="org/apache/wiki/rss/package-summary.html">org.apache.wiki.rss</a></th>
<td class="colLast">
<div class="block">Provides the JSPWiki RSS feeds functionality.</div>
</td>
</tr>
<tr class="altColor" id="i52">
<th class="colFirst" scope="row"><a href="org/apache/wiki/search/package-summary.html">org.apache.wiki.search</a></th>
<td class="colLast">
<div class="block">Provides the JSPWiki search functionality.</div>
</td>
</tr>
<tr class="rowColor" id="i53">
<th class="colFirst" scope="row"><a href="org/apache/wiki/search/kendra/package-summary.html">org.apache.wiki.search.kendra</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i54">
<th class="colFirst" scope="row"><a href="org/apache/wiki/search/tika/package-summary.html">org.apache.wiki.search.tika</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i55">
<th class="colFirst" scope="row"><a href="org/apache/wiki/spi/package-summary.html">org.apache.wiki.spi</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i56">
<th class="colFirst" scope="row"><a href="org/apache/wiki/tags/package-summary.html">org.apache.wiki.tags</a></th>
<td class="colLast">
<div class="block">Provides standard JSP tags for JSPWiki.</div>
</td>
</tr>
<tr class="rowColor" id="i57">
<th class="colFirst" scope="row"><a href="org/apache/wiki/tasks/package-summary.html">org.apache.wiki.tasks</a></th>
<td class="colLast">
<div class="block">Provides specific tasks for JSPWiki, meant to be executed by the workflow framework.</div>
</td>
</tr>
<tr class="altColor" id="i58">
<th class="colFirst" scope="row"><a href="org/apache/wiki/tasks/auth/package-summary.html">org.apache.wiki.tasks.auth</a></th>
<td class="colLast">
<div class="block">Provides auth-related Tasks, meant to be executed by the workflow framework.</div>
</td>
</tr>
<tr class="rowColor" id="i59">
<th class="colFirst" scope="row"><a href="org/apache/wiki/tasks/pages/package-summary.html">org.apache.wiki.tasks.pages</a></th>
<td class="colLast">
<div class="block">Provides WikiPages' saving related Tasks, meant to be executed by the workflow framework.</div>
</td>
</tr>
<tr class="altColor" id="i60">
<th class="colFirst" scope="row"><a href="org/apache/wiki/ui/package-summary.html">org.apache.wiki.ui</a></th>
<td class="colLast">
<div class="block">Java classes for management of the JSP user interface.</div>
</td>
</tr>
<tr class="rowColor" id="i61">
<th class="colFirst" scope="row"><a href="org/apache/wiki/ui/admin/package-summary.html">org.apache.wiki.ui.admin</a></th>
<td class="colLast">
<div class="block">Contains classes for the JSPWiki administrative interface.</div>
</td>
</tr>
<tr class="altColor" id="i62">
<th class="colFirst" scope="row"><a href="org/apache/wiki/ui/admin/beans/package-summary.html">org.apache.wiki.ui.admin.beans</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i63">
<th class="colFirst" scope="row"><a href="org/apache/wiki/ui/progress/package-summary.html">org.apache.wiki.ui.progress</a></th>
<td class="colLast">
<div class="block">Provides progress management routines.</div>
</td>
</tr>
<tr class="altColor" id="i64">
<th class="colFirst" scope="row"><a href="org/apache/wiki/url/package-summary.html">org.apache.wiki.url</a></th>
<td class="colLast">
<div class="block">Provides the URL generation routines.</div>
</td>
</tr>
<tr class="rowColor" id="i65">
<th class="colFirst" scope="row"><a href="org/apache/wiki/util/package-summary.html">org.apache.wiki.util</a></th>
<td class="colLast">
<div class="block">Provides a number of utility libraries that are of general use.</div>
</td>
</tr>
<tr class="altColor" id="i66">
<th class="colFirst" scope="row"><a href="org/apache/wiki/util/comparators/package-summary.html">org.apache.wiki.util.comparators</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i67">
<th class="colFirst" scope="row"><a href="org/apache/wiki/variables/package-summary.html">org.apache.wiki.variables</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i68">
<th class="colFirst" scope="row"><a href="org/apache/wiki/workflow/package-summary.html">org.apache.wiki.workflow</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i69">
<th class="colFirst" scope="row"><a href="org/apache/wiki/xmlrpc/package-summary.html">org.apache.wiki.xmlrpc</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</main>
<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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright (c) 2001-2022 The Apache Software Foundation. All rights reserved.</small></p>
</footer>
</body>
</html>