Javadocs and general formatting polish

spring-websocket/src/main/java/org/springframework/sockjs/AbstractSockJsSession.java

@@ -37,7 +37,8 @@
  */
 public abstract class AbstractSockJsSession implements WebSocketSession {
 
-	protected Log logger = LogFactory.getLog(this.getClass());
+	protected final Log logger = LogFactory.getLog(getClass());
+
 
 	private final String sessionId;
 

spring-websocket/src/main/java/org/springframework/sockjs/SockJsSessionFactory.java

@@ -20,15 +20,21 @@
 import org.springframework.websocket.WebSocketHandler;
 import org.springframework.websocket.WebSocketSession;
 
-
 /**
  * A factory for creating a SockJS session.
  *
+ * @param <S> The type of session being created
  * @author Rossen Stoyanchev
  * @since 4.0
  */
 public interface SockJsSessionFactory<S extends WebSocketSession>{
 
+	/**
+	 * Create a new SockJS session.
+	 * @param sessionId the ID of the session
+	 * @param handler the underlying {@link WebSocketHandler}
+	 * @return a new non-null session
+	 */
 	S createSession(String sessionId, HandlerProvider<WebSocketHandler> handler);
 
 }

spring-websocket/src/main/java/org/springframework/sockjs/package-info.java

@@ -1,7 +1,21 @@
+/*
+ * Copyright 2002-2013 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 /**
  * Common abstractions and Spring configuration support for the SockJS protocol.
- *
  */
 package org.springframework.sockjs;
 

spring-websocket/src/main/java/org/springframework/sockjs/server/AbstractServerSockJsSession.java

@@ -30,7 +30,6 @@
 import org.springframework.websocket.WebSocketHandler;
 import org.springframework.websocket.WebSocketMessage;
 
-
 /**
  * Provides partial implementations of {@link SockJsSession} methods to send messages,
  * including heartbeat messages and to manage session state.

spring-websocket/src/main/java/org/springframework/sockjs/server/AbstractSockJsService.java

@@ -39,7 +39,6 @@
 import org.springframework.websocket.HandlerProvider;
 import org.springframework.websocket.WebSocketHandler;
 
-
 /**
  * Provides support for SockJS configuration options and serves the static SockJS URLs.
  *

spring-websocket/src/main/java/org/springframework/sockjs/server/ConfigurableTransportHandler.java

@@ -16,9 +16,7 @@
 
 package org.springframework.sockjs.server;
 
-
 /**
- *
  * @author Rossen Stoyanchev
  * @since 4.0
  */

spring-websocket/src/main/java/org/springframework/sockjs/server/NestedSockJsRuntimeException.java

@@ -18,7 +18,6 @@
 
 import org.springframework.core.NestedRuntimeException;
 
-
 /**
  *
  * @author Rossen Stoyanchev
@@ -27,7 +26,6 @@
 @SuppressWarnings("serial")
 public class NestedSockJsRuntimeException extends NestedRuntimeException {
 
-
 	public NestedSockJsRuntimeException(String msg) {
 		super(msg);
 	}

spring-websocket/src/main/java/org/springframework/sockjs/server/SockJsConfiguration.java

@@ -13,13 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server;
 
 import org.springframework.scheduling.TaskScheduler;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
 
 /**
- *
  * @author Rossen Stoyanchev
  * @since 4.0
  */

spring-websocket/src/main/java/org/springframework/sockjs/server/SockJsFrame.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server;
 
 import java.nio.charset.Charset;
@@ -21,10 +22,7 @@
 
 import com.fasterxml.jackson.core.io.JsonStringEncoder;
 
-
 /**
- *
- *
  * @author Rossen Stoyanchev
  * @since 4.0
  */
@@ -46,6 +44,7 @@ private SockJsFrame(String content) {
 		this.content = content;
 	}
 
+
 	public static SockJsFrame openFrame() {
 		return OPEN_FRAME;
 	}

spring-websocket/src/main/java/org/springframework/sockjs/server/SockJsService.java

@@ -23,15 +23,12 @@
 import org.springframework.websocket.HandlerProvider;
 import org.springframework.websocket.WebSocketHandler;
 
-
 /**
- *
  * @author Rossen Stoyanchev
  * @since 4.0
  */
 public interface SockJsService {
 
-
 	void handleRequest(ServerHttpRequest request, ServerHttpResponse response, String sockJsPath,
 			HandlerProvider<WebSocketHandler> handler) throws IOException, TransportErrorException;
 

spring-websocket/src/main/java/org/springframework/sockjs/server/TransportHandler.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server;
 
 import org.springframework.http.server.ServerHttpRequest;
@@ -21,9 +22,7 @@
 import org.springframework.websocket.HandlerProvider;
 import org.springframework.websocket.WebSocketHandler;
 
-
 /**
- *
  * @author Rossen Stoyanchev
  * @since 4.0
  */

spring-websocket/src/main/java/org/springframework/sockjs/server/TransportType.java

@@ -13,16 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server;
 
 import java.util.Arrays;
 import java.util.List;
 
 import org.springframework.http.HttpMethod;
 
-
 /**
- *
  * @author Rossen Stoyanchev
  * @since 4.0
  */

spring-websocket/src/main/java/org/springframework/sockjs/server/package-info.java

@@ -1,7 +1,21 @@
+/*
+ * Copyright 2002-2013 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 /**
  * Server-side SockJS abstractions and base classes.
- *
  */
 package org.springframework.sockjs.server;
 

spring-websocket/src/main/java/org/springframework/sockjs/server/support/DefaultSockJsService.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server.support;
 
 import java.io.IOException;

spring-websocket/src/main/java/org/springframework/sockjs/server/support/SockJsHttpRequestHandler.java

@@ -35,9 +35,7 @@
 import org.springframework.websocket.WebSocketHandler;
 import org.springframework.websocket.support.SimpleHandlerProvider;
 
-
 /**
- *
  * @author Rossen Stoyanchev
  * @since 4.0
  */
@@ -89,6 +87,7 @@ public SockJsHttpRequestHandler(String prefix, SockJsService sockJsService,
 		this.handlerProvider = handlerProvider;
 	}
 
+
 	public String getPrefix() {
 		return this.prefix;
 	}

spring-websocket/src/main/java/org/springframework/sockjs/server/support/package-info.java

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2002-2013 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 /**
  * Server-side SockJS classes including a

spring-websocket/src/main/java/org/springframework/sockjs/server/transport/AbstractHttpReceivingTransportHandler.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server.transport;
 
 import java.io.IOException;
@@ -34,7 +35,6 @@
 import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
-
 /**
  * TODO
  *

spring-websocket/src/main/java/org/springframework/sockjs/server/transport/AbstractHttpSendingTransportHandler.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server.transport;
 
 import java.io.IOException;
@@ -94,4 +95,4 @@ else if (!httpServerSession.isActive()) {
 
 	protected abstract FrameFormat getFrameFormat(ServerHttpRequest request);
 
-}
+}

spring-websocket/src/main/java/org/springframework/sockjs/server/transport/AbstractHttpServerSockJsSession.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server.transport;
 
 import java.io.IOException;

spring-websocket/src/main/java/org/springframework/sockjs/server/transport/EventSourceTransportHandler.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server.transport;
 
 import java.io.IOException;
@@ -27,7 +28,6 @@
 import org.springframework.websocket.HandlerProvider;
 import org.springframework.websocket.WebSocketHandler;
 
-
 /**
  * TODO
  *
@@ -36,7 +36,6 @@
  */
 public class EventSourceTransportHandler extends AbstractHttpSendingTransportHandler {
 
-
 	@Override
 	public TransportType getTransportType() {
 		return TransportType.EVENT_SOURCE;

spring-websocket/src/main/java/org/springframework/sockjs/server/transport/HtmlFileTransportHandler.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server.transport;
 
 import java.io.IOException;
@@ -32,7 +33,6 @@
 import org.springframework.websocket.HandlerProvider;
 import org.springframework.websocket.WebSocketHandler;
 
-
 /**
  * TODO
  *

spring-websocket/src/main/java/org/springframework/sockjs/server/transport/JsonpPollingTransportHandler.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server.transport;
 
 import java.nio.charset.Charset;
@@ -31,7 +32,6 @@
 import org.springframework.websocket.HandlerProvider;
 import org.springframework.websocket.WebSocketHandler;
 
-
 /**
  * TODO
  *
@@ -40,7 +40,6 @@
  */
 public class JsonpPollingTransportHandler extends AbstractHttpSendingTransportHandler {
 
-
 	@Override
 	public TransportType getTransportType() {
 		return TransportType.JSONP;

spring-websocket/src/main/java/org/springframework/sockjs/server/transport/JsonpTransportHandler.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.sockjs.server.transport;
 
 import java.io.IOException;
@@ -27,7 +28,6 @@
 
 public class JsonpTransportHandler extends AbstractHttpReceivingTransportHandler {
 
-
 	@Override
 	public TransportType getTransportType() {
 		return TransportType.JSONP_SEND;