Author: markt
Date: Thu Mar 7 13:03:58 2013
New Revision: 1453842
URL: http://svn.apache.org/r1453842
Log:
Javadoc updates
Modified:
tomcat/trunk/java/javax/websocket/server/HandshakeRequest.java
tomcat/trunk/java/javax/websocket/server/PathParam.java
tomcat/trunk/java/javax/websocket/server/ServerApplicationConfig.java
tomcat/trunk/java/javax/websocket/server/ServerContainer.java
tomcat/trunk/java/javax/websocket/server/ServerContainerProvider.java
Modified: tomcat/trunk/java/javax/websocket/server/HandshakeRequest.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/websocket/server/HandshakeRequest.java?rev=1453842&r1=1453841&r2=1453842&view=diff
==============================================================================
--- tomcat/trunk/java/javax/websocket/server/HandshakeRequest.java (original)
+++ tomcat/trunk/java/javax/websocket/server/HandshakeRequest.java Thu Mar 7
13:03:58 2013
@@ -21,6 +21,9 @@ import java.security.Principal;
import java.util.List;
import java.util.Map;
+/**
+ * Represents the HTTP request that asked to be upgraded to WebSocket.
+ */
public interface HandshakeRequest {
static final String SEC_WEBSOCKET_KEY = "Sec-WebSocket-Key";
Modified: tomcat/trunk/java/javax/websocket/server/PathParam.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/websocket/server/PathParam.java?rev=1453842&r1=1453841&r2=1453842&view=diff
==============================================================================
--- tomcat/trunk/java/javax/websocket/server/PathParam.java (original)
+++ tomcat/trunk/java/javax/websocket/server/PathParam.java Thu Mar 7 13:03:58
2013
@@ -21,6 +21,11 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+/**
+ * Used to annotate method parameters on POJO endpoints the the {@link
+ * ServerEndpoint} has been defined with a {@link ServerEndpoint#value()} that
+ * uses a URI template.
+ */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface PathParam {
Modified: tomcat/trunk/java/javax/websocket/server/ServerApplicationConfig.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/websocket/server/ServerApplicationConfig.java?rev=1453842&r1=1453841&r2=1453842&view=diff
==============================================================================
--- tomcat/trunk/java/javax/websocket/server/ServerApplicationConfig.java
(original)
+++ tomcat/trunk/java/javax/websocket/server/ServerApplicationConfig.java Thu
Mar 7 13:03:58 2013
@@ -20,10 +20,32 @@ import java.util.Set;
import javax.websocket.Endpoint;
+/**
+ * Applications may provide an implementation of this interface to filter the
+ * discovered WebSocket endpoints that are deployed. Implementations of this
+ * class will be discovered via an ServletContainerInitializer scan.
+ */
public interface ServerApplicationConfig {
+ /**
+ * Enables applications to filter the discovered implementations of
+ * {@link ServerEndpointConfig}.
+ *
+ * @param scanned The {@link Endpoint} implementations found in the
+ * application
+ * @return The set of configurations for the endpoint the application
+ * wishes to deploy
+ */
Set<ServerEndpointConfig> getEndpointConfigs(
Set<Class<? extends Endpoint>> scanned);
+ /**
+ * Enables applications to filter the discovered classes annotated with
+ * {@link ServerEndpoint}.
+ *
+ * @param scanned The POJOs annotated with {@link ServerEndpoint} found
in
+ * the application
+ * @return The set of POJOs the application wishes to deploy
+ */
Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned);
}
Modified: tomcat/trunk/java/javax/websocket/server/ServerContainer.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/websocket/server/ServerContainer.java?rev=1453842&r1=1453841&r2=1453842&view=diff
==============================================================================
--- tomcat/trunk/java/javax/websocket/server/ServerContainer.java (original)
+++ tomcat/trunk/java/javax/websocket/server/ServerContainer.java Thu Mar 7
13:03:58 2013
@@ -19,6 +19,9 @@ package javax.websocket.server;
import javax.websocket.DeploymentException;
import javax.websocket.WebSocketContainer;
+/**
+ * Provides the ability to deploy endpoints programmatically.
+ */
public interface ServerContainer extends WebSocketContainer {
public abstract void addEndpoint(Class<?> clazz) throws
DeploymentException;
Modified: tomcat/trunk/java/javax/websocket/server/ServerContainerProvider.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/websocket/server/ServerContainerProvider.java?rev=1453842&r1=1453841&r2=1453842&view=diff
==============================================================================
--- tomcat/trunk/java/javax/websocket/server/ServerContainerProvider.java
(original)
+++ tomcat/trunk/java/javax/websocket/server/ServerContainerProvider.java Thu
Mar 7 13:03:58 2013
@@ -19,6 +19,10 @@ package javax.websocket.server;
import java.util.Iterator;
import java.util.ServiceLoader;
+/**
+ * Provides a standard mechanism for obtaining a reference to the
+ * {@link ServerContainer}.
+ */
public abstract class ServerContainerProvider {
private static final String DEFAULT_PROVIDER_CLASS_NAME =
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
