org.springframework.web.socket.sockjs.frame

Class AbstractSockJsMessageCodec

java.lang.Object

org.springframework.web.socket.sockjs.frame.AbstractSockJsMessageCodec

All Implemented Interfaces:

SockJsMessageCodec

Direct Known Subclasses:

Jackson2SockJsMessageCodec

public abstract class AbstractSockJsMessageCodec
extends java.lang.Object
implements SockJsMessageCodec

An base class for SockJS message codec that provides an implementation of encode(String[]).

Since:

4.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
AbstractSockJsMessageCodec()

Method Summary

Modifier and Type	Method and Description
protected abstract char[]	applyJsonQuoting(java.lang.String content) Apply standard JSON string quoting (see http://www.json.org/).
java.lang.String	encode(java.lang.String... messages) Encode the given messages as a SockJS message frame.
private java.lang.String	escapeSockJsSpecialChars(char[] characters) See "JSON Unicode Encoding" section of SockJS protocol.
private boolean	isSockJsSpecialChar(char ch) See `escapable_by_server` variable in the SockJS protocol test suite.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.socket.sockjs.frame.SockJsMessageCodec

decode, decodeInputStream

Constructor Detail

AbstractSockJsMessageCodec

public AbstractSockJsMessageCodec()

Method Detail

encode

public java.lang.String encode(java.lang.String... messages)

Description copied from interface: SockJsMessageCodec

Encode the given messages as a SockJS message frame. Aside from applying standard JSON quoting to each message, there are some additional JSON Unicode escaping rules. See the "JSON Unicode Encoding" section of SockJS protocol (i.e. the protocol test suite).

Specified by:

encode in interface SockJsMessageCodec

Parameters:

messages - the messages to encode

Returns:

the content for a SockJS message frame (never null)

applyJsonQuoting

protected abstract char[] applyJsonQuoting(java.lang.String content)

Apply standard JSON string quoting (see http://www.json.org/).

escapeSockJsSpecialChars

private java.lang.String escapeSockJsSpecialChars(char[] characters)

See "JSON Unicode Encoding" section of SockJS protocol.

isSockJsSpecialChar

private boolean isSockJsSpecialChar(char ch)

See `escapable_by_server` variable in the SockJS protocol test suite.