Author: gk
Date: Thu Apr 6 14:25:49 2017
New Revision: 1790413
URL: http://svn.apache.org/viewvc?rev=1790413&view=rev
Log:
- Javadoc Update Turbine User manager mapping Fulcrum -> Turbine
Modified:
turbine/fulcrum/trunk/security/api/src/java/org/apache/fulcrum/security/model/turbine/TurbineUserManager.java
Modified:
turbine/fulcrum/trunk/security/api/src/java/org/apache/fulcrum/security/model/turbine/TurbineUserManager.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/security/api/src/java/org/apache/fulcrum/security/model/turbine/TurbineUserManager.java?rev=1790413&r1=1790412&r2=1790413&view=diff
==============================================================================
---
turbine/fulcrum/trunk/security/api/src/java/org/apache/fulcrum/security/model/turbine/TurbineUserManager.java
(original)
+++
turbine/fulcrum/trunk/security/api/src/java/org/apache/fulcrum/security/model/turbine/TurbineUserManager.java
Thu Apr 6 14:25:49 2017
@@ -20,11 +20,29 @@ package org.apache.fulcrum.security.mode
*/
import org.apache.fulcrum.security.UserManager;
import org.apache.fulcrum.security.entity.User;
+import org.apache.fulcrum.security.model.turbine.entity.TurbineUser;
import org.apache.fulcrum.security.util.UnknownEntityException;
/**
* This interface describes the methods that glue the "turbine" model together.
- *
+ *
+ * This Fulcrum user manager is as used as a delegate in the default Turbine
user manager.
+ *
+ * The user <T extends {@link User}> is wrapped using an extended user
model,
+ * which includes at least {@link TurbineUser} interface.
+ *
+ * This interface´s methods are wrapped in Turbine user manager
(org.apache.turbine.services.security.UserManager) either in a method with the
same name (and very similar signature)
+ * or mapped to method names as listed below:
+ *
+ * <ul>
+ * <li>Turbine (framework) user manager method(s) -> method(s) in this
(Fulcrum )manager
+ * <li>createAccount -> {@link #addUser(User, String)}
+ * <li>removeAccount -> {@link #removeUser(User)}
+ * <li>store -> {@link #saveUser(User)}
+ * <li>retrieve (2x)-> {@link #getUser(String)}, {@link #getUser(String,
String)}
+ * <li>retrieveList -> {@link #getAllUsers()}
+ * <li>accountExists (2x)-> {@link #checkExists(String)}, {@link
#checkExists(User)}
+ *
* @author <a href="mailto:[email protected]";>Eric Pugh</a>
* @version $Id$
*/
@@ -34,7 +52,7 @@ public interface TurbineUserManager exte
* Constructs an User object to represent an anonymous user of the
* application.
*
- * @return An anonymous Turbine User.
+ * @return An anonymous Turbine User.
* @throws UnknownEntityException
* if the anonymous User object couldn't be constructed.
*/
