public class ServerEndpointExporter
extends org.springframework.web.context.support.WebApplicationObjectSupport
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.SmartInitializingSingleton
ServerEndpointConfig and registers
with the standard Java WebSocket runtime. Also detects beans annotated with
ServerEndpoint and registers them as well. Although not required, it is likely
annotated endpoints should have their configurator property set to
SpringConfigurator.
When this class is used, by declaring it in Spring configuration, it should be
possible to turn off a Servlet container's scan for WebSocket endpoints. This can be
done with the help of the <absolute-ordering> element in web.xml.
ServerEndpointRegistration,
SpringConfigurator,
ServletServerContainerFactoryBean| Constructor and Description |
|---|
ServerEndpointExporter() |
| Modifier and Type | Method and Description |
|---|---|
void |
afterPropertiesSet() |
void |
afterSingletonsInstantiated() |
protected ServerContainer |
getServerContainer()
Return the JSR-356
ServerContainer to use for endpoint registration. |
protected void |
initServletContext(ServletContext servletContext) |
protected boolean |
isContextRequired() |
protected void |
registerEndpoints()
Actually register the endpoints.
|
void |
setAnnotatedEndpointClasses(Class<?>... annotatedEndpointClasses)
Explicitly list annotated endpoint types that should be registered on startup.
|
void |
setServerContainer(ServerContainer serverContainer)
Set the JSR-356
ServerContainer to use for endpoint registration. |
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, setServletContextpublic void setAnnotatedEndpointClasses(Class<?>... annotatedEndpointClasses)
annotatedEndpointClasses - ServerEndpoint-annotated typespublic void setServerContainer(@Nullable
ServerContainer serverContainer)
ServerContainer to use for endpoint registration.
If not set, the container is going to be retrieved via the ServletContext.@Nullable protected ServerContainer getServerContainer()
ServerContainer to use for endpoint registration.protected void initServletContext(ServletContext servletContext)
initServletContext in class org.springframework.web.context.support.WebApplicationObjectSupportprotected boolean isContextRequired()
isContextRequired in class org.springframework.web.context.support.WebApplicationObjectSupportpublic void afterPropertiesSet()
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBeanpublic void afterSingletonsInstantiated()
afterSingletonsInstantiated in interface org.springframework.beans.factory.SmartInitializingSingletonprotected void registerEndpoints()
afterSingletonsInstantiated().