Return-Path: X-Original-To: apmail-tomcat-dev-archive@www.apache.org Delivered-To: apmail-tomcat-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 5F70DD77F for ; Sun, 2 Dec 2012 21:15:58 +0000 (UTC) Received: (qmail 60991 invoked by uid 500); 2 Dec 2012 21:15:57 -0000 Delivered-To: apmail-tomcat-dev-archive@tomcat.apache.org Received: (qmail 60904 invoked by uid 500); 2 Dec 2012 21:15:57 -0000 Mailing-List: contact dev-help@tomcat.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "Tomcat Developers List" Delivered-To: mailing list dev@tomcat.apache.org Received: (qmail 60895 invoked by uid 99); 2 Dec 2012 21:15:57 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 02 Dec 2012 21:15:57 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 02 Dec 2012 21:15:53 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 87F7F238890B for ; Sun, 2 Dec 2012 21:15:32 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1416262 - in /tomcat/trunk/java/org/apache/tomcat/websocket: Constants.java PathParam.java PojoMethodMapping.java UriTemplate.java WsEndpointPojo.java WsProtocolHandler.java WsServlet.java Date: Sun, 02 Dec 2012 21:15:32 -0000 To: dev@tomcat.apache.org From: markt@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121202211532.87F7F238890B@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: markt Date: Sun Dec 2 21:15:30 2012 New Revision: 1416262 URL: http://svn.apache.org/viewvc?rev=1416262&view=rev Log: Add some Javadoc Modified: tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java Modified: tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java?rev=1416262&r1=1416261&r2=1416262&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java Sun Dec 2 21:15:30 2012 @@ -16,6 +16,9 @@ */ package org.apache.tomcat.websocket; +/** + * Internal implementation constants. + */ public class Constants { protected static final String PACKAGE_NAME = "org.apache.tomcat.websocket"; Modified: tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java?rev=1416262&r1=1416261&r2=1416262&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java Sun Dec 2 21:15:30 2012 @@ -16,6 +16,13 @@ */ package org.apache.tomcat.websocket; +/** + * Stores the parameter type and name for a parameter that needs to be passed to + * an onXxx method of {@link javax.websocket.Endpoint}. The name is only present + * for parameters annotated with {@link javax.websocket.WebSocketPathParam}. For + * the {@link javax.websocket.Session} and {@link java.lang.Throwable} + * parameters, {@link #getName()} will always return null. + */ public class PathParam { private final Class type; private final String name; Modified: tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java?rev=1416262&r1=1416261&r2=1416262&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java Sun Dec 2 21:15:30 2012 @@ -26,6 +26,11 @@ import javax.websocket.WebSocketError; import javax.websocket.WebSocketOpen; import javax.websocket.WebSocketPathParam; +/** + * For a POJO class annotated with {@link javax.websocket.WebSocketEndpoint}, an + * instance of this class caches the method and parameter information for the + * onXXX calls. + */ public class PojoMethodMapping { private final Method onOpen; Modified: tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java?rev=1416262&r1=1416261&r2=1416262&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java Sun Dec 2 21:15:30 2012 @@ -23,6 +23,10 @@ import java.util.Map; import java.util.regex.Matcher; import java.util.regex.Pattern; +/** + * Extracts path parameters from URIs used to create web socket connections + * using the URI template defined for the associated Endpoint. + */ public class UriTemplate { private final Pattern pattern; Modified: tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java?rev=1416262&r1=1416261&r2=1416262&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java Sun Dec 2 21:15:30 2012 @@ -24,6 +24,11 @@ import javax.websocket.Endpoint; import javax.websocket.EndpointConfiguration; import javax.websocket.Session; +/** + * Wrapper class for instances of POJOs annotated with + * {@link javax.websocket.WebSocketEndpoint} so they appear as standard + * {@link Endpoint} instances. + */ public class WsEndpointPojo extends Endpoint { private final Object pojo; Modified: tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java?rev=1416262&r1=1416261&r2=1416262&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java Sun Dec 2 21:15:30 2012 @@ -20,6 +20,9 @@ import javax.servlet.http.ProtocolHandle import javax.servlet.http.WebConnection; import javax.websocket.Endpoint; +/** + * Servlet 3.1 HTTP upgrade handler for WebSocket connections. + */ public class WsProtocolHandler implements ProtocolHandler { private final Endpoint ep; Modified: tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java?rev=1416262&r1=1416261&r2=1416262&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java Sun Dec 2 21:15:30 2012 @@ -37,7 +37,9 @@ import javax.websocket.Endpoint; import javax.websocket.ServerEndpointConfiguration; import javax.xml.bind.DatatypeConverter; - +/** + * Handles the initial HTTP connection for WebSocket connections. + */ public class WsServlet extends HttpServlet { private static final long serialVersionUID = 1L; --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org For additional commands, e-mail: dev-help@tomcat.apache.org