http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/2e9374f1/apidocs/2.10.1/org/apache/wiki/PageManager.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/PageManager.html b/apidocs/2.10.1/org/apache/wiki/PageManager.html deleted file mode 100755 index 2366c51..0000000 --- a/apidocs/2.10.1/org/apache/wiki/PageManager.html +++ /dev/null @@ -1,1221 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.6.0_19) on Fri May 23 21:23:17 CEST 2014 --> -<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<TITLE> -PageManager (Apache JSPWiki Main War 2.10.1 API) -</TITLE> - -<META NAME="date" CONTENT="2014-05-23"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="PageManager (Apache JSPWiki Main War 2.10.1 API)"; - } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - -<!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PageManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki"><B>PREV CLASS</B></A> - <A HREF="../../../org/apache/wiki/PageManager.PreSaveWikiPageTask.html" title="class in org.apache.wiki"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?org/apache/wiki/PageManager.html" target="_top"><B>FRAMES</B></A> - <A HREF="PageManager.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> -<!-- ========= END OF TOP NAVBAR ========= --> - -<HR> -<!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -org.apache.wiki</FONT> -<BR> -Class PageManager</H2> -<PRE> -<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/apache/wiki/modules/ModuleManager.html" title="class in org.apache.wiki.modules">org.apache.wiki.modules.ModuleManager</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.wiki.PageManager</B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</A>, <A HREF="../../../org/apache/wiki/event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public class <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.73"><B>PageManager</B></A><DT>extends <A HREF="../../../org/apache/wiki/modules/ModuleManager.html" title="class in org.apache.wiki.modules">ModuleManager</A><DT>implements <A HREF="../../../org/apache/wiki/event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</A></DL> -</PRE> -<map id="APIVIZ" name="APIVIZ"> -<area shape="rect" id="node1" href="event/WikiEventListener.html" title="«interface» WikiEventListener (org.apache.wiki.event)" alt="" coords="5,6,160,69"/> -<area shape="rect" id="node2" href="modules/ModuleManager.html" title="ModuleManager (org.apache.wiki.modules)" alt="" coords="189,15,363,60"/> -<area shape="rect" id="node3" href="PageManager.html" title="PageManager" alt="" coords="128,109,229,137"/> -</map> -<div id="apivizContainer" style="text-align: center;"><img src="PageManager.png" usemap="#APIVIZ" border="0"></div> - -<P> -Manages the WikiPages. This class functions as an unified interface towards - the page providers. It handles initialization and management of the providers, - and provides utility methods for accessing the contents. - <p/> - Saving a page is a two-stage Task; first the pre-save operations and then the - actual save. See the descriptions of the tasks for further information. -<P> - -<P> -<DL> -<DT><B>Since:</B></DT> - <DD>2.0</DD> -</DL> -<HR> - -<P> -<!-- ======== NESTED CLASS SUMMARY ======== --> - -<A NAME="nested_class_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Nested Class Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static class</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.PreSaveWikiPageTask.html" title="class in org.apache.wiki">PageManager.PreSaveWikiPageTask</A></B></CODE> - -<BR> - Inner class that handles the page pre-save actions.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static class</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.SaveWikiPageTask.html" title="class in org.apache.wiki">PageManager.SaveWikiPageTask</A></B></CODE> - -<BR> - Inner class that handles the actual page save and post-save actions.</TD> -</TR> -</TABLE> - <!-- =========== FIELD SUMMARY =========== --> - -<A NAME="field_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Field Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#FACT_CURRENT_TEXT">FACT_CURRENT_TEXT</A></B></CODE> - -<BR> - Fact name for storing the current text.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#FACT_DIFF_TEXT">FACT_DIFF_TEXT</A></B></CODE> - -<BR> - Fact name for storing a diff text.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#FACT_IS_AUTHENTICATED">FACT_IS_AUTHENTICATED</A></B></CODE> - -<BR> - Fact name for storing whether the user is authenticated or not.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#FACT_PAGE_NAME">FACT_PAGE_NAME</A></B></CODE> - -<BR> - Fact name for storing the page name.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#FACT_PROPOSED_TEXT">FACT_PROPOSED_TEXT</A></B></CODE> - -<BR> - Fact name for storing the proposed (edited) text.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</A><<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#m_pageLocks">m_pageLocks</A></B></CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#PRESAVE_TASK_MESSAGE_KEY">PRESAVE_TASK_MESSAGE_KEY</A></B></CODE> - -<BR> - The message key for storing the text for the presave task.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#PRESAVE_WIKI_CONTEXT">PRESAVE_WIKI_CONTEXT</A></B></CODE> - -<BR> - The workflow attribute which stores the wikiContext.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#PROP_LOCKEXPIRY">PROP_LOCKEXPIRY</A></B></CODE> - -<BR> - The property value for setting the amount of time before the page locks expire.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#PROP_PAGEPROVIDER">PROP_PAGEPROVIDER</A></B></CODE> - -<BR> - The property value for setting the current page provider.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#PROP_USECACHE">PROP_USECACHE</A></B></CODE> - -<BR> - The property value for setting the cache on/off.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#SAVE_APPROVER">SAVE_APPROVER</A></B></CODE> - -<BR> - The name of the key from jspwiki.properties which defines who shall approve - the workflow of storing a wikipage.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#SAVE_DECISION_MESSAGE_KEY">SAVE_DECISION_MESSAGE_KEY</A></B></CODE> - -<BR> - The message key for storing the Decision text for saving a page.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#SAVE_REJECT_MESSAGE_KEY">SAVE_REJECT_MESSAGE_KEY</A></B></CODE> - -<BR> - The message key for rejecting the decision to save the page.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#SAVE_TASK_MESSAGE_KEY">SAVE_TASK_MESSAGE_KEY</A></B></CODE> - -<BR> - The message key of the text to finally approve a page save.</TD> -</TR> -</TABLE> - <A NAME="fields_inherited_from_class_org.apache.wiki.modules.ModuleManager"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Fields inherited from class org.apache.wiki.modules.<A HREF="../../../org/apache/wiki/modules/ModuleManager.html" title="class in org.apache.wiki.modules">ModuleManager</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="../../../org/apache/wiki/modules/ModuleManager.html#PLUGIN_RESOURCE_LOCATION">PLUGIN_RESOURCE_LOCATION</A></CODE></TD> -</TR> -</TABLE> - -<!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#PageManager(org.apache.wiki.WikiEngine, java.util.Properties)">PageManager</A></B>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props)</CODE> - -<BR> - Creates a new PageManager.</TD> -</TR> -</TABLE> - -<!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#actionPerformed(org.apache.wiki.event.WikiEvent)">actionPerformed</A></B>(<A HREF="../../../org/apache/wiki/event/WikiEvent.html" title="class in org.apache.wiki.event">WikiEvent</A> event)</CODE> - -<BR> - Listens for <A HREF="../../../org/apache/wiki/event/WikiSecurityEvent.html#PROFILE_NAME_CHANGED"><CODE>WikiSecurityEvent.PROFILE_NAME_CHANGED</CODE></A> - events.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#changeAcl(org.apache.wiki.WikiPage, java.security.Principal[], java.security.Principal)">changeAcl</A></B>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A>[] oldPrincipals, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A> newPrincipal)</CODE> - -<BR> - For a single wiki page, replaces all Acl entries matching a supplied array of Principals - with a new Principal.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#deletePage(org.apache.wiki.WikiPage)">deletePage</A></B>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page)</CODE> - -<BR> - Deletes an entire page, all versions, all traces.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#deleteVersion(org.apache.wiki.WikiPage)">deleteVersion</A></B>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page)</CODE> - -<BR> - Deletes only a specific version of a WikiPage.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#fireEvent(int, java.lang.String)">fireEvent</A></B>(int type, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pagename)</CODE> - -<BR> - Fires a WikiPageEvent of the provided type and page name - to all registered listeners.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getActiveLocks()">getActiveLocks</A></B>()</CODE> - -<BR> - Returns a list of currently applicable locks.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getAllPages()">getAllPages</A></B>()</CODE> - -<BR> - Returns all pages in some random order.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getCurrentLock(org.apache.wiki.WikiPage)">getCurrentLock</A></B>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page)</CODE> - -<BR> - Returns the current lock owner of a page.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getEngine()">getEngine</A></B>()</CODE> - -<BR> - Returns the WikiEngine to which this PageManager belongs to.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getPageInfo(java.lang.String, int)">getPageInfo</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName, - int version)</CODE> - -<BR> - Finds a WikiPage object describing a particular page and version.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getPageText(java.lang.String, int)">getPageText</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName, - int version)</CODE> - -<BR> - Fetches the page text from the repository.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../org/apache/wiki/providers/WikiPageProvider.html" title="interface in org.apache.wiki.providers">WikiPageProvider</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getProvider()">getProvider</A></B>()</CODE> - -<BR> - Returns the page provider currently in use.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getProviderDescription()">getProviderDescription</A></B>()</CODE> - -<BR> - Returns a human-readable description of the current provider.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getTotalPageCount()">getTotalPageCount</A></B>()</CODE> - -<BR> - Returns the total count of all pages in the repository.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#getVersionHistory(java.lang.String)">getVersionHistory</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName)</CODE> - -<BR> - Gets a version history of page.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#lockPage(org.apache.wiki.WikiPage, java.lang.String)">lockPage</A></B>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> user)</CODE> - -<BR> - Locks page for editing.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#modules()">modules</A></B>()</CODE> - -<BR> - Returns a collection of modules currently managed by this ModuleManager.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#pageExists(java.lang.String)">pageExists</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName)</CODE> - -<BR> - Returns true, if the page exists (any version).</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#pageExists(java.lang.String, int)">pageExists</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName, - int version)</CODE> - -<BR> - Checks for existence of a specific page and version.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#putPageText(org.apache.wiki.WikiPage, java.lang.String)">putPageText</A></B>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> content)</CODE> - -<BR> - Puts the page text into the repository.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/wiki/PageManager.html#unlockPage(org.apache.wiki.PageLock)">unlockPage</A></B>(<A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A> lock)</CODE> - -<BR> - Marks a page free to be written again.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_org.apache.wiki.modules.ModuleManager"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class org.apache.wiki.modules.<A HREF="../../../org/apache/wiki/modules/ModuleManager.html" title="class in org.apache.wiki.modules">ModuleManager</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="../../../org/apache/wiki/modules/ModuleManager.html#checkCompatibility(org.apache.wiki.modules.WikiModuleInfo)">checkCompatibility</A></CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/ lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - -<!-- ============ FIELD DETAIL =========== --> - -<A NAME="field_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Field Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="PROP_PAGEPROVIDER"><!-- --></A><H3> -PROP_PAGEPROVIDER</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.80"><B>PROP_PAGEPROVIDER</B></A></PRE> -<DL> -<DD>The property value for setting the current page provider. Value is "jspwiki.pageProvider". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.PROP_PAGEPROVIDER">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="PROP_USECACHE"><!-- --></A><H3> -PROP_USECACHE</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.85"><B>PROP_USECACHE</B></A></PRE> -<DL> -<DD>The property value for setting the cache on/off. Value is "jspwiki.usePageCache". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.PROP_USECACHE">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="PROP_LOCKEXPIRY"><!-- --></A><H3> -PROP_LOCKEXPIRY</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.90"><B>PROP_LOCKEXPIRY</B></A></PRE> -<DL> -<DD>The property value for setting the amount of time before the page locks expire. Value is "jspwiki.lockExpiryTime". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.PROP_LOCKEXPIRY">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="PRESAVE_TASK_MESSAGE_KEY"><!-- --></A><H3> -PRESAVE_TASK_MESSAGE_KEY</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.95"><B>PRESAVE_TASK_MESSAGE_KEY</B></A></PRE> -<DL> -<DD>The message key for storing the text for the presave task. Value is <tt>"task.preSaveWikiPage"</tt> -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.PRESAVE_TASK_MESSAGE_KEY">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="PRESAVE_WIKI_CONTEXT"><!-- --></A><H3> -PRESAVE_WIKI_CONTEXT</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.100"><B>PRESAVE_WIKI_CONTEXT</B></A></PRE> -<DL> -<DD>The workflow attribute which stores the wikiContext. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.PRESAVE_WIKI_CONTEXT">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="SAVE_APPROVER"><!-- --></A><H3> -SAVE_APPROVER</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.106"><B>SAVE_APPROVER</B></A></PRE> -<DL> -<DD>The name of the key from jspwiki.properties which defines who shall approve - the workflow of storing a wikipage. Value is <tt>"workflow.saveWikiPage"</tt> -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.SAVE_APPROVER">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="SAVE_DECISION_MESSAGE_KEY"><!-- --></A><H3> -SAVE_DECISION_MESSAGE_KEY</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.111"><B>SAVE_DECISION_MESSAGE_KEY</B></A></PRE> -<DL> -<DD>The message key for storing the Decision text for saving a page. Value is "decision.saveWikiPage". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.SAVE_DECISION_MESSAGE_KEY">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="SAVE_REJECT_MESSAGE_KEY"><!-- --></A><H3> -SAVE_REJECT_MESSAGE_KEY</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.116"><B>SAVE_REJECT_MESSAGE_KEY</B></A></PRE> -<DL> -<DD>The message key for rejecting the decision to save the page. Value is "notification.saveWikiPage.reject". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.SAVE_REJECT_MESSAGE_KEY">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="SAVE_TASK_MESSAGE_KEY"><!-- --></A><H3> -SAVE_TASK_MESSAGE_KEY</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.121"><B>SAVE_TASK_MESSAGE_KEY</B></A></PRE> -<DL> -<DD>The message key of the text to finally approve a page save. Value is "task.saveWikiPage". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.SAVE_TASK_MESSAGE_KEY">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="FACT_PAGE_NAME"><!-- --></A><H3> -FACT_PAGE_NAME</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.126"><B>FACT_PAGE_NAME</B></A></PRE> -<DL> -<DD>Fact name for storing the page name. Value is "fact.pageName". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.FACT_PAGE_NAME">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="FACT_DIFF_TEXT"><!-- --></A><H3> -FACT_DIFF_TEXT</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.131"><B>FACT_DIFF_TEXT</B></A></PRE> -<DL> -<DD>Fact name for storing a diff text. Value is "fact.diffText". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.FACT_DIFF_TEXT">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="FACT_CURRENT_TEXT"><!-- --></A><H3> -FACT_CURRENT_TEXT</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.136"><B>FACT_CURRENT_TEXT</B></A></PRE> -<DL> -<DD>Fact name for storing the current text. Value is "fact.currentText". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.FACT_CURRENT_TEXT">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="FACT_PROPOSED_TEXT"><!-- --></A><H3> -FACT_PROPOSED_TEXT</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.141"><B>FACT_PROPOSED_TEXT</B></A></PRE> -<DL> -<DD>Fact name for storing the proposed (edited) text. Value is "fact.proposedText". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.FACT_PROPOSED_TEXT">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="FACT_IS_AUTHENTICATED"><!-- --></A><H3> -FACT_IS_AUTHENTICATED</H3> -<PRE> -public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.146"><B>FACT_IS_AUTHENTICATED</B></A></PRE> -<DL> -<DD>Fact name for storing whether the user is authenticated or not. Value is "fact.isAuthenticated". -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.PageManager.FACT_IS_AUTHENTICATED">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="m_pageLocks"><!-- --></A><H3> -m_pageLocks</H3> -<PRE> -protected <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</A><<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A>> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.152"><B>m_pageLocks</B></A></PRE> -<DL> -<DL> -</DL> -</DL> - -<!-- ========= CONSTRUCTOR DETAIL ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="PageManager(org.apache.wiki.WikiEngine, java.util.Properties)"><!-- --></A><H3> -PageManager</H3> -<PRE> -public <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.167"><B>PageManager</B></A>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props) - throws <A HREF="../../../org/apache/wiki/api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</A></PRE> -<DL> -<DD>Creates a new PageManager. -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>engine</CODE> - WikiEngine instance<DD><CODE>props</CODE> - Properties to use for initialization -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</A></CODE> - If anything goes wrong, you get this.</DL> -</DL> - -<!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="getProvider()"><!-- --></A><H3> -getProvider</H3> -<PRE> -public <A HREF="../../../org/apache/wiki/providers/WikiPageProvider.html" title="interface in org.apache.wiki.providers">WikiPageProvider</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.215"><B>getProvider</B></A>()</PRE> -<DL> -<DD>Returns the page provider currently in use. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>A WikiPageProvider instance.</DL> -</DD> -</DL> -<HR> - -<A NAME="getAllPages()"><!-- --></A><H3> -getAllPages</H3> -<PRE> -public <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.227"><B>getAllPages</B></A>() - throws <A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></PRE> -<DL> -<DD>Returns all pages in some random order. If you need just the page names, - please see <A HREF="../../../org/apache/wiki/ReferenceManager.html#findCreated()"><CODE>ReferenceManager.findCreated()</CODE></A>, which is probably a lot - faster. This method may cause repository access. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>A Collection of WikiPage objects. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></CODE> - If the backend has problems.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPageText(java.lang.String, int)"><!-- --></A><H3> -getPageText</H3> -<PRE> -public <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.241"><B>getPageText</B></A>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName, - int version) - throws <A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></PRE> -<DL> -<DD>Fetches the page text from the repository. This method also does some sanity checks, - like checking for the pageName validity, etc. Also, if the page repository has been - modified externally, it is smart enough to handle such occurrences. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>pageName</CODE> - The name of the page to fetch.<DD><CODE>version</CODE> - The version to find -<DT><B>Returns:</B><DD>The page content as a raw string -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></CODE> - If the backend has issues.</DL> -</DD> -</DL> -<HR> - -<A NAME="getEngine()"><!-- --></A><H3> -getEngine</H3> -<PRE> -public <A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.284"><B>getEngine</B></A>()</PRE> -<DL> -<DD>Returns the WikiEngine to which this PageManager belongs to. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The WikiEngine object.</DL> -</DD> -</DL> -<HR> - -<A NAME="putPageText(org.apache.wiki.WikiPage, java.lang.String)"><!-- --></A><H3> -putPageText</H3> -<PRE> -public void <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.296"><B>putPageText</B></A>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> content) - throws <A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></PRE> -<DL> -<DD>Puts the page text into the repository. Note that this method does NOT update - JSPWiki internal data structures, and therefore you should always use WikiEngine.saveText() -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>page</CODE> - Page to save<DD><CODE>content</CODE> - Wikimarkup to save -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></CODE> - If something goes wrong in the saving phase</DL> -</DD> -</DL> -<HR> - -<A NAME="lockPage(org.apache.wiki.WikiPage, java.lang.String)"><!-- --></A><H3> -lockPage</H3> -<PRE> -public <A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.313"><B>lockPage</B></A>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> user)</PRE> -<DL> -<DD>Locks page for editing. Note, however, that the PageManager - will in no way prevent you from actually editing this page; - the lock is just for information. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>page</CODE> - WikiPage to lock<DD><CODE>user</CODE> - Username to use for locking -<DT><B>Returns:</B><DD>null, if page could not be locked.</DL> -</DD> -</DL> -<HR> - -<A NAME="unlockPage(org.apache.wiki.PageLock)"><!-- --></A><H3> -unlockPage</H3> -<PRE> -public void <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.353"><B>unlockPage</B></A>(<A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A> lock)</PRE> -<DL> -<DD>Marks a page free to be written again. If there has not been a lock, will fail quietly. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>lock</CODE> - A lock acquired in lockPage(). Safe to be null.</DL> -</DD> -</DL> -<HR> - -<A NAME="getCurrentLock(org.apache.wiki.WikiPage)"><!-- --></A><H3> -getCurrentLock</H3> -<PRE> -public <A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.373"><B>getCurrentLock</B></A>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page)</PRE> -<DL> -<DD>Returns the current lock owner of a page. If the page is not - locked, will return null. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>page</CODE> - The page to check the lock for -<DT><B>Returns:</B><DD>Current lock, or null, if there is no lock</DL> -</DD> -</DL> -<HR> - -<A NAME="getActiveLocks()"><!-- --></A><H3> -getActiveLocks</H3> -<PRE> -public <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki">PageLock</A>> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.391"><B>getActiveLocks</B></A>()</PRE> -<DL> -<DD>Returns a list of currently applicable locks. Note that by the time you get the list, - the locks may have already expired, so use this only for informational purposes. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>List of PageLock objects, detailing the locks. If no locks exist, returns - an empty list.<DT><B>Since:</B></DT> - <DD>2.0.22.</DD> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getPageInfo(java.lang.String, int)"><!-- --></A><H3> -getPageInfo</H3> -<PRE> -public <A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.412"><B>getPageInfo</B></A>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName, - int version) - throws <A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></PRE> -<DL> -<DD>Finds a WikiPage object describing a particular page and version. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>pageName</CODE> - The name of the page<DD><CODE>version</CODE> - A version number -<DT><B>Returns:</B><DD>A WikiPage object, or null, if the page does not exist -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></CODE> - If there is something wrong with the page - name or the repository</DL> -</DD> -</DL> -<HR> - -<A NAME="getVersionHistory(java.lang.String)"><!-- --></A><H3> -getVersionHistory</H3> -<PRE> -public <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.456"><B>getVersionHistory</B></A>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName) - throws <A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></PRE> -<DL> -<DD>Gets a version history of page. Each element in the returned - List is a WikiPage. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>pageName</CODE> - The name of the page to fetch history for -<DT><B>Returns:</B><DD>If the page does not exist, returns null, otherwise a List - of WikiPages. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></CODE> - If the repository fails.</DL> -</DD> -</DL> -<HR> - -<A NAME="getProviderDescription()"><!-- --></A><H3> -getProviderDescription</H3> -<PRE> -public <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.469"><B>getProviderDescription</B></A>()</PRE> -<DL> -<DD>Returns a human-readable description of the current provider. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>A human-readable description.</DL> -</DD> -</DL> -<HR> - -<A NAME="getTotalPageCount()"><!-- --></A><H3> -getTotalPageCount</H3> -<PRE> -public int <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.481"><B>getTotalPageCount</B></A>()</PRE> -<DL> -<DD>Returns the total count of all pages in the repository. This - method is equivalent of calling getAllPages().size(), but - it swallows the ProviderException and returns -1 instead of - any problems. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The number of pages, or -1, if there is an error.</DL> -</DD> -</DL> -<HR> - -<A NAME="pageExists(java.lang.String)"><!-- --></A><H3> -pageExists</H3> -<PRE> -public boolean <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.497"><B>pageExists</B></A>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName) - throws <A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></PRE> -<DL> -<DD>Returns true, if the page exists (any version). -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>pageName</CODE> - Name of the page. -<DT><B>Returns:</B><DD>A boolean value describing the existence of a page -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></CODE> - If the backend fails or the name is illegal.</DL> -</DD> -</DL> -<HR> - -<A NAME="pageExists(java.lang.String, int)"><!-- --></A><H3> -pageExists</H3> -<PRE> -public boolean <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.514"><B>pageExists</B></A>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pageName, - int version) - throws <A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></PRE> -<DL> -<DD>Checks for existence of a specific page and version. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>pageName</CODE> - Name of the page<DD><CODE>version</CODE> - The version to check -<DT><B>Returns:</B><DD><code>true</code> if the page exists, <code>false</code> otherwise -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></CODE> - If backend fails or name is illegal<DT><B>Since:</B></DT> - <DD>2.3.29</DD> -</DL> -</DD> -</DL> -<HR> - -<A NAME="deleteVersion(org.apache.wiki.WikiPage)"><!-- --></A><H3> -deleteVersion</H3> -<PRE> -public void <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.532"><B>deleteVersion</B></A>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page) - throws <A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></PRE> -<DL> -<DD>Deletes only a specific version of a WikiPage. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>page</CODE> - The page to delete. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></CODE> - if the page fails</DL> -</DD> -</DL> -<HR> - -<A NAME="deletePage(org.apache.wiki.WikiPage)"><!-- --></A><H3> -deletePage</H3> -<PRE> -public void <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.545"><B>deletePage</B></A>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page) - throws <A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></PRE> -<DL> -<DD>Deletes an entire page, all versions, all traces. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>page</CODE> - The WikiPage to delete -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../org/apache/wiki/api/exceptions/ProviderException.html" title="class in org.apache.wiki.api.exceptions">ProviderException</A></CODE> - If the repository operation fails</DL> -</DD> -</DL> -<HR> - -<A NAME="fireEvent(int, java.lang.String)"><!-- --></A><H3> -fireEvent</H3> -<PRE> -protected final void <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.699"><B>fireEvent</B></A>(int type, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pagename)</PRE> -<DL> -<DD>Fires a WikiPageEvent of the provided type and page name - to all registered listeners. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>type</CODE> - the event type to be fired<DD><CODE>pagename</CODE> - the wiki page name as a String<DT><B>See Also:</B><DD><A HREF="../../../org/apache/wiki/event/WikiPageEvent.html" title="class in org.apache.wiki.event"><CODE>WikiPageEvent</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="modules()"><!-- --></A><H3> -modules</H3> -<PRE> -public <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A> <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.709"><B>modules</B></A>()</PRE> -<DL> -<DD>Returns a collection of modules currently managed by this ModuleManager. Each - entry is an instance of the WikiModuleInfo class. This method should return something - which is safe to iterate over, even if the underlying collection changes. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/wiki/modules/ModuleManager.html#modules()">modules</A></CODE> in class <CODE><A HREF="../../../org/apache/wiki/modules/ModuleManager.html" title="class in org.apache.wiki.modules">ModuleManager</A></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>A Collection of WikiModuleInfo instances.</DL> -</DD> -</DL> -<HR> - -<A NAME="actionPerformed(org.apache.wiki.event.WikiEvent)"><!-- --></A><H3> -actionPerformed</H3> -<PRE> -public void <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.724"><B>actionPerformed</B></A>(<A HREF="../../../org/apache/wiki/event/WikiEvent.html" title="class in org.apache.wiki.event">WikiEvent</A> event)</PRE> -<DL> -<DD>Listens for <A HREF="../../../org/apache/wiki/event/WikiSecurityEvent.html#PROFILE_NAME_CHANGED"><CODE>WikiSecurityEvent.PROFILE_NAME_CHANGED</CODE></A> - events. If a user profile's name changes, each page ACL is inspected. If an entry contains - a name that has changed, it is replaced with the new one. No events are emitted - as a consequence of this method, because the page contents are still the same; it is - only the representations of the names within the ACL that are changing. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/wiki/event/WikiEventListener.html#actionPerformed(org.apache.wiki.event.WikiEvent)">actionPerformed</A></CODE> in interface <CODE><A HREF="../../../org/apache/wiki/event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</A></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>event</CODE> - The event</DL> -</DD> -</DL> -<HR> - -<A NAME="changeAcl(org.apache.wiki.WikiPage, java.security.Principal[], java.security.Principal)"><!-- --></A><H3> -changeAcl</H3> -<PRE> -protected boolean <A HREF="../../../src-html/org/apache/wiki/PageManager.html#line.774"><B>changeAcl</B></A>(<A HREF="../../../org/apache/wiki/WikiPage.html" title="class in org.apache.wiki">WikiPage</A> page, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A>[] oldPrincipals, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A> newPrincipal)</PRE> -<DL> -<DD>For a single wiki page, replaces all Acl entries matching a supplied array of Principals - with a new Principal. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>page</CODE> - the wiki page whose Acl is to be modified<DD><CODE>oldPrincipals</CODE> - an array of Principals to replace; all AclEntry objects whose - <A HREF="../../../org/apache/wiki/auth/acl/AclEntry.html#getPrincipal()"><CODE>AclEntry.getPrincipal()</CODE></A> method returns one of these Principals will be replaced<DD><CODE>newPrincipal</CODE> - the Principal that should receive the old Principals' permissions -<DT><B>Returns:</B><DD><code>true</code> if the Acl was actually changed; <code>false</code> otherwise</DL> -</DD> -</DL> -<!-- ========= END OF CLASS DATA ========= --> -<HR> - - -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PageManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../org/apache/wiki/PageLock.html" title="class in org.apache.wiki"><B>PREV CLASS</B></A> - <A HREF="../../../org/apache/wiki/PageManager.PreSaveWikiPageTask.html" title="class in org.apache.wiki"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?org/apache/wiki/PageManager.html" target="_top"><B>FRAMES</B></A> - <A HREF="PageManager.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. -</BODY> -</HTML>
http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/2e9374f1/apidocs/2.10.1/org/apache/wiki/PageManager.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/PageManager.png b/apidocs/2.10.1/org/apache/wiki/PageManager.png deleted file mode 100755 index ca65ee6..0000000 Binary files a/apidocs/2.10.1/org/apache/wiki/PageManager.png and /dev/null differ