securityservice.html

turbine教程

                           <A HREF="../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A>,
                           <A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></PRE>
<DL>
<DD>Change the password for an User.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - an User to change password for.<DD><CODE>oldPassword</CODE> - the current password supplied by the user.<DD><CODE>newPassword</CODE> - the current password requested by the user.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/PasswordMismatchException.html">PasswordMismatchException</A></CODE> - if the supplied password was
            incorrect.<DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if the user's record does not
            exist in the database.<DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></CODE> - if there is a problem accessing the
            storage.</DL>
</DD>
</DL>
<HR>

<A NAME="forcePassword(org.apache.turbine.om.security.User, java.lang.String)"><!-- --></A><H3>
forcePassword</H3>
<PRE>
public void <B>forcePassword</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/UnknownEntityException.html">UnknownEntityException</A>,
                          <A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></PRE>
<DL>
<DD>Forcibly sets new password for an User.

 This is supposed by the administrator to change the forgotten or
 compromised passwords. Certain implementatations of this feature
 would require administrative level access to the authenticating
 server / program.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - an User to change password for.<DD><CODE>password</CODE> - the new password.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/UnknownEntityException.html">UnknownEntityException</A></CODE> - if the user's record does not
            exist in the database.<DD><CODE><A HREF="../../../../../org/apache/turbine/util/security/DataBackendException.html">DataBackendException</A></CODE> - if there is a problem accessing the
            storage.</DL>
</DD>
</DL>
<HR>

<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.<DD><DL>
</DL>
</DD>
<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="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>
</DL>
</DD>
<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="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>
</DL>
</DD>
<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>
</DL>
</DD>
<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>
</DL>
</DD>
<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>
</DL>
</DD>
<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>
</DL>
</DD>
<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>
</DL>
</DD>
<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="getGlobalGroup()"><!-- --></A><H3>
getGlobalGroup</H3>
<PRE>
public <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 href="#global">global group</a>.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a Group object that represents the global group.</DL>
</DD>
</DL>
<HR>

<A NAME="getNewGroup(java.lang.String)"><!-- --></A><H3>
getNewGroup</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/om/security/Group.html">Group</A> <B>getNewGroup</B>(java.lang.String&nbsp;groupName)</PRE>
<DL>
<DD>Retrieves a new Group. It creates
 a new Group based on the Services Group implementation. It does not
 create a new Group in the system though. Use addGroup for that.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - The name of the Group to be retrieved.</DL>
</DD>
</DL>
<HR>

<A NAME="getNewRole(java.lang.String)"><!-- --></A><H3>
getNewRole</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/om/security/Role.html">Role</A> <B>getNewRole</B>(java.lang.String&nbsp;roleName)</PRE>
<DL>
<DD>Retrieves a new Role. It creates
 a new Group based on the Services Role implementation. It does not
 create a new Role in the system though. Use addRole for that.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roleName</CODE> - The name of the Role to be retrieved.</DL>
</DD>
</DL>
<HR>

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