org.springframework.web.socket.config

Class HandlersBeanDefinitionParser

java.lang.Object

org.springframework.web.socket.config.HandlersBeanDefinitionParser

All Implemented Interfaces:

BeanDefinitionParser

class HandlersBeanDefinitionParser
extends java.lang.Object
implements BeanDefinitionParser

Parses the configuration for the <websocket:handlers/> namespace element. Registers a Spring MVC SimpleUrlHandlerMapping to map HTTP WebSocket handshake (or SockJS) requests to WebSocketHandlers.

Since:

4.0

Author:

Brian Clozel, Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static interface	HandlersBeanDefinitionParser.HandlerMappingStrategy
private static class	HandlersBeanDefinitionParser.SockJsHandlerMappingStrategy
private static class	HandlersBeanDefinitionParser.WebSocketHandlerMappingStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_MAPPING_ORDER
private static java.lang.String	SOCK_JS_SCHEDULER_NAME

Constructor Summary

Constructors

Constructor and Description
HandlersBeanDefinitionParser()

Method Summary

Modifier and Type	Method and Description
BeanDefinition	parse(org.w3c.dom.Element element, ParserContext context) Parse the specified Element and register the resulting BeanDefinition(s) with the BeanDefinitionRegistry embedded in the supplied ParserContext.

Methods inherited from class java.lang.Object

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

Field Detail

SOCK_JS_SCHEDULER_NAME

private static final java.lang.String SOCK_JS_SCHEDULER_NAME

See Also:

Constant Field Values

DEFAULT_MAPPING_ORDER

private static final int DEFAULT_MAPPING_ORDER

See Also:

Constant Field Values

Constructor Detail

HandlersBeanDefinitionParser

HandlersBeanDefinitionParser()

Method Detail

parse

public BeanDefinition parse(org.w3c.dom.Element element,
                            ParserContext context)

Description copied from interface: BeanDefinitionParser

Parse the specified Element and register the resulting BeanDefinition(s) with the BeanDefinitionRegistry embedded in the supplied ParserContext.

Implementations must return the primary BeanDefinition that results from the parse if they will ever be used in a nested fashion (for example as an inner tag in a <property/> tag). Implementations may return null if they will not be used in a nested fashion.

Specified by:

parse in interface BeanDefinitionParser

Parameters:

element - the element that is to be parsed into one or more BeanDefinitions

context - the object encapsulating the current state of the parsing process; provides access to a BeanDefinitionRegistry

Returns:

the primary BeanDefinition