dbsecurityservice.html

turbine教程

<!-- ============ 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="getACL(org.apache.turbine.om.security.User)"><!-- --></A><H3>
getACL</H3>
<PRE>
public <A HREF="../../../../../../org/apache/turbine/util/security/AccessControlList.html">AccessControlList</A> <B>getACL</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>,
                                <A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Constructs an AccessControlList for a specific user.

 This method creates a snapshot of the state of security information
 concerning this user, at the moment of invocation and stores it
 into an AccessControlList object.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the user for whom the AccessControlList are to be retrieved<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.<DD><CODE><A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if user account is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="grant(org.apache.turbine.om.security.User, org.apache.turbine.om.security.Group, org.apache.turbine.om.security.Role)"><!-- --></A><H3>
grant</H3>
<PRE>
public void <B>grant</B>(<A HREF="../../../../../../org/apache/turbine/om/security/User.html">User</A>&nbsp;user,
                  <A HREF="../../../../../../org/apache/turbine/om/security/Group.html">Group</A>&nbsp;group,
                  <A HREF="../../../../../../org/apache/turbine/om/security/Role.html">Role</A>&nbsp;role)
           throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A>,
                  <A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Grant an User a Role in a Group.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>User</CODE> - the user.<DD><CODE>Group</CODE> - the group.<DD><CODE>Role</CODE> - the role.<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.<DD><CODE><A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if user account, group or role is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="revoke(org.apache.turbine.om.security.User, org.apache.turbine.om.security.Group, org.apache.turbine.om.security.Role)"><!-- --></A><H3>
revoke</H3>
<PRE>
public void <B>revoke</B>(<A HREF="../../../../../../org/apache/turbine/om/security/User.html">User</A>&nbsp;user,
                   <A HREF="../../../../../../org/apache/turbine/om/security/Group.html">Group</A>&nbsp;group,
                   <A HREF="../../../../../../org/apache/turbine/om/security/Role.html">Role</A>&nbsp;role)
            throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A>,
                   <A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Revoke a Role in a Group from an User.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>User</CODE> - the user.<DD><CODE>Group</CODE> - the group.<DD><CODE>Role</CODE> - the role.<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.<DD><CODE><A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if user account, group or role is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="revokeAll(org.apache.turbine.om.security.User)"><!-- --></A><H3>
revokeAll</H3>
<PRE>
public void <B>revokeAll</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>,
                      <A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Revokes all roles from an User.

 This method is used when deleting an account.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the User.<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.<DD><CODE><A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if the account is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="grant(org.apache.turbine.om.security.Role, org.apache.turbine.om.security.Permission)"><!-- --></A><H3>
grant</H3>
<PRE>
public void <B>grant</B>(<A HREF="../../../../../../org/apache/turbine/om/security/Role.html">Role</A>&nbsp;role,
                  <A HREF="../../../../../../org/apache/turbine/om/security/Permission.html">Permission</A>&nbsp;permission)
           throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A>,
                  <A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Grants a Role a Permission<DD><DL>
<DT><B>Parameters:</B><DD><CODE>role</CODE> - the Role.<DD><CODE>permission</CODE> - the Permission.<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.<DD><CODE><A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if role or permission is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="revoke(org.apache.turbine.om.security.Role, org.apache.turbine.om.security.Permission)"><!-- --></A><H3>
revoke</H3>
<PRE>
public void <B>revoke</B>(<A HREF="../../../../../../org/apache/turbine/om/security/Role.html">Role</A>&nbsp;role,
                   <A HREF="../../../../../../org/apache/turbine/om/security/Permission.html">Permission</A>&nbsp;permission)
            throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A>,
                   <A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Revokes a Permission from a Role.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>role</CODE> - the Role.<DD><CODE>permission</CODE> - the Permission.<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.<DD><CODE><A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if role or permission is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="revokeAll(org.apache.turbine.om.security.Role)"><!-- --></A><H3>
revokeAll</H3>
<PRE>
public void <B>revokeAll</B>(<A HREF="../../../../../../org/apache/turbine/om/security/Role.html">Role</A>&nbsp;role)
               throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A>,
                      <A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Revokes all permissions from a Role.

 This method is user when deleting a Role.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>role</CODE> - the Role<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.<DD><CODE><A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if the Role is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroups(org.apache.torque.util.Criteria)"><!-- --></A><H3>
getGroups</H3>
<PRE>
public <A HREF="../../../../../../org/apache/turbine/util/security/GroupSet.html">GroupSet</A> <B>getGroups</B>(org.apache.torque.util.Criteria&nbsp;criteria)
                   throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></PRE>
<DL>
<DD>Retrieve a set of Groups that meet the specified Criteria.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>a</CODE> - Criteria of Group selection.<DT><B>Returns:</B><DD>a set of Groups that meet the specified Criteria.</DL>
</DD>
</DL>
<HR>

<A NAME="getRoles(org.apache.torque.util.Criteria)"><!-- --></A><H3>
getRoles</H3>
<PRE>
public <A HREF="../../../../../../org/apache/turbine/util/security/RoleSet.html">RoleSet</A> <B>getRoles</B>(org.apache.torque.util.Criteria&nbsp;criteria)
                 throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></PRE>
<DL>
<DD>Retrieve a set of Roles that meet the specified Criteria.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>a</CODE> - Criteria of Roles selection.<DT><B>Returns:</B><DD>a set of Roles that meet the specified Criteria.</DL>
</DD>
</DL>
<HR>

<A NAME="getPermissions(org.apache.torque.util.Criteria)"><!-- --></A><H3>
getPermissions</H3>
<PRE>
public <A HREF="../../../../../../org/apache/turbine/util/security/PermissionSet.html">PermissionSet</A> <B>getPermissions</B>(org.apache.torque.util.Criteria&nbsp;criteria)
                             throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></PRE>
<DL>
<DD>Retrieve a set of Permissions that meet the specified Criteria.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>a</CODE> - Criteria of Permissions selection.<DT><B>Returns:</B><DD>a set of Permissions that meet the specified Criteria.</DL>
</DD>
</DL>
<HR>

<A NAME="getPermissions(org.apache.turbine.om.security.Role)"><!-- --></A><H3>
getPermissions</H3>
<PRE>
public <A HREF="../../../../../../org/apache/turbine/util/security/PermissionSet.html">PermissionSet</A> <B>getPermissions</B>(<A HREF="../../../../../../org/apache/turbine/om/security/Role.html">Role</A>&nbsp;role)
                             throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A>,
                                    <A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Retrieves all permissions associated with a role.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>role</CODE> - the role name, for which the permissions are to be retrieved.<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.<DD><CODE><A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if the role is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="saveGroup(org.apache.turbine.om.security.Group)"><!-- --></A><H3>
saveGroup</H3>
<PRE>
public void <B>saveGroup</B>(<A HREF="../../../../../../org/apache/turbine/om/security/Group.html">Group</A>&nbsp;group)
               throws <A HREF="../../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A>,
                      <A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></PRE>
<DL>
<DD>Stores Group's attributes. The Groups is required to exist in the system.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - The Group to be stored.<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.<DD><CODE><A HREF="../../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if the group does not exist.</DL>
</DD>
</DL>
<HR>

<A NAME="saveRole(org.apache.turbine.om.security.Role)"><!-- --></A><H3>
saveRole</H3>