Update of
/var/cvs/contributions/CMSContainer_Modules/community/src/java/com/finalist/cmsc/services/community
In directory
james.mmbase.org:/tmp/cvs-serv17129/community/src/java/com/finalist/cmsc/services/community
Modified Files:
CommunityServiceMysqlImpl.java HibernateCommunityService.java
NewsletterCommunicationServiceMysqlImpl.java
HibernateLoginModule.java
Log Message:
CMSC-211 Added JavaDoc to all the classes Community uses
See also:
http://cvs.mmbase.org/viewcvs/contributions/CMSContainer_Modules/community/src/java/com/finalist/cmsc/services/community
See also: http://www.mmbase.org/jira/browse/CMSC-211
Index: CommunityServiceMysqlImpl.java
===================================================================
RCS file:
/var/cvs/contributions/CMSContainer_Modules/community/src/java/com/finalist/cmsc/services/community/CommunityServiceMysqlImpl.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -b -r1.12 -r1.13
--- CommunityServiceMysqlImpl.java 16 Jan 2008 12:16:10 -0000 1.12
+++ CommunityServiceMysqlImpl.java 16 Jan 2008 12:59:11 -0000 1.13
@@ -1,5 +1,26 @@
package com.finalist.cmsc.services.community;
+/**
+ * CommunityServiceMysqlImpl, this is a CMSc service class.
+ * This class extends the service classes from the servicemanagement
+ * in the CMScontainer.
+ * All the request's to the community module come through here.
+ * This class will find out the class that is needed for each
+ * request and call the method in the needed class.
+ *
+ * In this class the LoginContext will be called within the loginUser method.
+ *
+ * <pre>
+ * LoginContext lc = new LoginContext("jaasdb", cbh);
+ * lc.login();
+ * </pre>
+ *
+ * This context is made by the jaas.config file in the class path. This config
file
+ * contains the required class for the login. In this case
"HibernateLoginModule"
+ * in this context lc means HibernateLoginModule.
+ *
+ * @author menno menninga
+ */
import javax.security.auth.login.LoginContext;
import java.util.*;
Index: HibernateCommunityService.java
===================================================================
RCS file:
/var/cvs/contributions/CMSContainer_Modules/community/src/java/com/finalist/cmsc/services/community/HibernateCommunityService.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- HibernateCommunityService.java 16 Jan 2008 12:16:10 -0000 1.2
+++ HibernateCommunityService.java 16 Jan 2008 12:59:11 -0000 1.3
@@ -14,6 +14,15 @@
import com.finalist.cmsc.services.community.data.User;
import com.finalist.cmsc.services.community.data.Role;
+/**
+ * HibernatCommunityService, this is a Hibernate service class.
+ * This class makes use of the DAO/transaction classes.
+ * All the request's to the database come through here.
+ * This class will find out the class that is needed for each
+ * request and call the method in the needed class.
+ *
+ * @author menno menninga
+ */
@Transactional
public class HibernateCommunityService {
Index: NewsletterCommunicationServiceMysqlImpl.java
===================================================================
RCS file:
/var/cvs/contributions/CMSContainer_Modules/community/src/java/com/finalist/cmsc/services/community/NewsletterCommunicationServiceMysqlImpl.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- NewsletterCommunicationServiceMysqlImpl.java 16 Jan 2008 12:16:10
-0000 1.6
+++ NewsletterCommunicationServiceMysqlImpl.java 16 Jan 2008 12:59:11
-0000 1.7
@@ -9,6 +9,13 @@
import org.springframework.context.ApplicationContext;
+/**
+ * This class is for now just a sort of interface because the Newsletter module
+ * is not yet updated to the new generic way of getting preferences. This class
+ * can be deleted as soon as the Newsletter module is updated.
+ *
+ * @author menno menninga
+ */
public class NewsletterCommunicationServiceMysqlImpl extends
NewsletterCommunicationService {
private static Log log =
LogFactory.getLog(NewsletterCommunicationServiceMysqlImpl.class);
Index: HibernateLoginModule.java
===================================================================
RCS file:
/var/cvs/contributions/CMSContainer_Modules/community/src/java/com/finalist/cmsc/services/community/HibernateLoginModule.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- HibernateLoginModule.java 16 Jan 2008 12:16:10 -0000 1.6
+++ HibernateLoginModule.java 16 Jan 2008 12:59:11 -0000 1.7
@@ -22,35 +22,16 @@
/**
* <p>
* HibernateLoginModule is a LoginModule that authenticates a given
- * username/password credential against a JDBC datasource.
- * <p>
- * This <code>LoginModule</code> interoperates with any conformant JDBC
- * datasource. To direct this <code>LoginModule</code> to use a specific JNDI
- * datasource, two options must be specified in the login
- * <code>Configuration</code> for this <code>LoginModule</code>.
- *
- * <pre>
- * url=<b>jdbc:mysql://localhost/jaasdb?user=root</b>
- * driverb>org.gjt.mm.mysql.Driver</b>
- * </pre>
+ * username/password credential against a Hibernate object.
*
* <p>
* For the purposed of this example, the format in which the user's information
- * must be stored in the database is in a table named "USER_AUTH" with the
- * following columns
- *
- * <pre>
- * USERID
- * PASSWORD
- * FIRST_NAME
- * LAST_NAME
- * DELETE_PERM
- * UPDATE_PERM
- * </pre>
+ * must be stored in the database is in the data/POJO classes of Hibernate
*
* @see javax.security.auth.spi.LoginModule
* @author Paul Feuer and John Musser
- * @version 1.0
+ * @editor Menno Menninga
+ * @version 1.3
*/
public class HibernateLoginModule<T> implements LoginModule {
@@ -347,7 +328,7 @@
/**
- * Validate the given user and password against the JDBC datasource.
+ * Validate the given user and password against the Hibernate Object.
* <p>
*
* @param user
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
