Author: norman
Date: Sat Jan 30 10:12:31 2010
New Revision: 904749
URL: http://svn.apache.org/viewvc?rev=904749&view=rev
Log:
Add some javadocs
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelope.java
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelopeImpl.java
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/SMTPRequest.java
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractAuthRequiredToRelayRcptHook.java
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractHookableCmdHandler.java
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractSenderAuthIdentifyVerificationRcptHook.java
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AcceptRecipientIfRelayingIsAllowed.java
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataCmdHandler.java
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataLineMessageHookHandler.java
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelope.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelope.java?rev=904749&r1=904748&r2=904749&view=diff
==============================================================================
---
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelope.java
(original)
+++
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelope.java
Sat Jan 30 10:12:31 2010
@@ -26,17 +26,49 @@
import org.apache.mailet.MailAddress;
+/**
+ * The MailEnvelope of a SMTP-Transaction
+ *
+ *
+ */
public interface MailEnvelope {
+ /**
+ * Return the size of the message. If the message is "empty" it will
return -1
+ *
+ * @return size
+ */
public int getSize();
+ /**
+ * Return the recipients which where supplied in the RCPT TO: command
+ *
+ * @return recipients
+ */
public List<MailAddress> getRecipients();
+ /**
+ * Return the sender of the mail which was supplied int the MAIL FROM:
command. If its a "null" sender,
+ * null will get returned
+ *
+ * @return sender
+ */
public MailAddress getSender();
- public void setRecipients(List<MailAddress> recipientCollection);
+ /**
+ * Return the OutputStream of the message
+ *
+ * @return out
+ * @throws Exception
+ */
public OutputStream getMessageOutputStream() throws Exception;
+ /**
+ * Return the InputStream of the message
+ *
+ * @return in
+ * @throws Exception
+ */
public InputStream getMessageInputStream() throws Exception;
}
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelopeImpl.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelopeImpl.java?rev=904749&r1=904748&r2=904749&view=diff
==============================================================================
---
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelopeImpl.java
(original)
+++
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/MailEnvelopeImpl.java
Sat Jan 30 10:12:31 2010
@@ -28,6 +28,11 @@
import org.apache.mailet.MailAddress;
+/**
+ * MailEnvelope implementation which stores everything in memory
+ *
+ *
+ */
public class MailEnvelopeImpl implements MailEnvelope{
private List<MailAddress> recipients;
@@ -36,33 +41,63 @@
private ByteArrayOutputStream outputStream;
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.smtpserver.protocol.MailEnvelope#getSize()
+ */
public int getSize() {
if (outputStream == null)
return -1;
return outputStream.size();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.smtpserver.protocol.MailEnvelope#getRecipients()
+ */
public List<MailAddress> getRecipients() {
return recipients;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.smtpserver.protocol.MailEnvelope#getSender()
+ */
public MailAddress getSender() {
return sender;
}
+ /**
+ * Set the recipients of the mail
+ *
+ * @param recipientCollection
+ */
public void setRecipients(List<MailAddress> recipientCollection) {
this.recipients = recipientCollection;
}
+ /**
+ * Set the sender of the mail
+ *
+ * @param sender
+ */
public void setSender(MailAddress sender) {
this.sender = sender;
}
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.smtpserver.protocol.MailEnvelope#getMessageOutputStream()
+ */
public OutputStream getMessageOutputStream() {
this.outputStream = new ByteArrayOutputStream(100000);
return outputStream;
}
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.smtpserver.protocol.MailEnvelope#getMessageInputStream()
+ */
public InputStream getMessageInputStream() {
return new ByteArrayInputStream(outputStream.toByteArray());
}
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/SMTPRequest.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/SMTPRequest.java?rev=904749&r1=904748&r2=904749&view=diff
==============================================================================
---
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/SMTPRequest.java
(original)
+++
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/SMTPRequest.java
Sat Jan 30 10:12:31 2010
@@ -21,6 +21,11 @@
import org.apache.james.api.protocol.BaseRequest;
+/**
+ * SMTPRequest which contains a command and an optional argument
+ *
+ *
+ */
public final class SMTPRequest extends BaseRequest {
public SMTPRequest(final String command, final String argument) {
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractAuthRequiredToRelayRcptHook.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractAuthRequiredToRelayRcptHook.java?rev=904749&r1=904748&r2=904749&view=diff
==============================================================================
---
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractAuthRequiredToRelayRcptHook.java
(original)
+++
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractAuthRequiredToRelayRcptHook.java
Sat Jan 30 10:12:31 2010
@@ -63,8 +63,9 @@
return new HookResult(HookReturnCode.DECLINED);
}
+
/**
- * Return if the given domain is local
+ * Return true if the given domain is a local domain for this server
*
* @param domain
* @return isLocal
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractHookableCmdHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractHookableCmdHandler.java?rev=904749&r1=904748&r2=904749&view=diff
==============================================================================
---
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractHookableCmdHandler.java
(original)
+++
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractHookableCmdHandler.java
Sat Jan 30 10:12:31 2010
@@ -34,7 +34,7 @@
import org.apache.james.smtpserver.protocol.hook.HookReturnCode;
/**
- * Abstract class which Handle hooks.
+ * Abstract class which Handle hook-aware CommanHandler.
*
*/
public abstract class AbstractHookableCmdHandler<Hook> implements
CommandHandler<SMTPSession>, ExtensibleHandler {
@@ -201,6 +201,7 @@
* @see
org.apache.james.api.protocol.ExtensibleHandler#wireExtensions(java.lang.Class,
* java.util.List)
*/
+ @SuppressWarnings("unchecked")
public void wireExtensions(Class interfaceName, List extension) {
if (getHookInterface().equals(interfaceName)) {
this.hooks = extension;
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractSenderAuthIdentifyVerificationRcptHook.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractSenderAuthIdentifyVerificationRcptHook.java?rev=904749&r1=904748&r2=904749&view=diff
==============================================================================
---
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractSenderAuthIdentifyVerificationRcptHook.java
(original)
+++
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AbstractSenderAuthIdentifyVerificationRcptHook.java
Sat Jan 30 10:12:31 2010
@@ -29,7 +29,7 @@
import org.apache.mailet.MailAddress;
/**
- * Handler which check if the authenticated user is incorrect
+ * Handler which check if the authenticated user is incorrect or correct
*/
public abstract class AbstractSenderAuthIdentifyVerificationRcptHook
implements RcptHook {
/**
@@ -57,6 +57,12 @@
}
+ /**
+ * Return true if the given domain is a local domain for this server
+ *
+ * @param domain
+ * @return isLocal
+ */
protected abstract boolean isLocalDomain(String domain);
}
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AcceptRecipientIfRelayingIsAllowed.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AcceptRecipientIfRelayingIsAllowed.java?rev=904749&r1=904748&r2=904749&view=diff
==============================================================================
---
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AcceptRecipientIfRelayingIsAllowed.java
(original)
+++
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/AcceptRecipientIfRelayingIsAllowed.java
Sat Jan 30 10:12:31 2010
@@ -25,7 +25,7 @@
import org.apache.mailet.MailAddress;
/**
- * This hook will stop the hook chain if relaying is allowed
+ * This hook will stop the hook chain if relaying is allowed
*/
public class AcceptRecipientIfRelayingIsAllowed implements RcptHook {
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataCmdHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataCmdHandler.java?rev=904749&r1=904748&r2=904749&view=diff
==============================================================================
---
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataCmdHandler.java
(original)
+++
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataCmdHandler.java
Sat Jan 30 10:12:31 2010
@@ -130,6 +130,7 @@
/**
* @see
org.apache.james.api.protocol.ExtensibleHandler#getMarkerInterfaces()
*/
+ @SuppressWarnings("unchecked")
public List getMarkerInterfaces() {
List classes = new LinkedList();
classes.add(DataLineFilter.class);
@@ -140,6 +141,7 @@
/**
* @see
org.apache.james.api.protocol.ExtensibleHandler#wireExtensions(java.lang.Class,
java.util.List)
*/
+ @SuppressWarnings("unchecked")
public void wireExtensions(Class interfaceName, List extension) throws
WiringException {
if (DataLineFilter.class.equals(interfaceName)) {
Modified:
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataLineMessageHookHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataLineMessageHookHandler.java?rev=904749&r1=904748&r2=904749&view=diff
==============================================================================
---
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataLineMessageHookHandler.java
(original)
+++
james/server/trunk/smtp-protocol-library/src/main/java/org/apache/james/smtpserver/protocol/core/DataLineMessageHookHandler.java
Sat Jan 30 10:12:31 2010
@@ -127,6 +127,7 @@
/**
* @see
org.apache.james.api.protocol.ExtensibleHandler#wireExtensions(java.lang.Class,
java.util.List)
*/
+ @SuppressWarnings("unchecked")
public void wireExtensions(Class interfaceName, List extension) throws
WiringException {
if (MessageHook.class.equals(interfaceName)) {
this.messageHandlers = extension;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
