jspwiki-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From juanpa...@apache.org
Subject [08/51] [abbrv] [partial] jspwiki-site git commit: Site + Apidocs Maven Publish
Date Tue, 20 Jun 2017 21:51:16 GMT
http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/b37788df/apidocs/2.10.1/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html
----------------------------------------------------------------------
diff --git a/apidocs/2.10.1/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html b/apidocs/2.10.1/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html
new file mode 100755
index 0000000..f3a8837
--- /dev/null
+++ b/apidocs/2.10.1/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html
@@ -0,0 +1,906 @@
+<!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>
+JDBCGroupDatabase (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="JDBCGroupDatabase (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>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JDBCGroupDatabase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+  </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/GroupManager.html" title="class in org.apache.wiki.auth.authorize"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../../../index.html?org/apache/wiki/auth/authorize/JDBCGroupDatabase.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="JDBCGroupDatabase.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
+&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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.authorize</FONT>
+<BR>
+Class JDBCGroupDatabase</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.authorize.JDBCGroupDatabase</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html" title="interface in org.apache.wiki.auth.authorize">GroupDatabase</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.135"><B>JDBCGroupDatabase</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/auth/authorize/GroupDatabase.html" title="interface in org.apache.wiki.auth.authorize">GroupDatabase</A></DL>
+</PRE>
+<map id="APIVIZ" name="APIVIZ">
+<area shape="rect" id="node1" href="GroupDatabase.html" title="&#171;interface&#187; GroupDatabase" alt="" coords="21,5,133,51"/>
+<area shape="rect" id="node2" href="JDBCGroupDatabase.html" title="JDBCGroupDatabase" alt="" coords="5,90,149,118"/>
+</map>
+<div id="apivizContainer" style="text-align: center;"><img src="JDBCGroupDatabase.png" usemap="#APIVIZ" border="0"></div>
+
+<P>
+<p>
+ Implementation of GroupDatabase that persists <A HREF="../../../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize"><CODE>Group</CODE></A> objects to a JDBC
+ DataSource, as might typically be provided by a web container. This
+ implementation looks up the JDBC DataSource using JNDI. The JNDI name of the
+ datasource, backing table and mapped columns used by this class can be
+ overridden by adding settings in <code>jspwiki.properties</code>.
+ </p>
+ <p>
+ Configurable properties are these:
+ </p>
+ <table>
+ <tr> <thead>
+ <th>Property</th>
+ <th>Default</th>
+ <th>Definition</th>
+ <thead> </tr>
+ <tr>
+ <td><code>jspwiki.groupdatabase.datasource</code></td>
+ <td><code>jdbc/GroupDatabase</code></td>
+ <td>The JNDI name of the DataSource</td>
+ </tr>
+ <tr>
+ <td><code>jspwiki.groupdatabase.table</code></td>
+ <td><code>groups</code></td>
+ <td>The table that stores the groups</td>
+ </tr>
+ <tr>
+ <td><code>jspwiki.groupdatabase.membertable</code></td>
+ <td><code>group_members</code></td>
+ <td>The table that stores the names of group members</td>
+ </tr>
+ <tr>
+ <td><code>jspwiki.groupdatabase.created</code></td>
+ <td><code>created</code></td>
+ <td>The column containing the group's creation timestamp</td>
+ </tr>
+ <tr>
+ <td><code>jspwiki.groupdatabase.creator</code></td>
+ <td><code>creator</code></td>
+ <td>The column containing the group creator's name</td>
+ </tr>
+ <tr>
+ <td><code>jspwiki.groupdatabase.name</code></td>
+ <td><code>name</code></td>
+ <td>The column containing the group's name</td>
+ </tr>
+ <tr>
+ <td><code>jspwiki.groupdatabase.member</code></td>
+ <td><code>member</code></td>
+ <td>The column containing the group member's name</td>
+ </tr>
+ <tr>
+ <td><code>jspwiki.groupdatabase.modified</code></td>
+ <td><code>modified</code></td>
+ <td>The column containing the group's last-modified timestamp</td>
+ </tr>
+ <tr>
+ <td><code>jspwiki.groupdatabase.modifier</code></td>
+ <td><code>modifier</code></td>
+ <td>The column containing the name of the user who last modified the group</td>
+ </tr>
+ </table>
+ <p>
+ This class is typically used in conjunction with a web container's JNDI
+ resource factory. For example, Tomcat versions 4 and higher provide a basic
+ JNDI factory for registering DataSources. To give JSPWiki access to the JNDI
+ resource named by <code>jdbc/GroupDatabase</code>, you would declare the
+ datasource resource similar to this:
+ </p>
+ <blockquote><code>&lt;Context ...&gt;<br/>
+  &nbsp;&nbsp;...<br/>
+  &nbsp;&nbsp;&lt;Resource name="jdbc/GroupDatabase" auth="Container"<br/>
+  &nbsp;&nbsp;&nbsp;&nbsp;type="javax.sql.DataSource" username="dbusername" password="dbpassword"<br/>
+  &nbsp;&nbsp;&nbsp;&nbsp;driverClassName="org.hsql.jdbcDriver" url="jdbc:HypersonicSQL:database"<br/>
+  &nbsp;&nbsp;&nbsp;&nbsp;maxActive="8" maxIdle="4"/&gt;<br/>
+  &nbsp;...<br/>
+ &lt;/Context&gt;</code></blockquote>
+ <p>
+ JDBC driver JARs should be added to Tomcat's <code>common/lib</code>
+ directory. For more Tomcat 5.5 JNDI configuration examples, see <a
+ href="http://tomcat.apache.org/tomcat-5.5-doc/jndi-resources-howto.html">
+ http://tomcat.apache.org/tomcat-5.5-doc/jndi-resources-howto.html</a>.
+ </p>
+ <p>
+ JDBCGroupDatabase commits changes as transactions if the back-end database
+ supports them. If the database supports transactions, group changes are saved
+ to permanent storage only when the <A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#commit()"><CODE>commit()</CODE></A> method is called. If the
+ database does <em>not</em> support transactions, then changes are made
+ immediately (during the <A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#save(org.apache.wiki.auth.authorize.Group, java.security.Principal)"><CODE>save(Group, Principal)</CODE></A> method), and the
+ <A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#commit()">commit()</A> method no-ops. Thus, callers should always call the
+ <A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#commit()">commit()</A> method after saving a profile to guarantee that
+ changes are applied.
+ </p>
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+  <DD>2.3</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&nbsp;<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/authorize/JDBCGroupDatabase.html#DEFAULT_GROUPDB_CREATED">DEFAULT_GROUPDB_CREATED</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default column name that stores the the group creation timestamps.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#DEFAULT_GROUPDB_CREATOR">DEFAULT_GROUPDB_CREATOR</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default column name that stores group creator names.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#DEFAULT_GROUPDB_DATASOURCE">DEFAULT_GROUPDB_DATASOURCE</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default column name that stores the JNDI name of the DataSource.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#DEFAULT_GROUPDB_MEMBER">DEFAULT_GROUPDB_MEMBER</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default column name that stores group member names.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#DEFAULT_GROUPDB_MEMBER_TABLE">DEFAULT_GROUPDB_MEMBER_TABLE</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default column name that stores the names of group members.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#DEFAULT_GROUPDB_MODIFIED">DEFAULT_GROUPDB_MODIFIED</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default column name that stores group last-modified timestamps.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#DEFAULT_GROUPDB_MODIFIER">DEFAULT_GROUPDB_MODIFIER</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default column name that stores names of users who last modified groups.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#DEFAULT_GROUPDB_NAME">DEFAULT_GROUPDB_NAME</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default column name that stores the group names.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#DEFAULT_GROUPDB_TABLE">DEFAULT_GROUPDB_TABLE</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default table name for the table that stores groups.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected static&nbsp;org.apache.log4j.Logger</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#log">log</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#PROP_GROUPDB_CREATED">PROP_GROUPDB_CREATED</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The column containing the group's creation timestamp.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#PROP_GROUPDB_CREATOR">PROP_GROUPDB_CREATOR</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The column containing the group creator's name.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#PROP_GROUPDB_DATASOURCE">PROP_GROUPDB_DATASOURCE</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The JNDI name of the DataSource.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#PROP_GROUPDB_MEMBER">PROP_GROUPDB_MEMBER</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The column containing the group member's name.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#PROP_GROUPDB_MEMBER_TABLE">PROP_GROUPDB_MEMBER_TABLE</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The table that stores the names of group members.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#PROP_GROUPDB_MODIFIED">PROP_GROUPDB_MODIFIED</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The column containing the group's last-modified timestamp.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#PROP_GROUPDB_MODIFIER">PROP_GROUPDB_MODIFIER</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The column containing the name of the user who last modified the group.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#PROP_GROUPDB_NAME">PROP_GROUPDB_NAME</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The column containing the group's name.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<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/authorize/JDBCGroupDatabase.html#PROP_GROUPDB_TABLE">PROP_GROUPDB_TABLE</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The table that stores the groups.</TD>
+</TR>
+</TABLE>
+&nbsp;
+<!-- ======== 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/authorize/JDBCGroupDatabase.html#JDBCGroupDatabase()">JDBCGroupDatabase</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+</TABLE>
+&nbsp;
+<!-- ========== 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>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#commit()">commit</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>there is no need to call this method because the save and
+             delete methods contain their own commit logic</I></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#delete(org.apache.wiki.auth.authorize.Group)">delete</A></B>(<A HREF="../../../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize">Group</A>&nbsp;group)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Looks up and deletes a <A HREF="../../../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize"><CODE>Group</CODE></A> from the group database.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize">Group</A>[]</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#groups()">groups</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all wiki groups that are stored in the GroupDatabase as an array
+ of Group objects.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#initialize(org.apache.wiki.WikiEngine, java.util.Properties)">initialize</A></B>(<A HREF="../../../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A>&nbsp;engine,
+                     <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A>&nbsp;props)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the group database based on values from a Properties object.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#save(org.apache.wiki.auth.authorize.Group, java.security.Principal)">save</A></B>(<A HREF="../../../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize">Group</A>&nbsp;group,
+         <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>&nbsp;modifier)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Saves a Group to the group database.</TD>
+</TR>
+</TABLE>
+&nbsp;<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>
+&nbsp;
+<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="DEFAULT_GROUPDB_DATASOURCE"><!-- --></A><H3>
+DEFAULT_GROUPDB_DATASOURCE</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/authorize/JDBCGroupDatabase.html#line.138"><B>DEFAULT_GROUPDB_DATASOURCE</B></A></PRE>
+<DL>
+<DD>Default column name that stores the JNDI name of the DataSource.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.DEFAULT_GROUPDB_DATASOURCE">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="DEFAULT_GROUPDB_TABLE"><!-- --></A><H3>
+DEFAULT_GROUPDB_TABLE</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/authorize/JDBCGroupDatabase.html#line.141"><B>DEFAULT_GROUPDB_TABLE</B></A></PRE>
+<DL>
+<DD>Default table name for the table that stores groups.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.DEFAULT_GROUPDB_TABLE">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="DEFAULT_GROUPDB_MEMBER_TABLE"><!-- --></A><H3>
+DEFAULT_GROUPDB_MEMBER_TABLE</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/authorize/JDBCGroupDatabase.html#line.144"><B>DEFAULT_GROUPDB_MEMBER_TABLE</B></A></PRE>
+<DL>
+<DD>Default column name that stores the names of group members.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.DEFAULT_GROUPDB_MEMBER_TABLE">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="DEFAULT_GROUPDB_CREATED"><!-- --></A><H3>
+DEFAULT_GROUPDB_CREATED</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/authorize/JDBCGroupDatabase.html#line.147"><B>DEFAULT_GROUPDB_CREATED</B></A></PRE>
+<DL>
+<DD>Default column name that stores the the group creation timestamps.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.DEFAULT_GROUPDB_CREATED">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="DEFAULT_GROUPDB_CREATOR"><!-- --></A><H3>
+DEFAULT_GROUPDB_CREATOR</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/authorize/JDBCGroupDatabase.html#line.150"><B>DEFAULT_GROUPDB_CREATOR</B></A></PRE>
+<DL>
+<DD>Default column name that stores group creator names.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.DEFAULT_GROUPDB_CREATOR">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="DEFAULT_GROUPDB_NAME"><!-- --></A><H3>
+DEFAULT_GROUPDB_NAME</H3>
+<PRE>
+public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.153"><B>DEFAULT_GROUPDB_NAME</B></A></PRE>
+<DL>
+<DD>Default column name that stores the group names.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.DEFAULT_GROUPDB_NAME">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="DEFAULT_GROUPDB_MEMBER"><!-- --></A><H3>
+DEFAULT_GROUPDB_MEMBER</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/authorize/JDBCGroupDatabase.html#line.156"><B>DEFAULT_GROUPDB_MEMBER</B></A></PRE>
+<DL>
+<DD>Default column name that stores group member names.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.DEFAULT_GROUPDB_MEMBER">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="DEFAULT_GROUPDB_MODIFIED"><!-- --></A><H3>
+DEFAULT_GROUPDB_MODIFIED</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/authorize/JDBCGroupDatabase.html#line.159"><B>DEFAULT_GROUPDB_MODIFIED</B></A></PRE>
+<DL>
+<DD>Default column name that stores group last-modified timestamps.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.DEFAULT_GROUPDB_MODIFIED">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="DEFAULT_GROUPDB_MODIFIER"><!-- --></A><H3>
+DEFAULT_GROUPDB_MODIFIER</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/authorize/JDBCGroupDatabase.html#line.162"><B>DEFAULT_GROUPDB_MODIFIER</B></A></PRE>
+<DL>
+<DD>Default column name that stores names of users who last modified groups.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.DEFAULT_GROUPDB_MODIFIER">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="PROP_GROUPDB_DATASOURCE"><!-- --></A><H3>
+PROP_GROUPDB_DATASOURCE</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/authorize/JDBCGroupDatabase.html#line.165"><B>PROP_GROUPDB_DATASOURCE</B></A></PRE>
+<DL>
+<DD>The JNDI name of the DataSource.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.PROP_GROUPDB_DATASOURCE">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="PROP_GROUPDB_TABLE"><!-- --></A><H3>
+PROP_GROUPDB_TABLE</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/authorize/JDBCGroupDatabase.html#line.168"><B>PROP_GROUPDB_TABLE</B></A></PRE>
+<DL>
+<DD>The table that stores the groups.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.PROP_GROUPDB_TABLE">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="PROP_GROUPDB_MEMBER_TABLE"><!-- --></A><H3>
+PROP_GROUPDB_MEMBER_TABLE</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/authorize/JDBCGroupDatabase.html#line.171"><B>PROP_GROUPDB_MEMBER_TABLE</B></A></PRE>
+<DL>
+<DD>The table that stores the names of group members.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.PROP_GROUPDB_MEMBER_TABLE">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="PROP_GROUPDB_CREATED"><!-- --></A><H3>
+PROP_GROUPDB_CREATED</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/authorize/JDBCGroupDatabase.html#line.174"><B>PROP_GROUPDB_CREATED</B></A></PRE>
+<DL>
+<DD>The column containing the group's creation timestamp.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.PROP_GROUPDB_CREATED">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="PROP_GROUPDB_CREATOR"><!-- --></A><H3>
+PROP_GROUPDB_CREATOR</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/authorize/JDBCGroupDatabase.html#line.177"><B>PROP_GROUPDB_CREATOR</B></A></PRE>
+<DL>
+<DD>The column containing the group creator's name.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.PROP_GROUPDB_CREATOR">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="PROP_GROUPDB_NAME"><!-- --></A><H3>
+PROP_GROUPDB_NAME</H3>
+<PRE>
+public static final <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.180"><B>PROP_GROUPDB_NAME</B></A></PRE>
+<DL>
+<DD>The column containing the group's name.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.PROP_GROUPDB_NAME">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="PROP_GROUPDB_MEMBER"><!-- --></A><H3>
+PROP_GROUPDB_MEMBER</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/authorize/JDBCGroupDatabase.html#line.183"><B>PROP_GROUPDB_MEMBER</B></A></PRE>
+<DL>
+<DD>The column containing the group member's name.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.PROP_GROUPDB_MEMBER">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="PROP_GROUPDB_MODIFIED"><!-- --></A><H3>
+PROP_GROUPDB_MODIFIED</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/authorize/JDBCGroupDatabase.html#line.186"><B>PROP_GROUPDB_MODIFIED</B></A></PRE>
+<DL>
+<DD>The column containing the group's last-modified timestamp.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.PROP_GROUPDB_MODIFIED">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="PROP_GROUPDB_MODIFIER"><!-- --></A><H3>
+PROP_GROUPDB_MODIFIER</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/authorize/JDBCGroupDatabase.html#line.189"><B>PROP_GROUPDB_MODIFIER</B></A></PRE>
+<DL>
+<DD>The column containing the name of the user who last modified the group.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.wiki.auth.authorize.JDBCGroupDatabase.PROP_GROUPDB_MODIFIER">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="log"><!-- --></A><H3>
+log</H3>
+<PRE>
+protected static final org.apache.log4j.Logger <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.191"><B>log</B></A></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="JDBCGroupDatabase()"><!-- --></A><H3>
+JDBCGroupDatabase</H3>
+<PRE>
+public <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.135"><B>JDBCGroupDatabase</B></A>()</PRE>
+<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="commit()"><!-- --></A><H3>
+commit</H3>
+<PRE>
+<FONT SIZE="-1"><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
+</FONT>public void <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.238"><B>commit</B></A>()
+            throws <A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></PRE>
+<DL>
+<DD><B>Deprecated.</B>&nbsp;<I>there is no need to call this method because the save and
+             delete methods contain their own commit logic</I>
+<P>
+<DD>No-op method that in previous versions of JSPWiki was intended to
+ atomically commit changes to the user database. Now, the
+ <A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#save(org.apache.wiki.auth.authorize.Group, java.security.Principal)"><CODE>save(Group, Principal)</CODE></A> and <A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#delete(org.apache.wiki.auth.authorize.Group)"><CODE>delete(Group)</CODE></A> methods are
+ atomic themselves.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html#commit()">commit</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html" title="interface in org.apache.wiki.auth.authorize">GroupDatabase</A></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></CODE> - never...</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="delete(org.apache.wiki.auth.authorize.Group)"><!-- --></A><H3>
+delete</H3>
+<PRE>
+public void <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.253"><B>delete</B></A>(<A HREF="../../../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize">Group</A>&nbsp;group)
+            throws <A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></PRE>
+<DL>
+<DD>Looks up and deletes a <A HREF="../../../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize"><CODE>Group</CODE></A> from the group database. If the
+ group database does not contain the supplied Group. this method throws a
+ <A HREF="../../../../../org/apache/wiki/auth/NoSuchPrincipalException.html" title="class in org.apache.wiki.auth"><CODE>NoSuchPrincipalException</CODE></A>. The method commits the results of the
+ delete to persistent storage.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html#delete(org.apache.wiki.auth.authorize.Group)">delete</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html" title="interface in org.apache.wiki.auth.authorize">GroupDatabase</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group to remove
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></CODE> - if the database does not contain the
+             supplied group (thrown as <A HREF="../../../../../org/apache/wiki/auth/NoSuchPrincipalException.html" title="class in org.apache.wiki.auth"><CODE>NoSuchPrincipalException</CODE></A>)
+             or if the commit did not succeed</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="groups()"><!-- --></A><H3>
+groups</H3>
+<PRE>
+public <A HREF="../../../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize">Group</A>[] <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.309"><B>groups</B></A>()
+               throws <A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></PRE>
+<DL>
+<DD>Returns all wiki groups that are stored in the GroupDatabase as an array
+ of Group objects. If the database does not contain any groups, this
+ method will return a zero-length array. This method causes back-end
+ storage to load the entire set of group; thus, it should be called
+ infrequently (e.g., at initialization time).
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html#groups()">groups</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html" title="interface in org.apache.wiki.auth.authorize">GroupDatabase</A></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the wiki groups
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></CODE> - if the groups cannot be returned by the
+             back-end</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="save(org.apache.wiki.auth.authorize.Group, java.security.Principal)"><!-- --></A><H3>
+save</H3>
+<PRE>
+public void <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.367"><B>save</B></A>(<A HREF="../../../../../org/apache/wiki/auth/authorize/Group.html" title="class in org.apache.wiki.auth.authorize">Group</A>&nbsp;group,
+                 <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>&nbsp;modifier)
+          throws <A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></PRE>
+<DL>
+<DD>Saves a Group to the group database. Note that this method <em>must</em>
+ fail, and throw an <code>IllegalArgumentException</code>, if the
+ proposed group is the same name as one of the built-in Roles: e.g.,
+ Admin, Authenticated, etc. The database is responsible for setting
+ create/modify timestamps, upon a successful save, to the Group. The
+ method commits the results of the delete to persistent storage.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html#save(org.apache.wiki.auth.authorize.Group, java.security.Principal)">save</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html" title="interface in org.apache.wiki.auth.authorize">GroupDatabase</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>group</CODE> - the Group to save<DD><CODE>modifier</CODE> - the user who saved the Group
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></CODE> - if the Group could not be saved
+             successfully</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="initialize(org.apache.wiki.WikiEngine, java.util.Properties)"><!-- --></A><H3>
+initialize</H3>
+<PRE>
+public void <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/JDBCGroupDatabase.html#line.463"><B>initialize</B></A>(<A HREF="../../../../../org/apache/wiki/WikiEngine.html" title="class in org.apache.wiki">WikiEngine</A>&nbsp;engine,
+                       <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A>&nbsp;props)
+                throws <A HREF="../../../../../org/apache/wiki/api/exceptions/NoRequiredPropertyException.html" title="class in org.apache.wiki.api.exceptions">NoRequiredPropertyException</A>,
+                       <A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></PRE>
+<DL>
+<DD>Initializes the group database based on values from a Properties object.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html#initialize(org.apache.wiki.WikiEngine, java.util.Properties)">initialize</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/wiki/auth/authorize/GroupDatabase.html" title="interface in org.apache.wiki.auth.authorize">GroupDatabase</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>engine</CODE> - the wiki engine<DD><CODE>props</CODE> - the properties used to initialize the group database
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../org/apache/wiki/auth/WikiSecurityException.html" title="class in org.apache.wiki.auth">WikiSecurityException</A></CODE> - if the database could not be initialized
+             successfully
+<DD><CODE><A HREF="../../../../../org/apache/wiki/api/exceptions/NoRequiredPropertyException.html" title="class in org.apache.wiki.api.exceptions">NoRequiredPropertyException</A></CODE> - if a required property is not present</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>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JDBCGroupDatabase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+  </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/GroupManager.html" title="class in org.apache.wiki.auth.authorize"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../../../index.html?org/apache/wiki/auth/authorize/JDBCGroupDatabase.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="JDBCGroupDatabase.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
+&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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/b37788df/apidocs/2.10.1/org/apache/wiki/auth/authorize/JDBCGroupDatabase.png
----------------------------------------------------------------------
diff --git a/apidocs/2.10.1/org/apache/wiki/auth/authorize/JDBCGroupDatabase.png b/apidocs/2.10.1/org/apache/wiki/auth/authorize/JDBCGroupDatabase.png
new file mode 100755
index 0000000..b2d43e0
Binary files /dev/null and b/apidocs/2.10.1/org/apache/wiki/auth/authorize/JDBCGroupDatabase.png differ

http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/b37788df/apidocs/2.10.1/org/apache/wiki/auth/authorize/Role.html
----------------------------------------------------------------------
diff --git a/apidocs/2.10.1/org/apache/wiki/auth/authorize/Role.html b/apidocs/2.10.1/org/apache/wiki/auth/authorize/Role.html
new file mode 100755
index 0000000..e999cd4
--- /dev/null
+++ b/apidocs/2.10.1/org/apache/wiki/auth/authorize/Role.html
@@ -0,0 +1,537 @@
+<!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>
+Role (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="Role (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>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Role.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+  </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html" title="class in org.apache.wiki.auth.authorize"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/WebAuthorizer.html" title="interface in org.apache.wiki.auth.authorize"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../../../index.html?org/apache/wiki/auth/authorize/Role.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="Role.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
+&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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.authorize</FONT>
+<BR>
+Class Role</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.authorize.Role</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</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></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public final class <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.31"><B>Role</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="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="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
+</PRE>
+<map id="APIVIZ" name="APIVIZ">
+<area shape="rect" id="node1" title="&#171;interface&#187; Serializable (java.io)" alt="" coords="5,6,93,69"/>
+<area shape="rect" id="node2" title="&#171;interface&#187; Principal (java.security)" alt="" coords="123,6,224,69"/>
+<area shape="rect" id="node3" href="Role.html" title="Role" alt="" coords="87,109,135,137"/>
+</map>
+<div id="apivizContainer" style="text-align: center;"><img src="Role.png" usemap="#APIVIZ" border="0"></div>
+
+<P>
+A lightweight, immutable Principal that represents a built-in wiki role such
+ as Anonymous, Asserted and Authenticated. It can also represent dynamic roles
+ used by an external <A HREF="../../../../../org/apache/wiki/auth/Authorizer.html" title="interface in org.apache.wiki.auth"><CODE>Authorizer</CODE></A>, such as a web
+ container.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+  <DD>2.3</DD>
+<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.wiki.auth.authorize.Role">Serialized Form</A></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&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ALL">ALL</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;All users, regardless of authentication status</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ANONYMOUS">ANONYMOUS</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the user hasn't supplied a name</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ASSERTED">ASSERTED</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the user has supplied a cookie with a username</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#AUTHENTICATED">AUTHENTICATED</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the user has authenticated with the Container or UserDatabase</TD>
+</TR>
+</TABLE>
+&nbsp;
+<!-- ======== 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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected </CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#Role()">Role</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create an empty Role.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#Role(java.lang.String)">Role</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>&nbsp;name)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new Role with a given name.</TD>
+</TR>
+</TABLE>
+&nbsp;
+<!-- ========== 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>&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#equals(java.lang.Object)">equals</A></B>(<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>&nbsp;obj)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Two Role objects are considered equal if their names are identical.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<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/authorize/Role.html#getName()">getName</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the Principal.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#hashCode()">hashCode</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a unique hashcode for the Role.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#isBuiltInRole(org.apache.wiki.auth.authorize.Role)">isBuiltInRole</A></B>(<A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A>&nbsp;role)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if a supplied Role is a built-in Role:
+ <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ALL"><CODE>ALL</CODE></A>, <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ANONYMOUS"><CODE>ANONYMOUS</CODE></A>, <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ASSERTED"><CODE>ASSERTED</CODE></A>,
+ or <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#AUTHENTICATED"><CODE>AUTHENTICATED</CODE></A>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#isReservedName(java.lang.String)">isReservedName</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>&nbsp;name)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the supplied name is identical to the name
+ of a built-in Role; that is, the value returned by <code>getName()</code>
+ for built-in Roles <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ALL"><CODE>ALL</CODE></A>, <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ANONYMOUS"><CODE>ANONYMOUS</CODE></A>,
+ <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ASSERTED"><CODE>ASSERTED</CODE></A>, or <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#AUTHENTICATED"><CODE>AUTHENTICATED</CODE></A>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<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/authorize/Role.html#toString()">toString</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a String representation of the role</TD>
+</TR>
+</TABLE>
+&nbsp;<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#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#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#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?i
 s-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>
+&nbsp;
+<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="ALL"><!-- --></A><H3>
+ALL</H3>
+<PRE>
+public static final <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A> <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.36"><B>ALL</B></A></PRE>
+<DL>
+<DD>All users, regardless of authentication status
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="ANONYMOUS"><!-- --></A><H3>
+ANONYMOUS</H3>
+<PRE>
+public static final <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A> <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.39"><B>ANONYMOUS</B></A></PRE>
+<DL>
+<DD>If the user hasn't supplied a name
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="ASSERTED"><!-- --></A><H3>
+ASSERTED</H3>
+<PRE>
+public static final <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A> <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.42"><B>ASSERTED</B></A></PRE>
+<DL>
+<DD>If the user has supplied a cookie with a username
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="AUTHENTICATED"><!-- --></A><H3>
+AUTHENTICATED</H3>
+<PRE>
+public static final <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A> <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.45"><B>AUTHENTICATED</B></A></PRE>
+<DL>
+<DD>If the user has authenticated with the Container or UserDatabase
+<P>
+<DL>
+</DL>
+</DL>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="Role()"><!-- --></A><H3>
+Role</H3>
+<PRE>
+protected <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.52"><B>Role</B></A>()</PRE>
+<DL>
+<DD>Create an empty Role.
+<P>
+</DL>
+<HR>
+
+<A NAME="Role(java.lang.String)"><!-- --></A><H3>
+Role</H3>
+<PRE>
+public <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.61"><B>Role</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>&nbsp;name)</PRE>
+<DL>
+<DD>Constructs a new Role with a given name.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the Role</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="isBuiltInRole(org.apache.wiki.auth.authorize.Role)"><!-- --></A><H3>
+isBuiltInRole</H3>
+<PRE>
+public static boolean <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.73"><B>isBuiltInRole</B></A>(<A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html" title="class in org.apache.wiki.auth.authorize">Role</A>&nbsp;role)</PRE>
+<DL>
+<DD>Returns <code>true</code> if a supplied Role is a built-in Role:
+ <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ALL"><CODE>ALL</CODE></A>, <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ANONYMOUS"><CODE>ANONYMOUS</CODE></A>, <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ASSERTED"><CODE>ASSERTED</CODE></A>,
+ or <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#AUTHENTICATED"><CODE>AUTHENTICATED</CODE></A>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>role</CODE> - the role to check
+<DT><B>Returns:</B><DD>the result of the check</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isReservedName(java.lang.String)"><!-- --></A><H3>
+isReservedName</H3>
+<PRE>
+public static boolean <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.89"><B>isReservedName</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>&nbsp;name)</PRE>
+<DL>
+<DD>Returns <code>true</code> if the supplied name is identical to the name
+ of a built-in Role; that is, the value returned by <code>getName()</code>
+ for built-in Roles <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ALL"><CODE>ALL</CODE></A>, <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ANONYMOUS"><CODE>ANONYMOUS</CODE></A>,
+ <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#ASSERTED"><CODE>ASSERTED</CODE></A>, or <A HREF="../../../../../org/apache/wiki/auth/authorize/Role.html#AUTHENTICATED"><CODE>AUTHENTICATED</CODE></A>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name to be tested
+<DT><B>Returns:</B><DD><code>true</code> if the name is reserved; <code>false</code>
+         if not</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="hashCode()"><!-- --></A><H3>
+hashCode</H3>
+<PRE>
+public int <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.100"><B>hashCode</B></A>()</PRE>
+<DL>
+<DD>Returns a unique hashcode for the Role.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Principal.html?is-external=true#hashCode()" title="class or interface in java.security">hashCode</A></CODE> in interface <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><DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the hashcode</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
+equals</H3>
+<PRE>
+public boolean <A HREF="../../../../../src-html/org/apache/wiki/auth/authorize/Role.html#line.111"><B>equals</B></A>(<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>&nbsp;obj)</PRE>
+<DL>
+<DD>Two Role objects are considered equal if their names are identical.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Principal.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.security">equals</A></CODE> in interface <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><DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to test
+<DT><B>Returns:</B><DD><code>true</code> if both objects are of type Role and have identical names<DT><B>See Also:</B><DD><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"><CODE>Object.equals(java.lang.Object)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getName()"><!-- --></A><H3>
+getName</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/authorize/Role.html#line.121"><B>getName</B></A>()</PRE>
+<DL>
+<DD>Returns the name of the Principal.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Principal.html?is-external=true#getName()" title="class or interface in java.security">getName</A></CODE> in interface <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></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the name of the Role</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="toString()"><!-- --></A><H3>
+toString</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/authorize/Role.html#line.131"><B>toString</B></A>()</PRE>
+<DL>
+<DD>Returns a String representation of the role
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/security/Principal.html?is-external=true#toString()" title="class or interface in java.security">toString</A></CODE> in interface <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><DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the string representation of the role<DT><B>See Also:</B><DD><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"><CODE>Object.toString()</CODE></A></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>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Role.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+  </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/JDBCGroupDatabase.html" title="class in org.apache.wiki.auth.authorize"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../org/apache/wiki/auth/authorize/WebAuthorizer.html" title="interface in org.apache.wiki.auth.authorize"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../../../index.html?org/apache/wiki/auth/authorize/Role.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="Role.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
+&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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/b37788df/apidocs/2.10.1/org/apache/wiki/auth/authorize/Role.png
----------------------------------------------------------------------
diff --git a/apidocs/2.10.1/org/apache/wiki/auth/authorize/Role.png b/apidocs/2.10.1/org/apache/wiki/auth/authorize/Role.png
new file mode 100755
index 0000000..534d7f2
Binary files /dev/null and b/apidocs/2.10.1/org/apache/wiki/auth/authorize/Role.png differ


Mime
View raw message