Author: norman
Date: Sat Sep 23 10:07:44 2006
New Revision: 449273
URL: http://svn.apache.org/viewvc?view=rev&rev=449273
Log:
Fix/Add javadocs. See JAMES-628
Modified:
james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java
james/server/trunk/src/java/org/apache/james/security/SMIMEKeyHolder.java
james/server/trunk/src/java/org/apache/james/smtpserver/SMTPHandler.java
james/server/trunk/src/java/org/apache/james/smtpserver/SMTPSession.java
james/server/trunk/src/java/org/apache/james/smtpserver/core/POP3BeforeSMTPHandler.java
james/server/trunk/src/java/org/apache/james/smtpserver/core/UnknownCmdHandler.java
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/AbstractVirtualUserTableHandler.java
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/DNSRBLHandler.java
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/GreylistHandler.java
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ResolvableEhloHeloHandler.java
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ReverseEqualsEhloHeloHandler.java
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ValidRcptHandler.java
james/server/trunk/src/java/org/apache/james/transport/mailets/DSNBounce.java
james/server/trunk/src/java/org/apache/james/transport/mailets/FromRepository.java
james/server/trunk/src/java/org/apache/james/transport/mailets/LogMessage.java
james/server/trunk/src/java/org/apache/james/transport/mailets/smime/AbstractSign.java
james/server/trunk/src/java/org/apache/james/transport/matchers/GenericRegexMatcher.java
james/server/trunk/src/java/org/apache/james/userrepository/AbstractUsersRepository.java
james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java
Modified:
james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
--- james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java
(original)
+++ james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java
Sat Sep 23 10:07:44 2006
@@ -503,7 +503,7 @@
/**
- * @see
org.apache.james.pop3server.POP3Session#setUserMailbox(java.util.ArrayList)
+ * @see org.apache.james.pop3server.POP3Session#setUserMailbox(List)
*/
public void setBackupUserMailbox(List backupUserMailbox) {
this.backupUserMailbox = backupUserMailbox;
Modified:
james/server/trunk/src/java/org/apache/james/security/SMIMEKeyHolder.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/security/SMIMEKeyHolder.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
--- james/server/trunk/src/java/org/apache/james/security/SMIMEKeyHolder.java
(original)
+++ james/server/trunk/src/java/org/apache/james/security/SMIMEKeyHolder.java
Sat Sep 23 10:07:44 2006
@@ -269,7 +269,7 @@
* Extracts the signer <I>common name</I> (CN=) from an
<CODE>X509Certificate</CODE> <I>distinguished name</I>.
* @param certificate The certificate to extract the information from.
* @return The requested information.
- * @see getSignerDistinguishedName(X509Certificate)
+ * @see #getSignerDistinguishedName(X509Certificate)
*/
public static String getSignerCN(X509Certificate certificate) {
@@ -281,7 +281,7 @@
* Extracts the signer <I>email address</I> (EMAILADDRESS=) from an
<CODE>X509Certificate</CODE> <I>distinguished name</I>.
* @param certificate The certificate to extract the information from.
* @return The requested information.
- * @see getSignerDistinguishedName(X509Certificate)
+ * @see #getSignerDistinguishedName(X509Certificate)
*/
public static String getSignerAddress(X509Certificate certificate) {
@@ -292,7 +292,7 @@
/**
* Getter for property signerDistinguishedName.
* @return Value of property signerDistinguishedName.
- * @see getSignerDistinguishedName(X509Certificate)
+ * @see #getSignerDistinguishedName(X509Certificate)
*/
public String getSignerDistinguishedName() {
return getSignerDistinguishedName(getCertificate());
@@ -301,7 +301,7 @@
/**
* Getter for property signerCN.
* @return Value of property signerCN.
- * @see getSignerCN(X509Certificate)
+ * @see #getSignerCN(X509Certificate)
*/
public String getSignerCN() {
return getSignerCN(getCertificate());
@@ -310,7 +310,7 @@
/**
* Getter for property signerAddress.
* @return Value of property signerMailAddress.
- * @see getSignerAddress(X509Certificate)
+ * @see #getSignerAddress(X509Certificate)
*/
public String getSignerAddress() {
return getSignerAddress(getCertificate());
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/SMTPHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/SMTPHandler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
--- james/server/trunk/src/java/org/apache/james/smtpserver/SMTPHandler.java
(original)
+++ james/server/trunk/src/java/org/apache/james/smtpserver/SMTPHandler.java
Sat Sep 23 10:07:44 2006
@@ -472,7 +472,7 @@
}
/**
- * @see org.apache.james.smtpserver.SMTPSession#setUser()
+ * @see org.apache.james.smtpserver.SMTPSession#setUser(String)
*/
public void setUser(String userID) {
authenticatedUser = userID;
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/SMTPSession.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/SMTPSession.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
--- james/server/trunk/src/java/org/apache/james/smtpserver/SMTPSession.java
(original)
+++ james/server/trunk/src/java/org/apache/james/smtpserver/SMTPSession.java
Sat Sep 23 10:07:44 2006
@@ -201,7 +201,7 @@
/**
* Sets the user name associated with this SMTP interaction.
*
- * @param userID the user name
+ * @param user the user name
*/
void setUser(String user);
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/core/POP3BeforeSMTPHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/core/POP3BeforeSMTPHandler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/smtpserver/core/POP3BeforeSMTPHandler.java
(original)
+++
james/server/trunk/src/java/org/apache/james/smtpserver/core/POP3BeforeSMTPHandler.java
Sat Sep 23 10:07:44 2006
@@ -58,7 +58,7 @@
/**
* Set the time after which an ipAddresses should be handled as expired
*
- * @param expireTime
+ * @param rawExpireTime
* The time
*/
public void setExpireTime(String rawExpireTime) {
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/core/UnknownCmdHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/core/UnknownCmdHandler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/smtpserver/core/UnknownCmdHandler.java
(original)
+++
james/server/trunk/src/java/org/apache/james/smtpserver/core/UnknownCmdHandler.java
Sat Sep 23 10:07:44 2006
@@ -71,12 +71,4 @@
return implCommands;
}
-
- /**
- * @see org.apache.james.smtpserver.CommandHandler#stopHandlerProcessing()
- */
- public boolean stopHandlerProcessing() {
- return stopHandlerProcessing ;
- }
-
}
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/AbstractVirtualUserTableHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/AbstractVirtualUserTableHandler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/AbstractVirtualUserTableHandler.java
(original)
+++
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/AbstractVirtualUserTableHandler.java
Sat Sep 23 10:07:44 2006
@@ -117,7 +117,7 @@
* if no mapping should be performed. Multiple recipients may be specified
by delineating
* the mapped string with commas, semi-colons or colons.
*
- * @param recipientsMap the mapping of virtual to real recipients, as
+ * @param recipient the mapping of virtual to real recipients, as
* <code>MailAddress</code>es to <code>String</code>s.
*/
protected abstract String mapRecipients(MailAddress recipient);
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/DNSRBLHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/DNSRBLHandler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/DNSRBLHandler.java
(original)
+++
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/DNSRBLHandler.java
Sat Sep 23 10:07:44 2006
@@ -172,8 +172,6 @@
* it will be permitted to send e-mail, otherwise if the remote IP is
blacklisted,
* the sender will only be permitted to send e-mail to postmaster (RFC
2821) or
* abuse (RFC 2142), unless authenticated.
- *
- * @see
org.apache.james.smtpserver.SMTPHandlerConfigurationData#checkDNSRBL(Socket)
*/
public void checkDNSRBL(SMTPSession session, String ipAddress) {
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/GreylistHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/GreylistHandler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/GreylistHandler.java
(original)
+++
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/GreylistHandler.java
Sat Sep 23 10:07:44 2006
@@ -266,7 +266,7 @@
* Setup the autowhitelist lifetime for which we should whitelist a
triplet.
* After this lifetime the record will be deleted
*
- * @param autoWhiteListTime
+ * @param autoWhiteListLifeTime
* The lifeTime
*/
public void setAutoWhiteListLifeTime(String autoWhiteListLifeTime) {
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ResolvableEhloHeloHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ResolvableEhloHeloHandler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ResolvableEhloHeloHandler.java
(original)
+++
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ResolvableEhloHeloHandler.java
Sat Sep 23 10:07:44 2006
@@ -88,7 +88,7 @@
/**
* Set to true if Auth users should be included in the EHLO/HELO check
*
- * @param checkAuthNetworks
+ * @param checkAuthUsers
* Set to true to enable
*/
public void setCheckAuthUsers(boolean checkAuthUsers) {
@@ -106,7 +106,7 @@
}
/**
- * @see
org.apache.james.smtpserver.core.filter.fastfail.HeloFilterHandler#onEhloCommand(SMTPSession)
+ * @see org.apache.james.smtpserver.CommandHandler#onCommand(SMTPSession)
*/
public void onCommand(SMTPSession session) {
String argument = session.getCommandArgument();
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ReverseEqualsEhloHeloHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ReverseEqualsEhloHeloHandler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ReverseEqualsEhloHeloHandler.java
(original)
+++
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ReverseEqualsEhloHeloHandler.java
Sat Sep 23 10:07:44 2006
@@ -85,7 +85,7 @@
/**
* Set to true if Auth users should be included in the EHLO/HELO check
*
- * @param checkAuthNetworks
+ * @param checkAuthUsers
* Set to true to enable
*/
public void setCheckAuthUsers(boolean checkAuthUsers) {
Modified:
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ValidRcptHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ValidRcptHandler.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ValidRcptHandler.java
(original)
+++
james/server/trunk/src/java/org/apache/james/smtpserver/core/filter/fastfail/ValidRcptHandler.java
Sat Sep 23 10:07:44 2006
@@ -92,7 +92,7 @@
/**
* Set the domains for which every rcpt will be accepted.
*
- * @param recip The valid domains. Commaseperated list
+ * @param dom The valid domains. Commaseperated list
*/
public void setValidDomains(String dom) {
StringTokenizer st = new StringTokenizer(dom, ", ", false);
Modified:
james/server/trunk/src/java/org/apache/james/transport/mailets/DSNBounce.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/transport/mailets/DSNBounce.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/transport/mailets/DSNBounce.java
(original)
+++
james/server/trunk/src/java/org/apache/james/transport/mailets/DSNBounce.java
Sat Sep 23 10:07:44 2006
@@ -449,8 +449,8 @@
* This method should use the status attribute when the
* SMTP-handler somewhen provides it
*
- * @param MessagingException
- * @return status code
+ * @param me the MessagingException of which the statusCode should be
generated
+ * @return status the generated statusCode
*/
protected String getStatus(MessagingException me) {
if (me.getNextException() == null) {
@@ -547,7 +547,8 @@
/**
* Utility method for getting the error message from the (nested)
exception.
- * @param MessagingException
+ *
+ * @param me MessagingException
* @return error message
*/
protected String getErrorMsg(MessagingException me) {
Modified:
james/server/trunk/src/java/org/apache/james/transport/mailets/FromRepository.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/transport/mailets/FromRepository.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/transport/mailets/FromRepository.java
(original)
+++
james/server/trunk/src/java/org/apache/james/transport/mailets/FromRepository.java
Sat Sep 23 10:07:44 2006
@@ -99,7 +99,7 @@
/**
* Spool mail from a particular repository.
*
- * @param triggering e-mail (eventually parameterize via the
+ * @param trigger triggering e-mail (eventually parameterize via the
* trigger message)
*/
public void service(Mail trigger) throws MessagingException {
Modified:
james/server/trunk/src/java/org/apache/james/transport/mailets/LogMessage.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/transport/mailets/LogMessage.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/transport/mailets/LogMessage.java
(original)
+++
james/server/trunk/src/java/org/apache/james/transport/mailets/LogMessage.java
Sat Sep 23 10:07:44 2006
@@ -69,7 +69,7 @@
/**
* Log a particular message
*
- * @param mail the mail to process
+ * @param genericmail the mail to process
*/
public void service(Mail genericmail) {
MailImpl mail = (MailImpl)genericmail;
Modified:
james/server/trunk/src/java/org/apache/james/transport/mailets/smime/AbstractSign.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/transport/mailets/smime/AbstractSign.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/transport/mailets/smime/AbstractSign.java
(original)
+++
james/server/trunk/src/java/org/apache/james/transport/mailets/smime/AbstractSign.java
Sat Sep 23 10:07:44 2006
@@ -204,7 +204,7 @@
/**
* Setter for property keyHolderClass.
- * @param signerName New value of property keyHolderClass.
+ * @param keyHolderClass New value of property keyHolderClass.
*/
public void setKeyHolderClass(Class keyHolderClass) {
this.keyHolderClass = keyHolderClass;
Modified:
james/server/trunk/src/java/org/apache/james/transport/matchers/GenericRegexMatcher.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/transport/matchers/GenericRegexMatcher.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/transport/matchers/GenericRegexMatcher.java
(original)
+++
james/server/trunk/src/java/org/apache/james/transport/matchers/GenericRegexMatcher.java
Sat Sep 23 10:07:44 2006
@@ -41,7 +41,7 @@
* could subclass match(), and call it as necessary during message
* processing (e.g., if a file of expressions changed).
*
- * @
+ *
*/
abstract public class GenericRegexMatcher extends GenericMatcher {
Modified:
james/server/trunk/src/java/org/apache/james/userrepository/AbstractUsersRepository.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/userrepository/AbstractUsersRepository.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
---
james/server/trunk/src/java/org/apache/james/userrepository/AbstractUsersRepository.java
(original)
+++
james/server/trunk/src/java/org/apache/james/userrepository/AbstractUsersRepository.java
Sat Sep 23 10:07:44 2006
@@ -53,17 +53,23 @@
/**
* Adds a user to the underlying Repository.
* The user name must not clash with an existing user.
+ *
+ * @param user the user to add
*/
protected abstract void doAddUser(User user);
/**
* Removes a user from the underlying repository.
* If the user doesn't exist, returns ok.
+ *
+ * @param user the user to remove
*/
protected abstract void doRemoveUser(User user);
/**
* Updates a user record to match the supplied User.
+ *
+ * @param user the user to update
*/
protected abstract void doUpdateUser(User user);
@@ -185,10 +191,10 @@
/**
* Removes a user from the repository
*
- * @param user the user to be removed
+ * @param userName the user to be removed
*/
- public void removeUser(String name) {
- User user = getUserByName(name);
+ public void removeUser(String userName) {
+ User user = getUserByName(userName);
if ( user != null ) {
doRemoveUser(user);
}
@@ -242,6 +248,8 @@
/**
* Returns whether or not this user is in the repository
+ *
+ * @return true or false
*/
public boolean contains(String name) {
User user = getUserByName(name, false);
@@ -251,6 +259,8 @@
/**
* Returns whether or not this user is in the repository. Names are
* matched on a case insensitive basis.
+ *
+ * @return true or false
*/
public boolean containsCaseInsensitive(String name) {
User user = getUserByName( name, true );
Modified:
james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java?view=diff&rev=449273&r1=449272&r2=449273
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java
(original)
+++ james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java
Sat Sep 23 10:07:44 2006
@@ -358,7 +358,7 @@
* Initializes the sql query environment from the SqlResources file.
* Will look for conf/sqlResources.xml.
* @param conn The connection for accessing the database
- * @param sqlResources.xml file
+ * @param file The sqlResources.xml file
* @throws Exception If any error occurs
*/
public void initSqlQueries(Connection conn, String file) throws Exception {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
