org.opendaylight.netconf.nettyutil

Class AbstractNetconfSession<S extends org.opendaylight.netconf.api.NetconfSession,L extends org.opendaylight.netconf.api.NetconfSessionListener<S>>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<Object>

org.opendaylight.protocol.framework.AbstractProtocolSession<org.opendaylight.netconf.api.NetconfMessage>

org.opendaylight.netconf.nettyutil.AbstractNetconfSession<S,L>

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, Closeable, AutoCloseable, org.opendaylight.netconf.api.NetconfExiSession, org.opendaylight.netconf.api.NetconfSession, org.opendaylight.protocol.framework.ProtocolSession<org.opendaylight.netconf.api.NetconfMessage>

public abstract class AbstractNetconfSession<S extends org.opendaylight.netconf.api.NetconfSession,L extends org.opendaylight.netconf.api.NetconfSessionListener<S>>
extends org.opendaylight.protocol.framework.AbstractProtocolSession<org.opendaylight.netconf.api.NetconfMessage>
implements org.opendaylight.netconf.api.NetconfSession, org.opendaylight.netconf.api.NetconfExiSession

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNetconfSession(L sessionListener, io.netty.channel.Channel channel, long sessionId)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addExiHandlers(io.netty.handler.codec.ByteToMessageDecoder decoder, io.netty.handler.codec.MessageToByteEncoder<org.opendaylight.netconf.api.NetconfMessage> encoder) Add a set encoder/decoder tuple into the channel pipeline as appropriate.
void	close()
protected void	endOfInput()
long	getSessionId()
protected void	handleMessage(org.opendaylight.netconf.api.NetconfMessage netconfMessage)
boolean	isUp()
protected void	replaceChannelHandler(String handlerName, io.netty.channel.ChannelHandler handler)
protected void	replaceMessageDecoder(io.netty.channel.ChannelHandler handler)
protected void	replaceMessageEncoder(io.netty.channel.ChannelHandler handler)
protected void	replaceMessageEncoderAfterNextMessage(io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelFuture	sendMessage(org.opendaylight.netconf.api.NetconfMessage netconfMessage)
protected void	sessionUp()
void	startExiCommunication(org.opendaylight.netconf.api.NetconfMessage startExiMessage)
protected abstract S	thisInstance()
String	toString()

Methods inherited from class org.opendaylight.protocol.framework.AbstractProtocolSession

channelInactive, channelRead0, handlerAdded

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.netconf.api.NetconfExiSession

stopExiCommunication

Methods inherited from interface io.netty.channel.ChannelHandler

handlerRemoved

Constructor Detail

AbstractNetconfSession

protected AbstractNetconfSession(L sessionListener,
                                 io.netty.channel.Channel channel,
                                 long sessionId)

Method Detail

thisInstance

protected abstract S thisInstance()

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.opendaylight.protocol.framework.ProtocolSession<org.opendaylight.netconf.api.NetconfMessage>

handleMessage

protected void handleMessage(org.opendaylight.netconf.api.NetconfMessage netconfMessage)

Specified by:

handleMessage in class org.opendaylight.protocol.framework.AbstractProtocolSession<org.opendaylight.netconf.api.NetconfMessage>

sendMessage

public io.netty.channel.ChannelFuture sendMessage(org.opendaylight.netconf.api.NetconfMessage netconfMessage)

Specified by:

sendMessage in interface org.opendaylight.netconf.api.NetconfSession

endOfInput

protected void endOfInput()

Specified by:

endOfInput in class org.opendaylight.protocol.framework.AbstractProtocolSession<org.opendaylight.netconf.api.NetconfMessage>

sessionUp

protected void sessionUp()

Specified by:

sessionUp in class org.opendaylight.protocol.framework.AbstractProtocolSession<org.opendaylight.netconf.api.NetconfMessage>

toString

public String toString()

Overrides:

toString in class Object

replaceMessageDecoder

protected final void replaceMessageDecoder(io.netty.channel.ChannelHandler handler)

replaceMessageEncoder

protected final void replaceMessageEncoder(io.netty.channel.ChannelHandler handler)

replaceMessageEncoderAfterNextMessage

protected final void replaceMessageEncoderAfterNextMessage(io.netty.channel.ChannelHandler handler)

replaceChannelHandler

protected final void replaceChannelHandler(String handlerName,
                                           io.netty.channel.ChannelHandler handler)

startExiCommunication

public final void startExiCommunication(org.opendaylight.netconf.api.NetconfMessage startExiMessage)

Specified by:

startExiCommunication in interface org.opendaylight.netconf.api.NetconfExiSession

addExiHandlers

protected abstract void addExiHandlers(io.netty.handler.codec.ByteToMessageDecoder decoder,
                                       io.netty.handler.codec.MessageToByteEncoder<org.opendaylight.netconf.api.NetconfMessage> encoder)

Add a set encoder/decoder tuple into the channel pipeline as appropriate.

Parameters:

decoder - EXI decoder

encoder - EXI encoder

isUp

public final boolean isUp()

getSessionId

public final long getSessionId()