Package rocks.xmpp.websocket.codec

Class XmppWebSocketEncoder

java.lang.Object

rocks.xmpp.websocket.codec.XmppWebSocketEncoder

All Implemented Interfaces:

javax.websocket.Encoder, javax.websocket.Encoder.TextStream<StreamElement>

public final class XmppWebSocketEncoder
extends Object
implements javax.websocket.Encoder.TextStream<StreamElement>

Encodes XMPP StreamElements to WebSocket text messages.

The required Marshaller for encoding must be supplied via EndpointConfig.getUserProperties(), see XmppWebSocketEncoder.UserProperties.MARSHALLER.

Optionally you can also provide a callback, which is called after marshalling with the encoded text message (the XML string) and the stream element. This is useful for debugging purposes, see XmppWebSocketEncoder.UserProperties.ON_WRITE.

See Also:

XmppWebSocketDecoder, XmppWebSocketEncoder.UserProperties

Nested Class Summary

Nested Classes

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

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

javax.websocket.Encoder.Binary<T extends Object>, javax.websocket.Encoder.BinaryStream<T extends Object>, javax.websocket.Encoder.Text<T extends Object>, javax.websocket.Encoder.TextStream<T extends Object>

Constructor Summary

Constructors

Constructor	Description
XmppWebSocketEncoder()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	encode(StreamElement object, Writer writer)
void	init(javax.websocket.EndpointConfig config)

Methods inherited from class java.lang.Object

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

Constructor Detail

XmppWebSocketEncoder

public XmppWebSocketEncoder()

Method Detail

encode

public final void encode(StreamElement object,
                         Writer writer)
                  throws javax.websocket.EncodeException,
                         IOException

Specified by:

encode in interface javax.websocket.Encoder.TextStream<StreamElement>

Throws:

javax.websocket.EncodeException

IOException

init

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

Specified by:

init in interface javax.websocket.Encoder

destroy

public final void destroy()

Specified by:

destroy in interface javax.websocket.Encoder