turbinesecurity.html

turbine教程

                         <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 static 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 static 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="addUser(org.apache.turbine.om.security.User, java.lang.String)"><!-- --></A><H3>
addUser</H3>
<PRE>
public static void <B>addUser</B>(<A HREF="../../../../../org/apache/turbine/om/security/User.html">User</A>&nbsp;user,
                           java.lang.String&nbsp;password)
                    throws <A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A>,
                           <A HREF="../../../../../org/apache/turbine/util/security/EntityExistsException.html">EntityExistsException</A></PRE>
<DL>
<DD>Creates new user account with specified attributes.

 <strong>TODO</strong> throw more specific exception<br><DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the object describing account to be created.<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/EntityExistsException.html">EntityExistsException</A></CODE> - if the user account already exists.</DL>
</DD>
</DL>
<HR>

<A NAME="removeUser(org.apache.turbine.om.security.User)"><!-- --></A><H3>
removeUser</H3>
<PRE>
public static void <B>removeUser</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>Removes an user account from the system.

 <strong>TODO</strong> throw more specific exception<br><DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the object describing the account to be removed.<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 user account is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="getGlobalGroup()"><!-- --></A><H3>
getGlobalGroup</H3>
<PRE>
public static <A HREF="../../../../../org/apache/turbine/om/security/Group.html">Group</A> <B>getGlobalGroup</B>()</PRE>
<DL>
<DD>Provides a reference to the Group object that represents the
 <a name="global">global group</a>.<DD><DL>
<DT><B>Returns:</B><DD>a Group object that represents the global group.</DL>
</DD>
</DL>
<HR>

<A NAME="createGroup(java.lang.String)"><!-- --></A><H3>
createGroup</H3>
<PRE>
public static <A HREF="../../../../../org/apache/turbine/om/security/Group.html">Group</A> <B>createGroup</B>(java.lang.String&nbsp;name)
                         throws <A HREF="../../../../../org/apache/turbine/util/security/TurbineSecurityException.html">TurbineSecurityException</A></PRE>
<DL>
<DD>Creates a new Group in the system. This is a convenience
 method.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the new Group.<DT><B>Returns:</B><DD>An object representing the new Group.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/TurbineSecurityException.html">TurbineSecurityException</A></CODE> - if the Group could not be created.</DL>
</DD>
</DL>
<HR>

<A NAME="createPermission(java.lang.String)"><!-- --></A><H3>
createPermission</H3>
<PRE>
public static <A HREF="../../../../../org/apache/turbine/om/security/Permission.html">Permission</A> <B>createPermission</B>(java.lang.String&nbsp;name)
                                   throws <A HREF="../../../../../org/apache/turbine/util/security/TurbineSecurityException.html">TurbineSecurityException</A></PRE>
<DL>
<DD>Creates a new Permission in the system. This is a convenience
 method.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the new Permission.<DT><B>Returns:</B><DD>An object representing the new Permission.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/TurbineSecurityException.html">TurbineSecurityException</A></CODE> - if the Permission could not be created.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroup(java.lang.String)"><!-- --></A><H3>
getGroup</H3>
<PRE>
public static <A HREF="../../../../../org/apache/turbine/om/security/Group.html">Group</A> <B>getGroup</B>(java.lang.String&nbsp;groupName)
                      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 a named Group.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - The name of the Group 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 Group is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="getNewGroup(java.lang.String)"><!-- --></A><H3>
getNewGroup</H3>
<PRE>
public static <A HREF="../../../../../org/apache/turbine/om/security/Group.html">Group</A> <B>getNewGroup</B>(java.lang.String&nbsp;groupName)
                         throws <A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></PRE>
<DL>
<DD>Retrieves a named Group. If the Group does not exist, it creates
 a new Group based on the Services Group implementation. It is ok
 to pass in null or "" here and then use Group.setName() at a later
 point.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - The name of the Group 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.</DL>
</DD>
</DL>
<HR>

<A NAME="getNewRole(java.lang.String)"><!-- --></A><H3>
getNewRole</H3>
<PRE>
public static <A HREF="../../../../../org/apache/turbine/om/security/Role.html">Role</A> <B>getNewRole</B>(java.lang.String&nbsp;roleName)
                       throws <A HREF="../../../../../org/apache/turbine/util/security/TurbineSecurityException.html">TurbineSecurityException</A></PRE>
<DL>
<DD>Retrieves a named Permission. If the Permission does not exist, it creates
 a new Permission based on the Services Permission implementation. It is ok
 to pass in null or "" here and then use Permission.setName() at a later
 point.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roleName</CODE> - The name of the Role 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.</DL>
</DD>
</DL>
<HR>

<A NAME="getNewPermission(java.lang.String)"><!-- --></A><H3>
getNewPermission</H3>
<PRE>
public static <A HREF="../../../../../org/apache/turbine/om/security/Permission.html">Permission</A> <B>getNewPermission</B>(java.lang.String&nbsp;permissionName)
                                   throws <A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></PRE>
<DL>
<DD>Retrieves a named Permission. If the Permission does not exist, it creates
 a new Permission based on the Services Permission implementation. It is ok
 to pass in null or "" here and then use Permission.setName() at a later
 point.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - The name of the Permission 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.</DL>
</DD>
</DL>
<HR>

<A NAME="getRole(java.lang.String)"><!-- --></A><H3>
getRole</H3>
<PRE>
public static <A HREF="../../../../../org/apache/turbine/om/security/Role.html">Role</A> <B>getRole</B>(java.lang.String&nbsp;roleName)
                    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 a named Role.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roleName</CODE> - The name of the Role 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="getPermission(java.lang.String)"><!-- --></A><H3>
getPermission</H3>
<PRE>
public static <A HREF="../../../../../org/apache/turbine/om/security/Permission.html">Permission</A> <B>getPermission</B>(java.lang.String&nbsp;permissionName)
                                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 a named Permission.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>permissionName</CODE> - The name of the Permission 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 Permission is not present.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroups(org.apache.torque.util.Criteria)"><!-- --></A><H3>
getGroups</H3>
<PRE>
public static <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 static <A HREF="../../../../../org/apache/turbine/util/security/RoleSet.html">RoleSet</A> <B>getRoles</B>(org.apache.torque.util.Criteria&nbsp;criteria)
                        throws <A HREF="../../../../../or