http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/2e9374f1/apidocs/2.10.1/org/apache/wiki/auth/SecurityVerifier.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/auth/SecurityVerifier.html b/apidocs/2.10.1/org/apache/wiki/auth/SecurityVerifier.html deleted file mode 100755 index 14383a5..0000000 --- a/apidocs/2.10.1/org/apache/wiki/auth/SecurityVerifier.html +++ /dev/null @@ -1,916 +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:16 CEST 2014 --> -<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<TITLE> -SecurityVerifier (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="SecurityVerifier (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/SecurityVerifier.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/auth/PrincipalComparator.html" title="class in org.apache.wiki.auth"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/wiki/auth/SessionMonitor.html" title="class in org.apache.wiki.auth"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/wiki/auth/SecurityVerifier.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecurityVerifier.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> | <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.auth</FONT> -<BR> -Class SecurityVerifier</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.auth.SecurityVerifier</B> -</PRE> -<HR> -<DL> -<DT><PRE>public final class <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.54"><B>SecurityVerifier</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></DL> -</PRE> -<map id="APIVIZ" name="APIVIZ"> -<area shape="rect" id="node1" href="SecurityVerifier.html" title="SecurityVerifier" alt="" coords="5,6,115,34"/> -</map> -<div id="apivizContainer" style="text-align: center;"><img src="SecurityVerifier.png" usemap="#APIVIZ" border="0"></div> - -<P> -Helper class for verifying JSPWiki's security configuration. Invoked by - <code>admin/SecurityConfig.jsp</code>. -<P> - -<P> -<DL> -<DT><B>Since:</B></DT> - <DD>2.4</DD> -</DL> -<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/auth/SecurityVerifier.html#ERROR">ERROR</A></B></CODE> - -<BR> - Message prefix for errors.</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/auth/SecurityVerifier.html#ERROR_DB">ERROR_DB</A></B></CODE> - -<BR> - Message topic for user database errors.</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/auth/SecurityVerifier.html#ERROR_GROUPS">ERROR_GROUPS</A></B></CODE> - -<BR> - Message topic for group database errors.</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/auth/SecurityVerifier.html#ERROR_JAAS">ERROR_JAAS</A></B></CODE> - -<BR> - Message topic for JAAS errors.</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/auth/SecurityVerifier.html#ERROR_POLICY">ERROR_POLICY</A></B></CODE> - -<BR> - Message topic for policy errors.</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/auth/SecurityVerifier.html#ERROR_ROLES">ERROR_ROLES</A></B></CODE> - -<BR> - Message topic for role-checking errors.</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/auth/SecurityVerifier.html#INFO">INFO</A></B></CODE> - -<BR> - Message prefix for information messages.</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/auth/SecurityVerifier.html#INFO_DB">INFO_DB</A></B></CODE> - -<BR> - Message topic for user database information messages.</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/auth/SecurityVerifier.html#INFO_GROUPS">INFO_GROUPS</A></B></CODE> - -<BR> - Message topic for group database information messages.</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/auth/SecurityVerifier.html#INFO_JAAS">INFO_JAAS</A></B></CODE> - -<BR> - Message topic for JAAS information messages.</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/auth/SecurityVerifier.html#INFO_POLICY">INFO_POLICY</A></B></CODE> - -<BR> - Message topic for policy information messages.</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/auth/SecurityVerifier.html#INFO_ROLES">INFO_ROLES</A></B></CODE> - -<BR> - Message topic for role-checking information messages.</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/auth/SecurityVerifier.html#WARNING">WARNING</A></B></CODE> - -<BR> - Message prefix for warnings.</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/auth/SecurityVerifier.html#WARNING_DB">WARNING_DB</A></B></CODE> - -<BR> - Message topic for user database warnings.</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/auth/SecurityVerifier.html#WARNING_GROUPS">WARNING_GROUPS</A></B></CODE> - -<BR> - Message topic for group database warnings.</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/auth/SecurityVerifier.html#WARNING_JAAS">WARNING_JAAS</A></B></CODE> - -<BR> - Message topic for JAAS warnings.</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/auth/SecurityVerifier.html#WARNING_POLICY">WARNING_POLICY</A></B></CODE> - -<BR> - Message topic for policy warnings.</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/auth/SecurityVerifier.html#SecurityVerifier(org.apache.wiki.WikiEngine, org.apache.wiki.WikiSession)">SecurityVerifier</A></B>(<A HREF="../../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine, - <A HREF="../../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A> session)</CODE> - -<BR> - Constructs a new SecurityVerifier for a supplied WikiEngine and WikiSession.</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> <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/auth/SecurityVerifier.html#containerRoleTable()">containerRoleTable</A></B>()</CODE> - -<BR> - Formats and returns an HTML table containing the roles the web container - is aware of, and whether each role maps to particular JSPs.</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/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/wiki/auth/SecurityVerifier.html#getFileFromProperty(java.lang.String)">getFileFromProperty</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> property)</CODE> - -<BR> - Looks up a file name based on a JRE system property and returns the associated - File object if it exists.</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/auth/SecurityVerifier.html#isSecurityPolicyConfigured()">isSecurityPolicyConfigured</A></B>()</CODE> - -<BR> - Returns <code>true</code> if the Java security policy is configured - correctly, and it verifies as valid.</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/auth/SecurityVerifier.html#policyPrincipals()">policyPrincipals</A></B>()</CODE> - -<BR> - Returns an array of unique Principals from the JSPWIki security policy - file.</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/auth/SecurityVerifier.html#policyRoleTable()">policyRoleTable</A></B>()</CODE> - -<BR> - Formats and returns an HTML table containing sample permissions and what - roles are allowed to have them.</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/auth/SecurityVerifier.html#verifyGroupDatabase()">verifyGroupDatabase</A></B>()</CODE> - -<BR> - Verifies that the group datbase was initialized properly, and that - user add and delete operations work as they should.</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/auth/SecurityVerifier.html#verifyJaas()">verifyJaas</A></B>()</CODE> - -<BR> - Verfies the JAAS configuration.</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/auth/SecurityVerifier.html#verifyPolicy()">verifyPolicy</A></B>()</CODE> - -<BR> - Verfies the Java security policy configuration.</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/auth/SecurityVerifier.html#verifyPolicyAndContainerRoles()">verifyPolicyAndContainerRoles</A></B>()</CODE> - -<BR> - Verifies that the roles given in the security policy are reflected by the - container <code>web.xml</code> file.</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/auth/SecurityVerifier.html#verifyStaticPermission(java.security.Principal, java.security.Permission)">verifyStaticPermission</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, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</A> permission)</CODE> - -<BR> - Verifies that a particular Principal possesses a Permission, as defined - in the security policy file.</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/auth/SecurityVerifier.html#verifyUserDatabase()">verifyUserDatabase</A></B>()</CODE> - -<BR> - Verifies that the user datbase was initialized properly, and that - user add and delete operations work as they should.</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/auth/SecurityVerifier.html#webContainerRoles()">webContainerRoles</A></B>()</CODE> - -<BR> - If the active Authorizer is the WebContainerAuthorizer, returns the roles - it knows about; otherwise, a zero-length array.</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="ERROR"><!-- --></A><H3> -ERROR</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/auth/SecurityVerifier.html#line.67"><B>ERROR</B></A></PRE> -<DL> -<DD>Message prefix for errors. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.ERROR">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="WARNING"><!-- --></A><H3> -WARNING</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/auth/SecurityVerifier.html#line.70"><B>WARNING</B></A></PRE> -<DL> -<DD>Message prefix for warnings. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.WARNING">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="INFO"><!-- --></A><H3> -INFO</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/auth/SecurityVerifier.html#line.73"><B>INFO</B></A></PRE> -<DL> -<DD>Message prefix for information messages. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.INFO">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_POLICY"><!-- --></A><H3> -ERROR_POLICY</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/auth/SecurityVerifier.html#line.76"><B>ERROR_POLICY</B></A></PRE> -<DL> -<DD>Message topic for policy errors. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.ERROR_POLICY">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="WARNING_POLICY"><!-- --></A><H3> -WARNING_POLICY</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/auth/SecurityVerifier.html#line.79"><B>WARNING_POLICY</B></A></PRE> -<DL> -<DD>Message topic for policy warnings. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.WARNING_POLICY">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="INFO_POLICY"><!-- --></A><H3> -INFO_POLICY</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/auth/SecurityVerifier.html#line.82"><B>INFO_POLICY</B></A></PRE> -<DL> -<DD>Message topic for policy information messages. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.INFO_POLICY">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_JAAS"><!-- --></A><H3> -ERROR_JAAS</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/auth/SecurityVerifier.html#line.85"><B>ERROR_JAAS</B></A></PRE> -<DL> -<DD>Message topic for JAAS errors. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.ERROR_JAAS">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="WARNING_JAAS"><!-- --></A><H3> -WARNING_JAAS</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/auth/SecurityVerifier.html#line.88"><B>WARNING_JAAS</B></A></PRE> -<DL> -<DD>Message topic for JAAS warnings. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.WARNING_JAAS">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_ROLES"><!-- --></A><H3> -ERROR_ROLES</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/auth/SecurityVerifier.html#line.91"><B>ERROR_ROLES</B></A></PRE> -<DL> -<DD>Message topic for role-checking errors. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.ERROR_ROLES">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="INFO_ROLES"><!-- --></A><H3> -INFO_ROLES</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/auth/SecurityVerifier.html#line.94"><B>INFO_ROLES</B></A></PRE> -<DL> -<DD>Message topic for role-checking information messages. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.INFO_ROLES">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_DB"><!-- --></A><H3> -ERROR_DB</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/auth/SecurityVerifier.html#line.97"><B>ERROR_DB</B></A></PRE> -<DL> -<DD>Message topic for user database errors. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.ERROR_DB">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="WARNING_DB"><!-- --></A><H3> -WARNING_DB</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/auth/SecurityVerifier.html#line.100"><B>WARNING_DB</B></A></PRE> -<DL> -<DD>Message topic for user database warnings. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.WARNING_DB">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="INFO_DB"><!-- --></A><H3> -INFO_DB</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/auth/SecurityVerifier.html#line.103"><B>INFO_DB</B></A></PRE> -<DL> -<DD>Message topic for user database information messages. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.INFO_DB">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="ERROR_GROUPS"><!-- --></A><H3> -ERROR_GROUPS</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/auth/SecurityVerifier.html#line.106"><B>ERROR_GROUPS</B></A></PRE> -<DL> -<DD>Message topic for group database errors. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.ERROR_GROUPS">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="WARNING_GROUPS"><!-- --></A><H3> -WARNING_GROUPS</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/auth/SecurityVerifier.html#line.109"><B>WARNING_GROUPS</B></A></PRE> -<DL> -<DD>Message topic for group database warnings. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.WARNING_GROUPS">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="INFO_GROUPS"><!-- --></A><H3> -INFO_GROUPS</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/auth/SecurityVerifier.html#line.112"><B>INFO_GROUPS</B></A></PRE> -<DL> -<DD>Message topic for group database information messages. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.INFO_GROUPS">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="INFO_JAAS"><!-- --></A><H3> -INFO_JAAS</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/auth/SecurityVerifier.html#line.115"><B>INFO_JAAS</B></A></PRE> -<DL> -<DD>Message topic for JAAS information messages. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.wiki.auth.SecurityVerifier.INFO_JAAS">Constant Field Values</A></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="SecurityVerifier(org.apache.wiki.WikiEngine, org.apache.wiki.WikiSession)"><!-- --></A><H3> -SecurityVerifier</H3> -<PRE> -public <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.136"><B>SecurityVerifier</B></A>(<A HREF="../../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine, - <A HREF="../../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A> session)</PRE> -<DL> -<DD>Constructs a new SecurityVerifier for a supplied WikiEngine and WikiSession. -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>engine</CODE> - the wiki engine<DD><CODE>session</CODE> - the wiki session (typically, that of an administrator)</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="policyPrincipals()"><!-- --></A><H3> -policyPrincipals</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/auth/SecurityVerifier.html#line.163"><B>policyPrincipals</B></A>()</PRE> -<DL> -<DD>Returns an array of unique Principals from the JSPWIki security policy - file. This array will be zero-length if the policy file was not - successfully located, or if the file did not specify any Principals in - the policy. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the array of principals</DL> -</DD> -</DL> -<HR> - -<A NAME="policyRoleTable()"><!-- --></A><H3> -policyRoleTable</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/auth/SecurityVerifier.html#line.175"><B>policyRoleTable</B></A>()</PRE> -<DL> -<DD>Formats and returns an HTML table containing sample permissions and what - roles are allowed to have them. This method will throw an - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalStateException</CODE></A> if the authorizer is not of type - <A HREF="../../../../org/apache/wiki/auth/authorize/WebContainerAuthorizer.html" title="class in org.apache.wiki.auth.authorize"><CODE>WebContainerAuthorizer</CODE></A> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the formatted HTML table containing the result of the tests</DL> -</DD> -</DL> -<HR> - -<A NAME="containerRoleTable()"><!-- --></A><H3> -containerRoleTable</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/auth/SecurityVerifier.html#line.345"><B>containerRoleTable</B></A>() - throws <A HREF="../../../../org/apache/wiki/api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</A></PRE> -<DL> -<DD>Formats and returns an HTML table containing the roles the web container - is aware of, and whether each role maps to particular JSPs. This method - throws an <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalStateException</CODE></A> if the authorizer is not of type - <A HREF="../../../../org/apache/wiki/auth/authorize/WebContainerAuthorizer.html" title="class in org.apache.wiki.auth.authorize"><CODE>WebContainerAuthorizer</CODE></A> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the formatted HTML table containing the result of the tests -<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 tests fail for unexpected reasons</DL> -</DD> -</DL> -<HR> - -<A NAME="isSecurityPolicyConfigured()"><!-- --></A><H3> -isSecurityPolicyConfigured</H3> -<PRE> -public boolean <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.435"><B>isSecurityPolicyConfigured</B></A>()</PRE> -<DL> -<DD>Returns <code>true</code> if the Java security policy is configured - correctly, and it verifies as valid. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the result of the configuration check</DL> -</DD> -</DL> -<HR> - -<A NAME="webContainerRoles()"><!-- --></A><H3> -webContainerRoles</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/auth/SecurityVerifier.html#line.446"><B>webContainerRoles</B></A>() - throws <A HREF="../../../../org/apache/wiki/api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</A></PRE> -<DL> -<DD>If the active Authorizer is the WebContainerAuthorizer, returns the roles - it knows about; otherwise, a zero-length array. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the roles parsed from <code>web.xml</code>, or a zero-length array -<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 the web authorizer cannot obtain the list of roles</DL> -</DD> -</DL> -<HR> - -<A NAME="verifyPolicyAndContainerRoles()"><!-- --></A><H3> -verifyPolicyAndContainerRoles</H3> -<PRE> -protected void <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.461"><B>verifyPolicyAndContainerRoles</B></A>() - throws <A HREF="../../../../org/apache/wiki/api/exceptions/WikiException.html" title="class in org.apache.wiki.api.exceptions">WikiException</A></PRE> -<DL> -<DD>Verifies that the roles given in the security policy are reflected by the - container <code>web.xml</code> file. -<P> -<DD><DL> - -<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 the web authorizer cannot verify the roles</DL> -</DD> -</DL> -<HR> - -<A NAME="verifyGroupDatabase()"><!-- --></A><H3> -verifyGroupDatabase</H3> -<PRE> -protected void <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.489"><B>verifyGroupDatabase</B></A>()</PRE> -<DL> -<DD>Verifies that the group datbase was initialized properly, and that - user add and delete operations work as they should. -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="verifyJaas()"><!-- --></A><H3> -verifyJaas</H3> -<PRE> -protected void <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.589"><B>verifyJaas</B></A>()</PRE> -<DL> -<DD>Verfies the JAAS configuration. The configuration is valid if value of the - <code>jspwiki.properties<code> property - <A HREF="../../../../org/apache/wiki/auth/AuthenticationManager.html#PROP_LOGIN_MODULE">"jspwiki.loginModule.class"</A> - resolves to a valid class on the classpath. -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getFileFromProperty(java.lang.String)"><!-- --></A><H3> -getFileFromProperty</H3> -<PRE> -protected <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.649"><B>getFileFromProperty</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> property)</PRE> -<DL> -<DD>Looks up a file name based on a JRE system property and returns the associated - File object if it exists. This method adds messages with the topic prefix - <A HREF="../../../../org/apache/wiki/auth/SecurityVerifier.html#ERROR"><CODE>ERROR</CODE></A> and <A HREF="../../../../org/apache/wiki/auth/SecurityVerifier.html#INFO"><CODE>INFO</CODE></A> as appropriate, with the suffix matching the - supplied property. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>property</CODE> - the system property to look up -<DT><B>Returns:</B><DD>the file object, or <code>null</code> if not found</DL> -</DD> -</DL> -<HR> - -<A NAME="verifyPolicy()"><!-- --></A><H3> -verifyPolicy</H3> -<PRE> -protected void <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.711"><B>verifyPolicy</B></A>()</PRE> -<DL> -<DD>Verfies the Java security policy configuration. The configuration is - valid if value of the local policy (at <code>WEB-INF/jspwiki.policy</code> - resolves to an existing file, and the policy file contained therein - represents a valid policy. -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="verifyStaticPermission(java.security.Principal, java.security.Permission)"><!-- --></A><H3> -verifyStaticPermission</H3> -<PRE> -protected boolean <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.790"><B>verifyStaticPermission</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, - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</A> permission)</PRE> -<DL> -<DD>Verifies that a particular Principal possesses a Permission, as defined - in the security policy file. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>principal</CODE> - the principal<DD><CODE>permission</CODE> - the permission -<DT><B>Returns:</B><DD>the result, based on consultation with the active Java security - policy</DL> -</DD> -</DL> -<HR> - -<A NAME="verifyUserDatabase()"><!-- --></A><H3> -verifyUserDatabase</H3> -<PRE> -protected void <A HREF="../../../../src-html/org/apache/wiki/auth/SecurityVerifier.html#line.825"><B>verifyUserDatabase</B></A>()</PRE> -<DL> -<DD>Verifies that the user datbase was initialized properly, and that - user add and delete operations work as they should. -<P> -<DD><DL> -</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/SecurityVerifier.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/auth/PrincipalComparator.html" title="class in org.apache.wiki.auth"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/wiki/auth/SessionMonitor.html" title="class in org.apache.wiki.auth"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/wiki/auth/SecurityVerifier.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecurityVerifier.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> | <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/auth/SecurityVerifier.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/auth/SecurityVerifier.png b/apidocs/2.10.1/org/apache/wiki/auth/SecurityVerifier.png deleted file mode 100755 index 72b0c0f..0000000 Binary files a/apidocs/2.10.1/org/apache/wiki/auth/SecurityVerifier.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/2e9374f1/apidocs/2.10.1/org/apache/wiki/auth/SessionMonitor.html ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/auth/SessionMonitor.html b/apidocs/2.10.1/org/apache/wiki/auth/SessionMonitor.html deleted file mode 100755 index dd5de4e..0000000 --- a/apidocs/2.10.1/org/apache/wiki/auth/SessionMonitor.html +++ /dev/null @@ -1,530 +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:16 CEST 2014 --> -<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<TITLE> -SessionMonitor (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="SessionMonitor (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/SessionMonitor.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/auth/SecurityVerifier.html" title="class in org.apache.wiki.auth"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/wiki/auth/UserManager.html" title="class in org.apache.wiki.auth"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/wiki/auth/SessionMonitor.html" target="_top"><B>FRAMES</B></A> - <A HREF="SessionMonitor.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <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.auth</FONT> -<BR> -Class SessionMonitor</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.auth.SessionMonitor</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>, javax.servlet.http.HttpSessionListener</DD> -</DL> -<HR> -<DL> -<DT><PRE>public class <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.45"><B>SessionMonitor</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 javax.servlet.http.HttpSessionListener</DL> -</PRE> -<map id="APIVIZ" name="APIVIZ"> -<area shape="rect" id="node1" title="«interface» HttpSessionListener (javax.servlet.http)" alt="" coords="5,6,144,69"/> -<area shape="rect" id="node2" href="SessionMonitor.html" title="SessionMonitor" alt="" coords="19,109,131,137"/> -</map> -<div id="apivizContainer" style="text-align: center;"><img src="SessionMonitor.png" usemap="#APIVIZ" border="0"></div> - -<P> -<p>Manages WikiSession's for different WikiEngine's.</p> - <p>The WikiSession's are stored both in the remote user - HttpSession and in the SessionMonitor for the WikeEngine. - This class must be configured as a session listener in the - web.xml for the wiki web application. - </p> -<P> - -<P> -<HR> - -<P> - -<!-- ======== 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/auth/SessionMonitor.html#SessionMonitor()">SessionMonitor</A></B>()</CODE> - -<BR> - Construct the SessionListener</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/auth/SessionMonitor.html#addWikiEventListener(org.apache.wiki.event.WikiEventListener)">addWikiEventListener</A></B>(<A HREF="../../../../org/apache/wiki/event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</A> listener)</CODE> - -<BR> - Registers a WikiEventListener with this instance.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <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/auth/SessionMonitor.html#find(javax.servlet.http.HttpSession)">find</A></B>(javax.servlet.http.HttpSession session)</CODE> - -<BR> - Looks up the wiki session associated with a user's Http session - and adds it to the session cache.</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/auth/SessionMonitor.html#fireEvent(int, java.security.Principal, org.apache.wiki.WikiSession)">fireEvent</A></B>(int type, - <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, - <A HREF="../../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A> session)</CODE> - -<BR> - Fires a WikiSecurityEvent to all registered listeners.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="../../../../org/apache/wiki/auth/SessionMonitor.html" title="class in org.apache.wiki.auth">SessionMonitor</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/wiki/auth/SessionMonitor.html#getInstance(org.apache.wiki.WikiEngine)">getInstance</A></B>(<A HREF="../../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine)</CODE> - -<BR> - Returns the instance of the SessionMonitor for this wiki.</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/auth/SessionMonitor.html#remove(javax.servlet.http.HttpSession)">remove</A></B>(javax.servlet.http.HttpSession session)</CODE> - -<BR> - Removes the wiki session associated with the user's HttpSession - from the session cache.</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/auth/SessionMonitor.html#removeWikiEventListener(org.apache.wiki.event.WikiEventListener)">removeWikiEventListener</A></B>(<A HREF="../../../../org/apache/wiki/event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</A> listener)</CODE> - -<BR> - Un-registers a WikiEventListener with this instance.</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/auth/SessionMonitor.html#sessionCreated(javax.servlet.http.HttpSessionEvent)">sessionCreated</A></B>(javax.servlet.http.HttpSessionEvent se)</CODE> - -<BR> - Fires when the web container creates a new HTTP 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/auth/SessionMonitor.html#sessionDestroyed(javax.servlet.http.HttpSessionEvent)">sessionDestroyed</A></B>(javax.servlet.http.HttpSessionEvent se)</CODE> - -<BR> - Removes the user's WikiSession from the internal session cache when the web - container destoys an HTTP session.</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/auth/SessionMonitor.html#sessions()">sessions</A></B>()</CODE> - -<BR> - Returns the current number of active wiki sessions.</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/auth/SessionMonitor.html#userPrincipals()">userPrincipals</A></B>()</CODE> - -<BR> - Returns the current wiki users as a sorted array of - Principal objects.</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> - -<!-- ========= 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="SessionMonitor()"><!-- --></A><H3> -SessionMonitor</H3> -<PRE> -public <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.89"><B>SessionMonitor</B></A>()</PRE> -<DL> -<DD>Construct the SessionListener -<P> -</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="getInstance(org.apache.wiki.WikiEngine)"><!-- --></A><H3> -getInstance</H3> -<PRE> -public static final <A HREF="../../../../org/apache/wiki/auth/SessionMonitor.html" title="class in org.apache.wiki.auth">SessionMonitor</A> <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.65"><B>getInstance</B></A>(<A HREF="../../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A> engine)</PRE> -<DL> -<DD>Returns the instance of the SessionMonitor for this wiki. - Only one SessionMonitor exists per WikiEngine. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>engine</CODE> - the wiki engine -<DT><B>Returns:</B><DD>the session monitor</DL> -</DD> -</DL> -<HR> - -<A NAME="find(javax.servlet.http.HttpSession)"><!-- --></A><H3> -find</H3> -<PRE> -public final <A HREF="../../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A> <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.136"><B>find</B></A>(javax.servlet.http.HttpSession session)</PRE> -<DL> -<DD><p>Looks up the wiki session associated with a user's Http session - and adds it to the session cache. This method will return the - "guest session" as constructed by <A HREF="../../../../org/apache/wiki/WikiSession.html#guestSession(org.apache.wiki.WikiEngine)"><CODE>WikiSession.guestSession(WikiEngine)</CODE></A> - if the HttpSession is not currently associated with a WikiSession. - This method is guaranteed to return a non-<code>null</code> WikiSession.</p> - <p>Internally, the session is stored in a HashMap; keys are - the HttpSession objects, while the values are - <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/WeakReference.html?is-external=true" title="class or interface in java.lang.ref"><CODE>WeakReference</CODE></A>-wrapped WikiSessions.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>session</CODE> - the HTTP session -<DT><B>Returns:</B><DD>the wiki session</DL> -</DD> -</DL> -<HR> - -<A NAME="remove(javax.servlet.http.HttpSession)"><!-- --></A><H3> -remove</H3> -<PRE> -public final void <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.163"><B>remove</B></A>(javax.servlet.http.HttpSession session)</PRE> -<DL> -<DD>Removes the wiki session associated with the user's HttpSession - from the session cache. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>session</CODE> - the user's HTTP session</DL> -</DD> -</DL> -<HR> - -<A NAME="sessions()"><!-- --></A><H3> -sessions</H3> -<PRE> -public final int <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.179"><B>sessions</B></A>()</PRE> -<DL> -<DD>Returns the current number of active wiki sessions. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the number of sessions</DL> -</DD> -</DL> -<HR> - -<A NAME="userPrincipals()"><!-- --></A><H3> -userPrincipals</H3> -<PRE> -public final <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/auth/SessionMonitor.html#line.197"><B>userPrincipals</B></A>()</PRE> -<DL> -<DD><p>Returns the current wiki users as a sorted array of - Principal objects. The principals are those returned by - each WikiSession's <A HREF="../../../../org/apache/wiki/WikiSession.html#getUserPrincipal()"><CODE>WikiSession.getUserPrincipal()</CODE></A>'s - method.</p> - <p>To obtain the list of current WikiSessions, we iterate - through our session Map and obtain the list of values, - which are WikiSessions wrapped in <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/WeakReference.html?is-external=true" title="class or interface in java.lang.ref"><CODE>WeakReference</CODE></A> - objects. Those <code>WeakReference</code>s whose <code>get()</code> - method returns non-<code>null</code> values are valid - sessions.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the array of user principals</DL> -</DD> -</DL> -<HR> - -<A NAME="addWikiEventListener(org.apache.wiki.event.WikiEventListener)"><!-- --></A><H3> -addWikiEventListener</H3> -<PRE> -public final void <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.214"><B>addWikiEventListener</B></A>(<A HREF="../../../../org/apache/wiki/event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</A> listener)</PRE> -<DL> -<DD>Registers a WikiEventListener with this instance. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the event listener<DT><B>Since:</B></DT> - <DD>2.4.75</DD> -</DL> -</DD> -</DL> -<HR> - -<A NAME="removeWikiEventListener(org.apache.wiki.event.WikiEventListener)"><!-- --></A><H3> -removeWikiEventListener</H3> -<PRE> -public final void <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.224"><B>removeWikiEventListener</B></A>(<A HREF="../../../../org/apache/wiki/event/WikiEventListener.html" title="interface in org.apache.wiki.event">WikiEventListener</A> listener)</PRE> -<DL> -<DD>Un-registers a WikiEventListener with this instance. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the event listener<DT><B>Since:</B></DT> - <DD>2.4.75</DD> -</DL> -</DD> -</DL> -<HR> - -<A NAME="fireEvent(int, java.security.Principal, org.apache.wiki.WikiSession)"><!-- --></A><H3> -fireEvent</H3> -<PRE> -protected final void <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.236"><B>fireEvent</B></A>(int type, - <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, - <A HREF="../../../../org/apache/wiki/WikiSession.html" title="class in org.apache.wiki">WikiSession</A> session)</PRE> -<DL> -<DD>Fires a WikiSecurityEvent to all registered listeners. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>type</CODE> - the event type<DD><CODE>principal</CODE> - the user principal associated with this session<DD><CODE>session</CODE> - the wiki session<DT><B>Since:</B></DT> - <DD>2.4.75</DD> -</DL> -</DD> -</DL> -<HR> - -<A NAME="sessionCreated(javax.servlet.http.HttpSessionEvent)"><!-- --></A><H3> -sessionCreated</H3> -<PRE> -public void <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.249"><B>sessionCreated</B></A>(javax.servlet.http.HttpSessionEvent se)</PRE> -<DL> -<DD>Fires when the web container creates a new HTTP session. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE>sessionCreated</CODE> in interface <CODE>javax.servlet.http.HttpSessionListener</CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>se</CODE> - the HTTP session event</DL> -</DD> -</DL> -<HR> - -<A NAME="sessionDestroyed(javax.servlet.http.HttpSessionEvent)"><!-- --></A><H3> -sessionDestroyed</H3> -<PRE> -public void <A HREF="../../../../src-html/org/apache/wiki/auth/SessionMonitor.html#line.261"><B>sessionDestroyed</B></A>(javax.servlet.http.HttpSessionEvent se)</PRE> -<DL> -<DD>Removes the user's WikiSession from the internal session cache when the web - container destoys an HTTP session. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE>sessionDestroyed</CODE> in interface <CODE>javax.servlet.http.HttpSessionListener</CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>se</CODE> - the HTTP session event</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/SessionMonitor.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/auth/SecurityVerifier.html" title="class in org.apache.wiki.auth"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/wiki/auth/UserManager.html" title="class in org.apache.wiki.auth"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/wiki/auth/SessionMonitor.html" target="_top"><B>FRAMES</B></A> - <A HREF="SessionMonitor.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <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/auth/SessionMonitor.png ---------------------------------------------------------------------- diff --git a/apidocs/2.10.1/org/apache/wiki/auth/SessionMonitor.png b/apidocs/2.10.1/org/apache/wiki/auth/SessionMonitor.png deleted file mode 100755 index fe4363f..0000000 Binary files a/apidocs/2.10.1/org/apache/wiki/auth/SessionMonitor.png and /dev/null differ