Remove duplicate words in documentation and polish Javadoc
This commit is contained in:
@@ -57,7 +57,7 @@ public abstract class AbstractWebSocketSession<T> implements NativeWebSocketSess
|
||||
|
||||
/**
|
||||
* Create a new instance and associate the given attributes with it.
|
||||
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
|
||||
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
|
||||
* session; the provided attributes are copied, the original map is not used.
|
||||
*/
|
||||
public AbstractWebSocketSession(@Nullable Map<String, Object> attributes) {
|
||||
|
||||
@@ -74,7 +74,7 @@ public class JettyWebSocketSession extends AbstractWebSocketSession<Session> {
|
||||
|
||||
/**
|
||||
* Create a new {@link JettyWebSocketSession} instance.
|
||||
* @param attributes attributes from the HTTP handshake to associate with the WebSocket session
|
||||
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket session
|
||||
*/
|
||||
public JettyWebSocketSession(Map<String, Object> attributes) {
|
||||
this(attributes, null);
|
||||
@@ -82,7 +82,7 @@ public class JettyWebSocketSession extends AbstractWebSocketSession<Session> {
|
||||
|
||||
/**
|
||||
* Create a new {@link JettyWebSocketSession} instance associated with the given user.
|
||||
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
|
||||
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
|
||||
* session; the provided attributes are copied, the original map is not used.
|
||||
* @param user the user associated with the session; if {@code null} we'll fallback on the
|
||||
* user available via {@link org.eclipse.jetty.websocket.api.Session#getUpgradeRequest()}
|
||||
|
||||
@@ -77,7 +77,7 @@ public class StandardWebSocketSession extends AbstractWebSocketSession<Session>
|
||||
/**
|
||||
* Constructor for a standard WebSocket session.
|
||||
* @param headers the headers of the handshake request
|
||||
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
|
||||
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
|
||||
* session; the provided attributes are copied, the original map is not used.
|
||||
* @param localAddress the address on which the request was received
|
||||
* @param remoteAddress the address of the remote client
|
||||
@@ -91,7 +91,7 @@ public class StandardWebSocketSession extends AbstractWebSocketSession<Session>
|
||||
/**
|
||||
* Constructor that associates a user with the WebSocket session.
|
||||
* @param headers the headers of the handshake request
|
||||
* @param attributes attributes from the HTTP handshake to associate with the WebSocket session
|
||||
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket session
|
||||
* @param localAddress the address on which the request was received
|
||||
* @param remoteAddress the address of the remote client
|
||||
* @param user the user associated with the session; if {@code null} we'll
|
||||
|
||||
@@ -116,7 +116,7 @@ public abstract class AbstractWebSocketClient implements WebSocketClient {
|
||||
* @param uri the target URI for the handshake (never {@code null})
|
||||
* @param subProtocols requested sub-protocols, or an empty list
|
||||
* @param extensions requested WebSocket extensions, or an empty list
|
||||
* @param attributes attributes to associate with the WebSocketSession, i.e. via
|
||||
* @param attributes the attributes to associate with the WebSocketSession, i.e. via
|
||||
* {@link WebSocketSession#getAttributes()}; currently always an empty map.
|
||||
* @return the established WebSocket session wrapped in a ListenableFuture.
|
||||
*/
|
||||
|
||||
@@ -41,7 +41,7 @@ public interface HandshakeHandler {
|
||||
* @param wsHandler the handler to process WebSocket messages; see
|
||||
* {@link PerConnectionWebSocketHandler} for providing a handler with
|
||||
* per-connection lifecycle.
|
||||
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
|
||||
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
|
||||
* session; the provided attributes are copied, the original map is not used.
|
||||
* @return whether the handshake negotiation was successful or not. In either case the
|
||||
* response status, headers, and body will have been updated to reflect the
|
||||
|
||||
@@ -40,7 +40,7 @@ public interface HandshakeInterceptor {
|
||||
* @param request the current request
|
||||
* @param response the current response
|
||||
* @param wsHandler the target WebSocket handler
|
||||
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
|
||||
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
|
||||
* session; the provided attributes are copied, the original map is not used.
|
||||
* @return whether to proceed with the handshake ({@code true}) or abort ({@code false})
|
||||
*/
|
||||
|
||||
@@ -59,7 +59,7 @@ public abstract class AbstractSockJsSession implements SockJsSession {
|
||||
|
||||
/**
|
||||
* Log category to use on network IO exceptions after a client has gone away.
|
||||
* <p>Servlet containers dn't expose a a client disconnected callback, see
|
||||
* <p>Servlet containers don't expose a client disconnected callback; see
|
||||
* <a href="https://github.com/eclipse-ee4j/servlet-api/issues/44">eclipse-ee4j/servlet-api#44</a>.
|
||||
* Therefore network IO failures may occur simply because a client has gone away,
|
||||
* and that can fill the logs with unnecessary stack traces.
|
||||
@@ -122,7 +122,7 @@ public abstract class AbstractSockJsSession implements SockJsSession {
|
||||
* @param id the session ID
|
||||
* @param config the SockJS service configuration options
|
||||
* @param handler the recipient of SockJS messages
|
||||
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
|
||||
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
|
||||
* session; the provided attributes are copied, the original map is not used.
|
||||
*/
|
||||
public AbstractSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler handler,
|
||||
|
||||
Reference in New Issue
Block a user