Author: markt
Date: Mon Nov 26 15:13:46 2012
New Revision: 1413675
URL: http://svn.apache.org/viewvc?rev=1413675&view=rev
Log:
Fill in some Javadoc. Address a TODO
Modified:
tomcat/trunk/java/javax/websocket/ContainerProvider.java
tomcat/trunk/java/javax/websocket/ServerContainer.java
Modified: tomcat/trunk/java/javax/websocket/ContainerProvider.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/websocket/ContainerProvider.java?rev=1413675&r1=1413674&r2=1413675&view=diff
==============================================================================
--- tomcat/trunk/java/javax/websocket/ContainerProvider.java (original)
+++ tomcat/trunk/java/javax/websocket/ContainerProvider.java Mon Nov 26
15:13:46 2012
@@ -19,13 +19,23 @@ package javax.websocket;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
+/**
+ * Provides access to the implementation. This version of the API is hard-coded
+ * to use the Apache Tomcat WebSocket implementation.
+ */
public class ContainerProvider {
private static final String CONTAINER_PROVIDER_IMPL =
"org.apache.tomcat.websocket.ServerContainerImpl";
+ /**
+ * Obtain a reference to the Server container used for processing incoming
+ * WebSocket connections.
+ */
public static ServerContainer getServerContainer() {
- // TODO SecurityManager
+ // Note: No special handling required when running under a
+ // SecurityManager as the caller and this class will have the
same
+ // ClassLoader
ServerContainer result = null;
try {
Class<?> clazz = Class.forName(CONTAINER_PROVIDER_IMPL);
@@ -40,6 +50,10 @@ public class ContainerProvider {
return result;
}
+ /**
+ * Obtain a reference to the ClientContainer used to create outgoing
+ * WebSocket connections.
+ */
public static ClientContainer getClientContainer() {
return null;
}
Modified: tomcat/trunk/java/javax/websocket/ServerContainer.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/websocket/ServerContainer.java?rev=1413675&r1=1413674&r2=1413675&view=diff
==============================================================================
--- tomcat/trunk/java/javax/websocket/ServerContainer.java (original)
+++ tomcat/trunk/java/javax/websocket/ServerContainer.java Mon Nov 26 15:13:46
2012
@@ -16,8 +16,18 @@
*/
package javax.websocket;
+/**
+ * Defines the additional server specific methods.
+ */
public interface ServerContainer extends ClientContainer {
+ /**
+ * Publish the Endpoint in this ServerContainer.
+ *
+ * @param clazz The implementation class for the Endpoint
+ *
+ * @throws DeploymentException If the publish process fails for any reason
+ */
void publishServer(Class<? extends Endpoint> clazz)
throws DeploymentException;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
