You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by fe...@apache.org on 2011/10/06 21:28:27 UTC
svn commit: r1179778 - in /james/server/trunk:
jcr/src/main/java/org/apache/james/mailrepository/jcr/
jcr/src/main/java/org/apache/james/user/jcr/
jdbc/src/main/java/org/apache/james/user/jdbc/
jpa/src/main/java/org/apache/james/domainlist/jpa/ jpa/src...
Author: felixk
Date: Thu Oct 6 19:28:25 2011
New Revision: 1179778
URL: http://svn.apache.org/viewvc?rev=1179778&view=rev
Log:
Some more javadocs updates/fixes
Modified:
james/server/trunk/jcr/src/main/java/org/apache/james/mailrepository/jcr/JCRMailRepository.java
james/server/trunk/jcr/src/main/java/org/apache/james/user/jcr/JCRUsersRepository.java
james/server/trunk/jdbc/src/main/java/org/apache/james/user/jdbc/AbstractJdbcUsersRepository.java
james/server/trunk/jpa/src/main/java/org/apache/james/domainlist/jpa/JPADomainList.java
james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/JPAUsersRepository.java
james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/model/JPAUser.java
james/server/trunk/ldap/src/main/java/org/apache/james/user/ldap/ReadOnlyUsersLDAPRepository.java
Modified: james/server/trunk/jcr/src/main/java/org/apache/james/mailrepository/jcr/JCRMailRepository.java
URL: http://svn.apache.org/viewvc/james/server/trunk/jcr/src/main/java/org/apache/james/mailrepository/jcr/JCRMailRepository.java?rev=1179778&r1=1179777&r2=1179778&view=diff
==============================================================================
--- james/server/trunk/jcr/src/main/java/org/apache/james/mailrepository/jcr/JCRMailRepository.java (original)
+++ james/server/trunk/jcr/src/main/java/org/apache/james/mailrepository/jcr/JCRMailRepository.java Thu Oct 6 19:28:25 2011
@@ -88,13 +88,12 @@ public class JCRMailRepository extends A
CndImporter.registerNodeTypes(new InputStreamReader(Thread.currentThread().getContextClassLoader().getResourceAsStream("org/apache/james/imap/jcr/james.cnd")), login());
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see
- * org.apache.james.mailrepository.AbstractMailRepository#doConfigure(org
- * .apache.commons.configuration.HierarchicalConfiguration)
+ * org.apache.james.mailrepository.lib.AbstractMailRepository
+ * #doConfigure(org.apache.commons.configuration.HierarchicalConfiguration)
*/
+ @Override
public void doConfigure(HierarchicalConfiguration config) throws ConfigurationException {
this.workspace = config.getString("workspace", null);
String username = config.getString("username", null);
Modified: james/server/trunk/jcr/src/main/java/org/apache/james/user/jcr/JCRUsersRepository.java
URL: http://svn.apache.org/viewvc/james/server/trunk/jcr/src/main/java/org/apache/james/user/jcr/JCRUsersRepository.java?rev=1179778&r1=1179777&r2=1179778&view=diff
==============================================================================
--- james/server/trunk/jcr/src/main/java/org/apache/james/user/jcr/JCRUsersRepository.java (original)
+++ james/server/trunk/jcr/src/main/java/org/apache/james/user/jcr/JCRUsersRepository.java Thu Oct 6 19:28:25 2011
@@ -86,7 +86,7 @@ public class JCRUsersRepository extends
* Get the user object with the specified user name. Return null if no such
* user.
*
- * @param name
+ * @param username
* the name of the user to retrieve
* @return the user being retrieved, null if the user doesn't exist
*
@@ -136,7 +136,10 @@ public class JCRUsersRepository extends
* Update the repository with the specified user object. A user object with
* this username must already exist.
*
- * @return true if successful.
+ * @param user
+ * the user
+ * @throws UsersRepositoryException
+ * If an error occurred
*/
public void updateUser(final User user) throws UsersRepositoryException {
if (user != null && user instanceof JCRUser) {
@@ -176,7 +179,7 @@ public class JCRUsersRepository extends
/**
* Removes a user from the repository
*
- * @param name
+ * @param username
* the user to remove from the repository
* @throws UsersRepositoryException
*/
@@ -240,7 +243,7 @@ public class JCRUsersRepository extends
/**
* Test if user with name 'name' has password 'password'.
*
- * @param name
+ * @param username
* the name of the user to be tested
* @param password
* the password to be tested
Modified: james/server/trunk/jdbc/src/main/java/org/apache/james/user/jdbc/AbstractJdbcUsersRepository.java
URL: http://svn.apache.org/viewvc/james/server/trunk/jdbc/src/main/java/org/apache/james/user/jdbc/AbstractJdbcUsersRepository.java?rev=1179778&r1=1179777&r2=1179778&view=diff
==============================================================================
--- james/server/trunk/jdbc/src/main/java/org/apache/james/user/jdbc/AbstractJdbcUsersRepository.java (original)
+++ james/server/trunk/jdbc/src/main/java/org/apache/james/user/jdbc/AbstractJdbcUsersRepository.java Thu Oct 6 19:28:25 2011
@@ -216,7 +216,7 @@ public abstract class AbstractJdbcUsersR
/**
* Set the DataSourceSelector
*
- * @param datasources
+ * @param m_datasource
* the DataSourceSelector
*/
@Resource(name = "datasource")
@@ -247,8 +247,6 @@ public abstract class AbstractJdbcUsersR
*
* @throws Exception
* if an error occurs
- *
- * @see org.apache.avalon.framework.activity.Initializable#initialize()
*/
@PostConstruct
public void init() throws Exception {
Modified: james/server/trunk/jpa/src/main/java/org/apache/james/domainlist/jpa/JPADomainList.java
URL: http://svn.apache.org/viewvc/james/server/trunk/jpa/src/main/java/org/apache/james/domainlist/jpa/JPADomainList.java?rev=1179778&r1=1179777&r2=1179778&view=diff
==============================================================================
--- james/server/trunk/jpa/src/main/java/org/apache/james/domainlist/jpa/JPADomainList.java (original)
+++ james/server/trunk/jpa/src/main/java/org/apache/james/domainlist/jpa/JPADomainList.java Thu Oct 6 19:28:25 2011
@@ -60,12 +60,9 @@ public class JPADomainList extends Abstr
createEntityManager().close();
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see
- * org.apache.james.domainlist.lib.AbstractDomainList#getDomainListInternal
- * ()
+ * org.apache.james.domainlist.lib.AbstractDomainList#getDomainListInternal()
*/
@SuppressWarnings("unchecked")
protected List<String> getDomainListInternal() throws DomainListException {
@@ -118,9 +115,7 @@ public class JPADomainList extends Abstr
}
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see
* org.apache.james.domainlist.api.DomainList#addDomain(java.lang.String)
*/
@@ -143,9 +138,7 @@ public class JPADomainList extends Abstr
}
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see
* org.apache.james.domainlist.api.DomainList#removeDomain(java.lang.String)
*/
Modified: james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/JPAUsersRepository.java
URL: http://svn.apache.org/viewvc/james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/JPAUsersRepository.java?rev=1179778&r1=1179777&r2=1179778&view=diff
==============================================================================
--- james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/JPAUsersRepository.java (original)
+++ james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/JPAUsersRepository.java Thu Oct 6 19:28:25 2011
@@ -49,7 +49,7 @@ public class JPAUsersRepository extends
/**
* Sets entity manager.
*
- * @param entityManager
+ * @param entityManagerFactory
* the entityManager to set
*/
@PersistenceUnit
@@ -108,7 +108,6 @@ public class JPAUsersRepository extends
* Update the repository with the specified user object. A user object with
* this username must already exist.
*
- * @return true if successful.
* @throws UsersRepositoryException
*/
public void updateUser(User user) throws UsersRepositoryException {
@@ -251,12 +250,9 @@ public class JPAUsersRepository extends
}
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see
- * org.apache.james.user.lib.AbstractUsersRepository#doConfigure(org.apache
- * .commons.configuration.HierarchicalConfiguration)
+ * org.apache.james.user.lib.AbstractUsersRepository#doConfigure(org.apache.commons.configuration.HierarchicalConfiguration)
*/
public void doConfigure(HierarchicalConfiguration config) throws ConfigurationException {
algo = config.getString("algorithm", "MD5");
@@ -272,12 +268,9 @@ public class JPAUsersRepository extends
return entityManagerFactory.createEntityManager();
}
- /*
- * (non-Javadoc)
- *
+ /**
* @see
- * org.apache.james.user.lib.AbstractUsersRepository#doAddUser(java.lang
- * .String, java.lang.String)
+ * org.apache.james.user.lib.AbstractUsersRepository#doAddUser(java.lang.String, java.lang.String)
*/
protected void doAddUser(String username, String password) throws UsersRepositoryException {
EntityManager entityManager = entityManagerFactory.createEntityManager();
Modified: james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/model/JPAUser.java
URL: http://svn.apache.org/viewvc/james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/model/JPAUser.java?rev=1179778&r1=1179777&r2=1179778&view=diff
==============================================================================
--- james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/model/JPAUser.java (original)
+++ james/server/trunk/jpa/src/main/java/org/apache/james/user/jpa/model/JPAUser.java Thu Oct 6 19:28:25 2011
@@ -95,19 +95,15 @@ public class JPAUser implements User {
this.password = hashPassword(userName, password, alg);
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.james.api.user.User#getUserName()
+ /**
+ * @see org.apache.james.user.api.model.User#getUserName()
*/
public String getUserName() {
return name;
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.james.api.user.User#setPassword(java.lang.String)
+ /**
+ * @see org.apache.james.user.api.model.User#setPassword(java.lang.String)
*/
public boolean setPassword(String newPass) {
final boolean result;
@@ -120,10 +116,8 @@ public class JPAUser implements User {
return result;
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.james.api.user.User#verifyPassword(java.lang.String)
+ /**
+ * @see org.apache.james.user.api.model.User#verifyPassword(java.lang.String)
*/
public boolean verifyPassword(String pass) {
final boolean result;
Modified: james/server/trunk/ldap/src/main/java/org/apache/james/user/ldap/ReadOnlyUsersLDAPRepository.java
URL: http://svn.apache.org/viewvc/james/server/trunk/ldap/src/main/java/org/apache/james/user/ldap/ReadOnlyUsersLDAPRepository.java?rev=1179778&r1=1179777&r2=1179778&view=diff
==============================================================================
--- james/server/trunk/ldap/src/main/java/org/apache/james/user/ldap/ReadOnlyUsersLDAPRepository.java (original)
+++ james/server/trunk/ldap/src/main/java/org/apache/james/user/ldap/ReadOnlyUsersLDAPRepository.java Thu Oct 6 19:28:25 2011
@@ -370,10 +370,8 @@ public class ReadOnlyUsersLDAPRepository
return null;
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.james.api.user.UsersRepository#contains(java.lang.String)
+ /**
+ * @see UsersRepository#contains(java.lang.String)
*/
public boolean contains(String name) throws UsersRepositoryException {
if (getUserByName(name) != null) {
@@ -383,11 +381,10 @@ public class ReadOnlyUsersLDAPRepository
}
/*
- * (non-Javadoc)
+ * TODO
+ * Should this be deprecated? At least the method isn't declared in the interface anymore
*
- * @see
- * org.apache.james.api.user.UsersRepository#containsCaseInsensitive(java
- * .lang.String)
+ * @see UsersRepository#containsCaseInsensitive(java.lang.String)
*/
public boolean containsCaseInsensitive(String name) throws UsersRepositoryException {
if (getUserByNameCaseInsensitive(name) != null) {
@@ -396,10 +393,8 @@ public class ReadOnlyUsersLDAPRepository
return false;
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.james.api.user.UsersRepository#countUsers()
+ /**
+ * @see UsersRepository#countUsers()
*/
public int countUsers() throws UsersRepositoryException {
try {
@@ -412,10 +407,10 @@ public class ReadOnlyUsersLDAPRepository
}
/*
- * (non-Javadoc)
+ * TODO
+ * Should this be deprecated? At least the method isn't declared in the interface anymore
*
- * @see
- * org.apache.james.api.user.UsersRepository#getRealName(java.lang.String)
+ * @see UsersRepository#getRealName(java.lang.String)
*/
public String getRealName(String name) throws UsersRepositoryException {
User u = getUserByNameCaseInsensitive(name);
@@ -426,11 +421,8 @@ public class ReadOnlyUsersLDAPRepository
return null;
}
- /*
- * (non-Javadoc)
- *
- * @see
- * org.apache.james.api.user.UsersRepository#getUserByName(java.lang.String)
+ /**
+ * @see UsersRepository#getUserByName(java.lang.String)
*/
public User getUserByName(String name) throws UsersRepositoryException {
try {
@@ -443,11 +435,10 @@ public class ReadOnlyUsersLDAPRepository
}
/*
- * (non-Javadoc)
+ * TODO
+ * Should this be deprecated? At least the method isn't declared in the interface anymore
*
- * @see
- * org.apache.james.api.user.UsersRepository#getUserByNameCaseInsensitive
- * (java.lang.String)
+ * @see UsersRepository#getUserByNameCaseInsensitive(java.lang.String)
*/
public User getUserByNameCaseInsensitive(String name) throws UsersRepositoryException {
try {
@@ -467,10 +458,8 @@ public class ReadOnlyUsersLDAPRepository
return null;
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.james.api.user.UsersRepository#list()
+ /**
+ * @see UsersRepository#list()
*/
public Iterator<String> list() throws UsersRepositoryException {
List<String> result = new ArrayList<String>();
@@ -509,11 +498,8 @@ public class ReadOnlyUsersLDAPRepository
return validUserDNs;
}
- /*
- * (non-Javadoc)
- *
- * @see
- * org.apache.james.api.user.UsersRepository#removeUser(java.lang.String)
+ /**
+ * @see UsersRepository#removeUser(java.lang.String)
*/
public void removeUser(String name) throws UsersRepositoryException {
log.warn("This user-repository is read-only. Modifications are not permitted.");
@@ -521,11 +507,8 @@ public class ReadOnlyUsersLDAPRepository
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.james.api.user.UsersRepository#test(java.lang.String,
- * java.lang.String)
+ /**
+ * @see UsersRepository#test(java.lang.String, java.lang.String)
*/
public boolean test(String name, String password) throws UsersRepositoryException {
User u = getUserByName(name);
@@ -535,11 +518,8 @@ public class ReadOnlyUsersLDAPRepository
return false;
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.james.api.user.UsersRepository#addUser(java.lang.String,
- * java.lang.String)
+ /**
+ * @see UsersRepository#addUser(java.lang.String, java.lang.String)
*/
public void addUser(String username, String password) throws UsersRepositoryException {
log.warn("This user-repository is read-only. Modifications are not permitted.");
@@ -547,21 +527,18 @@ public class ReadOnlyUsersLDAPRepository
}
/*
- * (non-Javadoc)
+ * TODO
+ * Should this be deprecated? At least the method isn't declared in the interface anymore
*
- * @see
- * org.apache.james.api.user.UsersRepository#updateUser(org.apache.james
- * .api.user.User)
+ * @see UsersRepository#updateUser(org.apache.james.api.user.User)
*/
public void updateUser(User user) throws UsersRepositoryException {
log.warn("This user-repository is read-only. Modifications are not permitted.");
throw new UsersRepositoryException("This user-repository is read-only. Modifications are not permitted.");
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.james.lifecycle.LogEnabled#setLog(org.slf4j.Logger)
+ /**
+ * @see org.apache.james.lifecycle.api.LogEnabled#setLog(org.slf4j.Logger)
*/
public void setLog(Logger log) {
this.log = log;
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org