Merge "builder class for path creating"
[netconf.git] / netconf / netconf-netty-util / src / main / java / org / opendaylight / netconf / nettyutil / AbstractNetconfSessionNegotiator.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.netconf.nettyutil;
10
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import io.netty.channel.Channel;
14 import io.netty.channel.ChannelFuture;
15 import io.netty.channel.ChannelHandler;
16 import io.netty.channel.ChannelHandlerContext;
17 import io.netty.channel.ChannelInboundHandlerAdapter;
18 import io.netty.handler.ssl.SslHandler;
19 import io.netty.util.Timeout;
20 import io.netty.util.Timer;
21 import io.netty.util.TimerTask;
22 import io.netty.util.concurrent.Future;
23 import io.netty.util.concurrent.GenericFutureListener;
24 import io.netty.util.concurrent.Promise;
25 import java.util.concurrent.TimeUnit;
26 import org.opendaylight.netconf.api.NetconfDocumentedException;
27 import org.opendaylight.netconf.api.NetconfMessage;
28 import org.opendaylight.netconf.api.NetconfSessionListener;
29 import org.opendaylight.netconf.api.NetconfSessionPreferences;
30 import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
31 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
32 import org.opendaylight.netconf.nettyutil.handler.FramingMechanismHandlerFactory;
33 import org.opendaylight.netconf.nettyutil.handler.NetconfChunkAggregator;
34 import org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
35 import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToHelloMessageDecoder;
36 import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
37 import org.opendaylight.netconf.util.messages.FramingMechanism;
38 import org.opendaylight.protocol.framework.AbstractSessionNegotiator;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
41 import org.w3c.dom.Document;
42 import org.w3c.dom.NodeList;
43
44 public abstract class AbstractNetconfSessionNegotiator<P extends NetconfSessionPreferences, S extends AbstractNetconfSession<S, L>, L extends NetconfSessionListener<S>>
45     extends AbstractSessionNegotiator<NetconfHelloMessage, S> {
46
47     private static final Logger LOG = LoggerFactory.getLogger(AbstractNetconfSessionNegotiator.class);
48
49     public static final String NAME_OF_EXCEPTION_HANDLER = "lastExceptionHandler";
50
51     protected final P sessionPreferences;
52
53     private final L sessionListener;
54     private Timeout timeout;
55
56     /**
57      * Possible states for Finite State Machine
58      */
59     protected enum State {
60         IDLE, OPEN_WAIT, FAILED, ESTABLISHED
61     }
62
63     private State state = State.IDLE;
64     private final Promise<S> promise;
65     private final Timer timer;
66     private final long connectionTimeoutMillis;
67
68     protected AbstractNetconfSessionNegotiator(final P sessionPreferences, final Promise<S> promise, final Channel channel, final Timer timer,
69             final L sessionListener, final long connectionTimeoutMillis) {
70         super(promise, channel);
71         this.sessionPreferences = sessionPreferences;
72         this.promise = promise;
73         this.timer = timer;
74         this.sessionListener = sessionListener;
75         this.connectionTimeoutMillis = connectionTimeoutMillis;
76     }
77
78     @Override
79     protected final void startNegotiation() {
80         final Optional<SslHandler> sslHandler = getSslHandler(channel);
81         if (sslHandler.isPresent()) {
82             Future<Channel> future = sslHandler.get().handshakeFuture();
83             future.addListener(new GenericFutureListener<Future<? super Channel>>() {
84                 @Override
85                 public void operationComplete(final Future<? super Channel> future) {
86                     Preconditions.checkState(future.isSuccess(), "Ssl handshake was not successful");
87                     LOG.debug("Ssl handshake complete");
88                     start();
89                 }
90             });
91         } else {
92             start();
93         }
94     }
95
96     private static Optional<SslHandler> getSslHandler(final Channel channel) {
97         final SslHandler sslHandler = channel.pipeline().get(SslHandler.class);
98         return sslHandler == null ? Optional.<SslHandler> absent() : Optional.of(sslHandler);
99     }
100
101     public P getSessionPreferences() {
102         return sessionPreferences;
103     }
104
105     private void start() {
106         final NetconfHelloMessage helloMessage = this.sessionPreferences.getHelloMessage();
107         LOG.debug("Session negotiation started with hello message {} on channel {}", helloMessage, channel);
108
109         channel.pipeline().addLast(NAME_OF_EXCEPTION_HANDLER, new ExceptionHandlingInboundChannelHandler());
110
111         sendMessage(helloMessage);
112
113         replaceHelloMessageOutboundHandler();
114         changeState(State.OPEN_WAIT);
115
116         timeout = this.timer.newTimeout(new TimerTask() {
117             @Override
118             public void run(final Timeout timeout) {
119                 synchronized (this) {
120                     if (state != State.ESTABLISHED) {
121
122                         LOG.debug("Connection timeout after {}, session is in state {}", timeout, state);
123
124                         // Do not fail negotiation if promise is done or canceled
125                         // It would result in setting result of the promise second time and that throws exception
126                         if (isPromiseFinished() == false) {
127                             LOG.warn("Netconf session was not established after {}", connectionTimeoutMillis);
128                             changeState(State.FAILED);
129
130                             channel.close().addListener(new GenericFutureListener<ChannelFuture>() {
131                                 @Override
132                                 public void operationComplete(final ChannelFuture future) throws Exception {
133                                     if(future.isSuccess()) {
134                                         LOG.debug("Channel {} closed: success", future.channel());
135                                     } else {
136                                         LOG.warn("Channel {} closed: fail", future.channel());
137                                     }
138                                 }
139                             });
140                         }
141                     } else if(channel.isOpen()) {
142                         channel.pipeline().remove(NAME_OF_EXCEPTION_HANDLER);
143                     }
144                 }
145             }
146
147             private boolean isPromiseFinished() {
148                 return promise.isDone() || promise.isCancelled();
149             }
150
151         }, connectionTimeoutMillis, TimeUnit.MILLISECONDS);
152     }
153
154     private void cancelTimeout() {
155         if(timeout!=null) {
156             timeout.cancel();
157         }
158     }
159
160     protected final S getSessionForHelloMessage(final NetconfHelloMessage netconfMessage) throws NetconfDocumentedException {
161         Preconditions.checkNotNull(netconfMessage, "netconfMessage");
162
163         final Document doc = netconfMessage.getDocument();
164
165         if (shouldUseChunkFraming(doc)) {
166             insertChunkFramingToPipeline();
167         }
168
169         changeState(State.ESTABLISHED);
170         return getSession(sessionListener, channel, netconfMessage);
171     }
172
173     /**
174      * Insert chunk framing handlers into the pipeline
175      */
176     private void insertChunkFramingToPipeline() {
177         replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_FRAME_ENCODER,
178                 FramingMechanismHandlerFactory.createHandler(FramingMechanism.CHUNK));
179         replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_AGGREGATOR,
180                 new NetconfChunkAggregator());
181     }
182
183     private boolean shouldUseChunkFraming(final Document doc) {
184         return containsBase11Capability(doc)
185                 && containsBase11Capability(sessionPreferences.getHelloMessage().getDocument());
186     }
187
188     /**
189      * Remove special inbound handler for hello message. Insert regular netconf xml message (en|de)coders.
190      *
191      * Inbound hello message handler should be kept until negotiation is successful
192      * It caches any non-hello messages while negotiation is still in progress
193      */
194     protected final void replaceHelloMessageInboundHandler(final S session) {
195         ChannelHandler helloMessageHandler = replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_DECODER, new NetconfXMLToMessageDecoder());
196
197         Preconditions.checkState(helloMessageHandler instanceof NetconfXMLToHelloMessageDecoder,
198                 "Pipeline handlers misplaced on session: %s, pipeline: %s", session, channel.pipeline());
199         Iterable<NetconfMessage> netconfMessagesFromNegotiation =
200                 ((NetconfXMLToHelloMessageDecoder) helloMessageHandler).getPostHelloNetconfMessages();
201
202         // Process messages received during negotiation
203         // The hello message handler does not have to be synchronized, since it is always call from the same thread by netty
204         // It means, we are now using the thread now
205         for (NetconfMessage message : netconfMessagesFromNegotiation) {
206             session.handleMessage(message);
207         }
208     }
209
210     /**
211      * Remove special outbound handler for hello message. Insert regular netconf xml message (en|de)coders.
212      */
213     private void replaceHelloMessageOutboundHandler() {
214         replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_ENCODER, new NetconfMessageToXMLEncoder());
215     }
216
217     private static ChannelHandler replaceChannelHandler(final Channel channel, final String handlerKey, final ChannelHandler decoder) {
218         return channel.pipeline().replace(handlerKey, handlerKey, decoder);
219     }
220
221     protected abstract S getSession(L sessionListener, Channel channel, NetconfHelloMessage message) throws NetconfDocumentedException;
222
223     private synchronized void changeState(final State newState) {
224         LOG.debug("Changing state from : {} to : {} for channel: {}", state, newState, channel);
225         Preconditions.checkState(isStateChangePermitted(state, newState), "Cannot change state from %s to %s for chanel %s", state,
226                 newState, channel);
227         this.state = newState;
228     }
229
230     private static boolean containsBase11Capability(final Document doc) {
231         final NodeList nList = doc.getElementsByTagName(XmlNetconfConstants.CAPABILITY);
232         for (int i = 0; i < nList.getLength(); i++) {
233             if (nList.item(i).getTextContent().contains(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1)) {
234                 return true;
235             }
236         }
237         return false;
238     }
239
240     private static boolean isStateChangePermitted(final State state, final State newState) {
241         if (state == State.IDLE && newState == State.OPEN_WAIT) {
242             return true;
243         }
244         if (state == State.OPEN_WAIT && newState == State.ESTABLISHED) {
245             return true;
246         }
247         if (state == State.OPEN_WAIT && newState == State.FAILED) {
248             return true;
249         }
250         LOG.debug("Transition from {} to {} is not allowed", state, newState);
251         return false;
252     }
253
254     /**
255      * Handler to catch exceptions in pipeline during negotiation
256      */
257     private final class ExceptionHandlingInboundChannelHandler extends ChannelInboundHandlerAdapter {
258         @Override
259         public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
260             LOG.warn("An exception occurred during negotiation with {}", channel.remoteAddress(), cause);
261             cancelTimeout();
262             negotiationFailed(cause);
263             changeState(State.FAILED);
264         }
265     }
266 }