diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/CloseStatus.java b/spring-websocket/src/main/java/org/springframework/web/socket/CloseStatus.java index 364a9597b7e..c34307370ec 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/CloseStatus.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/CloseStatus.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2013 the original author or authors. + * Copyright 2002-2014 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,15 +16,14 @@ package org.springframework.web.socket; -import org.eclipse.jetty.websocket.api.StatusCode; import org.springframework.util.Assert; import org.springframework.util.ObjectUtils; /** * Represents a WebSocket close status code and reason. Status codes in the 1xxx range are * pre-defined by the protocol. Optionally, a status code may be sent with a reason. - *

- * See RFC 6455, Section 7.4.1 + * + *

See RFC 6455, Section 7.4.1 * "Defined Status Codes". * * @author Rossen Stoyanchev @@ -133,18 +132,16 @@ public final class CloseStatus { */ public static final CloseStatus TLS_HANDSHAKE_FAILURE = new CloseStatus(1015); - /** - * Indicates that a session has become unreliable (e.g. timed out while sending - * a message) and extra care should be exercised while closing the session in - * order to avoid locking additional threads. - * - *

NOTE: Spring Framework specific status code. + * A status code for use within the framework the indicate a session has + * become unreliable (e.g. timed out while sending a message) and extra + * care should be exercised, e.g. avoid sending any further data to the + * client that may be done during normal shutdown. + * @since 4.0.3 */ public static final CloseStatus SESSION_NOT_RELIABLE = new CloseStatus(4500); - private final int code; private final String reason; @@ -164,39 +161,39 @@ public final class CloseStatus { * @param reason the reason */ public CloseStatus(int code, String reason) { - Assert.isTrue((code >= 1000 && code < 5000), "Invalid code"); + Assert.isTrue((code >= 1000 && code < 5000), "Invalid status code"); this.code = code; this.reason = reason; } /** - * Returns the status code. + * Return the status code. */ public int getCode() { return this.code; } /** - * Returns the reason or {@code null}. + * Return the reason, or {@code null} if none. */ public String getReason() { return this.reason; } /** - * Crate a new {@link CloseStatus} from this one with the specified reason. + * Create a new {@link CloseStatus} from this one with the specified reason. * @param reason the reason - * @return a new {@link StatusCode} instance + * @return a new {@link CloseStatus} instance */ public CloseStatus withReason(String reason) { Assert.hasText(reason, "Reason must not be empty"); return new CloseStatus(this.code, reason); } - @Override - public int hashCode() { - return this.code * 29 + ObjectUtils.nullSafeHashCode(this.reason); + + public boolean equalsCode(CloseStatus other) { + return (this.code == other.code); } @Override @@ -211,13 +208,14 @@ public final class CloseStatus { return (this.code == otherStatus.code && ObjectUtils.nullSafeEquals(this.reason, otherStatus.reason)); } - public boolean equalsCode(CloseStatus other) { - return this.code == other.code; + @Override + public int hashCode() { + return this.code * 29 + ObjectUtils.nullSafeHashCode(this.reason); } @Override public String toString() { - return "CloseStatus [code=" + this.code + ", reason=" + this.reason + "]"; + return "CloseStatus[code=" + this.code + ", reason=" + this.reason + "]"; } } diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionConnectEvent.java b/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionConnectEvent.java index 348609b1a7e..16477a5bd3d 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionConnectEvent.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionConnectEvent.java @@ -16,7 +16,6 @@ package org.springframework.web.socket.messaging; - import org.springframework.context.ApplicationEvent; import org.springframework.messaging.Message; import org.springframework.util.Assert; @@ -53,16 +52,16 @@ public class SessionConnectEvent extends ApplicationEvent { /** * Create a new SessionConnectEvent. - * * @param source the component that published the event (never {@code null}) * @param message the connect message */ public SessionConnectEvent(Object source, Message message) { super(source); - Assert.notNull(message, "'message' must not be null"); + Assert.notNull(message, "Message must not be null"); this.message = message; } + /** * Return the connect message. */ @@ -70,9 +69,9 @@ public class SessionConnectEvent extends ApplicationEvent { return this.message; } - @Override public String toString() { - return "SessionConnectEvent: message=" + message; + return "SessionConnectEvent: message=" + this.message; } + } diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionConnectedEvent.java b/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionConnectedEvent.java index 45e47dce81e..c0201a62e61 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionConnectedEvent.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionConnectedEvent.java @@ -16,7 +16,6 @@ package org.springframework.web.socket.messaging; - import org.springframework.context.ApplicationEvent; import org.springframework.messaging.Message; import org.springframework.util.Assert; @@ -35,17 +34,17 @@ public class SessionConnectedEvent extends ApplicationEvent { /** - * Create a new event. - * + * Create a new SessionConnectedEvent. * @param source the component that published the event (never {@code null}) * @param message the connected message */ public SessionConnectedEvent(Object source, Message message) { super(source); - Assert.notNull(message, "'message' must not be null"); + Assert.notNull(message, "Message must not be null"); this.message = message; } + /** * Return the connected message. */ @@ -53,9 +52,9 @@ public class SessionConnectedEvent extends ApplicationEvent { return this.message; } - @Override public String toString() { - return "SessionConnectedEvent: message=" + message; + return "SessionConnectedEvent: message=" + this.message; } + } diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionDisconnectEvent.java b/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionDisconnectEvent.java index 4f291115578..8c0c8dff346 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionDisconnectEvent.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SessionDisconnectEvent.java @@ -16,9 +16,7 @@ package org.springframework.web.socket.messaging; - import org.springframework.context.ApplicationEvent; -import org.springframework.messaging.Message; import org.springframework.util.Assert; import org.springframework.web.socket.CloseStatus; @@ -27,7 +25,7 @@ import org.springframework.web.socket.CloseStatus; * Protocol (e.g. STOMP) as the WebSocket sub-protocol is closed. * *

Note that this event may be raised more than once for a single session and - * therefore event consumers should be idempotent and ignore a duplicate event.. + * therefore event consumers should be idempotent and ignore a duplicate event. * * @author Rossen Stoyanchev * @since 4.0.3 @@ -39,12 +37,12 @@ public class SessionDisconnectEvent extends ApplicationEvent { private final CloseStatus status; + /** - * Create a new event. - * + * Create a new SessionDisconnectEvent. * @param source the component that published the event (never {@code null}) * @param sessionId the disconnect message - * @param closeStatus + * @param closeStatus the status object */ public SessionDisconnectEvent(Object source, String sessionId, CloseStatus closeStatus) { super(source); @@ -53,6 +51,7 @@ public class SessionDisconnectEvent extends ApplicationEvent { this.status = closeStatus; } + /** * Return the session id. */ @@ -71,4 +70,5 @@ public class SessionDisconnectEvent extends ApplicationEvent { public String toString() { return "SessionDisconnectEvent: sessionId=" + this.sessionId; } + }