Package org.springframework.web.socket.server.standard

Class ServletServerContainerFactoryBean

java.lang.Object
org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
All Implemented Interfaces:
Aware, FactoryBean<WebSocketContainer>, InitializingBean, ServletContextAware
public class ServletServerContainerFactoryBean extends Object implements FactoryBean<WebSocketContainer>, ServletContextAware, InitializingBean
A FactoryBean for configuring ServerContainer. Since there is usually only one ServerContainer instance accessible under a well-known jakarta.servlet.ServletContext attribute, simply declaring this FactoryBean and using its setters allows for configuring the ServerContainer through Spring configuration.

This is useful even if the ServerContainer is not injected into any other bean within the Spring application context. For example, an application can configure a DefaultHandshakeHandler, a SockJsService, or ServerEndpointExporter, and separately declare this FactoryBean in order to customize the properties of the (one and only) ServerContainer instance.

Since:
4.0
Author:
Rossen Stoyanchev, Sam Brannen

  • Constructor Details

    • ServletServerContainerFactoryBean

      public ServletServerContainerFactoryBean()

  • Method Details

    • setAsyncSendTimeout

      public void setAsyncSendTimeout(Long timeoutInMillis)

    • getAsyncSendTimeout

      @Nullable public Long getAsyncSendTimeout()

    • setMaxSessionIdleTimeout

      public void setMaxSessionIdleTimeout(Long timeoutInMillis)

    • getMaxSessionIdleTimeout

      @Nullable public Long getMaxSessionIdleTimeout()

    • setMaxTextMessageBufferSize

      public void setMaxTextMessageBufferSize(Integer bufferSize)

    • getMaxTextMessageBufferSize

      @Nullable public Integer getMaxTextMessageBufferSize()

    • setMaxBinaryMessageBufferSize

      public void setMaxBinaryMessageBufferSize(Integer bufferSize)

    • getMaxBinaryMessageBufferSize

      @Nullable public Integer getMaxBinaryMessageBufferSize()

    • setServletContext

      public void setServletContext(ServletContext servletContext)
      Description copied from interface: ServletContextAware
      Set the ServletContext that this object runs in.

      Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.

      Specified by:
      setServletContext in interface ServletContextAware
      Parameters:
      servletContext - the ServletContext object to be used by this object
      See Also:

    • afterPropertiesSet

      public void afterPropertiesSet()
      Description copied from interface: InitializingBean
      Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

      This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

      Specified by:
      afterPropertiesSet in interface InitializingBean

    • getObject

      @Nullable public ServerContainer getObject()
      Description copied from interface: FactoryBean
      Return an instance (possibly shared or independent) of the object managed by this factory.

      As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

      If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

      As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

      Specified by:
      getObject in interface FactoryBean<WebSocketContainer>
      Returns:
      an instance of the bean (can be null)
      See Also:

    • getObjectType

      public Class<?> getObjectType()
      Description copied from interface: FactoryBean
      Return the type of object that this FactoryBean creates, or null if not known in advance.

      This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

      In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

      This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

      NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

      Specified by:
      getObjectType in interface FactoryBean<WebSocketContainer>
      Returns:
      the type of object that this FactoryBean creates, or null if not known at the time of the call
      See Also:

    • isSingleton

      public boolean isSingleton()
      Description copied from interface: FactoryBean
      Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?

      NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

      The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

      NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean.isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

      The default implementation returns true, since a FactoryBean typically manages a singleton instance.

      Specified by:
      isSingleton in interface FactoryBean<WebSocketContainer>
      Returns:
      whether the exposed object is a singleton
      See Also: