Package org.opendaylight.netconf.nettyutil.handler

Class NetconfHelloMessageToXMLEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToByteEncoder<org.opendaylight.netconf.api.NetconfMessage>

org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder

org.opendaylight.netconf.nettyutil.handler.NetconfHelloMessageToXMLEncoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler

public final class NetconfHelloMessageToXMLEncoder
extends NetconfMessageToXMLEncoder

Customized NetconfMessageToXMLEncoder that serializes additional header with session metadata along with NetconfHelloMessage . Used by netconf clients to send information about the user, ip address, protocol etc.

Hello message with header example:

 
 [tomas;10.0.0.0/10000;tcp;1000;1000;;/home/tomas;;]
 < hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
 < capabilities>
 < capability>urn:ietf:params:netconf:base:1.0< /capability>
 < /capabilities>
 < /hello>
 
 

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
NetconfHelloMessageToXMLEncoder()

Method Summary

Modifier and Type	Method	Description
void	encode(io.netty.channel.ChannelHandlerContext ctx, org.opendaylight.netconf.api.NetconfMessage msg, io.netty.buffer.ByteBuf out)

Methods inherited from class io.netty.handler.codec.MessageToByteEncoder

acceptOutboundMessage, allocateBuffer, isPreferDirect, write

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

NetconfHelloMessageToXMLEncoder

public NetconfHelloMessageToXMLEncoder()

Method Detail

encode

public void encode(io.netty.channel.ChannelHandlerContext ctx,
                   org.opendaylight.netconf.api.NetconfMessage msg,
                   io.netty.buffer.ByteBuf out)
            throws IOException,
                   TransformerException

Overrides:

encode in class NetconfMessageToXMLEncoder

Throws:

IOException

TransformerException