Class DefaultSockJsService
java.lang.Object
org.springframework.web.socket.sockjs.support.AbstractSockJsService
org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
org.springframework.web.socket.sockjs.transport.handler.DefaultSockJsService
- All Implemented Interfaces:
Aware,Lifecycle,ServletContextAware,CorsConfigurationSource,SockJsService,SockJsServiceConfig
public class DefaultSockJsService
extends TransportHandlingSockJsService
implements ServletContextAware
A default implementation of
SockJsService
with all default TransportHandler implementations pre-registered.- Since:
- 4.0
- Author:
- Rossen Stoyanchev, Juergen Hoeller
-
Field Summary
Fields inherited from class org.springframework.web.socket.sockjs.support.AbstractSockJsService
corsConfiguration, logger -
Constructor Summary
ConstructorsConstructorDescriptionDefaultSockJsService(TaskScheduler scheduler) Create a DefaultSockJsService with defaulthandlertypes.DefaultSockJsService(TaskScheduler scheduler, Collection<TransportHandler> handlerOverrides) Create a DefaultSockJsService with overriddenhandlertypes replacing the corresponding default handler implementation.DefaultSockJsService(TaskScheduler scheduler, TransportHandler... handlerOverrides) Create a DefaultSockJsService with overriddenhandlertypes replacing the corresponding default handler implementation. -
Method Summary
Modifier and TypeMethodDescriptionvoidsetServletContext(ServletContext servletContext) Set theServletContextthat this object runs in.Methods inherited from class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
getHandshakeInterceptors, getMessageCodec, getTransportHandlers, handleRawWebSocketRequest, handleTransportRequest, isRunning, setHandshakeInterceptors, setMessageCodec, start, stop, validateRequestMethods inherited from class org.springframework.web.socket.sockjs.support.AbstractSockJsService
addCacheHeaders, addNoCacheHeaders, checkOrigin, getAllowedOriginPatterns, getAllowedOrigins, getCorsConfiguration, getDisconnectDelay, getHeartbeatTime, getHttpMessageCacheSize, getName, getSockJsClientLibraryUrl, getStreamBytesLimit, getTaskScheduler, handleRequest, isSessionCookieNeeded, isWebSocketEnabled, sendMethodNotAllowed, setAllowedOriginPatterns, setAllowedOrigins, setDisconnectDelay, setHeartbeatTime, setHttpMessageCacheSize, setName, setSessionCookieNeeded, setSockJsClientLibraryUrl, setStreamBytesLimit, setSuppressCors, setWebSocketEnabled, shouldSuppressCorsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig
getHeartbeatTime, getHttpMessageCacheSize, getStreamBytesLimit, getTaskScheduler
-
Constructor Details
-
DefaultSockJsService
Create a DefaultSockJsService with defaulthandlertypes.- Parameters:
scheduler- a task scheduler for heart-beat messages and removing timed-out sessions; the provided TaskScheduler should be declared as a Spring bean to ensure it is initialized at start up and shut down when the application stops.
-
DefaultSockJsService
Create a DefaultSockJsService with overriddenhandlertypes replacing the corresponding default handler implementation.- Parameters:
scheduler- a task scheduler for heart-beat messages and removing timed-out sessions; the provided TaskScheduler should be declared as a Spring bean to ensure it gets initialized at start-up and shuts down when the application stopshandlerOverrides- zero or more overrides to the default transport handler types
-
DefaultSockJsService
Create a DefaultSockJsService with overriddenhandlertypes replacing the corresponding default handler implementation.- Parameters:
scheduler- a task scheduler for heart-beat messages and removing timed-out sessions; the provided TaskScheduler should be declared as a Spring bean to ensure it gets initialized at start-up and shuts down when the application stopshandlerOverrides- zero or more overrides to the default transport handler types
-
-
Method Details
-
setServletContext
Description copied from interface:ServletContextAwareSet theServletContextthat this object runs in.Invoked after population of normal bean properties but before an init callback like InitializingBean's
afterPropertiesSetor a custom init-method. Invoked after ApplicationContextAware'ssetApplicationContext.- Specified by:
setServletContextin interfaceServletContextAware- Parameters:
servletContext- the ServletContext object to be used by this object- See Also:
-