org.springframework.web.socket.client.standard

Class WebSocketContainerFactoryBean

java.lang.Object

org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

All Implemented Interfaces:

FactoryBean<WebSocketContainer>

public class WebSocketContainerFactoryBean
extends Object
implements FactoryBean<WebSocketContainer>

A FactoryBean for creating and configuring a WebSocketContainer through Spring XML configuration. In Java configuration, ignore this class and use ContainerProvider.getWebSocketContainer() instead.

Since:

4.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
WebSocketContainerFactoryBean()

Method Summary

Modifier and Type	Method and Description
long	getAsyncSendTimeout()
int	getMaxBinaryMessageBufferSize()
long	getMaxSessionIdleTimeout()
int	getMaxTextMessageBufferSize()
WebSocketContainer	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketContainerFactoryBean

public WebSocketContainerFactoryBean()

Method Detail

setAsyncSendTimeout

public void setAsyncSendTimeout(long timeoutInMillis)

getAsyncSendTimeout

public long getAsyncSendTimeout()

setMaxSessionIdleTimeout

public void setMaxSessionIdleTimeout(long timeoutInMillis)

getMaxSessionIdleTimeout

public long getMaxSessionIdleTimeout()

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int bufferSize)

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int bufferSize)

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

getObject

public WebSocketContainer getObject()
                             throws Exception

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)

Throws:

Exception - in case of creation errors

See Also:

FactoryBeanNotInitializedException

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:

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()