You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2013/01/29 15:44:25 UTC
git commit: Added class headers
Updated Branches:
refs/heads/trunk d5b20b1e1 -> 564638ab6
Added class headers
Project: http://git-wip-us.apache.org/repos/asf/mina/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/564638ab
Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/564638ab
Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/564638ab
Branch: refs/heads/trunk
Commit: 564638ab6575a26c167b3ee607dbe1a0de077fac
Parents: d5b20b1
Author: Emmanuel Lécharny <el...@apache.org>
Authored: Tue Jan 29 15:43:14 2013 +0100
Committer: Emmanuel Lécharny <el...@apache.org>
Committed: Tue Jan 29 15:43:14 2013 +0100
----------------------------------------------------------------------
.../mina/filter/codec/ProtocolCodecFilter.java | 46 +++++++-------
.../main/java/org/apache/mina/http/ArrayUtil.java | 4 +
.../main/java/org/apache/mina/http/DateUtil.java | 4 +
.../java/org/apache/mina/http/DecoderState.java | 4 +
.../java/org/apache/mina/http/HttpException.java | 4 +
.../java/org/apache/mina/http/HttpRequestImpl.java | 4 +
.../java/org/apache/mina/http/api/HttpStatus.java | 2 +
.../java/org/apache/mina/http/DateUtilTest.java | 2 +
.../main/java/org/apache/mina/ldap/LdapCodec.java | 2 +-
9 files changed, 48 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina/blob/564638ab/core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFilter.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFilter.java b/core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFilter.java
index e7970c0..bd8ef2e 100644
--- a/core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFilter.java
+++ b/core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFilter.java
@@ -64,7 +64,7 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
*
* @param factory The associated factory
*/
- public ProtocolCodecFilter(final ProtocolCodecFactory<MESSAGE, ENCODED> factory) {
+ public ProtocolCodecFilter(ProtocolCodecFactory<MESSAGE, ENCODED> factory) {
if (factory == null) {
throw new IllegalArgumentException("factory");
}
@@ -80,20 +80,20 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
* @param encoderClass The class responsible for encoding the message
* @param decoderClass The class responsible for decoding the message
*/
- public ProtocolCodecFilter(final Class<? extends ProtocolEncoder<MESSAGE, ENCODED>> encoderClass,
- final Class<? extends ProtocolDecoder<ENCODED, MESSAGE>> decoderClass) {
+ public ProtocolCodecFilter(Class<? extends ProtocolEncoder<MESSAGE, ENCODED>> encoderClass,
+ Class<? extends ProtocolDecoder<ENCODED, MESSAGE>> decoderClass) {
Assert.assertNotNull(encoderClass, "Encoder Class");
Assert.assertNotNull(decoderClass, "Decoder Class");
try {
encoderClass.getConstructor(EMPTY_PARAMS);
- } catch (final NoSuchMethodException e) {
+ } catch (NoSuchMethodException e) {
throw new IllegalArgumentException("encoderClass doesn't have a public default constructor.");
}
try {
decoderClass.getConstructor(EMPTY_PARAMS);
- } catch (final NoSuchMethodException e) {
+ } catch (NoSuchMethodException e) {
throw new IllegalArgumentException("decoderClass doesn't have a public default constructor.");
}
@@ -101,7 +101,7 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
try {
encoder = encoderClass.newInstance();
- } catch (final Exception e) {
+ } catch (Exception e) {
throw new IllegalArgumentException("encoderClass cannot be initialized");
}
@@ -109,19 +109,19 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
try {
decoder = decoderClass.newInstance();
- } catch (final Exception e) {
+ } catch (Exception e) {
throw new IllegalArgumentException("decoderClass cannot be initialized");
}
// Create the inner factory based on the two parameters.
this.factory = new ProtocolCodecFactory<MESSAGE, ENCODED>() {
@Override
- public ProtocolEncoder<MESSAGE, ENCODED> getEncoder(final IoSession session) {
+ public ProtocolEncoder<MESSAGE, ENCODED> getEncoder(IoSession session) {
return encoder;
}
@Override
- public ProtocolDecoder<ENCODED, MESSAGE> getDecoder(final IoSession session) {
+ public ProtocolDecoder<ENCODED, MESSAGE> getDecoder(IoSession session) {
return decoder;
}
};
@@ -133,7 +133,7 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
* @param session The associated session we will get the encoder from
* @return The encoder instance, if any
*/
- public ProtocolEncoder<MESSAGE, ENCODED> getEncoder(final IoSession session) {
+ public ProtocolEncoder<MESSAGE, ENCODED> getEncoder(IoSession session) {
return factory.getEncoder(session);
}
@@ -143,7 +143,7 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
* @param session The associated session we will get the decoder from
* @return The decoder instance, if any
*/
- public ProtocolDecoder<ENCODED, MESSAGE> getDecoder(final IoSession session) {
+ public ProtocolDecoder<ENCODED, MESSAGE> getDecoder(IoSession session) {
return factory.getDecoder(session);
}
@@ -159,10 +159,10 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
*/
@SuppressWarnings("unchecked")
@Override
- public void messageReceived(final IoSession session, final Object in, final ReadFilterChainController controller) {
+ public void messageReceived(IoSession session, Object in, ReadFilterChainController controller) {
LOGGER.debug("Processing a MESSAGE_RECEIVED for session {}", session);
- final ProtocolDecoder<ENCODED, MESSAGE> decoder = getDecoder(session);
+ ProtocolDecoder<ENCODED, MESSAGE> decoder = getDecoder(session);
// Loop until the codec cannot decode more
MESSAGE[] msg;
@@ -185,7 +185,7 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
public void messageWriting(IoSession session, WriteRequest message, WriteFilterChainController controller) {
LOGGER.debug("Processing a MESSAGE_WRITTING for session {}", session);
- final ProtocolEncoder<MESSAGE, ENCODED> encoder = session.getAttribute(ENCODER, null);
+ ProtocolEncoder<MESSAGE, ENCODED> encoder = getEncoder(session);
ENCODED encoded = encoder.encode((MESSAGE) message.getMessage());
message.setMessage(encoded);
@@ -196,12 +196,12 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
* {@inheritDoc}
*/
@Override
- public void sessionOpened(final IoSession session) {
+ public void sessionOpened(IoSession session) {
// Initialize the encoder and decoder if we use a factory
if (factory != null) {
- final ProtocolEncoder<MESSAGE, ENCODED> encoder = factory.getEncoder(session);
+ ProtocolEncoder<MESSAGE, ENCODED> encoder = factory.getEncoder(session);
session.setAttribute(ENCODER, encoder);
- final ProtocolDecoder<ENCODED, MESSAGE> decoder = factory.getDecoder(session);
+ ProtocolDecoder<ENCODED, MESSAGE> decoder = factory.getDecoder(session);
session.setAttribute(DECODER, decoder);
}
}
@@ -210,7 +210,7 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
* {@inheritDoc}
*/
@Override
- public void sessionClosed(final IoSession session) {
+ public void sessionClosed(IoSession session) {
disposeCodec(session);
}
@@ -218,7 +218,7 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
/**
* Dispose the encoder, decoder, and the callback for the decoded messages.
*/
- private void disposeCodec(final IoSession session) {
+ private void disposeCodec(IoSession session) {
// We just remove the two instances of encoder/decoder to release resources
// from the session
disposeEncoder(session);
@@ -229,7 +229,7 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
* Dispose the encoder, removing its instance from the session's attributes, and calling the associated dispose
* method.
*/
- private void disposeEncoder(final IoSession session) {
+ private void disposeEncoder(IoSession session) {
session.removeAttribute(ENCODER);
}
@@ -237,12 +237,12 @@ public class ProtocolCodecFilter<MESSAGE, ENCODED> extends AbstractIoFilter {
* Dispose the decoder, removing its instance from the session's attributes, and calling the associated dispose
* method.
*/
- private void disposeDecoder(final IoSession session) {
+ private void disposeDecoder(IoSession session) {
@SuppressWarnings("unchecked")
- final ProtocolDecoder<ENCODED, MESSAGE> decoder = session.removeAttribute(DECODER);
+ ProtocolDecoder<ENCODED, MESSAGE> decoder = session.removeAttribute(DECODER);
try {
decoder.finishDecode();
- } catch (final Throwable t) {
+ } catch (Throwable t) {
LOGGER.warn("Failed to dispose: " + decoder.getClass().getName() + " (" + decoder + ')');
}
}
http://git-wip-us.apache.org/repos/asf/mina/blob/564638ab/http/src/main/java/org/apache/mina/http/ArrayUtil.java
----------------------------------------------------------------------
diff --git a/http/src/main/java/org/apache/mina/http/ArrayUtil.java b/http/src/main/java/org/apache/mina/http/ArrayUtil.java
index 19d88e3..074c2b1 100644
--- a/http/src/main/java/org/apache/mina/http/ArrayUtil.java
+++ b/http/src/main/java/org/apache/mina/http/ArrayUtil.java
@@ -19,6 +19,10 @@
*/
package org.apache.mina.http;
+/**
+ *
+ * @author <a href="http://mina.apache.org">Apache MINA Project</a>
+ */
public class ArrayUtil {
public static String[] dropFromEndWhile(String[] array, String regex) {
http://git-wip-us.apache.org/repos/asf/mina/blob/564638ab/http/src/main/java/org/apache/mina/http/DateUtil.java
----------------------------------------------------------------------
diff --git a/http/src/main/java/org/apache/mina/http/DateUtil.java b/http/src/main/java/org/apache/mina/http/DateUtil.java
index 1717169..1fd24c6 100644
--- a/http/src/main/java/org/apache/mina/http/DateUtil.java
+++ b/http/src/main/java/org/apache/mina/http/DateUtil.java
@@ -28,6 +28,10 @@ import java.util.Locale;
import java.util.TimeZone;
import java.util.regex.Pattern;
+/**
+ *
+ * @author <a href="http://mina.apache.org">Apache MINA Project</a>
+ */
public class DateUtil {
private final static Locale LOCALE = Locale.US;
http://git-wip-us.apache.org/repos/asf/mina/blob/564638ab/http/src/main/java/org/apache/mina/http/DecoderState.java
----------------------------------------------------------------------
diff --git a/http/src/main/java/org/apache/mina/http/DecoderState.java b/http/src/main/java/org/apache/mina/http/DecoderState.java
index 8782ca4..ecf6dba 100644
--- a/http/src/main/java/org/apache/mina/http/DecoderState.java
+++ b/http/src/main/java/org/apache/mina/http/DecoderState.java
@@ -19,6 +19,10 @@
*/
package org.apache.mina.http;
+/**
+ *
+ * @author <a href="http://mina.apache.org">Apache MINA Project</a>
+ */
public enum DecoderState {
NEW, // waiting for a new HTTP requests, the session is new of last request was completed
HEAD, // accumulating the HTTP request head (everything before the body)
http://git-wip-us.apache.org/repos/asf/mina/blob/564638ab/http/src/main/java/org/apache/mina/http/HttpException.java
----------------------------------------------------------------------
diff --git a/http/src/main/java/org/apache/mina/http/HttpException.java b/http/src/main/java/org/apache/mina/http/HttpException.java
index 97f54d2..e823fc9 100644
--- a/http/src/main/java/org/apache/mina/http/HttpException.java
+++ b/http/src/main/java/org/apache/mina/http/HttpException.java
@@ -19,6 +19,10 @@
*/
package org.apache.mina.http;
+/**
+ *
+ * @author <a href="http://mina.apache.org">Apache MINA Project</a>
+ */
@SuppressWarnings("serial")
public class HttpException extends RuntimeException {
http://git-wip-us.apache.org/repos/asf/mina/blob/564638ab/http/src/main/java/org/apache/mina/http/HttpRequestImpl.java
----------------------------------------------------------------------
diff --git a/http/src/main/java/org/apache/mina/http/HttpRequestImpl.java b/http/src/main/java/org/apache/mina/http/HttpRequestImpl.java
index 71f095d..bed1a39 100644
--- a/http/src/main/java/org/apache/mina/http/HttpRequestImpl.java
+++ b/http/src/main/java/org/apache/mina/http/HttpRequestImpl.java
@@ -29,6 +29,10 @@ import org.apache.mina.http.api.HttpPduEncodingVisitor;
import org.apache.mina.http.api.HttpRequest;
import org.apache.mina.http.api.HttpVersion;
+/**
+ *
+ * @author <a href="http://mina.apache.org">Apache MINA Project</a>
+ */
public class HttpRequestImpl implements HttpRequest {
private final HttpVersion version;
http://git-wip-us.apache.org/repos/asf/mina/blob/564638ab/http/src/main/java/org/apache/mina/http/api/HttpStatus.java
----------------------------------------------------------------------
diff --git a/http/src/main/java/org/apache/mina/http/api/HttpStatus.java b/http/src/main/java/org/apache/mina/http/api/HttpStatus.java
index 18ac72d..65471c3 100644
--- a/http/src/main/java/org/apache/mina/http/api/HttpStatus.java
+++ b/http/src/main/java/org/apache/mina/http/api/HttpStatus.java
@@ -21,6 +21,8 @@ package org.apache.mina.http.api;
/**
* An <code>Enumeration</code> of all known HTTP status codes.
+ *
+ * @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
public enum HttpStatus {
http://git-wip-us.apache.org/repos/asf/mina/blob/564638ab/http/src/test/java/org/apache/mina/http/DateUtilTest.java
----------------------------------------------------------------------
diff --git a/http/src/test/java/org/apache/mina/http/DateUtilTest.java b/http/src/test/java/org/apache/mina/http/DateUtilTest.java
index 640c7da..cb7ba22 100644
--- a/http/src/test/java/org/apache/mina/http/DateUtilTest.java
+++ b/http/src/test/java/org/apache/mina/http/DateUtilTest.java
@@ -11,6 +11,8 @@ import org.junit.Test;
/**
* Test class for DateUtil
+ *
+ * @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
public class DateUtilTest {
http://git-wip-us.apache.org/repos/asf/mina/blob/564638ab/ldap/src/main/java/org/apache/mina/ldap/LdapCodec.java
----------------------------------------------------------------------
diff --git a/ldap/src/main/java/org/apache/mina/ldap/LdapCodec.java b/ldap/src/main/java/org/apache/mina/ldap/LdapCodec.java
index 4509867..3e872d9 100644
--- a/ldap/src/main/java/org/apache/mina/ldap/LdapCodec.java
+++ b/ldap/src/main/java/org/apache/mina/ldap/LdapCodec.java
@@ -41,9 +41,9 @@ import org.apache.directory.shared.ldap.model.message.SearchResultEntry;
import org.apache.directory.shared.ldap.model.message.SearchResultReference;
import org.apache.mina.api.IdleStatus;
import org.apache.mina.api.IoSession;
-import org.apache.mina.codec.ProtocolCodecFilter;
import org.apache.mina.codec.ProtocolDecoder;
import org.apache.mina.codec.ProtocolEncoder;
+import org.apache.mina.filter.codec.ProtocolCodecFilter;
import org.apache.mina.filterchain.WriteFilterChainController;
import org.apache.mina.session.AttributeKey;
import org.apache.mina.session.WriteRequest;