Author: markt
Date: Tue Nov 27 10:35:30 2012
New Revision: 1414110
URL: http://svn.apache.org/viewvc?rev=1414110&view=rev
Log:
More Javadoc
Modified:
tomcat/trunk/java/org/apache/tomcat/websocket/ServerContainerImpl.java
tomcat/trunk/java/org/apache/tomcat/websocket/Util.java
Modified: tomcat/trunk/java/org/apache/tomcat/websocket/ServerContainerImpl.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/ServerContainerImpl.java?rev=1414110&r1=1414109&r2=1414110&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/ServerContainerImpl.java
(original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/ServerContainerImpl.java Tue
Nov 27 10:35:30 2012
@@ -27,16 +27,26 @@ import javax.websocket.Endpoint;
import javax.websocket.ServerContainer;
import javax.websocket.ServerEndpointConfiguration;
+/**
+ * Provides a per class loader (i.e. per web application) instance of a
+ * {@link ServerContainer}.
+ */
public class ServerContainerImpl extends ClientContainerImpl implements
ServerContainer {
- // Needs to be a WekaHashMap to prevent memory leaks when a context is
+ // Needs to be a WeakHashMap to prevent memory leaks when a context is
// stopped
private static Map<ClassLoader, ServerContainerImpl>
classLoaderContainerMap = new WeakHashMap<>();
private static ReadWriteLock classLoaderContainerMapLock =
new ReentrantReadWriteLock();
+
+ /**
+ * Intended to be used be implementations of {@link
+ * javax.websocket.ContainerProvider#getServerContainer()} to obtain the
+ * correct {@link ServerContainer} instance.
+ */
public static ServerContainerImpl getServerContainer() {
// TODO SecurityManager
ClassLoader tccl = Thread.currentThread().getContextClassLoader();
@@ -67,10 +77,12 @@ public class ServerContainerImpl extends
return result;
}
+
private ServerContainerImpl() {
// Hide default constructor
}
+
@Override
public void publishServer(Class<? extends Endpoint> clazz)
throws DeploymentException {
@@ -91,6 +103,15 @@ public class ServerContainerImpl extends
}
}
+
+ /**
+ * Provides the equivalent of {@link #publishServer(Class)} for publishing
+ * plain old java objects (POJOs) that have been annotated as WebSocket
+ * endpoints.
+ *
+ * @param pojo
+ * @param path
+ */
public void publishServer(Class<?> pojo, String path) {
// TODO Replace following debug code with something useful.
System.out.println("Class [" + pojo.getName() +
Modified: tomcat/trunk/java/org/apache/tomcat/websocket/Util.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/Util.java?rev=1414110&r1=1414109&r2=1414110&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/Util.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/Util.java Tue Nov 27 10:35:30
2012
@@ -16,12 +16,24 @@
*/
package org.apache.tomcat.websocket;
+/**
+ * Utility class for internal use only within the {@link
+ * org.apache.tomcat.websocket} package.
+ */
class Util {
private Util() {
// Hide default constructor
}
+ /**
+ * Converts a path defined for a WebSocket endpoint into a path that can be
+ * used as a servlet mapping.
+ *
+ * @param wsPath The WebSocket endpoint path to convert
+ *
+ * @return The servlet mapping
+ */
static String getServletMappingPath(String wsPath) {
int templateStart = wsPath.indexOf('{');
if (templateStart == -1) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
