Author: norman
Date: Sun Sep 25 17:55:58 2011
New Revision: 1175445
URL: http://svn.apache.org/viewvc?rev=1175445&view=rev
Log:
Add javadocs
Modified:
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/BaseRequest.java
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSession.java
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSessionFactory.java
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolTransport.java
Modified:
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/BaseRequest.java
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/BaseRequest.java?rev=1175445&r1=1175444&r2=1175445&view=diff
==============================================================================
---
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/BaseRequest.java
(original)
+++
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/BaseRequest.java
Sun Sep 25 17:55:58 2011
@@ -51,6 +51,7 @@ public class BaseRequest implements Requ
}
+ @Override
public String toString() {
if (argument == null) {
return command;
Modified:
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSession.java
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSession.java?rev=1175445&r1=1175444&r2=1175445&view=diff
==============================================================================
---
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSession.java
(original)
+++
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSession.java
Sun Sep 25 17:55:58 2011
@@ -90,14 +90,16 @@ public interface ProtocolSession {
/**
* Define a response object to be used as reply for a too long input line
- * @return Response
+ *
+ * @return Response or null if no response should be written before
closing the connection
*/
Response newLineTooLongResponse();
/**
* Define a response object to be used as reply during a fatal error.
* Connection will be closed after this response.
- * @return Response
+ *
+ * @return Response or null if no response should be written before
closing the connection
*/
Response newFatalErrorResponse();
Modified:
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSessionFactory.java
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSessionFactory.java?rev=1175445&r1=1175444&r2=1175445&view=diff
==============================================================================
---
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSessionFactory.java
(original)
+++
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolSessionFactory.java
Sun Sep 25 17:55:58 2011
@@ -19,8 +19,19 @@
package org.apache.james.protocols.api;
+/**
+ * Factory which is responsible for creating new {@link ProtocolSession}'s
+ *
+ *
+ */
public interface ProtocolSessionFactory {
+ /**
+ * Create a new {@link ProtocolSession} for the given {@link
ProtocolTransport}
+ *
+ * @param transport
+ * @return session
+ */
ProtocolSession newSession(ProtocolTransport transport);
}
Modified:
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolTransport.java
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolTransport.java?rev=1175445&r1=1175444&r2=1175445&view=diff
==============================================================================
---
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolTransport.java
(original)
+++
james/protocols/trunk/api/src/main/java/org/apache/james/protocols/api/ProtocolTransport.java
Sun Sep 25 17:55:58 2011
@@ -29,20 +29,62 @@ import org.apache.james.protocols.api.ha
*/
public interface ProtocolTransport {
+ /**
+ * Return the {@link InetSocketAddress} of the remote peer
+ *
+ * @return address
+ */
InetSocketAddress getRemoteAddress();
+ /**
+ * Return the unique id. The id MUST NOT be 100 % unique for ever. It just
should just not have the same
+ * id when having concurrent connections
+ *
+ * @return id
+ */
String getId();
+ /**
+ * Return <code>true</code> if <code>TLS</code> encryption is active
+ *
+ * @return tlsStarted
+ */
boolean isTLSStarted();
+ /**
+ * Return <code>true</code> if <code>STARTTLS</code> is supported by this
{@link ProtocolTransport}
+ *
+ * @return tlsSupprted
+ */
boolean isStartTLSSupported();
+ /**
+ * Write the {@link Response} to the {@link ProtocolTransport} which will
forward it to the connected
+ * peer
+ *
+ * @param response
+ * @param session
+ */
void writeResponse(Response response, ProtocolSession session);
+ /**
+ * Pop a {@link LineHandler} of the stack
+ */
void popLineHandler();
- <T extends ProtocolSession> void pushLineHandler(LineHandler<T>
overrideCommandHandler, T smtpNettySession);
-
+ /**
+ * Push a {@link LineHandler} in.
+ *
+ * @param overrideCommandHandler
+ * @param session
+ */
+ <T extends ProtocolSession> void pushLineHandler(LineHandler<T>
overrideCommandHandler, T session);
+
+ /**
+ * Return the count of pushed {@link LineHandler}'s
+ *
+ * @return lineCount
+ */
int getPushedLineHandlerCount();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
