org.opendaylight.netconf.nettyutil

Class AbstractNetconfSessionNegotiator<P extends org.opendaylight.netconf.api.NetconfSessionPreferences,S extends AbstractNetconfSession<S,L>,L extends org.opendaylight.netconf.api.NetconfSessionListener<S>>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.opendaylight.protocol.framework.AbstractSessionNegotiator<org.opendaylight.netconf.api.messages.NetconfHelloMessage,S>

org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator<P,S,L>

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, org.opendaylight.protocol.framework.SessionNegotiator<S>

public abstract class AbstractNetconfSessionNegotiator<P extends org.opendaylight.netconf.api.NetconfSessionPreferences,S extends AbstractNetconfSession<S,L>,L extends org.opendaylight.netconf.api.NetconfSessionListener<S>>
extends org.opendaylight.protocol.framework.AbstractSessionNegotiator<org.opendaylight.netconf.api.messages.NetconfHelloMessage,S>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractNetconfSessionNegotiator.State Possible states for Finite State Machine.

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_OF_EXCEPTION_HANDLER
protected P	sessionPreferences

Fields inherited from class org.opendaylight.protocol.framework.AbstractSessionNegotiator

channel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNetconfSessionNegotiator(P sessionPreferences, io.netty.util.concurrent.Promise<S> promise, io.netty.channel.Channel channel, io.netty.util.Timer timer, L sessionListener, long connectionTimeoutMillis)

Method Summary

Modifier and Type	Method and Description
protected abstract S	getSession(L sessionListener, io.netty.channel.Channel channel, org.opendaylight.netconf.api.messages.NetconfHelloMessage message)
protected S	getSessionForHelloMessage(org.opendaylight.netconf.api.messages.NetconfHelloMessage netconfMessage)
P	getSessionPreferences()
protected void	replaceHelloMessageInboundHandler(S session) Remove special inbound handler for hello message.
protected void	startNegotiation()

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

channelActive, channelRead, exceptionCaught, handleMessage, negotiationFailed, negotiationSuccessful, sendMessage

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

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.ChannelInboundHandler

channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

NAME_OF_EXCEPTION_HANDLER

public static final String NAME_OF_EXCEPTION_HANDLER

See Also:

Constant Field Values

sessionPreferences

protected final P extends org.opendaylight.netconf.api.NetconfSessionPreferences sessionPreferences

Constructor Detail

AbstractNetconfSessionNegotiator

protected AbstractNetconfSessionNegotiator(P sessionPreferences,
                                           io.netty.util.concurrent.Promise<S> promise,
                                           io.netty.channel.Channel channel,
                                           io.netty.util.Timer timer,
                                           L sessionListener,
                                           long connectionTimeoutMillis)

Method Detail

startNegotiation

protected final void startNegotiation()

Specified by:

startNegotiation in class org.opendaylight.protocol.framework.AbstractSessionNegotiator<org.opendaylight.netconf.api.messages.NetconfHelloMessage,S extends AbstractNetconfSession<S,L>>

getSessionPreferences

public P getSessionPreferences()

getSessionForHelloMessage

protected final S getSessionForHelloMessage(org.opendaylight.netconf.api.messages.NetconfHelloMessage netconfMessage)
                                     throws org.opendaylight.netconf.api.NetconfDocumentedException

Throws:

org.opendaylight.netconf.api.NetconfDocumentedException

replaceHelloMessageInboundHandler

protected final void replaceHelloMessageInboundHandler(S session)

Remove special inbound handler for hello message. Insert regular netconf xml message (en|de)coders.

Inbound hello message handler should be kept until negotiation is successful It caches any non-hello messages while negotiation is still in progress

getSession

protected abstract S getSession(L sessionListener,
                                io.netty.channel.Channel channel,
                                org.opendaylight.netconf.api.messages.NetconfHelloMessage message)
                         throws org.opendaylight.netconf.api.NetconfDocumentedException

Throws:

org.opendaylight.netconf.api.NetconfDocumentedException