http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java b/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java index f016b51..7715581 100644 --- a/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java +++ b/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java @@ -62,11 +62,15 @@ public abstract class StreamIoHandler extends IoHandlerAdapter { * Implement this method to execute your stream I/O logic; * <b>please note that you must forward the process request to other * thread or thread pool.</b> + * + * @param session The current session + * @param in The input stream + * @param out The output stream */ protected abstract void processStreamIo(IoSession session, InputStream in, OutputStream out); /** - * Returns read timeout in seconds. + * @return read timeout in seconds. * The default value is <tt>0</tt> (disabled). */ public int getReadTimeout() { @@ -76,13 +80,14 @@ public abstract class StreamIoHandler extends IoHandlerAdapter { /** * Sets read timeout in seconds. * The default value is <tt>0</tt> (disabled). + * @param readTimeout The Read timeout */ public void setReadTimeout(int readTimeout) { this.readTimeout = readTimeout; } /** - * Returns write timeout in seconds. + * @return write timeout in seconds. * The default value is <tt>0</tt> (disabled). */ public int getWriteTimeout() { @@ -92,6 +97,8 @@ public abstract class StreamIoHandler extends IoHandlerAdapter { /** * Sets write timeout in seconds. * The default value is <tt>0</tt> (disabled). + * + * @param writeTimeout The Write timeout */ public void setWriteTimeout(int writeTimeout) { this.writeTimeout = writeTimeout;
http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyIoHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyIoHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyIoHandler.java index 7d2c4ee..1d78ed8 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyIoHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyIoHandler.java @@ -40,6 +40,7 @@ public abstract class AbstractProxyIoHandler extends IoHandlerAdapter { * Method called only when handshake has completed. * * @param session the io session + * @throws Exception If the proxy session can't be opened */ public abstract void proxySessionOpened(IoSession session) throws Exception; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java index d9e866e..d92fc7d 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java @@ -73,21 +73,21 @@ public abstract class AbstractProxyLogicHandler implements ProxyLogicHandler { } /** - * Returns the proxy filter {@link ProxyFilter}. + * @return the proxy filter {@link ProxyFilter}. */ protected ProxyFilter getProxyFilter() { return proxyIoSession.getProxyFilter(); } /** - * Returns the session. + * @return the session. */ protected IoSession getSession() { return proxyIoSession.getSession(); } /** - * Returns the {@link ProxyIoSession} object. + * @return the {@link ProxyIoSession} object. */ public ProxyIoSession getProxyIoSession() { return proxyIoSession; @@ -98,6 +98,7 @@ public abstract class AbstractProxyLogicHandler implements ProxyLogicHandler { * * @param nextFilter the next filter * @param data Data buffer to be written. + * @return A Future for the write operation */ protected WriteFuture writeData(final NextFilter nextFilter, final IoBuffer data) { // write net data @@ -112,7 +113,7 @@ public abstract class AbstractProxyLogicHandler implements ProxyLogicHandler { } /** - * Returns <tt>true</tt> if handshaking is complete and + * @return <tt>true</tt> if handshaking is complete and * data can be sent through the proxy. */ public boolean isHandshakeComplete() { @@ -145,6 +146,8 @@ public abstract class AbstractProxyLogicHandler implements ProxyLogicHandler { /** * Send any write requests which were queued whilst waiting for handshaking to complete. + * + * @throws Exception If we can't flush the pending write requests */ protected synchronized void flushPendingWriteRequests() throws Exception { LOGGER.debug(" flushPendingWriteRequests()"); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/ProxyAuthException.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/ProxyAuthException.java b/mina-core/src/main/java/org/apache/mina/proxy/ProxyAuthException.java index 10b0714..d386993 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/ProxyAuthException.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/ProxyAuthException.java @@ -33,6 +33,8 @@ public class ProxyAuthException extends SaslException { /** * @see SaslException#SaslException(String) + * + * @param message The detail message */ public ProxyAuthException(String message) { super(message); @@ -40,6 +42,9 @@ public class ProxyAuthException extends SaslException { /** * @see SaslException#SaslException(String, Throwable) + * + * @param message The detail message + * @param ex The exception's cause */ public ProxyAuthException(String message, Throwable ex) { super(message, ex); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java b/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java index 916b34e..2e070fc 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java @@ -104,6 +104,10 @@ public class ProxyConnector extends AbstractIoConnector { /** * Creates a new proxy connector. + * + * @param connector The Connector used to establish proxy connections. + * @param config The session confiugarion to use + * @param executor The associated executor */ public ProxyConnector(final SocketConnector connector, IoSessionConfig config, Executor executor) { super(config, executor); @@ -118,7 +122,7 @@ public class ProxyConnector extends AbstractIoConnector { } /** - * Returns the {@link ProxyIoSession} linked with this connector. + * @return the {@link ProxyIoSession} linked with this connector. */ public ProxyIoSession getProxyIoSession() { return proxyIoSession; @@ -200,7 +204,7 @@ public class ProxyConnector extends AbstractIoConnector { } /** - * Get the {@link SocketConnector} to be used for connections + * @return the {@link SocketConnector} to be used for connections * to the proxy server. */ public final SocketConnector getConnector() { http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java index 1e29527..b57db97 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java @@ -58,9 +58,7 @@ public interface ProxyLogicHandler { void doHandshake(NextFilter nextFilter) throws ProxyAuthException; /** - * Returns the {@link ProxyIoSession}. - * - * @return the proxy session object + * @return the {@link ProxyIoSession}. */ ProxyIoSession getProxyIoSession(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEvent.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEvent.java b/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEvent.java index a4af1c6..785e3d7 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEvent.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEvent.java @@ -133,8 +133,6 @@ public class IoSessionEvent { } /** - * Returns the idle status of the event. - * * @return the idle status of the event */ public IdleStatus getStatus() { @@ -142,27 +140,21 @@ public class IoSessionEvent { } /** - * Returns the next filter to which the event should be sent. - * - * @return the next filter + * @return the next filter to which the event should be sent. */ public NextFilter getNextFilter() { return nextFilter; } /** - * Returns the session on which the event occured. - * - * @return the session + * @return the session on which the event occured. */ public IoSession getSession() { return session; } /** - * Returns the event type that occured. - * - * @return the event type + * @return the event type that occured. */ public IoSessionEventType getType() { return type; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventQueue.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventQueue.java b/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventQueue.java index 6aea122..0f02918 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventQueue.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventQueue.java @@ -108,6 +108,8 @@ public class IoSessionEventQueue { * Send any session event which were queued while waiting for handshaking to complete. * * Please note this is an internal method. DO NOT USE it in your code. + * + * @throws Exception If something went wrong while flushing the pending events */ public void flushPendingSessionEvents() throws Exception { synchronized (sessionEventsQueue) { http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventType.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventType.java b/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventType.java index b316a05..a499ae7 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventType.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/event/IoSessionEventType.java @@ -38,8 +38,6 @@ public enum IoSessionEventType { } /** - * Returns the event id. - * * @return the event id */ public int getId() { http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/ProxyRequest.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/ProxyRequest.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/ProxyRequest.java index 1cc14c2..9e605a8 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/ProxyRequest.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/ProxyRequest.java @@ -52,8 +52,6 @@ public abstract class ProxyRequest { } /** - * Returns the address of the request endpoint. - * * @return the address of the request endpoint */ public InetSocketAddress getEndpointAddress() { http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractAuthLogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractAuthLogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractAuthLogicHandler.java index 85d6578..5cded04 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractAuthLogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractAuthLogicHandler.java @@ -59,7 +59,7 @@ public abstract class AbstractAuthLogicHandler { * Instantiates a handler for the given proxy session. * * @param proxyIoSession the proxy session object - * @throws ProxyAuthException + * @throws ProxyAuthException If we get an error during the proxy authentication */ protected AbstractAuthLogicHandler(final ProxyIoSession proxyIoSession) throws ProxyAuthException { this.proxyIoSession = proxyIoSession; @@ -74,7 +74,7 @@ public abstract class AbstractAuthLogicHandler { * Method called at each step of the handshaking process. * * @param nextFilter the next filter - * @throws ProxyAuthException + * @throws ProxyAuthException If we get an error during the proxy authentication */ public abstract void doHandshake(final NextFilter nextFilter) throws ProxyAuthException; @@ -82,7 +82,7 @@ public abstract class AbstractAuthLogicHandler { * Handles a HTTP response from the proxy server. * * @param response The HTTP response. - * @throws ProxyAuthException + * @throws ProxyAuthException If we get an error during the proxy authentication */ public abstract void handleResponse(final HttpProxyResponse response) throws ProxyAuthException; @@ -91,7 +91,7 @@ public abstract class AbstractAuthLogicHandler { * * @param nextFilter the next filter * @param request the request to write - * @throws ProxyAuthException + * @throws ProxyAuthException If we get an error during the proxy authentication */ protected void writeRequest(final NextFilter nextFilter, final HttpProxyRequest request) throws ProxyAuthException { logger.debug(" sending HTTP request"); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractHttpLogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractHttpLogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractHttpLogicHandler.java index 65cdf31..61785c0 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractHttpLogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/AbstractHttpLogicHandler.java @@ -279,6 +279,7 @@ public abstract class AbstractHttpLogicHandler extends AbstractProxyLogicHandler * Handles a HTTP response from the proxy server. * * @param response The response. + * @throws ProxyAuthException If we get an error during the proxy authentication */ public abstract void handleResponse(final HttpProxyResponse response) throws ProxyAuthException; @@ -354,6 +355,8 @@ public abstract class AbstractHttpLogicHandler extends AbstractProxyLogicHandler * Parse a HTTP response from the proxy server. * * @param response The response string. + * @return The decoded HttpResponse + * @throws Exception If we get an error while decoding the response */ protected HttpProxyResponse decodeResponse(final String response) throws Exception { LOGGER.debug(" parseResponse()"); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpAuthenticationMethods.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpAuthenticationMethods.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpAuthenticationMethods.java index 5d1816d..5f89490 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpAuthenticationMethods.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpAuthenticationMethods.java @@ -43,8 +43,7 @@ public enum HttpAuthenticationMethods { } /** - * Returns the authentication mechanism id. - * @return the id + * @return the authentication mechanism id. */ public int getId() { return id; @@ -55,6 +54,7 @@ public enum HttpAuthenticationMethods { * * @param proxyIoSession the proxy session object * @return a new logic handler + * @throws ProxyAuthException If we get an error during the proxy authentication */ public AbstractAuthLogicHandler getNewHandler(ProxyIoSession proxyIoSession) throws ProxyAuthException { return getNewHandler(this.id, proxyIoSession); @@ -66,6 +66,7 @@ public enum HttpAuthenticationMethods { * @param method the authentication mechanism to use * @param proxyIoSession the proxy session object * @return a new logic handler + * @throws ProxyAuthException If we get an error during the proxy authentication */ public static AbstractAuthLogicHandler getNewHandler(int method, ProxyIoSession proxyIoSession) throws ProxyAuthException { http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyRequest.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyRequest.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyRequest.java index 529be5a..ce2b1fa 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyRequest.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyRequest.java @@ -164,14 +164,14 @@ public class HttpProxyRequest extends ProxyRequest { } /** - * Returns the HTTP request verb. + * @return the HTTP request verb. */ public final String getHttpVerb() { return httpVerb; } /** - * Returns the HTTP version. + * @return the HTTP version. */ public String getHttpVersion() { return httpVersion; @@ -187,7 +187,7 @@ public class HttpProxyRequest extends ProxyRequest { } /** - * Returns the host to which we are connecting. + * @return the host to which we are connecting. */ public synchronized final String getHost() { if (host == null) { @@ -208,14 +208,14 @@ public class HttpProxyRequest extends ProxyRequest { } /** - * Returns the request HTTP URI. + * @return the request HTTP URI. */ public final String getHttpURI() { return httpURI; } /** - * Returns the HTTP headers. + * @return the HTTP headers. */ public final Map<String, List<String>> getHeaders() { return headers; @@ -223,13 +223,15 @@ public class HttpProxyRequest extends ProxyRequest { /** * Set the HTTP headers. + * + * @param headers The HTTP headers to set */ public final void setHeaders(Map<String, List<String>> headers) { this.headers = headers; } /** - * Returns additional properties for the request. + * @return additional properties for the request. */ public Map<String, String> getProperties() { return properties; @@ -237,6 +239,8 @@ public class HttpProxyRequest extends ProxyRequest { /** * Set additional properties for the request. + * + * @param properties The properties to add to the reqyest */ public void setProperties(Map<String, String> properties) { this.properties = properties; @@ -245,6 +249,9 @@ public class HttpProxyRequest extends ProxyRequest { /** * Check if the given property(ies) is(are) set. Otherwise throws a * {@link ProxyAuthException}. + * + * @param propNames The list of property name to check + * @throws ProxyAuthException If we get an error during the proxy authentication */ public void checkRequiredProperties(String... propNames) throws ProxyAuthException { StringBuilder sb = new StringBuilder(); @@ -260,7 +267,7 @@ public class HttpProxyRequest extends ProxyRequest { } /** - * Returns the string representation of the HTTP request . + * @return the string representation of the HTTP request . */ public String toHttpString() { StringBuilder sb = new StringBuilder(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyResponse.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyResponse.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyResponse.java index 3f634b3..efab717 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyResponse.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/HttpProxyResponse.java @@ -74,28 +74,28 @@ public class HttpProxyResponse { } /** - * Returns the HTTP response protocol version. + * @return the HTTP response protocol version. */ public final String getHttpVersion() { return httpVersion; } /** - * Returns the HTTP response status code. + * @return the HTTP response status code. */ public final int getStatusCode() { return statusCode; } /** - * Returns the HTTP response status line. + * @return the HTTP response status line. */ public final String getStatusLine() { return statusLine; } /** - * Returns the HTTP response body. + * @return the HTTP response body. */ public String getBody() { return body; @@ -103,13 +103,15 @@ public class HttpProxyResponse { /** * Sets the HTTP response body. + * + * @param body The HTTP Body */ public void setBody(String body) { this.body = body; } /** - * Returns the HTTP response headers. + * @return the HTTP response headers. */ public final Map<String, List<String>> getHeaders() { return headers; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpBasicAuthLogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpBasicAuthLogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpBasicAuthLogicHandler.java index 43cea3e..de15bc0 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpBasicAuthLogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpBasicAuthLogicHandler.java @@ -46,6 +46,9 @@ public class HttpBasicAuthLogicHandler extends AbstractAuthLogicHandler { /** * Build an HttpBasicAuthLogicHandler + * + * @param proxyIoSession The proxy session + * @throws ProxyAuthException If we had a probelm during the proxy authentication */ public HttpBasicAuthLogicHandler(final ProxyIoSession proxyIoSession) throws ProxyAuthException { super(proxyIoSession); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpNoAuthLogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpNoAuthLogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpNoAuthLogicHandler.java index e58a4b1..d2c8843 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpNoAuthLogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/basic/HttpNoAuthLogicHandler.java @@ -39,6 +39,9 @@ public class HttpNoAuthLogicHandler extends AbstractAuthLogicHandler { /** * Build an HttpNoAuthLogicHandler + * + * @param proxyIoSession The original session + * @throws ProxyAuthException If we get an error during the proxy authentication */ public HttpNoAuthLogicHandler(final ProxyIoSession proxyIoSession) throws ProxyAuthException { super(proxyIoSession); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/digest/DigestUtilities.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/digest/DigestUtilities.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/digest/DigestUtilities.java index 4a240da..206c71d 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/digest/DigestUtilities.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/digest/DigestUtilities.java @@ -66,9 +66,13 @@ public class DigestUtilities { * @param pwd the password * @param charsetName the name of the charset used for the challenge * @param body the html body to be hashed for integrity calculations + * @return The response + * @throws AuthenticationException if we weren't able to find a directive value in the map + * @throws UnsupportedEncodingException If we weren't able to encode to ISO 8859_1 the username or realm, + * or if we weren't able to encode the charsetName */ public static String computeResponseValue(IoSession session, HashMap<String, String> map, String method, - String pwd, String charsetName, String body) throws AuthenticationException, UnsupportedEncodingException { + String pwd, String charsetName, String body) throws AuthenticationException, UnsupportedEncodingException{ byte[] hA1; StringBuilder sb; @@ -81,6 +85,7 @@ public class DigestUtilities { ':'); String realm = StringUtilities.stringTo8859_1(StringUtilities.getDirectiveValue(map, "realm", false)); + if (realm != null) { sb.append(realm); } @@ -89,6 +94,7 @@ public class DigestUtilities { if (isMD5Sess) { byte[] prehA1; + synchronized (md5) { md5.reset(); prehA1 = md5.digest(sb.toString().getBytes(charsetName)); @@ -122,6 +128,7 @@ public class DigestUtilities { sb.append(StringUtilities.getDirectiveValue(map, "uri", false)); String qop = StringUtilities.getDirectiveValue(map, "qop", false); + if ("auth-int".equalsIgnoreCase(qop)) { ProxyIoSession proxyIoSession = (ProxyIoSession) session.getAttribute(ProxyIoSession.PROXY_SESSION); byte[] hEntity; @@ -130,6 +137,7 @@ public class DigestUtilities { md5.reset(); hEntity = md5.digest(body.getBytes(proxyIoSession.getCharsetName())); } + sb.append(':').append(hEntity); } @@ -149,6 +157,7 @@ public class DigestUtilities { sb.append(ByteUtilities.asHex(hA2)); byte[] hFinal; + synchronized (md5) { md5.reset(); hFinal = md5.digest(sb.toString().getBytes(charsetName)); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/HttpNTLMAuthLogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/HttpNTLMAuthLogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/HttpNTLMAuthLogicHandler.java index d1202a7..6c73988 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/HttpNTLMAuthLogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/HttpNTLMAuthLogicHandler.java @@ -53,6 +53,9 @@ public class HttpNTLMAuthLogicHandler extends AbstractAuthLogicHandler { /** * Build an HttpNTLMAuthLogicHandler + * + * @param proxyIoSession The original session + * @throws ProxyAuthException If we get an error during the proxy authentication */ public HttpNTLMAuthLogicHandler(final ProxyIoSession proxyIoSession) throws ProxyAuthException { super(proxyIoSession); @@ -111,7 +114,7 @@ public class HttpNTLMAuthLogicHandler extends AbstractAuthLogicHandler { } /** - * Returns the value of the NTLM Proxy-Authenticate header. + * @return the value of the NTLM Proxy-Authenticate header. * * @param response the proxy response */ http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMResponses.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMResponses.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMResponses.java index 86cbe33..6a3df95 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMResponses.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMResponses.java @@ -54,6 +54,7 @@ public class NTLMResponses { * @param challenge The Type 2 challenge from the server. * * @return The LM Response. + * @throws Exception If something went wrong */ public static byte[] getLMResponse(String password, byte[] challenge) throws Exception { byte[] lmHash = lmHash(password); @@ -68,6 +69,7 @@ public class NTLMResponses { * @param challenge The Type 2 challenge from the server. * * @return The NTLM Response. + * @throws Exception If something went wrong */ public static byte[] getNTLMResponse(String password, byte[] challenge) throws Exception { byte[] ntlmHash = ntlmHash(password); @@ -88,6 +90,7 @@ public class NTLMResponses { * @param clientNonce The random 8-byte client nonce. * * @return The NTLMv2 Response. + * @throws Exception If something went wrong */ public static byte[] getNTLMv2Response(String target, String user, String password, byte[] targetInformation, byte[] challenge, byte[] clientNonce) throws Exception { @@ -111,6 +114,7 @@ public class NTLMResponses { * @param time The time stamp. * * @return The NTLMv2 Response. + * @throws Exception If something went wrong */ public static byte[] getNTLMv2Response(String target, String user, String password, byte[] targetInformation, byte[] challenge, byte[] clientNonce, long time) throws Exception { @@ -131,6 +135,7 @@ public class NTLMResponses { * @param clientNonce The random 8-byte client nonce. * * @return The LMv2 Response. + * @throws Exception If something went wrong */ public static byte[] getLMv2Response(String target, String user, String password, byte[] challenge, byte[] clientNonce) throws Exception { @@ -149,6 +154,7 @@ public class NTLMResponses { * @return The NTLM2 Session Response. This is placed in the NTLM * response field of the Type 3 message; the LM response field contains * the client nonce, null-padded to 24 bytes. + * @throws Exception If something went wrong */ public static byte[] getNTLM2SessionResponse(String password, byte[] challenge, byte[] clientNonce) throws Exception { @@ -319,6 +325,7 @@ public class NTLMResponses { * @param key The hashing key. * * @return The HMAC-MD5 hash of the given data. + * @throws Exception If something went wrong */ public static byte[] hmacMD5(byte[] data, byte[] key) throws Exception { byte[] ipad = new byte[64]; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMUtilities.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMUtilities.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMUtilities.java index 0bcca93..50c841f 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMUtilities.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/http/ntlm/NTLMUtilities.java @@ -38,6 +38,10 @@ import org.apache.mina.proxy.utils.ByteUtilities; public class NTLMUtilities implements NTLMConstants { /** * @see #writeSecurityBuffer(short, short, int, byte[], int) + * + * @param length The length of the security buffer + * @param bufferOffset The offset in the security buffer + * @return Th created buffer */ public final static byte[] writeSecurityBuffer(short length, int bufferOffset) { byte[] b = new byte[8]; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java index 9903316..7fc1d64 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java @@ -40,6 +40,8 @@ public class Socks4LogicHandler extends AbstractSocksLogicHandler { /** * @see AbstractSocksLogicHandler#AbstractSocksLogicHandler(ProxyIoSession) + * + * @param proxyIoSession The original session */ public Socks4LogicHandler(final ProxyIoSession proxyIoSession) { super(proxyIoSession); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks5LogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks5LogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks5LogicHandler.java index fce364f..3b00cdb 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks5LogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks5LogicHandler.java @@ -68,6 +68,8 @@ public class Socks5LogicHandler extends AbstractSocksLogicHandler { /** * @see AbstractSocksLogicHandler#AbstractSocksLogicHandler(ProxyIoSession) + * + * @param proxyIoSession The original session */ public Socks5LogicHandler(final ProxyIoSession proxyIoSession) { super(proxyIoSession); @@ -329,7 +331,8 @@ public class Socks5LogicHandler extends AbstractSocksLogicHandler { * * @param nextFilter the next filter * @param buf the buffered data received - * @param step the current step in the authentication process + * @param step the current step in the authentication process + * @throws Exception If something went wrong */ protected void handleResponse(final NextFilter nextFilter, final IoBuffer buf, int step) throws Exception { int len = 2; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/SocksProxyRequest.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/SocksProxyRequest.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/SocksProxyRequest.java index 63e5d39..e6c3a14 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/SocksProxyRequest.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/SocksProxyRequest.java @@ -98,11 +98,9 @@ public class SocksProxyRequest extends ProxyRequest { } /** - * Returns the endpoint address resulting from the {@link #getEndpointAddress()}. + * @return the endpoint address resulting from the {@link #getEndpointAddress()}. * If not set, it will return the {@link SocksProxyConstants#FAKE_IP} constant * value which will be ignored in a SOCKS v4 request. - * - * @return the endpoint address */ public byte[] getIpAddress() { if (getEndpointAddress() == null) { http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java b/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java index 95ac628..dad537f 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java @@ -116,14 +116,14 @@ public class ProxyIoSession { } /** - * Returns the pending event queue. + * @return the pending event queue. */ public IoSessionEventQueue getEventQueue() { return eventQueue; } /** - * Returns the list of the prefered order for the authentication methods. + * @return the list of the prefered order for the authentication methods. * This list is used by the {@link HttpSmartProxyHandler} to determine * which authentication mechanism to use first between those accepted by the * proxy server. This list is only used when connecting to an http proxy. @@ -142,7 +142,7 @@ public class ProxyIoSession { } /** - * Returns the {@link ProxyLogicHandler} currently in use. + * @return the {@link ProxyLogicHandler} currently in use. */ public ProxyLogicHandler getHandler() { return handler; @@ -158,7 +158,7 @@ public class ProxyIoSession { } /** - * Returns the {@link ProxyFilter}. + * @return the {@link ProxyFilter}. */ public ProxyFilter getProxyFilter() { return proxyFilter; @@ -176,7 +176,7 @@ public class ProxyIoSession { } /** - * Returns the proxy request. + * @return the proxy request. */ public ProxyRequest getRequest() { return request; @@ -196,7 +196,7 @@ public class ProxyIoSession { } /** - * Returns the current {@link IoSession}. + * @return the current {@link IoSession}. */ public IoSession getSession() { return session; @@ -214,7 +214,7 @@ public class ProxyIoSession { } /** - * Returns the proxy connector. + * @return the proxy connector. */ public ProxyConnector getConnector() { return connector; @@ -232,7 +232,7 @@ public class ProxyIoSession { } /** - * Returns the IP address of the proxy server. + * @return the IP address of the proxy server. */ public InetSocketAddress getProxyAddress() { return proxyAddress; @@ -252,7 +252,7 @@ public class ProxyIoSession { } /** - * Returns true if the current authentication process is not finished + * @return true if the current authentication process is not finished * but the server has closed the connection. */ public boolean isReconnectionNeeded() { @@ -274,14 +274,14 @@ public class ProxyIoSession { } /** - * Returns a charset instance of the in use charset name. + * @return a charset instance of the in use charset name. */ public Charset getCharset() { return Charset.forName(getCharsetName()); } /** - * Returns the used charset name or {@link #DEFAULT_ENCODING} if null. + * @return the used charset name or {@link #DEFAULT_ENCODING} if null. */ public String getCharsetName() { if (charsetName == null) { @@ -301,7 +301,7 @@ public class ProxyIoSession { } /** - * Returns true if authentication failed. + * @return true if authentication failed. */ public boolean isAuthenticationFailed() { return authenticationFailed; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/utils/ByteUtilities.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/utils/ByteUtilities.java b/mina-core/src/main/java/org/apache/mina/proxy/utils/ByteUtilities.java index a28210e..c03d642 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/utils/ByteUtilities.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/utils/ByteUtilities.java @@ -33,9 +33,9 @@ public class ByteUtilities { * Returns the integer represented by up to 4 bytes in network byte order. * * @param buf the buffer to read the bytes from - * @param start - * @param count - * @return the integer value + * @param start The starting position + * @param count The number of bytes to in the buffer + * @return the integer value */ public static int networkByteOrderToInt(byte[] buf, int start, int count) { if (count > 4) { @@ -91,6 +91,7 @@ public class ByteUtilities { * Write a 16 bit short as LITTLE_ENDIAN. * * @param v the short to write + * @return the Short in a byte[] */ public final static byte[] writeShort(short v) { return writeShort(v, new byte[2], 0); @@ -103,6 +104,7 @@ public class ByteUtilities { * @param v the short to write * @param b the byte array to write to * @param offset the offset at which to start writing in the array + * @return the Short in a byte[] */ public final static byte[] writeShort(short v, byte[] b, int offset) { b[offset] = (byte) v; @@ -115,6 +117,7 @@ public class ByteUtilities { * Write a 32 bit int as LITTLE_ENDIAN. * * @param v the int to write + * @return the Int in a byte[] */ public final static byte[] writeInt(int v) { return writeInt(v, new byte[4], 0); @@ -127,6 +130,7 @@ public class ByteUtilities { * @param v the int to write * @param b the byte array to write to * @param offset the offset at which to start writing in the array + * @return the Int in a byte[] */ public final static byte[] writeInt(int v, byte[] b, int offset) { b[offset] = (byte) v; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/utils/IoBufferDecoder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/utils/IoBufferDecoder.java b/mina-core/src/main/java/org/apache/mina/proxy/utils/IoBufferDecoder.java index a9a3723..148a98a 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/utils/IoBufferDecoder.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/utils/IoBufferDecoder.java @@ -180,6 +180,7 @@ public class IoBufferDecoder { * all the data and the trailing delimiter. * * @param in the data to decode + * @return The decoded buffer */ public IoBuffer decodeFully(IoBuffer in) { int contentLength = ctx.getContentLength(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java b/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java index c3b8687..48b2dc1 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java @@ -102,6 +102,7 @@ public class StringUtilities { * is a directive. * * @param buf A non-null digest-challenge string. + * @return A Map containing the aprsed directives * @throws SaslException if the String cannot be parsed according to RFC 2831 */ public static HashMap<String, String> parseDirectives(byte[] buf) throws SaslException { @@ -273,7 +274,7 @@ public class StringUtilities { * * @param str a non-null String * @return a non-null String containing the 8859_1 encoded string - * @throws UnsupportedEncodingException + * @throws UnsupportedEncodingException if we weren't able to decode using the ISO 8859_1 encoding */ public static String stringTo8859_1(String str) throws UnsupportedEncodingException { if (str == null) { http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java index 6fec90a..0c0734c 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java @@ -74,7 +74,7 @@ public abstract class AbstractDatagramSessionConfig extends AbstractIoSessionCon } /** - * Returns <tt>true</tt> if and only if the <tt>broadcast</tt> property + * @return <tt>true</tt> if and only if the <tt>broadcast</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -85,7 +85,7 @@ public abstract class AbstractDatagramSessionConfig extends AbstractIoSessionCon } /** - * Returns <tt>true</tt> if and only if the <tt>receiveBufferSize</tt> property + * @return <tt>true</tt> if and only if the <tt>receiveBufferSize</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -96,7 +96,7 @@ public abstract class AbstractDatagramSessionConfig extends AbstractIoSessionCon } /** - * Returns <tt>true</tt> if and only if the <tt>reuseAddress</tt> property + * @return <tt>true</tt> if and only if the <tt>reuseAddress</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -107,7 +107,7 @@ public abstract class AbstractDatagramSessionConfig extends AbstractIoSessionCon } /** - * Returns <tt>true</tt> if and only if the <tt>sendBufferSize</tt> property + * @return <tt>true</tt> if and only if the <tt>sendBufferSize</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -118,7 +118,7 @@ public abstract class AbstractDatagramSessionConfig extends AbstractIoSessionCon } /** - * Returns <tt>true</tt> if and only if the <tt>trafficClass</tt> property + * @return <tt>true</tt> if and only if the <tt>trafficClass</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java index b8b85ff..f96f70c 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java @@ -82,7 +82,7 @@ public abstract class AbstractSocketSessionConfig extends AbstractIoSessionConfi } /** - * Returns <tt>true</tt> if and only if the <tt>keepAlive</tt> property + * @return <tt>true</tt> if and only if the <tt>keepAlive</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -93,7 +93,7 @@ public abstract class AbstractSocketSessionConfig extends AbstractIoSessionConfi } /** - * Returns <tt>true</tt> if and only if the <tt>oobInline</tt> property + * @return <tt>true</tt> if and only if the <tt>oobInline</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -104,7 +104,7 @@ public abstract class AbstractSocketSessionConfig extends AbstractIoSessionConfi } /** - * Returns <tt>true</tt> if and only if the <tt>receiveBufferSize</tt> property + * @return <tt>true</tt> if and only if the <tt>receiveBufferSize</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -115,7 +115,7 @@ public abstract class AbstractSocketSessionConfig extends AbstractIoSessionConfi } /** - * Returns <tt>true</tt> if and only if the <tt>reuseAddress</tt> property + * @return <tt>true</tt> if and only if the <tt>reuseAddress</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -126,7 +126,7 @@ public abstract class AbstractSocketSessionConfig extends AbstractIoSessionConfi } /** - * Returns <tt>true</tt> if and only if the <tt>sendBufferSize</tt> property + * @return <tt>true</tt> if and only if the <tt>sendBufferSize</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -137,7 +137,7 @@ public abstract class AbstractSocketSessionConfig extends AbstractIoSessionConfi } /** - * Returns <tt>true</tt> if and only if the <tt>soLinger</tt> property + * @return <tt>true</tt> if and only if the <tt>soLinger</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -148,7 +148,7 @@ public abstract class AbstractSocketSessionConfig extends AbstractIoSessionConfi } /** - * Returns <tt>true</tt> if and only if the <tt>tcpNoDelay</tt> property + * @return <tt>true</tt> if and only if the <tt>tcpNoDelay</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation @@ -159,7 +159,7 @@ public abstract class AbstractSocketSessionConfig extends AbstractIoSessionConfi } /** - * Returns <tt>true</tt> if and only if the <tt>trafficClass</tt> property + * @return <tt>true</tt> if and only if the <tt>trafficClass</tt> property * has been changed by its setter method. The system call related with * the property is made only when this method returns <tt>true</tt>. By * default, this method always returns <tt>true</tt> to simplify implementation http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramAcceptor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramAcceptor.java b/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramAcceptor.java index 99b2b99..fba0319 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramAcceptor.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramAcceptor.java @@ -33,7 +33,7 @@ import org.apache.mina.core.session.IoSessionRecycler; */ public interface DatagramAcceptor extends IoAcceptor { /** - * Returns the local InetSocketAddress which is bound currently. If more than one + * @return the local InetSocketAddress which is bound currently. If more than one * address are bound, only one of them will be returned, but it's not * necessarily the firstly bound address. * This method overrides the {@link IoAcceptor#getLocalAddress()} method. @@ -41,7 +41,7 @@ public interface DatagramAcceptor extends IoAcceptor { InetSocketAddress getLocalAddress(); /** - * Returns a {@link Set} of the local InetSocketAddress which are bound currently. + * @return a {@link Set} of the local InetSocketAddress which are bound currently. * This method overrides the {@link IoAcceptor#getDefaultLocalAddress()} method. */ InetSocketAddress getDefaultLocalAddress(); @@ -51,11 +51,13 @@ public interface DatagramAcceptor extends IoAcceptor { * {@link #bind()} method. Please note that the default will not be used * if any local InetSocketAddress is specified. * This method overrides the {@link IoAcceptor#setDefaultLocalAddress(java.net.SocketAddress)} method. + * + * @param localAddress The local address */ void setDefaultLocalAddress(InetSocketAddress localAddress); /** - * Returns the {@link IoSessionRecycler} for this service. + * @return the {@link IoSessionRecycler} for this service. */ IoSessionRecycler getSessionRecycler(); @@ -67,7 +69,7 @@ public interface DatagramAcceptor extends IoAcceptor { void setSessionRecycler(IoSessionRecycler sessionRecycler); /** - * Returns the default Datagram configuration of the new {@link IoSession}s + * @return the default Datagram configuration of the new {@link IoSession}s * created by this service. */ DatagramSessionConfig getSessionConfig(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramConnector.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramConnector.java b/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramConnector.java index 4775ef4..02e5249 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramConnector.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramConnector.java @@ -30,14 +30,14 @@ import org.apache.mina.core.service.IoConnector; */ public interface DatagramConnector extends IoConnector { /** - * Returns the default remote InetSocketAddress to connect to when no argument + * @return the default remote InetSocketAddress to connect to when no argument * is specified in {@link #connect()} method. * This method overrides the {@link IoConnector#getDefaultRemoteAddress()} method. */ InetSocketAddress getDefaultRemoteAddress(); /** - * Returns the default configuration of the new FatagramSessions created by + * @return the default configuration of the new FatagramSessions created by * this connect service. */ DatagramSessionConfig getSessionConfig(); @@ -46,6 +46,8 @@ public interface DatagramConnector extends IoConnector { * Sets the default remote InetSocketAddress to connect to when no argument is * specified in {@link #connect()} method. * This method overrides the {@link IoConnector#setDefaultRemoteAddress(java.net.SocketAddress)} method. + * + * @param remoteAddress The remote address to set */ void setDefaultRemoteAddress(InetSocketAddress remoteAddress); } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramSessionConfig.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramSessionConfig.java b/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramSessionConfig.java index d9aaf31..a17d295 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramSessionConfig.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/DatagramSessionConfig.java @@ -32,63 +32,88 @@ import org.apache.mina.core.session.IoSessionConfig; public interface DatagramSessionConfig extends IoSessionConfig { /** * @see DatagramSocket#getBroadcast() + * + * @return <tt>true</tt> if SO_BROADCAST is enabled. */ boolean isBroadcast(); /** * @see DatagramSocket#setBroadcast(boolean) + * + * @param broadcast Tells if SO_BROACAST is enabled or not */ void setBroadcast(boolean broadcast); /** * @see DatagramSocket#getReuseAddress() + * + * @return <tt>true</tt> if SO_REUSEADDR is enabled. */ boolean isReuseAddress(); /** * @see DatagramSocket#setReuseAddress(boolean) + * + * @param reuseAddress Tells if SO_REUSEADDR is enabled or disabled */ void setReuseAddress(boolean reuseAddress); /** * @see DatagramSocket#getReceiveBufferSize() + * + * @return the size of the receive buffer */ int getReceiveBufferSize(); /** * @see DatagramSocket#setReceiveBufferSize(int) + * + * @param receiveBufferSize The size of the receive buffer */ void setReceiveBufferSize(int receiveBufferSize); /** * @see DatagramSocket#getSendBufferSize() + * + * @return the size of the send buffer */ int getSendBufferSize(); /** * @see DatagramSocket#setSendBufferSize(int) + * + * @param sendBufferSize The size of the send buffer */ void setSendBufferSize(int sendBufferSize); /** * @see DatagramSocket#getTrafficClass() + * + * @return the traffic class */ int getTrafficClass(); /** * @see DatagramSocket#setTrafficClass(int) + * + * @param trafficClass The traffic class to set, one of IPTOS_LOWCOST (0x02) + * IPTOS_RELIABILITY (0x04), IPTOS_THROUGHPUT (0x08) or IPTOS_LOWDELAY (0x10) */ void setTrafficClass(int trafficClass); /** * If method returns true, it means session should be closed when a * {@link PortUnreachableException} occurs. + * + * @return Tells if we should close if the port is unreachable */ boolean isCloseOnPortUnreachable(); /** * Sets if the session should be closed if an {@link PortUnreachableException} * occurs. + * + * @param closeOnPortUnreachable <tt>true</tt> if we should close if the port is unreachable */ void setCloseOnPortUnreachable(boolean closeOnPortUnreachable); } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/SocketAcceptor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketAcceptor.java b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketAcceptor.java index 5825cf2..86d1f47 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketAcceptor.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketAcceptor.java @@ -33,7 +33,7 @@ import org.apache.mina.core.service.IoAcceptor; */ public interface SocketAcceptor extends IoAcceptor { /** - * Returns the local InetSocketAddress which is bound currently. If more than one + * @return the local InetSocketAddress which is bound currently. If more than one * address are bound, only one of them will be returned, but it's not * necessarily the firstly bound address. * This method overrides the {@link IoAcceptor#getLocalAddress()} method. @@ -41,7 +41,7 @@ public interface SocketAcceptor extends IoAcceptor { InetSocketAddress getLocalAddress(); /** - * Returns a {@link Set} of the local InetSocketAddress which are bound currently. + * @return a {@link Set} of the local InetSocketAddress which are bound currently. * This method overrides the {@link IoAcceptor#getDefaultLocalAddress()} method. */ InetSocketAddress getDefaultLocalAddress(); @@ -51,32 +51,40 @@ public interface SocketAcceptor extends IoAcceptor { * {@link #bind()} method. Please note that the default will not be used * if any local InetSocketAddress is specified. * This method overrides the {@link IoAcceptor#setDefaultLocalAddress(java.net.SocketAddress)} method. + * + * @param localAddress The local address */ void setDefaultLocalAddress(InetSocketAddress localAddress); /** * @see ServerSocket#getReuseAddress() + * + * @return <tt>true</tt> if the <tt>SO_REUSEADDR</tt> is enabled */ boolean isReuseAddress(); /** * @see ServerSocket#setReuseAddress(boolean) + * + * @param reuseAddress tells if the <tt>SO_REUSEADDR</tt> is to be enabled */ void setReuseAddress(boolean reuseAddress); /** - * Returns the size of the backlog. + * @return the size of the backlog. */ int getBacklog(); /** * Sets the size of the backlog. This can only be done when this * class is not bound + * + * @param backlog The backlog's size */ void setBacklog(int backlog); /** - * Returns the default configuration of the new SocketSessions created by + * @return the default configuration of the new SocketSessions created by * this acceptor service. */ SocketSessionConfig getSessionConfig(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/SocketConnector.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketConnector.java b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketConnector.java index 2cf216a..f91b188 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketConnector.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketConnector.java @@ -30,14 +30,14 @@ import org.apache.mina.core.service.IoConnector; */ public interface SocketConnector extends IoConnector { /** - * Returns the default remote InetSocketAddress to connect to when no argument + * @return the default remote InetSocketAddress to connect to when no argument * is specified in {@link #connect()} method. * This method overrides the {@link IoConnector#getDefaultRemoteAddress()} method. */ InetSocketAddress getDefaultRemoteAddress(); /** - * Returns the default configuration of the new SocketSessions created by + * @return the default configuration of the new SocketSessions created by * this connect service. */ SocketSessionConfig getSessionConfig(); @@ -46,6 +46,8 @@ public interface SocketConnector extends IoConnector { * Sets the default remote InetSocketAddress to connect to when no argument is * specified in {@link #connect()} method. * This method overrides the {@link IoConnector#setDefaultRemoteAddress(java.net.SocketAddress)} method. + * + * @param remoteAddress The remote address to set */ void setDefaultRemoteAddress(InetSocketAddress remoteAddress); } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/SocketSessionConfig.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketSessionConfig.java b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketSessionConfig.java index 5b8254e..24bc41e 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketSessionConfig.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketSessionConfig.java @@ -31,61 +31,86 @@ import org.apache.mina.core.session.IoSessionConfig; public interface SocketSessionConfig extends IoSessionConfig { /** * @see Socket#getReuseAddress() + * + * @return <tt>true</tt> if SO_REUSEADDR is enabled. */ boolean isReuseAddress(); /** * @see Socket#setReuseAddress(boolean) + * + * @param reuseAddress Tells if SO_REUSEADDR is enabled or disabled */ void setReuseAddress(boolean reuseAddress); /** * @see Socket#getReceiveBufferSize() + * + * @return the size of the receive buffer */ int getReceiveBufferSize(); /** * @see Socket#setReceiveBufferSize(int) + * + * @param receiveBufferSize The size of the receive buffer */ void setReceiveBufferSize(int receiveBufferSize); /** * @see Socket#getSendBufferSize() + * + * @return the size of the send buffer */ int getSendBufferSize(); /** * @see Socket#setSendBufferSize(int) + * + * @param sendBufferSize The size of the send buffer */ void setSendBufferSize(int sendBufferSize); /** * @see Socket#getTrafficClass() + * + * @return the traffic class */ int getTrafficClass(); /** * @see Socket#setTrafficClass(int) + * + * @param trafficClass The traffic class to set, one of <tt>IPTOS_LOWCOST</tt> (0x02) + * <tt>IPTOS_RELIABILITY</tt> (0x04), <tt>IPTOS_THROUGHPUT</tt> (0x08) or <tt>IPTOS_LOWDELAY</tt> (0x10) */ void setTrafficClass(int trafficClass); /** * @see Socket#getKeepAlive() + * + * @return <tt>true</tt> if <tt>SO_KEEPALIVE</tt> is enabled. */ boolean isKeepAlive(); /** * @see Socket#setKeepAlive(boolean) + * + * @param keepAlive if <tt>SO_KEEPALIVE</tt> is to be enabled */ void setKeepAlive(boolean keepAlive); /** * @see Socket#getOOBInline() + * + * @return <tt>true</tt> if <tt>SO_OOBINLINE</tt> is enabled. */ boolean isOobInline(); /** * @see Socket#setOOBInline(boolean) + * + * @param oobInline if <tt>SO_OOBINLINE</tt> is to be enabled */ void setOobInline(boolean oobInline); @@ -95,6 +120,8 @@ public interface SocketSessionConfig extends IoSessionConfig { * * @see Socket#getSoLinger() * @see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6179351";>Sun Bug Database</a> + * + * @return The value for <tt>SO_LINGER</tt> */ int getSoLinger(); @@ -111,11 +138,15 @@ public interface SocketSessionConfig extends IoSessionConfig { /** * @see Socket#getTcpNoDelay() + * + * @return <tt>true</tt> if <tt>TCP_NODELAY</tt> is enabled. */ boolean isTcpNoDelay(); /** * @see Socket#setTcpNoDelay(boolean) + * + * @param tcpNoDelay <tt>true</tt> if <tt>TCP_NODELAY</tt> is to be enabled */ void setTcpNoDelay(boolean tcpNoDelay); } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramAcceptor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramAcceptor.java b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramAcceptor.java index c353de3..1577ff2 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramAcceptor.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramAcceptor.java @@ -113,6 +113,8 @@ public final class NioDatagramAcceptor extends AbstractIoAcceptor implements Dat /** * Creates a new instance. + * + * @param executor The executor to use */ public NioDatagramAcceptor(Executor executor) { this(new DefaultDatagramSessionConfig(), executor); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramConnector.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramConnector.java b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramConnector.java index b232f9e..9da09de 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramConnector.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramConnector.java @@ -53,6 +53,8 @@ DatagramConnector { /** * Creates a new instance. + * + * @param processorCount The number of IoProcessor instance to create */ public NioDatagramConnector(int processorCount) { super(new DefaultDatagramSessionConfig(), NioProcessor.class, processorCount); @@ -60,6 +62,8 @@ DatagramConnector { /** * Creates a new instance. + * + * @param processor The IoProcessor instance to use */ public NioDatagramConnector(IoProcessor<NioSession> processor) { super(new DefaultDatagramSessionConfig(), processor); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioProcessor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioProcessor.java b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioProcessor.java index 6730ba1..f621bcf 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioProcessor.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioProcessor.java @@ -52,7 +52,7 @@ public final class NioProcessor extends AbstractPollingIoProcessor<NioSession> { * * Creates a new instance of NioProcessor. * - * @param executor + * @param executor The executor to use */ public NioProcessor(Executor executor) { super(executor); @@ -69,7 +69,8 @@ public final class NioProcessor extends AbstractPollingIoProcessor<NioSession> { * * Creates a new instance of NioProcessor. * - * @param executor + * @param executor The executor to use + * @param selectorProvider The Selector provider to use */ public NioProcessor(Executor executor, SelectorProvider selectorProvider) { super(executor); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSession.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSession.java b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSession.java index b633e49..cddf4bc 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSession.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSession.java @@ -54,7 +54,9 @@ public abstract class NioSession extends AbstractIoSession { * <br> * This method is only called by the inherited class. * - * @param processor The associated IoProcessor + * @param processor The associated {@link IoProcessor} + * @param service The associated {@link IoService} + * @param channel The associated {@link Channel} */ protected NioSession(IoProcessor<NioSession> processor, IoService service, Channel channel) { super(service); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java b/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java index 250167f..3d6f727 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java +++ b/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java @@ -57,6 +57,8 @@ public final class VmPipeAcceptor extends AbstractIoAcceptor { /** * Creates a new instance. + * + * @param executor The executor to use */ public VmPipeAcceptor(Executor executor) { super(new DefaultVmPipeSessionConfig(), executor); @@ -66,6 +68,9 @@ public final class VmPipeAcceptor extends AbstractIoAcceptor { executeWorker(idleChecker.getNotifyingTask(), "idleStatusChecker"); } + /** + * {@inheritDoc} + */ public TransportMetadata getTransportMetadata() { return VmPipeSession.METADATA; } @@ -77,11 +82,17 @@ public final class VmPipeAcceptor extends AbstractIoAcceptor { return (VmPipeSessionConfig) sessionConfig; } + /** + * {@inheritDoc} + */ @Override public VmPipeAddress getLocalAddress() { return (VmPipeAddress) super.getLocalAddress(); } + /** + * {@inheritDoc} + */ @Override public VmPipeAddress getDefaultLocalAddress() { return (VmPipeAddress) super.getDefaultLocalAddress(); @@ -89,11 +100,18 @@ public final class VmPipeAcceptor extends AbstractIoAcceptor { // This method is overriden to work around a problem with // bean property access mechanism. - + /** + * Sets the local Address for this acceptor + * + * @param localAddress The local address to use + */ public void setDefaultLocalAddress(VmPipeAddress localAddress) { super.setDefaultLocalAddress(localAddress); } + /** + * {@inheritDoc} + */ @Override protected void dispose0() throws Exception { // stop the idle checking task @@ -101,6 +119,9 @@ public final class VmPipeAcceptor extends AbstractIoAcceptor { unbind(); } + /** + * {@inheritDoc} + */ @Override protected Set<SocketAddress> bindInternal(List<? extends SocketAddress> localAddresses) throws IOException { Set<SocketAddress> newLocalAddresses = new HashSet<SocketAddress>(); @@ -155,6 +176,9 @@ public final class VmPipeAcceptor extends AbstractIoAcceptor { } } + /** + * {@inheritDoc} + */ public IoSession newSession(SocketAddress remoteAddress, SocketAddress localAddress) { throw new UnsupportedOperationException(); } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAddress.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAddress.java b/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAddress.java index 0ec0d9e..5d42e1b 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAddress.java +++ b/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeAddress.java @@ -33,31 +33,37 @@ public class VmPipeAddress extends SocketAddress implements Comparable<VmPipeAdd /** * Creates a new instance with the specifid port number. + * + * @param port the port to use */ public VmPipeAddress(int port) { this.port = port; } /** - * Returns the port number. + * @return the port number. */ public int getPort() { return port; } + /** + * {@inheritDoc} + */ @Override public int hashCode() { return port; } + /** + * {@inheritDoc} + */ @Override public boolean equals(Object o) { - if (o == null) { - return false; - } if (this == o) { return true; } + if (o instanceof VmPipeAddress) { VmPipeAddress that = (VmPipeAddress) o; return this.port == that.port; @@ -66,10 +72,16 @@ public class VmPipeAddress extends SocketAddress implements Comparable<VmPipeAdd return false; } + /** + * {@inheritDoc} + */ public int compareTo(VmPipeAddress o) { return this.port - o.port; } + /** + * {@inheritDoc} + */ @Override public String toString() { if (port >= 0) { http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeConnector.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeConnector.java b/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeConnector.java index 6c1f7d6..9804ce7 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeConnector.java +++ b/mina-core/src/main/java/org/apache/mina/transport/vmpipe/VmPipeConnector.java @@ -57,6 +57,8 @@ public final class VmPipeConnector extends AbstractIoConnector { /** * Creates a new instance. + * + * @param executor The executor to use */ public VmPipeConnector(Executor executor) { super(new DefaultVmPipeSessionConfig(), executor); @@ -66,6 +68,9 @@ public final class VmPipeConnector extends AbstractIoConnector { executeWorker(idleChecker.getNotifyingTask(), "idleStatusChecker"); } + /** + * {@inheritDoc} + */ public TransportMetadata getTransportMetadata() { return VmPipeSession.METADATA; } @@ -77,6 +82,9 @@ public final class VmPipeConnector extends AbstractIoConnector { return (VmPipeSessionConfig) sessionConfig; } + /** + * {@inheritDoc} + */ @Override protected ConnectFuture connect0(SocketAddress remoteAddress, SocketAddress localAddress, IoSessionInitializer<? extends ConnectFuture> sessionInitializer) { @@ -138,6 +146,9 @@ public final class VmPipeConnector extends AbstractIoConnector { return future; } + /** + * {@inheritDoc} + */ @Override protected void dispose0() throws Exception { // stop the idle checking task http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/util/AvailablePortFinder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/util/AvailablePortFinder.java b/mina-core/src/main/java/org/apache/mina/util/AvailablePortFinder.java index c3a4e56..e0564b9 100644 --- a/mina-core/src/main/java/org/apache/mina/util/AvailablePortFinder.java +++ b/mina-core/src/main/java/org/apache/mina/util/AvailablePortFinder.java @@ -51,7 +51,7 @@ public class AvailablePortFinder { } /** - * Returns the {@link Set} of currently available port numbers + * @return the {@link Set} of currently available port numbers * ({@link Integer}). This method is identical to * <code>getAvailablePorts(MIN_PORT_NUMBER, MAX_PORT_NUMBER)</code>. * @@ -62,7 +62,7 @@ public class AvailablePortFinder { } /** - * Gets an available port, selected by the system. + * @return an available port, selected by the system. * * @throws NoSuchElementException if there are no ports available */ @@ -84,7 +84,7 @@ public class AvailablePortFinder { } /** - * Gets the next available port starting at a port. + * @return the next available port starting at a port. * * @param fromPort the port to scan for availability * @throws NoSuchElementException if there are no ports available @@ -107,6 +107,7 @@ public class AvailablePortFinder { * Checks to see if a specific port is available. * * @param port the port to check for availability + * @return <tt>true</tt> if the port is available */ public static boolean available(int port) { if (port < MIN_PORT_NUMBER || port > MAX_PORT_NUMBER) { @@ -142,7 +143,9 @@ public class AvailablePortFinder { } /** - * Returns the {@link Set} of currently avaliable port numbers ({@link Integer}) + * @param fromPort The port we start from + * @param toPort The posrt we stop at + * @return the {@link Set} of currently avalaible port numbers ({@link Integer}) * between the specified port range. * * @throws IllegalArgumentException if port range is not between http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java b/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java index e49a6f9..db95929 100644 --- a/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java +++ b/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java @@ -87,7 +87,7 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria } /** - * Returns the capacity of this queue. + * @return the capacity of this queue. */ public int capacity() { return items.length; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java b/mina-core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java index cf8717b..75bddd6 100644 --- a/mina-core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java +++ b/mina-core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java @@ -128,7 +128,7 @@ public class CopyOnWriteMap<K, V> implements Map<K, V>, Cloneable { // ==== the internal Maps ==== // ============================================== /** - * Returns the number of key/value pairs in this map. + * @return the number of key/value pairs in this map. * * @see java.util.Map#size() */ @@ -137,7 +137,7 @@ public class CopyOnWriteMap<K, V> implements Map<K, V>, Cloneable { } /** - * Returns true if this map is empty, otherwise false. + * @return true if this map is empty, otherwise false. * * @see java.util.Map#isEmpty() */ @@ -146,7 +146,7 @@ public class CopyOnWriteMap<K, V> implements Map<K, V>, Cloneable { } /** - * Returns true if this map contains the provided key, otherwise + * @return true if this map contains the provided key, otherwise * this method return false. * * @see java.util.Map#containsKey(java.lang.Object) @@ -156,7 +156,7 @@ public class CopyOnWriteMap<K, V> implements Map<K, V>, Cloneable { } /** - * Returns true if this map contains the provided value, otherwise + * @return true if this map contains the provided value, otherwise * this method returns false. * * @see java.util.Map#containsValue(java.lang.Object) @@ -166,7 +166,7 @@ public class CopyOnWriteMap<K, V> implements Map<K, V>, Cloneable { } /** - * Returns the value associated with the provided key from this + * @return the value associated with the provided key from this * map. * * @see java.util.Map#get(java.lang.Object) http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/util/ExceptionMonitor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/util/ExceptionMonitor.java b/mina-core/src/main/java/org/apache/mina/util/ExceptionMonitor.java index 2ba1390..97cc621 100644 --- a/mina-core/src/main/java/org/apache/mina/util/ExceptionMonitor.java +++ b/mina-core/src/main/java/org/apache/mina/util/ExceptionMonitor.java @@ -36,7 +36,7 @@ public abstract class ExceptionMonitor { private static ExceptionMonitor instance = new DefaultExceptionMonitor(); /** - * Returns the current exception monitor. + * @return the current exception monitor. */ public static ExceptionMonitor getInstance() { return instance; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/util/ExpiringMap.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/util/ExpiringMap.java b/mina-core/src/main/java/org/apache/mina/util/ExpiringMap.java index d06641a..b3fd9e0 100644 --- a/mina-core/src/main/java/org/apache/mina/util/ExpiringMap.java +++ b/mina-core/src/main/java/org/apache/mina/util/ExpiringMap.java @@ -388,10 +388,7 @@ public class ExpiringMap<K, V> implements Map<K, V> { } /** - * Returns the Time-to-live value. - * - * @return - * The time-to-live (seconds) + * @return the Time-to-live value in seconds. */ public int getTimeToLive() { stateLock.readLock().lock(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/util/LazyInitializedCacheMap.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/util/LazyInitializedCacheMap.java b/mina-core/src/main/java/org/apache/mina/util/LazyInitializedCacheMap.java index cc51c55..68742fa 100644 --- a/mina-core/src/main/java/org/apache/mina/util/LazyInitializedCacheMap.java +++ b/mina-core/src/main/java/org/apache/mina/util/LazyInitializedCacheMap.java @@ -70,6 +70,8 @@ public class LazyInitializedCacheMap<K, V> implements Map<K, V> { /** * This constructor allows to provide a fine tuned {@link ConcurrentHashMap} * to stick with each special case the user needs. + * + * @param map The map to use as a cache */ public LazyInitializedCacheMap(final ConcurrentHashMap<K, LazyInitializer<V>> map) { this.cache = map;
