org.springframework.web.socket.server.endpoint

Class ServletServerContainerFactoryBean

java.lang.Object

org.springframework.web.socket.server.endpoint.ServletServerContainerFactoryBean

All Implemented Interfaces:

Aware, FactoryBean<WebSocketContainer>, InitializingBean, ServletContextAware

public class ServletServerContainerFactoryBean
extends java.lang.Object
implements FactoryBean<WebSocketContainer>, InitializingBean, ServletContextAware

A FactoryBean for configuring javax.websocket.server.ServerContainer. Since there is only one ServerContainer instance accessible under a well-known javax.servlet.ServletContext attribute, simply declaring this FactoryBean and using its setters allows configuring the ServerContainer through Spring configuration.

This is useful even if the ServerContainer is not injected into any other bean. 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

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Long	asyncSendTimeout
private java.lang.Integer	maxBinaryMessageBufferSize
private java.lang.Long	maxSessionIdleTimeout
private java.lang.Integer	maxTextMessageBufferSize
private ServerContainer	serverContainer

Constructor Summary

Constructors

Constructor and Description
ServletServerContainerFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
long	getAsyncSendTimeout()
java.lang.Integer	getMaxBinaryMessageBufferSize()
java.lang.Long	getMaxSessionIdleTimeout()
java.lang.Integer	getMaxTextMessageBufferSize()
ServerContainer	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
java.lang.Class<?>	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() 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)?
void	setAsyncSendTimeout(long timeoutInMillis)
void	setMaxBinaryMessageBufferSize(int bufferSize)
void	setMaxSessionIdleTimeout(long timeoutInMillis)
void	setMaxTextMessageBufferSize(int bufferSize)
void	setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

asyncSendTimeout

private java.lang.Long asyncSendTimeout

maxSessionIdleTimeout

private java.lang.Long maxSessionIdleTimeout

maxTextMessageBufferSize

private java.lang.Integer maxTextMessageBufferSize

maxBinaryMessageBufferSize

private java.lang.Integer maxBinaryMessageBufferSize

serverContainer

private ServerContainer serverContainer

Constructor Detail

ServletServerContainerFactoryBean

public ServletServerContainerFactoryBean()

Method Detail

setAsyncSendTimeout

public void setAsyncSendTimeout(long timeoutInMillis)

getAsyncSendTimeout

public long getAsyncSendTimeout()

setMaxSessionIdleTimeout

public void setMaxSessionIdleTimeout(long timeoutInMillis)

getMaxSessionIdleTimeout

public java.lang.Long getMaxSessionIdleTimeout()

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int bufferSize)

getMaxTextMessageBufferSize

public java.lang.Integer getMaxTextMessageBufferSize()

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int bufferSize)

getMaxBinaryMessageBufferSize

public java.lang.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 - ServletContext object to be used by this object

See Also:

InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)

getObject

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:

FactoryBeanNotInitializedException

getObjectType

public java.lang.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:

ListableBeanFactory.getBeansOfType(java.lang.Class<T>)

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.

Specified by:

isSingleton in interface FactoryBean<WebSocketContainer>

Returns:

whether the exposed object is a singleton

See Also:

FactoryBean.getObject(), SmartFactoryBean.isPrototype()

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

java.lang.Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails.