You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2017/05/09 19:15:37 UTC
[36/51] [partial] jspwiki-site git commit: Automatic Site Publish by
Buildbot
http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/edae175e/content/apidocs/2.10.1/org/apache/wiki/WikiSession.html
----------------------------------------------------------------------
diff --git a/content/apidocs/2.10.1/org/apache/wiki/WikiSession.html b/content/apidocs/2.10.1/org/apache/wiki/WikiSession.html
new file mode 100755
index 0000000..6e590af
--- /dev/null
+++ b/content/apidocs/2.10.1/org/apache/wiki/WikiSession.html
@@ -0,0 +1,1169 @@
+<!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>
+WikiSession (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="WikiSession (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/WikiSession.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/WikiServlet.html" title="class in org.apache.wiki"><B>PREV CLASS</B></A>
+ NEXT CLASS</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/wiki/WikiSession.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="WikiSession.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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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 WikiSession</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 "><B>org.apache.wiki.WikiSession</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 final class <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.85"><B>WikiSession</B></A><DT>extends <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><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="27,6,181,69"/>
+<area shape="rect" id="node2" href="WikiSession.html" title="WikiSession" alt="" coords="57,113,151,141"/>
+<area shape="rect" id="node3" href="auth/login/WebContainerCallbackHandler.html" title="WebContainerCallbackHandler (org.apache.wiki.auth.login)" alt="" coords="5,200,203,245"/>
+</map>
+<div id="apivizContainer" style="text-align: center;"><img src="WikiSession.png" usemap="#APIVIZ" border="0"></div>
+
+<P>
+<p>Represents a long-running wiki session, with an associated user Principal,
+ user Subject, and authentication status. This class is initialized with
+ minimal, default-deny values: authentication is set to <code>false</code>,
+ and the user principal is set to <code>null</code>.</p>
+ <p>The WikiSession class allows callers to:</p>
+ <ul>
+ <li>Obtain the authentication status of the user via
+ <A HREF="../../../org/apache/wiki/WikiSession.html#isAnonymous()"><CODE>isAnonymous()</CODE></A> and <A HREF="../../../org/apache/wiki/WikiSession.html#isAuthenticated()"><CODE>isAuthenticated()</CODE></A></li>
+ <li>Query the session for Principals representing the
+ user's identity via <A HREF="../../../org/apache/wiki/WikiSession.html#getLoginPrincipal()"><CODE>getLoginPrincipal()</CODE></A>,
+ <A HREF="../../../org/apache/wiki/WikiSession.html#getUserPrincipal()"><CODE>getUserPrincipal()</CODE></A> and <A HREF="../../../org/apache/wiki/WikiSession.html#getPrincipals()"><CODE>getPrincipals()</CODE></A></li>
+ <li>Store, retrieve and clear UI messages via
+ <A HREF="../../../org/apache/wiki/WikiSession.html#addMessage(java.lang.String)"><CODE>addMessage(String)</CODE></A>, <A HREF="../../../org/apache/wiki/WikiSession.html#getMessages(java.lang.String)"><CODE>getMessages(String)</CODE></A>
+ and <A HREF="../../../org/apache/wiki/WikiSession.html#clearMessages(java.lang.String)"><CODE>clearMessages(String)</CODE></A></li>
+ </ul>
+ <p>To keep track of the Principals each user posseses, each WikiSession
+ stores a JAAS Subject. Various login processes add or remove Principals
+ when users authenticate or log out.</p>
+ <p>WikiSession implements the <A HREF="../../../org/apache/wiki/event/WikiEventListener.html" title="interface in org.apache.wiki.event"><CODE>WikiEventListener</CODE></A>
+ interface and listens for group add/change/delete events fired by
+ event sources the WikiSession is registered with. Normally,
+ <A HREF="../../../org/apache/wiki/auth/AuthenticationManager.html" title="class in org.apache.wiki.auth"><CODE>AuthenticationManager</CODE></A> registers each WikiSession
+ with the <A HREF="../../../org/apache/wiki/auth/authorize/GroupManager.html" title="class in org.apache.wiki.auth.authorize"><CODE>GroupManager</CODE></A>
+ so it can catch group events. Thus, when a user is added to a
+ <A HREF="../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize"><CODE>Group</CODE></A>, a corresponding
+ <A HREF="../../../org/apache/wiki/auth/GroupPrincipal.html" title="class in org.apache.wiki.auth"><CODE>GroupPrincipal</CODE></A> is injected into
+ the Subject's Principal set. Likewise, when the user is removed from
+ the Group or the Group is deleted, the GroupPrincipal is removed
+ from the Subject. The effect that this strategy produces is extremely
+ beneficial: when someone adds a user to a wiki group, that user
+ <em>immediately</em> gains the privileges associated with that
+ group; he or she does not need to re-authenticate.
+ </p>
+ <p>In addition to methods for examining individual <code>WikiSession</code>
+ objects, this class also contains a number of static methods for
+ managing WikiSessions for an entire wiki. These methods allow callers
+ to find, query and remove WikiSession objects, and
+ to obtain a list of the current wiki session users.</p>
+ <p>WikiSession encloses a protected static class, <A HREF="../../../org/apache/wiki/auth/SessionMonitor.html" title="class in org.apache.wiki.auth"><CODE>SessionMonitor</CODE></A>,
+ to keep track of WikiSessions registered with each wiki.</p>
+<P>
+
+<P>
+<HR>
+
+<P>
+<!-- =========== 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/WikiSession.html#ANONYMOUS">ANONYMOUS</A></B></CODE>
+
+<BR>
+ An anonymous user's session status.</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/WikiSession.html#ASSERTED">ASSERTED</A></B></CODE>
+
+<BR>
+ An asserted user's session status.</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/WikiSession.html#AUTHENTICATED">AUTHENTICATED</A></B></CODE>
+
+<BR>
+ An authenticated user's session status.</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/WikiSession.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 WikiEvents generated by source objects such as the
+ GroupManager.</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/WikiSession.html#addMessage(java.lang.String)">addMessage</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> message)</CODE>
+
+<BR>
+ Adds a message to the generic list of messages associated with the
+ session.</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/WikiSession.html#addMessage(java.lang.String, java.lang.String)">addMessage</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> topic,
+ <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> message)</CODE>
+
+<BR>
+ Adds a message to the specific set of messages associated with the
+ session.</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/WikiSession.html#clearMessages()">clearMessages</A></B>()</CODE>
+
+<BR>
+ Clears all messages associated with this session.</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/WikiSession.html#clearMessages(java.lang.String)">clearMessages</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> topic)</CODE>
+
+<BR>
+ Clears all messages associated with a session topic.</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/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#doPrivileged(org.apache.wiki.WikiSession, java.security.PrivilegedAction)">doPrivileged</A></B>(<A HREF="../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A> session,
+ <A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/PrivilegedAction.html?is-external=true" title="class or interface in java.security">PrivilegedAction</A><?> action)</CODE>
+
+<BR>
+ Wrapper for
+ <A HREF="http://docs.oracle.com/javase/6/docs/api/javax/security/auth/Subject.html?is-external=true#doAsPrivileged(javax.security.auth.Subject, java.security.PrivilegedExceptionAction, java.security.AccessControlContext)" title="class or interface in javax.security.auth"><CODE>Subject.doAsPrivileged(Subject, java.security.PrivilegedExceptionAction, java.security.AccessControlContext)</CODE></A>
+ that executes an action with the privileges posssessed by a
+ WikiSession's Subject.</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/Locale.html?is-external=true" title="class or interface in java.util">Locale</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#getLocale()">getLocale</A></B>()</CODE>
+
+<BR>
+ Returns a cached Locale object for this user.</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/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#getLoginPrincipal()">getLoginPrincipal</A></B>()</CODE>
+
+<BR>
+ Returns the Principal used to log in to an authenticated session.</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/WikiSession.html#getMessages()">getMessages</A></B>()</CODE>
+
+<BR>
+ Returns all generic messages associated with this session.</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/WikiSession.html#getMessages(java.lang.String)">getMessages</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> topic)</CODE>
+
+<BR>
+ Returns all messages associated with a session topic.</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/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A>[]</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#getPrincipals()">getPrincipals</A></B>()</CODE>
+
+<BR>
+ Returns all user Principals associated with this session.</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/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A>[]</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#getRoles()">getRoles</A></B>()</CODE>
+
+<BR>
+ Returns an array of Principal objects that represents the groups and
+ roles that the user associated with a WikiSession possesses.</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/WikiSession.html#getStatus()">getStatus</A></B>()</CODE>
+
+<BR>
+ Returns the status of the wiki session as a text string.</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/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#getUserPrincipal()">getUserPrincipal</A></B>()</CODE>
+
+<BR>
+ Returns the primary user Principal associated with this session.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#getWikiSession(org.apache.wiki.WikiEngine, javax.servlet.http.HttpServletRequest)">getWikiSession</A></B>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine,
+ javax.servlet.http.HttpServletRequest request)</CODE>
+
+<BR>
+ Static factory method that returns the WikiSession object associated with
+ the current HTTP request.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#guestSession(org.apache.wiki.WikiEngine)">guestSession</A></B>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine)</CODE>
+
+<BR>
+ Static factory method that creates a new "guest" session containing a single
+ user Principal <A HREF="../../../org/apache/wiki/auth/WikiPrincipal.html#GUEST"><CODE>WikiPrincipal.GUEST</CODE></A>,
+ plus the role principals <A HREF="../../../org/apache/wiki/auth/authorize/Role.html#ALL"><CODE>Role.ALL</CODE></A> and
+ <A HREF="../../../org/apache/wiki/auth/authorize/Role.html#ANONYMOUS"><CODE>Role.ANONYMOUS</CODE></A>.</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/WikiSession.html#hasPrincipal(java.security.Principal)">hasPrincipal</A></B>(<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> principal)</CODE>
+
+<BR>
+ Returns <code>true</code> if the WikiSession's Subject
+ possess a supplied Principal.</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/WikiSession.html#injectGroupPrincipals()">injectGroupPrincipals</A></B>()</CODE>
+
+<BR>
+ Injects GroupPrincipal objects into the user's Principal set based on the
+ groups the user belongs to.</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/WikiSession.html#injectUserProfilePrincipals()">injectUserProfilePrincipals</A></B>()</CODE>
+
+<BR>
+ Adds Principal objects to the Subject that correspond to the
+ logged-in user's profile attributes for the wiki name, full name
+ and login name.</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/WikiSession.html#invalidate()">invalidate</A></B>()</CODE>
+
+<BR>
+ Invalidates the WikiSession and resets its Subject's
+ Principals to the equivalent of a "guest session".</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/WikiSession.html#isAnonymous()">isAnonymous</A></B>()</CODE>
+
+<BR>
+ Determines whether the current session is anonymous.</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/WikiSession.html#isAsserted()">isAsserted</A></B>()</CODE>
+
+<BR>
+ Returns <code>true</code> if the user is considered asserted via
+ a session cookie; that is, the Subject contains the Principal
+ Role.ASSERTED.</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/WikiSession.html#isAuthenticated()">isAuthenticated</A></B>()</CODE>
+
+<BR>
+ Returns the authentication status of the user's session.</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/WikiSession.html#isInGroup(org.apache.wiki.auth.authorize.Group)">isInGroup</A></B>(<A HREF="../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize">Group</A> group)</CODE>
+
+<BR>
+ Returns <code>true</code> if one of this WikiSession's user Principals
+ can be shown to belong to a particular wiki group.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected static boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#isIPV4Address(java.lang.String)">isIPV4Address</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> name)</CODE>
+
+<BR>
+ Verifies whether a String represents an IPv4 address.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#removeWikiSession(org.apache.wiki.WikiEngine, javax.servlet.http.HttpServletRequest)">removeWikiSession</A></B>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine,
+ javax.servlet.http.HttpServletRequest request)</CODE>
+
+<BR>
+ Removes the wiki session associated with the user's HTTP request
+ from the cache of wiki sessions, typically as part of a logout
+ process.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#sessions(org.apache.wiki.WikiEngine)">sessions</A></B>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine)</CODE>
+
+<BR>
+ Returns the total number of active wiki sessions for a
+ particular wiki.</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/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A>[]</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/wiki/WikiSession.html#userPrincipals(org.apache.wiki.WikiEngine)">userPrincipals</A></B>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine)</CODE>
+
+<BR>
+ Returns Principals representing the current users known
+ to a particular wiki.</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="ANONYMOUS"><!-- --></A><H3>
+ANONYMOUS</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/WikiSession.html#line.89"><B>ANONYMOUS</B></A></PRE>
+<DL>
+<DD>An anonymous user's session status.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.WikiSession.ANONYMOUS">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="ASSERTED"><!-- --></A><H3>
+ASSERTED</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/WikiSession.html#line.92"><B>ASSERTED</B></A></PRE>
+<DL>
+<DD>An asserted user's session status.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.WikiSession.ASSERTED">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="AUTHENTICATED"><!-- --></A><H3>
+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/WikiSession.html#line.95"><B>AUTHENTICATED</B></A></PRE>
+<DL>
+<DD>An authenticated user's session status.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.wiki.WikiSession.AUTHENTICATED">Constant Field Values</A></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="isInGroup(org.apache.wiki.auth.authorize.Group)"><!-- --></A><H3>
+isInGroup</H3>
+<PRE>
+protected boolean <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.131"><B>isInGroup</B></A>(<A HREF="../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize">Group</A> group)</PRE>
+<DL>
+<DD>Returns <code>true</code> if one of this WikiSession's user Principals
+ can be shown to belong to a particular wiki group. If the user is
+ not authenticated, this method will always return <code>false</code>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group to test
+<DT><B>Returns:</B><DD>the result</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isAsserted()"><!-- --></A><H3>
+isAsserted</H3>
+<PRE>
+public boolean <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.157"><B>isAsserted</B></A>()</PRE>
+<DL>
+<DD>Returns <code>true</code> if the user is considered asserted via
+ a session cookie; that is, the Subject contains the Principal
+ Role.ASSERTED.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Returns <code>true</code> if the user is asserted</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isAuthenticated()"><!-- --></A><H3>
+isAuthenticated</H3>
+<PRE>
+public boolean <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.170"><B>isAuthenticated</B></A>()</PRE>
+<DL>
+<DD>Returns the authentication status of the user's session. The user is
+ considered authenticated if the Subject contains the Principal
+ Role.AUTHENTICATED. If this method determines that an earlier
+ LoginModule did not inject Role.AUTHENTICATED, it will inject one
+ if the user is not anonymous <em>and</em> not asserted.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Returns <code>true</code> if the user is authenticated</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isAnonymous()"><!-- --></A><H3>
+isAnonymous</H3>
+<PRE>
+public boolean <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.206"><B>isAnonymous</B></A>()</PRE>
+<DL>
+<DD><p>Determines whether the current session is anonymous. This will be
+ true if any of these conditions are true:</p>
+ <ul>
+ <li>The session's Principal set contains
+ <A HREF="../../../org/apache/wiki/auth/authorize/Role.html#ANONYMOUS"><CODE>Role.ANONYMOUS</CODE></A></li>
+ <li>The session's Principal set contains
+ <A HREF="../../../org/apache/wiki/auth/WikiPrincipal.html#GUEST"><CODE>WikiPrincipal.GUEST</CODE></A></li>
+ <li>The Principal returned by <A HREF="../../../org/apache/wiki/WikiSession.html#getUserPrincipal()"><CODE>getUserPrincipal()</CODE></A> evaluates
+ to an IP address.</li>
+ </ul>
+ <p>The criteria above are listed in the order in which they are
+ evaluated.</p>
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>whether the current user's identity is equivalent to an IP
+ address</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getLoginPrincipal()"><!-- --></A><H3>
+getLoginPrincipal</H3>
+<PRE>
+public <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> <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.226"><B>getLoginPrincipal</B></A>()</PRE>
+<DL>
+<DD><p> Returns the Principal used to log in to an authenticated session. The
+ login principal is determined by examining the Subject's Principal set
+ for PrincipalWrappers or WikiPrincipals with type designator
+ <code>LOGIN_NAME</code>; the first one found is the login principal.
+ If one is not found, this method returns the first principal that isn't
+ of type Role or GroupPrincipal. If neither of these conditions hold, this method returns
+ <A HREF="../../../org/apache/wiki/auth/WikiPrincipal.html#GUEST"><CODE>WikiPrincipal.GUEST</CODE></A>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the login Principal. If it is a PrincipalWrapper containing an
+ externally-provided Principal, the object returned is the Principal, not
+ the wrapper around it.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getUserPrincipal()"><!-- --></A><H3>
+getUserPrincipal</H3>
+<PRE>
+public <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> <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.244"><B>getUserPrincipal</B></A>()</PRE>
+<DL>
+<DD><p>Returns the primary user Principal associated with this session. The
+ primary user principal is determined as follows:</p> <ol> <li>If the
+ Subject's Principal set contains WikiPrincipals, the first WikiPrincipal
+ with type designator <code>WIKI_NAME</code> or (alternatively)
+ <code>FULL_NAME</code> is the primary Principal.</li>
+ <li>For all other cases, the first Principal in the Subject's principal
+ collection that that isn't of type Role or GroupPrincipal is the primary.</li>
+ </ol>
+ If no primary user Principal is found, this method returns
+ <A HREF="../../../org/apache/wiki/auth/WikiPrincipal.html#GUEST"><CODE>WikiPrincipal.GUEST</CODE></A>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the primary user Principal</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getLocale()"><!-- --></A><H3>
+getLocale</H3>
+<PRE>
+public <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.260"><B>getLocale</B></A>()</PRE>
+<DL>
+<DD>Returns a cached Locale object for this user. It's better to use
+ WikiContext's corresponding getBundle() method, since that will actually
+ react if the user changes the locale in the middle, but if that's not
+ available (or, for some reason, you need the speed), this method can
+ also be used. The Locale expires when the WikiSession expires, and
+ currently there is no way to reset the Locale.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>A cached Locale object<DT><B>Since:</B></DT>
+ <DD>2.5.96</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="addMessage(java.lang.String)"><!-- --></A><H3>
+addMessage</H3>
+<PRE>
+public void <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.271"><B>addMessage</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> message)</PRE>
+<DL>
+<DD>Adds a message to the generic list of messages associated with the
+ session. These messages retain their order of insertion and remain until
+ the <A HREF="../../../org/apache/wiki/WikiSession.html#clearMessages()"><CODE>clearMessages()</CODE></A> method is called.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to add; if <code>null</code> it is ignored.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="addMessage(java.lang.String, java.lang.String)"><!-- --></A><H3>
+addMessage</H3>
+<PRE>
+public void <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.284"><B>addMessage</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> topic,
+ <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> message)</PRE>
+<DL>
+<DD>Adds a message to the specific set of messages associated with the
+ session. These messages retain their order of insertion and remain until
+ the <A HREF="../../../org/apache/wiki/WikiSession.html#clearMessages()"><CODE>clearMessages()</CODE></A> method is called.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the topic to associate the message to;<DD><CODE>message</CODE> - the message to add</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="clearMessages()"><!-- --></A><H3>
+clearMessages</H3>
+<PRE>
+public void <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.302"><B>clearMessages</B></A>()</PRE>
+<DL>
+<DD>Clears all messages associated with this session.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="clearMessages(java.lang.String)"><!-- --></A><H3>
+clearMessages</H3>
+<PRE>
+public void <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.311"><B>clearMessages</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> topic)</PRE>
+<DL>
+<DD>Clears all messages associated with a session topic.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>topic</CODE> - the topic whose messages should be cleared.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMessages()"><!-- --></A><H3>
+getMessages</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/WikiSession.html#line.326"><B>getMessages</B></A>()</PRE>
+<DL>
+<DD>Returns all generic messages associated with this session.
+ The messages stored with the session persist throughout the
+ session unless they have been reset with <A HREF="../../../org/apache/wiki/WikiSession.html#clearMessages()"><CODE>clearMessages()</CODE></A>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the current messages.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMessages(java.lang.String)"><!-- --></A><H3>
+getMessages</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/WikiSession.html#line.338"><B>getMessages</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> topic)</PRE>
+<DL>
+<DD>Returns all messages associated with a session topic.
+ The messages stored with the session persist throughout the
+ session unless they have been reset with <A HREF="../../../org/apache/wiki/WikiSession.html#clearMessages(java.lang.String)"><CODE>clearMessages(String)</CODE></A>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic
+<DT><B>Returns:</B><DD>the current messages.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPrincipals()"><!-- --></A><H3>
+getPrincipals</H3>
+<PRE>
+public <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>[] <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.355"><B>getPrincipals</B></A>()</PRE>
+<DL>
+<DD>Returns all user Principals associated with this session. User principals
+ are those in the Subject's principal collection that aren't of type Role or
+ of type GroupPrincipal. This is a defensive copy.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Returns the user principal<DT><B>See Also:</B><DD><A HREF="../../../org/apache/wiki/auth/AuthenticationManager.html#isUserPrincipal(java.security.Principal)"><CODE>AuthenticationManager.isUserPrincipal(Principal)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRoles()"><!-- --></A><H3>
+getRoles</H3>
+<PRE>
+public <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>[] <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.384"><B>getRoles</B></A>()</PRE>
+<DL>
+<DD>Returns an array of Principal objects that represents the groups and
+ roles that the user associated with a WikiSession possesses. The array is
+ built by iterating through the Subject's Principal set and extracting all
+ Role and GroupPrincipal objects into a list. The list is returned as an
+ array sorted in the natural order implied by each Principal's
+ <code>getName</code> method. Note that this method does <em>not</em>
+ consult the external Authorizer or GroupManager; it relies on the
+ Principals that have been injected into the user's Subject at login time,
+ or after group creation/modification/deletion.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>an array of Principal objects corresponding to the roles the
+ Subject possesses</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removeWikiSession(org.apache.wiki.WikiEngine, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
+removeWikiSession</H3>
+<PRE>
+public static void <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.407"><B>removeWikiSession</B></A>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine,
+ javax.servlet.http.HttpServletRequest request)</PRE>
+<DL>
+<DD>Removes the wiki session associated with the user's HTTP request
+ from the cache of wiki sessions, typically as part of a logout
+ process.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>engine</CODE> - the wiki engine<DD><CODE>request</CODE> - the users's HTTP request</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="hasPrincipal(java.security.Principal)"><!-- --></A><H3>
+hasPrincipal</H3>
+<PRE>
+public boolean <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.424"><B>hasPrincipal</B></A>(<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> principal)</PRE>
+<DL>
+<DD>Returns <code>true</code> if the WikiSession's Subject
+ possess a supplied Principal. This method eliminates the need
+ to externally request and inspect the JAAS subject.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>principal</CODE> - the Principal to test
+<DT><B>Returns:</B><DD>the result</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/WikiSession.html#line.436"><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 WikiEvents generated by source objects such as the
+ GroupManager. This method adds Principals to the private Subject managed
+ by the WikiSession.
+<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> - a WikiEvent object<DT><B>See Also:</B><DD><A HREF="../../../org/apache/wiki/event/WikiEventListener.html#actionPerformed(org.apache.wiki.event.WikiEvent)"><CODE>WikiEventListener.actionPerformed(org.apache.wiki.event.WikiEvent)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="invalidate()"><!-- --></A><H3>
+invalidate</H3>
+<PRE>
+public void <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.600"><B>invalidate</B></A>()</PRE>
+<DL>
+<DD>Invalidates the WikiSession and resets its Subject's
+ Principals to the equivalent of a "guest session".
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="injectGroupPrincipals()"><!-- --></A><H3>
+injectGroupPrincipals</H3>
+<PRE>
+protected void <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.623"><B>injectGroupPrincipals</B></A>()</PRE>
+<DL>
+<DD>Injects GroupPrincipal objects into the user's Principal set based on the
+ groups the user belongs to. For Groups, the algorithm first calls the
+ <A HREF="../../../org/apache/wiki/auth/authorize/GroupManager.html#getRoles()"><CODE>GroupManager.getRoles()</CODE></A> to obtain the array of GroupPrincipals
+ the authorizer knows about. Then, the method
+ <A HREF="../../../org/apache/wiki/auth/authorize/GroupManager.html#isUserInRole(org.apache.wiki.WikiSession, java.security.Principal)"><CODE>GroupManager.isUserInRole(WikiSession, Principal)</CODE></A> is called for
+ each Principal. If the user is a member of the group, an equivalent
+ GroupPrincipal is injected into the user's principal set. Existing
+ GroupPrincipals are flushed and replaced. This method should generally be
+ called after a user's <A HREF="../../../org/apache/wiki/auth/user/UserProfile.html" title="interface in org.apache.wiki.auth.user"><CODE>UserProfile</CODE></A> is
+ saved. If the wiki session is null, or there is no matching user profile,
+ the method returns silently.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="injectUserProfilePrincipals()"><!-- --></A><H3>
+injectUserProfilePrincipals</H3>
+<PRE>
+protected void <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.646"><B>injectUserProfilePrincipals</B></A>()</PRE>
+<DL>
+<DD>Adds Principal objects to the Subject that correspond to the
+ logged-in user's profile attributes for the wiki name, full name
+ and login name. These Principals will be WikiPrincipals, and they
+ will replace all other WikiPrincipals in the Subject. <em>Note:
+ this method is never called during anonymous or asserted sessions.</em>
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getStatus()"><!-- --></A><H3>
+getStatus</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/WikiSession.html#line.701"><B>getStatus</B></A>()</PRE>
+<DL>
+<DD><p>Returns the status of the wiki session as a text string. Valid values are:</p>
+ <ul>
+ <li><A HREF="../../../org/apache/wiki/WikiSession.html#AUTHENTICATED"><CODE>AUTHENTICATED</CODE></A></li>
+ <li><A HREF="../../../org/apache/wiki/WikiSession.html#ASSERTED"><CODE>ASSERTED</CODE></A></li>
+ <li><A HREF="../../../org/apache/wiki/WikiSession.html#ANONYMOUS"><CODE>ANONYMOUS</CODE></A></li>
+ </ul>
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the user's session status</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getWikiSession(org.apache.wiki.WikiEngine, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
+getWikiSession</H3>
+<PRE>
+public static <A HREF="../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A> <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.720"><B>getWikiSession</B></A>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine,
+ javax.servlet.http.HttpServletRequest request)</PRE>
+<DL>
+<DD><p>Static factory method that returns the WikiSession object associated with
+ the current HTTP request. This method looks up the associated HttpSession
+ in an internal WeakHashMap and attempts to retrieve the WikiSession. If
+ not found, one is created. This method is guaranteed to always return a
+ WikiSession, although the authentication status is unpredictable until
+ the user attempts to log in. If the servlet request parameter is
+ <code>null</code>, a synthetic <A HREF="../../../org/apache/wiki/WikiSession.html#guestSession(org.apache.wiki.WikiEngine)"><CODE>guestSession(WikiEngine)</CODE></A>is returned.</p>
+ <p>When a session is created, this method attaches a WikiEventListener
+ to the GroupManager so that changes to groups are detected automatically.</p>
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>engine</CODE> - the wiki engine<DD><CODE>request</CODE> - the servlet request object
+<DT><B>Returns:</B><DD>the existing (or newly created) wiki session</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="guestSession(org.apache.wiki.WikiEngine)"><!-- --></A><H3>
+guestSession</H3>
+<PRE>
+public static <A HREF="../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A> <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.755"><B>guestSession</B></A>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine)</PRE>
+<DL>
+<DD>Static factory method that creates a new "guest" session containing a single
+ user Principal <A HREF="../../../org/apache/wiki/auth/WikiPrincipal.html#GUEST"><CODE>WikiPrincipal.GUEST</CODE></A>,
+ plus the role principals <A HREF="../../../org/apache/wiki/auth/authorize/Role.html#ALL"><CODE>Role.ALL</CODE></A> and
+ <A HREF="../../../org/apache/wiki/auth/authorize/Role.html#ANONYMOUS"><CODE>Role.ANONYMOUS</CODE></A>. This method also adds the session as a listener
+ for GroupManager, AuthenticationManager and UserManager events.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>engine</CODE> - the wiki engine
+<DT><B>Returns:</B><DD>the guest wiki session</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sessions(org.apache.wiki.WikiEngine)"><!-- --></A><H3>
+sessions</H3>
+<PRE>
+public static int <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.805"><B>sessions</B></A>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine)</PRE>
+<DL>
+<DD>Returns the total number of active wiki sessions for a
+ particular wiki. This method delegates to the wiki's
+ <A HREF="../../../org/apache/wiki/auth/SessionMonitor.html#sessions()"><CODE>SessionMonitor.sessions()</CODE></A> method.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>engine</CODE> - the wiki session
+<DT><B>Returns:</B><DD>the number of sessions</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="userPrincipals(org.apache.wiki.WikiEngine)"><!-- --></A><H3>
+userPrincipals</H3>
+<PRE>
+public static <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>[] <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.819"><B>userPrincipals</B></A>(<A HREF="../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine)</PRE>
+<DL>
+<DD>Returns Principals representing the current users known
+ to a particular wiki. Each Principal will correspond to the
+ value returned by each WikiSession's <A HREF="../../../org/apache/wiki/WikiSession.html#getUserPrincipal()"><CODE>getUserPrincipal()</CODE></A>
+ method. This method delegates to <A HREF="../../../org/apache/wiki/auth/SessionMonitor.html#userPrincipals()"><CODE>SessionMonitor.userPrincipals()</CODE></A>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>engine</CODE> - the wiki engine
+<DT><B>Returns:</B><DD>an array of Principal objects, sorted by name</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="doPrivileged(org.apache.wiki.WikiSession, java.security.PrivilegedAction)"><!-- --></A><H3>
+doPrivileged</H3>
+<PRE>
+public static <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> <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.838"><B>doPrivileged</B></A>(<A HREF="../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A> session,
+ <A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/PrivilegedAction.html?is-external=true" title="class or interface in java.security">PrivilegedAction</A><?> action)
+ throws <A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/AccessControlException.html?is-external=true" title="class or interface in java.security">AccessControlException</A></PRE>
+<DL>
+<DD>Wrapper for
+ <A HREF="http://docs.oracle.com/javase/6/docs/api/javax/security/auth/Subject.html?is-external=true#doAsPrivileged(javax.security.auth.Subject, java.security.PrivilegedExceptionAction, java.security.AccessControlContext)" title="class or interface in javax.security.auth"><CODE>Subject.doAsPrivileged(Subject, java.security.PrivilegedExceptionAction, java.security.AccessControlContext)</CODE></A>
+ that executes an action with the privileges posssessed by a
+ WikiSession's Subject. The action executes with a <code>null</code>
+ AccessControlContext, which has the effect of running it "cleanly"
+ without the AccessControlContexts of the caller.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>session</CODE> - the wiki session<DD><CODE>action</CODE> - the privileged action
+<DT><B>Returns:</B><DD>the result of the privileged action; may be <code>null</code>
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/AccessControlException.html?is-external=true" title="class or interface in java.security">AccessControlException</A></CODE> - if the action is not permitted
+ by the security policy</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isIPV4Address(java.lang.String)"><!-- --></A><H3>
+isIPV4Address</H3>
+<PRE>
+protected static boolean <A HREF="../../../src-html/org/apache/wiki/WikiSession.html#line.849"><B>isIPV4Address</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> name)</PRE>
+<DL>
+<DD>Verifies whether a String represents an IPv4 address. The algorithm is
+ extremely efficient and does not allocate any objects.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the address to test
+<DT><B>Returns:</B><DD>the result</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/WikiSession.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/WikiServlet.html" title="class in org.apache.wiki"><B>PREV CLASS</B></A>
+ NEXT CLASS</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/wiki/WikiSession.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="WikiSession.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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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/edae175e/content/apidocs/2.10.1/org/apache/wiki/WikiSession.png
----------------------------------------------------------------------
diff --git a/content/apidocs/2.10.1/org/apache/wiki/WikiSession.png b/content/apidocs/2.10.1/org/apache/wiki/WikiSession.png
new file mode 100755
index 0000000..ce818f4
Binary files /dev/null and b/content/apidocs/2.10.1/org/apache/wiki/WikiSession.png differ
http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/edae175e/content/apidocs/2.10.1/org/apache/wiki/api/engine/AdminBeanManager.html
----------------------------------------------------------------------
diff --git a/content/apidocs/2.10.1/org/apache/wiki/api/engine/AdminBeanManager.html b/content/apidocs/2.10.1/org/apache/wiki/api/engine/AdminBeanManager.html
new file mode 100755
index 0000000..e9cec47
--- /dev/null
+++ b/content/apidocs/2.10.1/org/apache/wiki/api/engine/AdminBeanManager.html
@@ -0,0 +1,306 @@
+<!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:15 CEST 2014 -->
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<TITLE>
+AdminBeanManager (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="AdminBeanManager (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/AdminBeanManager.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">
+ PREV CLASS
+ <A HREF="../../../../../org/apache/wiki/api/engine/FilterManager.html" title="interface in org.apache.wiki.api.engine"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/wiki/api/engine/AdminBeanManager.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="AdminBeanManager.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <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.api.engine</FONT>
+<BR>
+Interface AdminBeanManager</H2>
+<DL>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/wiki/ui/admin/DefaultAdminBeanManager.html" title="class in org.apache.wiki.ui.admin">DefaultAdminBeanManager</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public interface <A HREF="../../../../../src-html/org/apache/wiki/api/engine/AdminBeanManager.html#line.27"><B>AdminBeanManager</B></A></DL>
+</PRE>
+<map id="APIVIZ" name="APIVIZ">
+<area shape="rect" id="node1" href="AdminBeanManager.html" title="«interface» AdminBeanManager" alt="" coords="25,5,164,51"/>
+<area shape="rect" id="node2" href="../../ui/admin/DefaultAdminBeanManager.html" title="DefaultAdminBeanManager (org.apache.wiki.ui.admin)" alt="" coords="5,89,184,135"/>
+</map>
+<div id="apivizContainer" style="text-align: center;"><img src="AdminBeanManager.png" usemap="#APIVIZ" border="0"></div>
+
+<P>
+<HR>
+
+<P>
+
+<!-- ========== 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/api/engine/AdminBeanManager.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>
+ Unregisters AdminBeans upon SHUTDOWN event.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../../org/apache/wiki/ui/admin/AdminBean.html" title="interface in org.apache.wiki.ui.admin">AdminBean</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/api/engine/AdminBeanManager.html#findBean(java.lang.String)">findBean</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> id)</CODE>
+
+<BR>
+ Locates a bean based on the AdminBean.getId() out of all
+ the registered beans.</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/ui/admin/AdminBean.html" title="interface in org.apache.wiki.ui.admin">AdminBean</A>></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/api/engine/AdminBeanManager.html#getAllBeans()">getAllBeans</A></B>()</CODE>
+
+<BR>
+ Lists all administration beans which are currently known
+ and instantiated.</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/api/engine/AdminBeanManager.html#getTypeFromString(java.lang.String)">getTypeFromString</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> type)</CODE>
+
+<BR>
+ Returns the type identifier for a string type.</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/api/engine/AdminBeanManager.html#initialize()">initialize</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ 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="initialize()"><!-- --></A><H3>
+initialize</H3>
+<PRE>
+void <A HREF="../../../../../src-html/org/apache/wiki/api/engine/AdminBeanManager.html#line.29"><B>initialize</B></A>()</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAllBeans()"><!-- --></A><H3>
+getAllBeans</H3>
+<PRE>
+<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/ui/admin/AdminBean.html" title="interface in org.apache.wiki.ui.admin">AdminBean</A>> <A HREF="../../../../../src-html/org/apache/wiki/api/engine/AdminBeanManager.html#line.37"><B>getAllBeans</B></A>()</PRE>
+<DL>
+<DD>Lists all administration beans which are currently known
+ and instantiated.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>all AdminBeans known to the manager</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="findBean(java.lang.String)"><!-- --></A><H3>
+findBean</H3>
+<PRE>
+<A HREF="../../../../../org/apache/wiki/ui/admin/AdminBean.html" title="interface in org.apache.wiki.ui.admin">AdminBean</A> <A HREF="../../../../../src-html/org/apache/wiki/api/engine/AdminBeanManager.html#line.46"><B>findBean</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> id)</PRE>
+<DL>
+<DD>Locates a bean based on the AdminBean.getId() out of all
+ the registered beans.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>id</CODE> - ID
+<DT><B>Returns:</B><DD>An AdminBean, or null, if no such bean is found.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="actionPerformed(org.apache.wiki.event.WikiEvent)"><!-- --></A><H3>
+actionPerformed</H3>
+<PRE>
+void <A HREF="../../../../../src-html/org/apache/wiki/api/engine/AdminBeanManager.html#line.53"><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>Unregisters AdminBeans upon SHUTDOWN event.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>event</CODE> - the WikiEvent</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getTypeFromString(java.lang.String)"><!-- --></A><H3>
+getTypeFromString</H3>
+<PRE>
+int <A HREF="../../../../../src-html/org/apache/wiki/api/engine/AdminBeanManager.html#line.61"><B>getTypeFromString</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> type)</PRE>
+<DL>
+<DD>Returns the type identifier for a string type.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>type</CODE> - A type string.
+<DT><B>Returns:</B><DD>A type value.</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/AdminBeanManager.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">
+ PREV CLASS
+ <A HREF="../../../../../org/apache/wiki/api/engine/FilterManager.html" title="interface in org.apache.wiki.api.engine"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/wiki/api/engine/AdminBeanManager.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="AdminBeanManager.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <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/edae175e/content/apidocs/2.10.1/org/apache/wiki/api/engine/AdminBeanManager.png
----------------------------------------------------------------------
diff --git a/content/apidocs/2.10.1/org/apache/wiki/api/engine/AdminBeanManager.png b/content/apidocs/2.10.1/org/apache/wiki/api/engine/AdminBeanManager.png
new file mode 100755
index 0000000..b52f020
Binary files /dev/null and b/content/apidocs/2.10.1/org/apache/wiki/api/engine/AdminBeanManager.png differ