basesecurityservice.html

turbine教程

<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.turbine.services.<A HREF="../../../../../org/apache/turbine/services/BaseService.html">BaseService</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/turbine/services/BaseService.html#getConfiguration()">getConfiguration</A>, <A HREF="../../../../../org/apache/turbine/services/BaseService.html#getName()">getName</A>, <A HREF="../../../../../org/apache/turbine/services/BaseService.html#getProperties()">getProperties</A>, <A HREF="../../../../../org/apache/turbine/services/BaseService.html#getServiceBroker()">getServiceBroker</A>, <A HREF="../../../../../org/apache/turbine/services/BaseService.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../../org/apache/turbine/services/BaseService.html#setServiceBroker(org.apache.turbine.services.ServiceBroker)">setServiceBroker</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.turbine.services.BaseInitable"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.turbine.services.<A HREF="../../../../../org/apache/turbine/services/BaseInitable.html">BaseInitable</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/turbine/services/BaseInitable.html#getInit()">getInit</A>, <A HREF="../../../../../org/apache/turbine/services/BaseInitable.html#getInitableBroker()">getInitableBroker</A>, <A HREF="../../../../../org/apache/turbine/services/BaseInitable.html#setInit(boolean)">setInit</A>, <A HREF="../../../../../org/apache/turbine/services/BaseInitable.html#setInitableBroker(org.apache.turbine.services.InitableBroker)">setInitableBroker</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.turbine.services.security.SecurityService"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from interface org.apache.turbine.services.security.<A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html">SecurityService</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#addGroup(org.apache.turbine.om.security.Group)">addGroup</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#addPermission(org.apache.turbine.om.security.Permission)">addPermission</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#addRole(org.apache.turbine.om.security.Role)">addRole</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getACL(org.apache.turbine.om.security.User)">getACL</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getGroups(org.apache.torque.util.Criteria)">getGroups</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getNewGroup(java.lang.String)">getNewGroup</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getNewPermission(java.lang.String)">getNewPermission</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getNewRole(java.lang.String)">getNewRole</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getPermissions(org.apache.torque.util.Criteria)">getPermissions</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getPermissions(org.apache.turbine.om.security.Role)">getPermissions</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getRoles(org.apache.torque.util.Criteria)">getRoles</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#grant(org.apache.turbine.om.security.Role, org.apache.turbine.om.security.Permission)">grant</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#grant(org.apache.turbine.om.security.User, org.apache.turbine.om.security.Group, org.apache.turbine.om.security.Role)">grant</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#removeGroup(org.apache.turbine.om.security.Group)">removeGroup</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#removePermission(org.apache.turbine.om.security.Permission)">removePermission</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#removeRole(org.apache.turbine.om.security.Role)">removeRole</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#renameGroup(org.apache.turbine.om.security.Group, java.lang.String)">renameGroup</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#renamePermission(org.apache.turbine.om.security.Permission, java.lang.String)">renamePermission</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#renameRole(org.apache.turbine.om.security.Role, java.lang.String)">renameRole</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#revoke(org.apache.turbine.om.security.Role, org.apache.turbine.om.security.Permission)">revoke</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#revoke(org.apache.turbine.om.security.User, org.apache.turbine.om.security.Group, org.apache.turbine.om.security.Role)">revoke</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#revokeAll(org.apache.turbine.om.security.Role)">revokeAll</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#revokeAll(org.apache.turbine.om.security.User)">revokeAll</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#saveGroup(org.apache.turbine.om.security.Group)">saveGroup</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#savePermission(org.apache.turbine.om.security.Permission)">savePermission</A>, <A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#saveRole(org.apache.turbine.om.security.Role)">saveRole</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.turbine.services.Service"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from interface org.apache.turbine.services.<A HREF="../../../../../org/apache/turbine/services/Service.html">Service</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/turbine/services/Service.html#getConfiguration()">getConfiguration</A>, <A HREF="../../../../../org/apache/turbine/services/Service.html#getName()">getName</A>, <A HREF="../../../../../org/apache/turbine/services/Service.html#getProperties()">getProperties</A>, <A HREF="../../../../../org/apache/turbine/services/Service.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../../org/apache/turbine/services/Service.html#setServiceBroker(org.apache.turbine.services.ServiceBroker)">setServiceBroker</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.turbine.services.Initable"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from interface org.apache.turbine.services.<A HREF="../../../../../org/apache/turbine/services/Initable.html">Initable</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/turbine/services/Initable.html#getInit()">getInit</A>, <A HREF="../../../../../org/apache/turbine/services/Initable.html#init()">init</A>, <A HREF="../../../../../org/apache/turbine/services/Initable.html#init(java.lang.Object)">init</A>, <A HREF="../../../../../org/apache/turbine/services/Initable.html#setInitableBroker(org.apache.turbine.services.InitableBroker)">setInitableBroker</A>, <A HREF="../../../../../org/apache/turbine/services/Initable.html#shutdown()">shutdown</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="BaseSecurityService()"><!-- --></A><H3>
BaseSecurityService</H3>
<PRE>
public <B>BaseSecurityService</B>()</PRE>
<DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="encryptPassword(java.lang.String)"><!-- --></A><H3>
encryptPassword</H3>
<PRE>
public java.lang.String <B>encryptPassword</B>(java.lang.String&nbsp;password)</PRE>
<DL>
<DD>This method provides client-side encryption of passwords.

 If <code>secure.passwords</code> are enabled in TurbineResources,
 the password will be encrypted, if not, it will be returned unchanged.
 The <code>secure.passwords.algorithm</code> property can be used
 to chose which digest algorithm should be used for performing the
 encryption. <code>SHA</code> is used by default.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#encryptPassword(java.lang.String)">encryptPassword</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html">SecurityService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>password</CODE> - the password to process<DT><B>Returns:</B><DD>processed password</DL>
</DD>
</DL>
<HR>

<A NAME="init(javax.servlet.ServletConfig)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(javax.servlet.ServletConfig&nbsp;config)
          throws <A HREF="../../../../../org/apache/turbine/services/InitializationException.html">InitializationException</A></PRE>
<DL>
<DD>Initializes the SecurityService, locating the apropriate UserManager<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/TurbineBaseService.html#init(javax.servlet.ServletConfig)">init</A></CODE> in class <CODE><A HREF="../../../../../org/apache/turbine/services/TurbineBaseService.html">TurbineBaseService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - a ServletConfig, to enforce early initialization</DL>
</DD>
</DL>
<HR>

<A NAME="getUserClass()"><!-- --></A><H3>
getUserClass</H3>
<PRE>
public java.lang.Class <B>getUserClass</B>()
                             throws <A HREF="../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Return a Class object representing the system's chosen implementation of
 of User interface.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getUserClass()">getUserClass</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html">SecurityService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>systems's chosen implementation of User interface.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if the implementation of User interface
         could not be determined, or does not exist.</DL>
</DD>
</DL>
<HR>

<A NAME="getUserInstance()"><!-- --></A><H3>
getUserInstance</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/om/security/User.html">User</A> <B>getUserInstance</B>()
                     throws <A HREF="../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Construct a blank User object.

 This method calls getUserClass, and then creates a new object using
 the default constructor.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#getUserInstance()">getUserInstance</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html">SecurityService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an object implementing User interface.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if the object could not be instantiated.</DL>
</DD>
</DL>
<HR>

<A NAME="accountExists(org.apache.turbine.om.security.User)"><!-- --></A><H3>
accountExists</H3>
<PRE>
public boolean <B>accountExists</B>(<A HREF="../../../../../org/apache/turbine/om/security/User.html">User</A>&nbsp;user)
                      throws <A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></PRE>
<DL>
<DD>Check whether a specified user's account exists.

 The login name is used for looking up the account.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#accountExists(org.apache.turbine.om.security.User)">accountExists</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html">SecurityService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - The user to be checked.<DT><B>Returns:</B><DD>true if the specified account exists<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></CODE> - if there was an error accessing the data
         backend.</DL>
</DD>
</DL>
<HR>

<A NAME="accountExists(java.lang.String)"><!-- --></A><H3>
accountExists</H3>
<PRE>
public boolean <B>accountExists</B>(java.lang.String&nbsp;username)
                      throws <A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></PRE>
<DL>
<DD>Check whether a specified user's account exists.

 The login name is used for looking up the account.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html#accountExists(java.lang.String)">accountExists</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/security/SecurityService.html">SecurityService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>usename</CODE> - The name of the user to be checked.<DT><B>Returns:</B><DD>true if the specified account exists<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></CODE> - if there was an error accessing the data
         backend.</DL>
</DD>
</DL>
<HR>

<A NAME="getAuthenticatedUser(java.lang.String, java.lang.String)"><!-- --></A><H3>
getAuthenticatedUser</H3>
<PRE>