rocks.xmpp.websocket.codec

Class XmppWebSocketDecoder

java.lang.Object

rocks.xmpp.websocket.codec.XmppWebSocketDecoder

All Implemented Interfaces:

javax.websocket.Decoder, javax.websocket.Decoder.Text<StreamElement>

public final class XmppWebSocketDecoder
extends java.lang.Object
implements javax.websocket.Decoder.Text<StreamElement>

Decodes WebSocket text messages to XMPP StreamElements.

The required Unmarshaller for decoding must be supplied via EndpointConfig.getUserProperties(), see XmppWebSocketDecoder.UserProperties.UNMARSHALLER.

Optionally you can also provide a callback, which is called after unmarshalling with the XML string (the text message) and the unmarshalled element. This is useful for debugging purposes, see XmppWebSocketDecoder.UserProperties.ON_READ.

See Also:

XmppWebSocketEncoder, XmppWebSocketDecoder.UserProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmppWebSocketDecoder.UserProperties User properties for usage in EndpointConfig.getUserProperties().

Nested classes/interfaces inherited from interface javax.websocket.Decoder

javax.websocket.Decoder.Binary<T>, javax.websocket.Decoder.BinaryStream<T>, javax.websocket.Decoder.Text<T>, javax.websocket.Decoder.TextStream<T>

Constructor Summary

Constructors

Constructor and Description
XmppWebSocketDecoder()

Method Summary

Modifier and Type	Method and Description
StreamElement	decode(java.lang.String s)
void	destroy()
void	init(javax.websocket.EndpointConfig config)
boolean	willDecode(java.lang.String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

XmppWebSocketDecoder

public XmppWebSocketDecoder()

Method Detail

decode

public final StreamElement decode(java.lang.String s)
                           throws javax.websocket.DecodeException

Specified by:

decode in interface javax.websocket.Decoder.Text<StreamElement>

Throws:

javax.websocket.DecodeException

willDecode

public final boolean willDecode(java.lang.String s)

Specified by:

willDecode in interface javax.websocket.Decoder.Text<StreamElement>

init

public final void init(javax.websocket.EndpointConfig config)

Specified by:

init in interface javax.websocket.Decoder

destroy

public final void destroy()

Specified by:

destroy in interface javax.websocket.Decoder